DiscreteNucleationTimeStep.C File Reference

Go to the source code of this file.

Functions
	registerMooseObject ("PhaseFieldApp", DiscreteNucleationTimeStep)
template<>
InputParameters	validParams< DiscreteNucleationTimeStep > ()

Function Documentation

registerMooseObject()

registerMooseObject	(	"PhaseFieldApp"	,
		DiscreteNucleationTimeStep
	)

validParams< DiscreteNucleationTimeStep >()

template<>

InputParameters validParams< DiscreteNucleationTimeStep >

(

)

Definition at line 18 of file DiscreteNucleationTimeStep.C.

{
  InputParameters params = validParams<GeneralPostprocessor>();
  params.addClassDescription(
      "Return a time step limit for nucleation event to be used by IterationAdaptiveDT");
  params.addRequiredParam<Real>("dt_max",
                                "Time step to cut back to at the start of a nucleation event");
  params.addRangeCheckedParam<Real>(
      "p2nucleus",
      0.01,
      "p2nucleus > 0 & p2nucleus < 1",
      "Maximum probability for more than one nucleus to appear during a time "
      "step. This will limit the time step based on the total nucleation rate for "
      "the domain to make sure the probability for two or more nuclei to appear "
      "is always below the chosen number.");
  params.addRequiredParam<UserObjectName>("inserter", "DiscreteNucleationInserter user object");
  return params;
}