DiscreteNucleationForce.h File Reference

Go to the source code of this file.

Classes
class	DiscreteNucleationForce
	Free energy penalty contribution to force the nucleation of subresolution particles. More...

Functions
template<>
InputParameters	validParams< DiscreteNucleationForce > ()

Function Documentation

validParams< DiscreteNucleationForce >()

template<>

InputParameters validParams< DiscreteNucleationForce >

(

)

Definition at line 17 of file DiscreteNucleationForce.C.

{
  InputParameters params = validParams<Kernel>();
  params.addClassDescription(
      "Term for inserting grain nuclei or phases in non-conserved order parameter fields");
  params.addRequiredParam<UserObjectName>("map", "DiscreteNucleationMap user object");
  params.addParam<Real>("no_nucleus_value", 0.0, "Variable value indicating no nucleus is present");
  params.addParam<Real>(
      "nucleus_value", 1.0, "Variable value indicating the presence of a nucleus");
  return params;
}