EqualValueBoundaryConstraint

Constraint for enforcing that variables on each side of a boundary are equivalent.

The difference between the two variables (or a single variable) values on the primary node and the secondary node (or boundary) is simply multiplied by a penalty factor then added to the residual.

Example input syntax

In this example, the variable diffused is constrained to be equal on node 45 and the top boundary, using a 10e6 penalty factor.

[Constraints]
  [./y_top]
    type = EqualValueBoundaryConstraint
    variable = diffused
    primary = '45' # node on boundary
    secondary = 'top' # boundary
    penalty = 10e6
  [../]
[]
(../moose/test/tests/constraints/equal_value_boundary_constraint/equal_value_boundary_constraint_test.i)

Input Parameters

  • penaltyThe penalty used for the boundary term

    C++ Type:double

    Controllable:No

    Description:The penalty used for the boundary term

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

    C++ Type:NonlinearVariableName

    Controllable:No

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

Required Parameters

  • formulationpenaltyFormulation used to calculate constraint - penalty or kinematic.

    Default:penalty

    C++ Type:MooseEnum

    Options:penalty, kinematic

    Controllable:No

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

  • primary4294967295The ID of the primary node. If no ID is provided, first node of secondary set is chosen.

    Default:4294967295

    C++ Type:unsigned int

    Controllable:No

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

  • secondaryNaNThe boundary ID associated with the secondary side

    Default:NaN

    C++ Type:BoundaryName

    Controllable:No

    Description:The boundary ID associated with the secondary side

  • secondary_node_idsThe IDs of the secondary node

    C++ Type:std::vector<unsigned int>

    Controllable:No

    Description:The IDs of the secondary node

  • variable_secondaryThe name of the variable for the secondary nodes, if it is different from the primary nodes' variable

    C++ Type:NonlinearVariableName

    Controllable:No

    Description:The name of the variable for the secondary nodes, if it is different from the primary nodes' variable

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>

    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>

    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>

    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

    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

    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>

    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

    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

    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

    Controllable:No

    Description:The seed for the master random number generator

  • 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

    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