GrainAdvectionVelocity.h File Reference

Go to the source code of this file.

Classes
class	GrainAdvectionVelocity
	This Material calculates the advection velocity, it's divergence and derivatives acting on a particle/grain. More...

Functions
template<>
InputParameters	validParams< GrainAdvectionVelocity > ()

Function Documentation

validParams< GrainAdvectionVelocity >()

template<>

InputParameters validParams< GrainAdvectionVelocity >

(

)

Definition at line 16 of file GrainAdvectionVelocity.C.

{
  InputParameters params = validParams<Material>();
  params.addClassDescription(
      "Calculation the advection velocity of grain due to rigid body translation and rotation");
  params.addRequiredCoupledVarWithAutoBuild(
      "etas", "var_name_base", "op_num", "Array of other coupled order parameters");
  params.addCoupledVar("c", "Concentration field");
  params.addParam<Real>(
      "translation_constant", 500, "constant value characterizing grain translation");
  params.addParam<Real>("rotation_constant", 1.0, "constant value characterizing grain rotation");
  params.addParam<std::string>("base_name",
                               "Optional parameter that allows the user to define "
                               "type of force density under consideration");
  params.addParam<UserObjectName>("grain_data",
                                  "UserObject for getting the center of mass of grains");
  params.addParam<UserObjectName>("grain_force",
                                  "userobject for getting force and torque acting on grains");
  params.addParam<VectorPostprocessorName>("grain_volumes",
                                           "The feature volume VectorPostprocessorValue.");
  return params;
}