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

Go to the source code of this file.

Classes

class  NonconservedAction
 

Functions

template<>
InputParameters validParams< NonconservedAction > ()
 

Function Documentation

template<>
InputParameters validParams< NonconservedAction > ( )

Definition at line 21 of file NonconservedAction.C.

22 {
23  InputParameters params = validParams<Action>();
24  params.addClassDescription(
25  "Set up the variable and the kernels needed for a nonconserved phase field variable");
26  // Get MooseEnums for the possible order/family options for this variable
27  MooseEnum families(AddVariableAction::getNonlinearVariableFamilies());
28  MooseEnum orders(AddVariableAction::getNonlinearVariableOrders());
29  params.addParam<MooseEnum>("family",
30  families,
31  "Specifies the family of FE "
32  "shape functions to use for this variable");
33  params.addParam<MooseEnum>("order",
34  orders,
35  "Specifies the order of the FE "
36  "shape function to use for this variable");
37  params.addParam<Real>("scaling", 1.0, "Specifies a scaling factor to apply to this variable");
38  params.addParam<bool>("implicit", true, "Whether kernels are implicit or not");
39  params.addParam<bool>(
40  "use_displaced_mesh", false, "Whether to use displaced mesh in the kernels");
41  params.addParamNamesToGroup("scaling implicit use_displaced_mesh", "Advanced");
42  params.addParam<MaterialPropertyName>("mobility", "L", "The mobility used with the kernel");
43  params.addParam<std::vector<VariableName>>("args",
44  "Vector of variable arguments this kernel depends on");
45  params.addRequiredParam<MaterialPropertyName>(
46  "free_energy", "Base name of the free energy function F defined in a free energy material");
47  params.addParam<MaterialPropertyName>("kappa", "kappa_op", "The kappa used with the kernel");
48  params.addParam<bool>("variable_mobility",
49  true,
50  "The mobility is a function of any MOOSE variable (if "
51  "this is set to false, L must be constant over the "
52  "entire domain!)");
53 
54  return params;
55 }