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

Go to the source code of this file.

Classes

class  GrainRigidBodyMotionBase
 

Functions

template<>
InputParameters validParams< GrainRigidBodyMotionBase > ()
 

Function Documentation

template<>
InputParameters validParams< GrainRigidBodyMotionBase > ( )

Definition at line 15 of file GrainRigidBodyMotionBase.C.

Referenced by validParams< MultiGrainRigidBodyMotion >(), and validParams< SingleGrainRigidBodyMotion >().

16 {
17  InputParameters params = validParams<NonlocalKernel>();
18  params.addClassDescription("Base class for adding rigid body motion to grains");
19  params.addRequiredCoupledVar("c", "Concentration");
20  params.addRequiredCoupledVarWithAutoBuild(
21  "v", "var_name_base", "op_num", "Array of coupled variable names");
22  params.addParam<std::string>("base_name",
23  "Optional parameter that allows the user to define "
24  "type of force density under consideration");
25  params.addParam<Real>(
26  "translation_constant", 500, "constant value characterizing grain translation");
27  params.addParam<Real>("rotation_constant", 1.0, "constant value characterizing grain rotation");
28  params.addRequiredParam<UserObjectName>(
29  "grain_force", "UserObject for getting force and torque acting on grains");
30  params.addRequiredParam<UserObjectName>("grain_tracker_object",
31  "The FeatureFloodCount UserObject to get values from.");
32  params.addRequiredParam<VectorPostprocessorName>("grain_volumes",
33  "The feature volume VectorPostprocessorValue.");
34  return params;
35 }