DiscreteNucleation.h File Reference

Go to the source code of this file.

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

Functions
template<>
InputParameters	validParams< DiscreteNucleation > ()

Function Documentation

validParams< DiscreteNucleation >()

template<>

InputParameters validParams< DiscreteNucleation >

(

)

Definition at line 19 of file DiscreteNucleation.C.

{
  InputParameters params = validParams<DerivativeFunctionMaterialBase>();
  params.addClassDescription("Free energy contribution for nucleating discrete particles");
  params.addRequiredCoupledVar("op_names",
                               "List of variables to force to a target concentration value");
  params.addRequiredParam<UserObjectName>("map", "DiscreteNucleationMap user object");
  params.addRequiredParam<std::vector<Real>>("op_values", "List of target concentration values");
  params.addParam<Real>("penalty", 20.0, "Penalty factor for enforcing the target concentrations");
  MooseEnum penalty_mode("MATCH MIN MAX", "MATCH");
  params.addParam<MooseEnum>(
      "penalty_mode",
      penalty_mode,
      "Match the target concentration or take it as a minimum or maximum concentration target");
  return params;
}