GapValueAux

buildconstruction:Undocumented Class

The GapValueAux has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.


# GapValueAux

!syntax description /AuxKernels/GapValueAux

## Overview

!! Replace these lines with information regarding the GapValueAux object.

## Example Input File Syntax

!! Describe and include an example of how to use the GapValueAux object.

!syntax parameters /AuxKernels/GapValueAux

!syntax inputs /AuxKernels/GapValueAux

!syntax children /AuxKernels/GapValueAux

Return the nearest value of a variable on a boundary from across a gap.

Input Parameters

  • paired_boundaryThe boundary on the other side of a gap.

    C++ Type:BoundaryName

    Options:

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

  • paired_variableThe variable to get the value of.

    C++ Type:VariableName

    Options:

    Description:The variable to get the value of.

  • variableThe name of the variable that this object applies to

    C++ Type:AuxVariableName

    Options:

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

Required Parameters

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

    C++ Type:std::vector<SubdomainName>

    Options:

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

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

    C++ Type:std::vector<BoundaryName>

    Options:

    Description:The list of boundary IDs from the mesh where this boundary condition 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

    Options:

    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, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE.

    Default:LINEAR TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_DISPLACE

    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, PRE_DISPLACE.

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

    C++ Type:double

    Options:

    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

    Options:

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

  • orderFIRSTThe finite element order

    Default:FIRST

    C++ Type:MooseEnum

    Options:FIRST, SECOND, THIRD, FOURTH

    Description:The finite element order

  • tangential_toleranceTangential distance to extend edges of contact surfaces

    C++ Type:double

    Options:

    Description:Tangential distance to extend edges of contact surfaces

  • warningsFalseWhether to output warning messages concerning nodes not being found

    Default:False

    C++ Type:bool

    Options:

    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>

    Options:

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

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Options:

    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

    Options:

    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

Input Files