GrandPotentialInterface.C File Reference

Go to the source code of this file.

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

Function Documentation

registerMooseObject()

registerMooseObject	(	"PhaseFieldApp"	,
		GrandPotentialInterface
	)

validParams< GrandPotentialInterface >()

template<>

InputParameters validParams< GrandPotentialInterface >

(

)

Definition at line 19 of file GrandPotentialInterface.C.

{
  InputParameters params = validParams<Material>();
  params.addClassDescription("Calculate Grand Potential interface parameters for a specified "
                             "interfacial free energy and width");
  params.addRequiredParam<std::vector<Real>>("sigma", "Interfacial free energies");
  params.addRequiredRangeCheckedParam<Real>(
      "width", "width > 0", "Interfacial width (for the interface with gamma = 1.5)");
  params.addParam<std::vector<MaterialPropertyName>>(
      "gamma_names",
      "Interfacial / grain boundary gamma parameter names (leave empty for gamma0... gammaN)");
  params.addParam<MaterialPropertyName>("kappa_name", "kappa", "Gradient interface parameter name");
  params.addParam<MaterialPropertyName>("mu_name", "mu", "Grain growth bulk energy parameter name");
  params.addParam<unsigned int>(
      "sigma_index",
      "Sigma index to choose gamma = 1.5 for. Omit this to automatically chose the median sigma.");
  params.addParamNamesToGroup("mu_name sigma_index", "Advanced");
  return params;
}