Classes | Functions
AuxScalarKernel.h File Reference

Go to the source code of this file.


class  AuxScalarKernel
 Base class for making kernels that work on auxiliary scalar variables. More...


InputParameters validParams< AuxScalarKernel > ()

Function Documentation

Definition at line 24 of file AuxScalarKernel.C.

Referenced by validParams< AuxNodalScalarKernel >(), validParams< ConstantScalarAux >(), validParams< FunctionScalarAux >(), and validParams< QuotientScalarAux >().

25 {
27  params += validParams<SetupInterface>();
30  params.addRequiredParam<AuxVariableName>("variable",
31  "The name of the variable that this kernel operates on");
32  params.addParam<bool>("use_displaced_mesh",
33  false,
34  "Whether or not this object should use the "
35  "displaced mesh for computation. Note that "
36  "in the case this is true but no "
37  "displacements are provided in the Mesh block "
38  "the undisplaced mesh will still be used.");
39  params.addParamNamesToGroup("use_displaced_mesh", "Advanced");
41  params.declareControllable("enable"); // allows Control to enable/disable this type of object
42  params.registerBase("AuxScalarKernel");
44  return params;
45 }
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< MeshChangedInterface >()
InputParameters validParams< MooseObject >()
Definition: MooseObject.C:22