NonconservedAction.h File Reference

Go to the source code of this file.

Classes
class	NonconservedAction

Functions
template<>
InputParameters	validParams< NonconservedAction > ()

Function Documentation

validParams< NonconservedAction >()

template<>

InputParameters validParams< NonconservedAction >

(

)

Definition at line 27 of file NonconservedAction.C.

{
  InputParameters params = validParams<Action>();
  params.addClassDescription(
      "Set up the variable and the kernels needed for a non-conserved phase field variable");
  // Get MooseEnums for the possible order/family options for this variable
  MooseEnum families(AddVariableAction::getNonlinearVariableFamilies());
  MooseEnum orders(AddVariableAction::getNonlinearVariableOrders());
  params.addParam<MooseEnum>("family",
                             families,
                             "Specifies the family of FE "
                             "shape functions to use for this variable");
  params.addParam<MooseEnum>("order",
                             orders,
                             "Specifies the order of the FE "
                             "shape function to use for this variable");
  params.addParam<Real>("scaling", 1.0, "Specifies a scaling factor to apply to this variable");
  params.addParam<bool>("implicit", true, "Whether kernels are implicit or not");
  params.addParam<bool>(
      "use_displaced_mesh", false, "Whether to use displaced mesh in the kernels");
  params.addParamNamesToGroup("scaling implicit use_displaced_mesh", "Advanced");
  params.addParam<MaterialPropertyName>("mobility", "L", "The mobility used with the kernel");
  params.addParam<std::vector<VariableName>>("args",
                                             "Vector of variable arguments this kernel depends on");
  params.addRequiredParam<MaterialPropertyName>(
      "free_energy", "Base name of the free energy function F defined in a free energy material");
  params.addParam<MaterialPropertyName>("kappa", "kappa_op", "The kappa used with the kernel");
  params.addParam<bool>("variable_mobility",
                        true,
                        "The mobility is a function of any MOOSE variable (if "
                        "this is set to false, L must be constant over the "
                        "entire domain!)");
 
  return params;
}