- functionSigned level-set function; negative inside by default (see inside_is_negative).
C++ Type:FunctionName
Unit:(no unit assumed)
Controllable:No
Description:Signed level-set function; negative inside by default (see inside_is_negative).
PointInSignedFunctionCheckUO
PointInSignedFunctionCheckUO classifies a point against a surface defined implicitly as the zero level set of a signed function. Unlike the mesh-based PointInPolyhedronCheckUO, it needs no surface mesh: the classification comes directly from the sign of the function value at the query point. It implements the point-in-surface check interface, so it can be combined with mesh-based checkers inside a PointInUnionCheckUO.
Sign convention
By default a negative function value denotes the interior, matching the usual signed-distance-function convention (and the union signed distance used elsewhere in the shifted boundary method). If your level set is positive inside instead, set inside_is_negative = false and the sign is flipped internally.
Tolerance and the on-surface band
A point is labeled as follows, after normalizing so that negative denotes the interior:
phi < -tolerance->INSIDE|phi| <= tolerance->ONphi > tolerance->OUTSIDE
Two consequences are worth noting:
toleranceaffects containment. BecauseONis treated as contained (spatialValue()returns1for it), the contained region is the true interior grown by a shell of half-widthtolerancearound the zero level set, rather than the exact sign region. This matches how the mesh backend treats on-surface points.toleranceis measured in function value space, not distance. It equals a geometric distance only when the function is a normalized signed distance (|grad phi| = 1). For a general level set (for examplex^2 + y^2 - 1, whose gradient magnitude varies) the geometric thickness of the on-surface band changes with position, so choosetolerancewith the function's scaling in mind.
Usage
Set function to the signed level-set function. The result is available through the standard spatial user object interface and can be sampled by a SpatialUserObjectAux.
Classifies a point as inside, on, or outside a surface defined by the zero level set of a signed function.
Input Parameters
- inside_is_negativeTrueWhether negative function values denote the interior. True matches the signed-distance convention; set false for a level set that is positive inside.
Default:True
C++ Type:bool
Controllable:No
Description:Whether negative function values denote the interior. True matches the signed-distance convention; set false for a level set that is positive inside.
- tolerance1e-06Half-width, in function value space, of the on-surface band around the zero level set. Points within this band are labeled as on the surface.
Default:1e-06
C++ Type:Real
Unit:(no unit assumed)
Controllable:No
Description:Half-width, in function value space, of the on-surface band around the zero level set. Points within this band are labeled as on the surface.
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.