www.mooseframework.org
Functions
PolycrystalVariablesAction.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< PolycrystalVariablesAction > ()
 

Function Documentation

template<>
InputParameters validParams< PolycrystalVariablesAction > ( )

Definition at line 17 of file PolycrystalVariablesAction.C.

18 {
19  InputParameters params = validParams<Action>();
20  params.addClassDescription("Set up order parameter variables for a polycrystal simulation");
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.addRequiredParam<unsigned int>("op_num",
34  "specifies the number of order parameters to create");
35  params.addRequiredParam<std::string>("var_name_base", "specifies the base name of the variables");
36  return params;
37 }