HHPFCRFFSplitKernelAction.h File Reference

Go to the source code of this file.

Classes
class	HHPFCRFFSplitKernelAction

Functions
template<>
InputParameters	validParams< HHPFCRFFSplitKernelAction > ()

Function Documentation

validParams< HHPFCRFFSplitKernelAction >()

template<>

InputParameters validParams< HHPFCRFFSplitKernelAction >

(

)

Definition at line 19 of file HHPFCRFFSplitKernelAction.C.

{
  InputParameters params = validParams<Action>();
  params.addClassDescription(
      "Set up kernels for the rational function fit (RFF) phase field crystal model");
  params.addRequiredParam<unsigned int>(
      "num_L", "specifies the number of complex L variables will be solved for");
  params.addRequiredParam<VariableName>("n_name", "Variable name used for the n variable");
  params.addRequiredParam<std::string>("L_name_base", "Base name for the complex L variables");
  params.addParam<MaterialPropertyName>("mob_name", "M", "The mobility used for n in this model");
  MooseEnum log_options("tolerance cancelation expansion");
  params.addRequiredParam<MooseEnum>(
      "log_approach", log_options, "Which approach will be used to handle the natural log");
  params.addParam<Real>("tol", 1.0e-9, "Tolerance used when the tolerance approach is chosen");
  params.addParam<Real>(
      "n_exp_terms", 4, "Number of terms used in the Taylor expansion of the natural log term");
  params.addParam<bool>(
      "use_displaced_mesh", false, "Whether to use displaced mesh in the kernels");
  return params;
}

Referenced by validParams< PFCRFFKernelAction >().