Classes | Functions
DiscreteNucleationInserter.h File Reference

Go to the source code of this file.


class  DiscreteNucleationInserter
 This UserObject manages the insertion and expiration of nuclei in the simulation domain it manages a list of nuclei with their insertion times and their center positions. More...


InputParameters validParams< DiscreteNucleationInserter > ()

Function Documentation

InputParameters validParams< DiscreteNucleationInserter > ( )

Definition at line 15 of file DiscreteNucleationInserter.C.

16 {
17  InputParameters params = validParams<ElementUserObject>();
18  params.addClassDescription("Manages the list of currently active nucleation sites and adds new "
19  "sites according to a given probability function.");
20  params.addRequiredParam<MaterialPropertyName>(
21  "probability", "Probability density for inserting a discrete nucleus");
22  params.addRequiredParam<Real>("hold_time", "Time to keep each nucleus active");
23  params.addParam<Point>("test", "Insert a fixed nucleus at a point in the simulation cell");
24  MultiMooseEnum setup_options(SetupInterface::getExecuteOptions());
25  setup_options = "timestep_end";
26  params.set<MultiMooseEnum>("execute_on") = setup_options;
27  return params;
28 }