NodalEqualValueConstraint

under construction:Undocumented Class

The NodalEqualValueConstraint has not been documented. The content contained on this page 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.

!syntax description /ScalarKernels/NodalEqualValueConstraint

Input Parameters

  • varVariable(s) to put the constraint on

    C++ Type:std::vector

    Options:

    Description:Variable(s) to put the constraint on

  • variableThe name of the variable that this kernel operates on

    C++ Type:NonlinearVariableName

    Options:

    Description:The name of the variable that this kernel operates on

Required Parameters

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

    C++ Type:std::vector

    Options:

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

  • nodesSupply nodes using node ids

    C++ Type:std::vector

    Options:

    Description:Supply nodes using node ids

Optional Parameters

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

    C++ Type:std::vector

    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.

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

    Default:True

    C++ Type:bool

    Options:

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

  • 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

    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

  • vector_tagsnontimeThe tag for the vectors this Kernel should fill

    Default:nontime

    C++ Type:MultiMooseEnum

    Options:nontime time

    Description:The tag for the vectors this Kernel should fill

  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

    C++ Type:std::vector

    Options:

    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

    Options:nontime system

    Description:The tag for the matrices this Kernel should fill

  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

    C++ Type:std::vector

    Options:

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

Tagging Parameters

Input Files

References