EqualValueBoundaryConstraint

under construction:Undocumented Class

The EqualValueBoundaryConstraint 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 /Constraints/EqualValueBoundaryConstraint

Input Parameters

  • penaltyThe penalty used for the boundary term

    C++ Type:double

    Description:The penalty used for the boundary term

  • variableThe name of the variable that this constraint is applied to.

    C++ Type:NonlinearVariableName

    Description:The name of the variable that this constraint is applied to.

Required Parameters

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

  • master4294967295The ID of the master node. If no ID is provided, first node of slave set is chosen.

    Default:4294967295

    C++ Type:unsigned int

    Description:The ID of the master node. If no ID is provided, first node of slave set is chosen.

  • slave_node_idsThe IDs of the slave node

    C++ Type:std::vector

    Description:The IDs of the slave node

  • slaveNaNThe boundary ID associated with the slave side

    Default:NaN

    C++ Type:BoundaryName

    Description:The boundary ID associated with the slave side

  • formulationpenaltyFormulation used to calculate constraint - penalty or kinematic.

    Default:penalty

    C++ Type:MooseEnum

    Description:Formulation used to calculate constraint - penalty or kinematic.

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.

  • 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

    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