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

validParams< CHPFCRFFSplitVariablesAction >()

template<>

InputParameters validParams< CHPFCRFFSplitVariablesAction >

(

)

Definition at line 22 of file CHPFCRFFSplitVariablesAction.C.

{
  InputParameters params = validParams<Action>();
  MooseEnum familyEnum = AddVariableAction::getNonlinearVariableFamilies();
  params.addParam<MooseEnum>(
      "family",
      familyEnum,
      "Specifies the family of FE shape functions to use for the L variables");
  MooseEnum orderEnum = AddVariableAction::getNonlinearVariableOrders();
  params.addParam<MooseEnum>(
      "order",
      orderEnum,
      "Specifies the order of the FE shape function to use for the L variables");
  params.addParam<Real>("scaling", 1.0, "Specifies a scaling factor to apply to the L variables");
  params.addRequiredParam<unsigned int>(
      "num_L", "specifies the number of complex L variables will be solved for");
  params.addRequiredParam<std::string>("L_name_base", "Base name for the complex L variables");
  params.addRequiredParam<std::vector<FileName>>("sub_filenames",
                                                 "This is the filename of the sub.i file");
  params.addRequiredParam<AuxVariableName>("n_name", "Name of atomic density variable");
 
  return params;
}