www.mooseframework.org
Classes | Functions
Constraint.h File Reference

Go to the source code of this file.

Classes

class  Constraint
 Base class for all Constraint types. More...
 

Functions

template<>
InputParameters validParams< Constraint > ()
 

Function Documentation

Definition at line 20 of file Constraint.C.

Referenced by validParams< ElemElemConstraint >(), validParams< FaceFaceConstraint >(), validParams< NodalConstraint >(), and validParams< NodeFaceConstraint >().

21 {
23  // Add the SetupInterface parameter, 'execute_on', default is 'linear'
24  params += validParams<SetupInterface>();
25 
26  params.addRequiredParam<NonlinearVariableName>(
27  "variable", "The name of the variable that this constraint is applied to.");
28  params.addParam<bool>("use_displaced_mesh",
29  false,
30  "Whether or not this object should use the "
31  "displaced mesh for computation. Note that "
32  "in the case this is true but no "
33  "displacements are provided in the Mesh block "
34  "the undisplaced mesh will still be used.");
35  params.addParamNamesToGroup("use_displaced_mesh", "Advanced");
36 
37  params.declareControllable("enable");
38  params.registerBase("Constraint");
39 
40  return params;
41 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< SetupInterface >()
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
InputParameters validParams< MooseObject >()
Definition: MooseObject.C:22