www.mooseframework.org
Classes | Functions
PFCRFFVariablesAction.h File Reference

Go to the source code of this file.

Classes

class  PFCRFFVariablesAction
 Automatically generates all the L variables for the RFF phase field crystal model. More...
 

Functions

template<>
InputParameters validParams< PFCRFFVariablesAction > ()
 

Function Documentation

template<>
InputParameters validParams< PFCRFFVariablesAction > ( )

Definition at line 18 of file PFCRFFVariablesAction.C.

19 {
20  InputParameters params = validParams<Action>();
21  MooseEnum familyEnum = AddVariableAction::getNonlinearVariableFamilies();
22  params.addParam<MooseEnum>(
23  "family",
24  familyEnum,
25  "Specifies the family of FE shape functions to use for the L variables");
26  MooseEnum orderEnum = AddVariableAction::getNonlinearVariableOrders();
27  params.addParam<MooseEnum>(
28  "order",
29  orderEnum,
30  "Specifies the order of the FE shape function to use for the L variables");
31  params.addParam<Real>("scaling", 1.0, "Specifies a scaling factor to apply to the L variables");
32  params.addRequiredParam<unsigned int>(
33  "num_L", "specifies the number of complex L variables will be solved for");
34  params.addRequiredParam<std::string>("L_name_base", "Base name for the complex L variables");
35 
36  return params;
37 }