www.mooseframework.org
Functions
KernelBase.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< KernelBase > ()
 

Function Documentation

Definition at line 27 of file KernelBase.C.

Referenced by validParams< EigenKernel >(), and validParams< Kernel >().

28 {
32  params += validParams<RandomInterface>();
35 
36  params.addRequiredParam<NonlinearVariableName>(
37  "variable", "The name of the variable that this Kernel operates on");
38  params.addParam<std::vector<AuxVariableName>>(
39  "save_in",
40  "The name of auxiliary variables to save this Kernel's residual contributions to. "
41  " Everything about that variable must match everything about this variable (the "
42  "type, what blocks it's on, etc.)");
43  params.addParam<std::vector<AuxVariableName>>(
44  "diag_save_in",
45  "The name of auxiliary variables to save this Kernel's diagonal Jacobian "
46  "contributions to. Everything about that variable must match everything "
47  "about this variable (the type, what blocks it's on, etc.)");
48  params.addParam<bool>(
49  "eigen_kernel", false, "Whether or not this kernel will be used as an eigen kernel");
50  params.addParam<bool>("use_displaced_mesh",
51  false,
52  "Whether or not this object should use the "
53  "displaced mesh for computation. Note that in "
54  "the case this is true but no displacements "
55  "are provided in the Mesh block the "
56  "undisplaced mesh will still be used.");
57  params.addParamNamesToGroup("use_displaced_mesh", "Advanced");
58 
59  params.addParamNamesToGroup("diag_save_in save_in", "Advanced");
60 
61  params.declareControllable("enable");
62  return params;
63 }
InputParameters validParams< MaterialPropertyInterface >()
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< MeshChangedInterface >()
InputParameters validParams< MooseObject >()
Definition: MooseObject.C:22
InputParameters validParams< TransientInterface >()