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

Go to the source code of this file.

Classes

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

Functions

template<>
InputParameters validParams< CHPFCRFFSplitVariablesAction > ()
 

Function Documentation

template<>
InputParameters validParams< CHPFCRFFSplitVariablesAction > ( )

Definition at line 17 of file CHPFCRFFSplitVariablesAction.C.

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