DiscreteNucleationMap.h File Reference

Go to the source code of this file.

Classes
class	DiscreteNucleationMap
	This UserObject maintains a per QP map that indicates if a nucleus is present or not. More...

Functions
template<>
InputParameters	validParams< DiscreteNucleationMap > ()

Function Documentation

validParams< DiscreteNucleationMap >()

template<>

InputParameters validParams< DiscreteNucleationMap >

(

)

Definition at line 19 of file DiscreteNucleationMap.C.

{
  InputParameters params = validParams<ElementUserObject>();
  params.addClassDescription("Generates a spatial smoothed map of all nucleation sites with the "
                             "data of the DiscreteNucleationInserter for use by the "
                             "DiscreteNucleation material.");
  params.addParam<Real>("radius", 0.0, "Radius for the inserted nuclei");
  params.addParam<Real>("int_width", 0.0, "Nucleus interface width for smooth nuclei");
  params.addRequiredParam<UserObjectName>("inserter", "DiscreteNucleationInserter user object");
  params.addCoupledVar("periodic",
                       "Use the periodicity settings of this variable to populate the grain map");
  // the mapping needs to run at timestep begin, which is after the adaptivity
  // run of the previous timestep.
  params.set<ExecFlagEnum>("execute_on") = EXEC_TIMESTEP_BEGIN;
  return params;
}