- surface_meshThe name of the surface mesh saved via the MeshGenerator's `save_mesh_as` parameter.
C++ Type:std::string
Controllable:No
Description:The name of the surface mesh saved via the MeshGenerator's `save_mesh_as` parameter.
SBMSurfaceMeshBuilder
SBMSurfaceMeshBuilder prepares the geometric data structures required by UnsignedDistanceToSurfaceMesh and other distance-based components. It processes a source mesh—identified by the surface_mesh parameter—to generate a list of boundary element wrappers (such as SBMBndEdge2 and SBMBndTri3), a map of element IDs, and a KDTree for efficient nearest-neighbor queries.
To ensure valid spatial searches, the builder verifies that the input mesh is replicated (serial) and that its dimensionality matches the problem domain (e.g., a 2-D surface within a 3-D mesh). Users can optionally configure the KDTree leaf size to balance build time against query speed or enable watertightness checks to validate the boundary topology. Once constructed, these data structures are exposed for reuse by other objects in the simulation.
Constructs a KDTree and boundary elements from a pre-existing surface mesh. The surface mesh is specified in the Mesh block.
Input Parameters
- build_kd_treeTrueWhether to build a kd-tree or not. If false, the kd-tree will not be built, and the mesh will be used directly for queries.
Default:True
C++ Type:bool
Controllable:No
Description:Whether to build a kd-tree or not. If false, the kd-tree will not be built, and the mesh will be used directly for queries.
- 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.
- leaf_max_size10Maximum number of points allowed in a leaf node of the KDTree. Smaller values yield deeper trees with faster queries but slower build times; larger values result in shallower trees with faster builds but slower queries. Benchmarking is recommended to find an optimal tradeoff for your use case.
Default:10
C++ Type:int
Controllable:No
Description:Maximum number of points allowed in a leaf node of the KDTree. Smaller values yield deeper trees with faster queries but slower build times; larger values result in shallower trees with faster builds but slower queries. Benchmarking is recommended to find an optimal tradeoff for your use case.
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.
Material Property Retrieval Parameters
Input Files
- (modules/shifted_boundary_method/test/tests/coverage/coverage_omnibus.i)
- (modules/shifted_boundary_method/test/tests/distance_calc/2D_distance_refine.i)
- (modules/shifted_boundary_method/test/tests/coverage/gradient_on_surface.i)
- (modules/shifted_boundary_method/test/tests/coverage/build_kd_tree_false.i)
- (modules/shifted_boundary_method/test/tests/distance_calc/3D_distance_refine.i)
- (modules/shifted_boundary_method/test/tests/distance_calc/2D_multiple_distances_refine_test.i)
- (modules/shifted_boundary_method/test/tests/distance_calc/3D_multiple_distances_refine.i)
- (modules/shifted_boundary_method/test/tests/coverage/non_watertight.i)