EqualValueBoundaryConstraint

under construction:Undocumented Class

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


# EqualValueBoundaryConstraint

!syntax description /Constraints/EqualValueBoundaryConstraint

## Overview

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

## Example Input File Syntax

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

!syntax parameters /Constraints/EqualValueBoundaryConstraint

!syntax inputs /Constraints/EqualValueBoundaryConstraint

!syntax children /Constraints/EqualValueBoundaryConstraint

!syntax description /Constraints/EqualValueBoundaryConstraint

Input Parameters

  • penaltyThe penalty used for the boundary term

    C++ Type:double

    Options:

    Description:The penalty used for the boundary term

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

    C++ Type:NonlinearVariableName

    Options:

    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

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM

    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.

  • formulationpenaltyFormulation used to calculate constraint - penalty or kinematic.

    Default:penalty

    C++ Type:MooseEnum

    Options:penalty kinematic

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

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

    Default:4294967295

    C++ Type:unsigned int

    Options:

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

  • slaveNaNThe boundary ID associated with the slave side

    Default:NaN

    C++ Type:BoundaryName

    Options:

    Description:The boundary ID associated with the slave side

  • slave_node_idsThe IDs of the slave node

    C++ Type:std::vector

    Options:

    Description:The IDs of the slave node

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.

  • 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

  • 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

  • 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

  • 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

Tagging Parameters

Input Files