ArbitrarilyTiedValueConstraint

buildconstruction:Undocumented Class

The ArbitrarilyTiedValueConstraint 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.

Overview

Example Input File Syntax

Input Parameters

  • HThe value of u_secondary/u_primary.

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The value of u_secondary/u_primary.

  • variableThe name of the variable that this residual object operates on

    C++ Type:NonlinearVariableName

    Unit:(no unit assumed)

    Controllable:No

    Description:The name of the variable that this residual object operates on

Required Parameters

  • 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 used for projections

    Default:FIRST

    C++ Type:MooseEnum

    Unit:(no unit assumed)

    Options:FIRST, SECOND, THIRD, FOURTH

    Controllable:No

    Description:The finite element order used for projections

  • primaryThe boundary ID associated with the primary side

    C++ Type:BoundaryName

    Unit:(no unit assumed)

    Controllable:No

    Description:The boundary ID associated with the primary side

  • primary_variableThe variable on the primary side of the domain

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

    Unit:(no unit assumed)

    Controllable:No

    Description:The variable on the primary side of the domain

  • scaling1scaling factor to be applied to constraint equations

    Default:1

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:scaling factor to be applied to constraint equations

  • secondaryThe boundary ID associated with the secondary side

    C++ Type:BoundaryName

    Unit:(no unit assumed)

    Controllable:No

    Description:The boundary ID associated with the secondary side

  • 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

Optional Parameters

  • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

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

    Unit:(no unit assumed)

    Controllable:No

    Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

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

    Unit:(no unit assumed)

    Controllable:No

    Description:The extra tags for the matrices this Kernel should fill

  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

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

    Unit:(no unit assumed)

    Controllable:No

    Description:The extra tags for the vectors this Kernel should fill

  • matrix_tagssystemThe tag for the matrices this Kernel should fill

    Default:system

    C++ Type:MultiMooseEnum

    Unit:(no unit assumed)

    Options:nontime, system

    Controllable:No

    Description:The tag for the matrices this Kernel should fill

  • vector_tagsnontimeThe tag for the vectors this Kernel should fill

    Default:nontime

    C++ Type:MultiMooseEnum

    Unit:(no unit assumed)

    Options:nontime, time

    Controllable:No

    Description:The tag for the vectors this Kernel should fill

Tagging 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.

  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Determines whether this object is calculated using an implicit or explicit form

  • 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.

Advanced Parameters