PolycrystalVariablesAction.h File Reference

Go to the source code of this file.

Classes
class	PolycrystalVariablesAction
	Automatically generates all variables to model a polycrystal with op_num orderparameters. More...

Functions
template<>
InputParameters	validParams< PolycrystalVariablesAction > ()

Function Documentation

validParams< PolycrystalVariablesAction >()

template<>

InputParameters validParams< PolycrystalVariablesAction >

(

)

Definition at line 25 of file PolycrystalVariablesAction.C.

{
  InputParameters params = validParams<Action>();
  params.addClassDescription("Set up order parameter variables for a polycrystal simulation");
  // Get MooseEnums for the possible order/family options for this variable
  MooseEnum families(AddVariableAction::getNonlinearVariableFamilies());
  MooseEnum orders(AddVariableAction::getNonlinearVariableOrders());
  params.addParam<MooseEnum>("family",
                             families,
                             "Specifies the family of FE "
                             "shape function to use for the order parameters");
  params.addParam<MooseEnum>("order",
                             orders,
                             "Specifies the order of the FE "
                             "shape function to use for the order parameters");
  params.addParam<bool>(
      "initial_from_file",
      false,
      "Take the initial condition of all polycrystal variables from the mesh file");
  params.addParam<Real>("scaling", 1.0, "Specifies a scaling factor to apply to this variable");
  params.addRequiredParam<unsigned int>("op_num",
                                        "specifies the number of order parameters to create");
  params.addRequiredParam<std::string>("var_name_base", "specifies the base name of the variables");
  return params;
}