- ghost_uoThe GhostUserObject from which to obtain ghosting information from.
C++ Type:UserObjectName
Description:The GhostUserObject from which to obtain ghosting information from.
- pidThe PID to see the ghosting for
C++ Type:unsigned int
Description:The PID to see the ghosting for
- variableThe name of the variable that this object applies to
C++ Type:AuxVariableName
Description:The name of the variable that this object applies to
GhostingAux
Colors the elements ghosted to the chosen PID.
Description
GhostingAux allows you to visualize what the current algebraic and geomtric ghosting functors (and RelationshipManagers) are going to do. This is useful in tracking down both under and over-ghosting.
At any one time it will only show you the ghosted elements for one processor ID.
Normally, this class shouldn't be used directly. Instead set it up through the (DisplayGhostingAction.md).
Figure 1: The default geometric ghosting for PID 1
Figure 2: The default algebraic ghosting for PID 1
Input Parameters
- blockThe list of block ids (SubdomainID) that this object will be applied
C++ Type:std::vector
Description:The list of block ids (SubdomainID) that this object will be applied
- boundaryThe list of boundary IDs from the mesh where this boundary condition applies
C++ Type:std::vector
Description:The list of boundary IDs from the mesh where this boundary condition applies
- execute_onINITIAL TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
Default:INITIAL TIMESTEP_END
C++ Type:ExecFlagEnum
Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.
- functor_typegeometricThe type of ghosting functor to use
Default:geometric
C++ Type:MooseEnum
Description:The type of ghosting functor to use
- include_local_elementsFalseWhether or not to include local elements as part of the ghosting set
Default:False
C++ Type:bool
Description:Whether or not to include local elements as part of the ghosting set
Optional Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector
Description:Adds user-defined labels for accessing object parameters via control logic.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Description:Set the enabled status of the MooseObject.
- seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Description:The seed for the master random number generator
- use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
Default:False
C++ Type:bool
Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.