Classes | Functions
AddVariableAction.h File Reference

Go to the source code of this file.


class  AddVariableAction
 Adds nonlinear variable. More...


InputParameters validParams< AddVariableAction > ()

Function Documentation

Definition at line 40 of file AddVariableAction.C.

41 {
42  // Get MooseEnums for the possible order/family options for this variable
46  // Define the general input options
48  params += validParams<OutputInterface>();
49  params.addParam<MooseEnum>(
50  "family", families, "Specifies the family of FE shape functions to use for this variable");
51  params.addParam<MooseEnum>("order",
52  orders,
53  "Specifies the order of the FE shape function to use "
54  "for this variable (additional orders not listed are "
55  "allowed)");
56  params.addParam<Real>("initial_condition", "Specifies the initial condition for this variable");
57  params.addParam<std::vector<SubdomainName>>("block", "The block id where this variable lives");
58  params.addParam<bool>("eigen", false, "True to make this variable an eigen variable");
60  // Advanced input options
61  params.addParam<Real>("scaling", 1.0, "Specifies a scaling factor to apply to this variable");
62  params.addParamNamesToGroup("scaling eigen", "Advanced");
64  return params;
65 }
InputParameters validParams< OutputInterface >()
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
static MooseEnum getNonlinearVariableFamilies()
Get the possible variable families.
static MooseEnum getNonlinearVariableOrders()
Get the possible variable orders.
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
Definition: MooseEnum.h:37
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an option parameter and a documentation string to the InputParameters object...
InputParameters validParams< Action >()
Definition: Action.C:23