- surface_meshThe name of the surface mesh saved via the MeshGenerator's `save_with_name` parameter.
C++ Type:std::string
Controllable:No
Description:The name of the surface mesh saved via the MeshGenerator's `save_with_name` parameter.
BoundaryMeshBuilder
BoundaryMeshBuilder owns a saved surface (boundary) mesh and the surface-element wrappers built from it, exposing both for reuse by point-containment and distance user objects. It is the sole retriever of the saved mesh: a mesh saved through a MeshGenerator's save_with_name parameter has single-retrieval semantics, so exactly one object may own it. Consumers hold a non-owning reference to this builder rather than retrieving the saved mesh again.
Description
The builder retrieves the saved surface mesh named by the surface_mesh parameter during initialSetup, prepares it for use, and validates that:
the mesh is replicated (serialized); a distributed surface mesh is rejected, because point-containment queries require the whole surface on every rank;
the background (embedding) mesh dimension equals the surface mesh dimension plus one (e.g. a 2-D surface inside a 3-D domain).
The surface-element wrappers (the SurfaceElementSet) are built lazily on first use, so backends that classify from the mesh directly (such as the fixed_x_ray TriangleManifold engine) pay no allocation for a set they never read.
When check_watertightness = true the builder reports, via an informational message, whether every surface element has a neighbor on every side. A non-watertight surface may not be suitable for in-out tests.
Example Input Syntax
[UserObjects]
[surface_builder]
type = BoundaryMeshBuilder
surface_mesh = boundary_mesh
[]
[]
Owns a saved surface (boundary) mesh and the SurfaceElement wrappers built from it, for use by point-containment and distance user objects.
Input Parameters
- check_watertightnessFalseCheck if the mesh is watertight. If false, the mesh may not be suitable for In-Out tests.
Default:False
C++ Type:bool
Controllable:No
Description:Check if the mesh is watertight. If false, the mesh may not be suitable for In-Out tests.
Optional Parameters
- allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
Default:False
C++ Type:bool
Controllable:No
Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
- execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
- execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
Default:0
C++ Type:int
Controllable:No
Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
- force_postauxFalseForces the UserObject to be executed in POSTAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in POSTAUX
- force_preauxFalseForces the UserObject to be executed in PREAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREAUX
- force_preicFalseForces the UserObject to be executed in PREIC during initial setup
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup
Execution Scheduling Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:Yes
Description:Set the enabled status of the MooseObject.
- 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
Controllable:No
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.
Advanced Parameters
- prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
- use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
Default:False
C++ Type:bool
Controllable:No
Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.