RigidBodyMultiKernelAction.C File Reference

Go to the source code of this file.


InputParameters validParams< RigidBodyMultiKernelAction > ()

Function Documentation

InputParameters validParams< RigidBodyMultiKernelAction > ( )

Definition at line 15 of file RigidBodyMultiKernelAction.C.

16 {
17  InputParameters params = validParams<Action>();
18  params.addClassDescription(
19  "Action for applying AllenCahn equations and SingleGrainRigidBodyMotion to grains");
20  params.addRequiredParam<unsigned int>("op_num", "specifies the number of grains to create");
21  params.addRequiredParam<std::string>("var_name_base", "specifies the base name of the variables");
22  params.addParam<VariableName>("c", "Name of coupled concentration variable");
23  params.addParam<MaterialPropertyName>("kappa_name", "kappa_op", "The kappa used with the kernel");
24  params.addParam<MaterialPropertyName>("mob_name", "L", "The mobility used with the kernel");
25  params.addParam<MaterialPropertyName>(
26  "f_name", "Base name of the free energy function F defined in a DerivativeParsedMaterial");
27  params.addParam<std::string>("base_name",
28  "Optional parameter that allows the user to define "
29  "type of force density under consideration");
30  params.addParam<Real>(
31  "translation_constant", 500, "constant value characterizing grain translation");
32  params.addParam<Real>("rotation_constant", 1.0, "constant value characterizing grain rotation");
33  params.addRequiredParam<UserObjectName>(
34  "grain_force", "userobject for getting force and torque acting on grains");
35  params.addRequiredParam<UserObjectName>("grain_tracker_object",
36  "The FeatureFloodCount UserObject to get values from.");
37  params.addRequiredParam<VectorPostprocessorName>("grain_volumes",
38  "The feature volume VectorPostprocessorValue.");
39  params.addParam<bool>("implicit", true, "Whether kernels are implicit or not");
40  params.addParam<bool>(
41  "use_displaced_mesh", false, "Whether to use displaced mesh in the kernels");
42  return params;
43 }