www.mooseframework.org
Functions
NodalKernel.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< NodalKernel > ()
 

Function Documentation

Definition at line 24 of file NodalKernel.C.

Referenced by validParams< ConstantRate >(), validParams< TimeDerivativeNodalKernel >(), validParams< TimeNodalKernel >(), and validParams< UserForcingFunctionNodalKernel >().

25 {
30  params += validParams<RandomInterface>();
31 
32  params.addRequiredParam<NonlinearVariableName>(
33  "variable", "The name of the variable that this boundary condition applies to");
34 
35  params.addParam<std::vector<AuxVariableName>>(
36  "save_in",
37  "The name of auxiliary variables to save this BC's residual contributions to. "
38  "Everything about that variable must match everything about this variable (the "
39  "type, what blocks it's on, etc.)");
40 
41  params.addParam<std::vector<AuxVariableName>>(
42  "diag_save_in",
43  "The name of auxiliary variables to save this BC's diagonal jacobian "
44  "contributions to. Everything about that variable must match everything "
45  "about this variable (the type, what blocks it's on, etc.)");
46 
47  params.addParam<bool>("use_displaced_mesh",
48  false,
49  "Whether or not this object should use the "
50  "displaced mesh for computation. Note that "
51  "in the case this is true but no "
52  "displacements are provided in the Mesh block "
53  "the undisplaced mesh will still be used.");
54  params.addParamNamesToGroup("use_displaced_mesh", "Advanced");
55 
56  params.declareControllable("enable");
57 
58  params.registerBase("NodalKernel");
59 
60  return params;
61 }
InputParameters validParams< BlockRestrictable >()
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
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< RandomInterface >()
InputParameters validParams< MooseObject >()
Definition: MooseObject.C:22
InputParameters validParams< BoundaryRestrictable >()
InputParameters validParams< TransientInterface >()