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

Go to the source code of this file.

Classes

class  ConservedAction
 

Functions

template<>
InputParameters validParams< ConservedAction > ()
 

Function Documentation

template<>
InputParameters validParams< ConservedAction > ( )

Definition at line 21 of file ConservedAction.C.

22 {
23  InputParameters params = validParams<Action>();
24  params.addClassDescription(
25  "Set up the variable(s) and the kernels needed for a conserved phase field variable."
26  " Note that for a direct solve, the element family and order are overwritten with hermite "
27  "and third.");
28  MooseEnum solves("DIRECT REVERSE_SPLIT FORWARD_SPLIT");
29  params.addRequiredParam<MooseEnum>("solve_type", solves, "Split or direct solve?");
30  // Get MooseEnums for the possible order/family options for this variable
31  MooseEnum families(AddVariableAction::getNonlinearVariableFamilies());
32  MooseEnum orders(AddVariableAction::getNonlinearVariableOrders());
33  params.addParam<MooseEnum>("family",
34  families,
35  "Specifies the family of FE "
36  "shape functions to use for this variable");
37  params.addParam<MooseEnum>("order",
38  orders,
39  "Specifies the order of the FE "
40  "shape function to use for this variable");
41  params.addParam<Real>("scaling", 1.0, "Specifies a scaling factor to apply to this variable");
42  params.addParam<bool>("implicit", true, "Whether kernels are implicit or not");
43  params.addParam<bool>(
44  "use_displaced_mesh", false, "Whether to use displaced mesh in the kernels");
45  params.addParamNamesToGroup("scaling implicit use_displaced_mesh", "Advanced");
46  params.addRequiredParam<MaterialPropertyName>("mobility", "The mobility used with the kernel");
47  params.addParam<std::vector<VariableName>>("args",
48  "Vector of variable arguments this kernel depends on");
49  params.addRequiredParam<MaterialPropertyName>(
50  "free_energy", "Base name of the free energy function F defined in a free energy material");
51  params.addRequiredParam<MaterialPropertyName>("kappa", "The kappa used with the kernel");
52 
53  return params;
54 }