www.mooseframework.org
Classes | Functions
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

template<>
InputParameters validParams< DiscreteNucleationMap > ( )

Definition at line 15 of file DiscreteNucleationMap.C.

16 {
17  InputParameters params = validParams<ElementUserObject>();
18  params.addClassDescription("Generates a spatial smoothed map of all nucleation sites with the "
19  "data of the DiscreteNucleationInserter for use by the "
20  "DiscreteNucleation material.");
21  params.addParam<Real>("radius", 0.0, "Radius for the inserted nuclei");
22  params.addParam<Real>("int_width", 0.0, "Nucleus interface width for smooth nuclei");
23  params.addRequiredParam<UserObjectName>("inserter", "DiscreteNucleationInserter user object");
24  params.addCoupledVar("periodic",
25  "Use the periodicity settings of this variable to populate the grain map");
26  MultiMooseEnum setup_options(SetupInterface::getExecuteOptions());
27  // the mapping needs to run at timestep begin, which is after the adaptivity
28  // run of the previous timestep.
29  setup_options = "timestep_begin";
30  params.set<MultiMooseEnum>("execute_on") = setup_options;
31  return params;
32 }