DiscreteNucleationFromFile.h File Reference

Go to the source code of this file.

Classes
class	DiscreteNucleationFromFile
	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...

Functions
template<>
InputParameters	validParams< DiscreteNucleationFromFile > ()

Function Documentation

validParams< DiscreteNucleationFromFile >()

template<>

InputParameters validParams< DiscreteNucleationFromFile >

(

)

Definition at line 19 of file DiscreteNucleationFromFile.C.

{
  InputParameters params = validParams<DiscreteNucleationInserterBase>();
  params.addClassDescription(
      "Manages the list of currently active nucleation sites and adds new "
      "sites according to a predetermined list from a CSV file (use this with sync_times).");
  params.addRequiredParam<FileName>(
      "file", "CSV file with (time, x, y, z) coordinates for nucleation events.");
  params.addRequiredParam<Real>("hold_time", "Time to keep each nucleus active");
  params.addParam<Real>("tolerance", 1e-9, "Tolerance for determining insertion time");
  return params;
}