GapValueAux

under construction:Undocumented Class

The GapValueAux has not been documented, if you would like to contribute to MOOSE by writing documentation, please see Documenting MOOSE. The content contained on this page explains the typical documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

!syntax description /AuxKernels/GapValueAux

Input Parameters

  • variableThe name of the variable that this object applies to

    C++ Type:AuxVariableName

    Description:The name of the variable that this object applies to

  • paired_variableThe variable to get the value of.

    C++ Type:VariableName

    Description:The variable to get the value of.

  • paired_boundaryThe boundary on the other side of a gap.

    C++ Type:BoundaryName

    Description:The boundary on the other side of a gap.

Required Parameters

  • tangential_toleranceTangential distance to extend edges of contact surfaces

    C++ Type:double

    Description:Tangential distance to extend edges of contact surfaces

  • warningsFalseWhether to output warning messages concerning nodes not being found

    Default:False

    C++ Type:bool

    Description:Whether to output warning messages concerning nodes not being found

  • normal_smoothing_distanceDistance from edge in parametric coordinates over which to smooth contact normal

    C++ Type:double

    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

    Description:Method to use to smooth normals (edge_based|nodal_normal_based)

  • execute_onLINEARThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

    Default:LINEAR

    C++ Type:ExecFlagEnum

    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies

    C++ Type:std::vector

    Description:The list of boundary IDs from the mesh where this boundary condition applies

  • orderFIRSTThe finite element order

    Default:FIRST

    C++ Type:MooseEnum

    Description:The finite element order

  • blockThe list of block ids (SubdomainID) that this object will be applied

    C++ Type:std::vector

    Description:The list of block ids (SubdomainID) that this object will be applied

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Description:Set the enabled status of the MooseObject.

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    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

    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

References