- paired_boundaryThe boundary on the other side of a gap.
C++ Type:BoundaryName
Unit:(no unit assumed)
Controllable:No
Description:The boundary on the other side of a gap.
- paired_variableThe variable to get the value of.
C++ Type:VariableName
Unit:(no unit assumed)
Controllable:No
Description:The variable to get the value of.
- variableThe name of the variable that this object applies to
C++ Type:AuxVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this object applies to
GapValueAux
Return the nearest value of a variable on a boundary from across a gap.
This object is typically used in mechanical contact problems to get information about the variable on the other side of the boundary.
See GeometricSearchData for more information on the treatment of contact problems.
Example syntax
In this example, the GapValueAux
is used to retrieve the value of variable u
on boundary rightleft
across from boundary leftright
.
[AuxKernels]
[./gap_value_aux]
type = GapValueAux
variable = gap_value
boundary = leftright
paired_variable = u
paired_boundary = rightleft
[../]
[]
(moose/test/tests/auxkernels/gap_value/gap_value.i)Input Parameters
- blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Unit:(no unit assumed)
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
- boundaryThe list of boundaries (ids or names) from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Unit:(no unit assumed)
Controllable:No
Description:The list of boundaries (ids or names) from the mesh where this object applies
- check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
- execute_onLINEAR TIMESTEP_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:LINEAR TIMESTEP_END
C++ Type:ExecFlagEnum
Unit:(no unit assumed)
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.
- normal_smoothing_distanceDistance from edge in parametric coordinates over which to smooth contact normal
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Distance from edge in parametric coordinates over which to smooth contact normal
- normal_smoothing_methodMethod to use to smooth normals (edge_based|nodal_normal_based)
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:Method to use to smooth normals (edge_based|nodal_normal_based)
- orderFIRSTThe finite element order
Default:FIRST
C++ Type:MooseEnum
Unit:(no unit assumed)
Controllable:No
Description:The finite element order
- 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.
- tangential_toleranceTangential distance to extend edges of contact surfaces
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Tangential distance to extend edges of contact surfaces
- 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
Unit:(no unit assumed)
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.
- warningsFalseWhether to output warning messages concerning nodes not being found
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether to output warning messages concerning nodes not being found
Optional Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Controllable:Yes
Description:Set the enabled status of the MooseObject.
- seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:The seed for the master random number generator
- use_displaced_meshTrueWhether 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:True
C++ Type:bool
Unit:(no unit assumed)
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.