- boundaryThe list of boundary IDs from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The list of boundary IDs from the mesh where this object applies
BoundaryShortestDistanceToSurface
Provides, at each quadrature point on a (surrogate) boundary, the vector from that point to its projection on the true surface, together with the true surface normal there. The true surface may be described by level-set/distance functions or a mesh-based representation.
Overview
The BoundaryShortestDistanceToSurface user object precomputes and caches the geometric shift data required by the Shifted Boundary Method (SBM) and Shifted Interface Method (SIM). At each quadrature point on designated surrogate boundary sides, it provides: - The distance vector** () from the surrogate quadrature point to its closest projection on the true surface. - The true surface normal** () evaluated at that projected point.
These quantities are used by downstream objects—such as interface kernels and material models—to perform Taylor expansions that transfer boundary/interface conditions from the surrogate boundary to the true interface.
Distance Data Sources
Distance and normal data can be supplied through two modes: 1. Analytical Distance Functions**: Through the "surfaces" parameter, specifying parsed functions or distance functions corresponding to each surrogate boundary in "boundary". 2. Mesh-Based Interfaces via Manager**: Through the "manager" parameter, referencing an SBMInterfaceManager and specifying the subdomain pairs ("interface_subdomain_pairs") that correspond to each boundary.
The Shifted Cohesive Zone Physics can configure and instantiate this object automatically.
Element Scale Validation and Warnings
In the Shifted Boundary Method, the surrogate boundary is expected to be adjacent to the true interface (lying within approximately one element layer). To prevent silently computing inaccurate Taylor expansions when an incorrect surface or boundary has been specified: - The object computes the estimated element diagonal (where is the element volume). - If the shift distance exceeds this estimated element diagonal, a warning is emitted reporting the element ID, side index, distance magnitude, and element diagonal scale. - If large shift distances are intentional for a specific model, this warning can be disabled by setting "suppress_distance_warning" to true.
Example Input File Syntax
The following snippet demonstrates configuring BoundaryShortestDistanceToSurface on an internal surrogate interface using an analytical distance function:
[UserObjects<<<{"href": "../../syntax/UserObjects/index.html"}>>>]
[sbm_distance_uo]
type = BoundaryShortestDistanceToSurface<<<{"description": "Provides, at each quadrature point on a (surrogate) boundary, the vector from that point to its projection on the true surface, together with the true surface normal there. The true surface may be described by level-set/distance functions or a mesh-based representation.", "href": "BoundaryShortestDistanceToSurface.html"}>>>
surfaces<<<{"description": "Level-set or mesh-based functions that define the boundary distances."}>>> = signed_dist_func
boundary<<<{"description": "The list of boundary IDs from the mesh where this object applies"}>>> = 'Block1_Block2'
execution_order_group<<<{"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."}>>> = 0
execute_on<<<{"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."}>>> = INITIAL
[]
[]Input Parameters
- debug_outputFalseIf true, debug output will be enabled.
Default:False
C++ Type:bool
Controllable:No
Description:If true, debug output will be enabled.
- interface_subdomain_pairsOrdered subdomain pair for each boundary. If omitted, pairs are inferred from boundary names of the form grainX_grainY or blockX_blockY.
C++ Type:std::vector<std::vector<unsigned short>>
Controllable:No
Description:Ordered subdomain pair for each boundary. If omitted, pairs are inferred from boundary names of the form grainX_grainY or blockX_blockY.
- managerSBMInterfaceManager used instead of per-interface surface functions.
C++ Type:UserObjectName
Controllable:No
Description:SBMInterfaceManager used instead of per-interface surface functions.
- suppress_distance_warningFalseIf true, warnings about large distances will be suppressed.
Default:False
C++ Type:bool
Controllable:No
Description:If true, warnings about large distances will be suppressed.
- surfacesLevel-set or mesh-based functions that define the boundary distances.
C++ Type:std::vector<FunctionName>
Unit:(no unit assumed)
Controllable:No
Description:Level-set or mesh-based functions that define the boundary distances.
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/shifted_cohesive_zone/angled_sczm_ad_elastic.i)
- (modules/shifted_boundary_method/test/tests/shifted_cohesive_zone/angled_sczm_common.i)
- (modules/shifted_boundary_method/test/tests/shifted_cohesive_zone/rectangle_sczm_tri_material.i)
- (modules/shifted_boundary_method/test/tests/shifted_cohesive_zone/angled_sczm_nonad_salehani.i)
- (modules/shifted_boundary_method/test/tests/shifted_cohesive_zone/sczm_triangle_mms.i)