www.mooseframework.org
Functions
AddPrimarySpeciesAction.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< AddPrimarySpeciesAction > ()
 

Function Documentation

template<>
InputParameters validParams< AddPrimarySpeciesAction > ( )

Definition at line 16 of file AddPrimarySpeciesAction.C.

17 {
18  InputParameters params = validParams<Action>();
19  params.addRequiredParam<std::vector<NonlinearVariableName>>(
20  "primary_species", "The list of primary variables to add");
21  // Get MooseEnums for the possible order/family options for this variable
22  MooseEnum families(AddVariableAction::getNonlinearVariableFamilies());
23  MooseEnum orders(AddVariableAction::getNonlinearVariableOrders());
24  params.addParam<MooseEnum>("family",
25  families,
26  "Specifies the family of FE "
27  "shape function to use for the order parameters");
28  params.addParam<MooseEnum>("order",
29  orders,
30  "Specifies the order of the FE "
31  "shape function to use for the order parameters");
32  params.addParam<Real>("scaling", 1.0, "Specifies a scaling factor to apply to this variable");
33  params.addClassDescription("Adds Variables for all primary species");
34  return params;
35 }