HHPFCRFFSplitKernelAction.C File Reference

Go to the source code of this file.


InputParameters validParams< HHPFCRFFSplitKernelAction > ()

Function Documentation

InputParameters validParams< HHPFCRFFSplitKernelAction > ( )

Definition at line 15 of file HHPFCRFFSplitKernelAction.C.

Referenced by validParams< PFCRFFKernelAction >().

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