GrainRigidBodyMotionBase.h File Reference

Go to the source code of this file.

Classes
class	GrainRigidBodyMotionBase

Functions
template<>
InputParameters	validParams< GrainRigidBodyMotionBase > ()

Function Documentation

validParams< GrainRigidBodyMotionBase >()

template<>

InputParameters validParams< GrainRigidBodyMotionBase >

(

)

Definition at line 18 of file GrainRigidBodyMotionBase.C.

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

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