KKSMultiFreeEnergy.h File Reference

Go to the source code of this file.

Classes
class	KKSMultiFreeEnergy
	Compute the free energy in the multi-phase KKS Model \( F = \sum_i h_i F_i + + wg_i + \frac{\kappa}{2}|\eta_i|^2 \). More...

Functions
template<>
InputParameters	validParams< KKSMultiFreeEnergy > ()

Function Documentation

validParams< KKSMultiFreeEnergy >()

template<>

InputParameters validParams< KKSMultiFreeEnergy >

(

)

Definition at line 16 of file KKSMultiFreeEnergy.C.

{
  InputParameters params = validParams<TotalFreeEnergyBase>();
  params.addClassDescription("Total free energy in multi-phase KKS system, including chemical, "
                             "barrier and gradient terms");
  params.addRequiredParam<std::vector<MaterialPropertyName>>(
      "Fj_names",
      "List of free energies for each phase. Place in same order as hj_names and gj_names!");
  params.addRequiredParam<std::vector<MaterialPropertyName>>(
      "hj_names",
      "Switching Function Materials that provide h. Place in same order as Fj_names and gj_names!");
  params.addRequiredParam<std::vector<MaterialPropertyName>>(
      "gj_names",
      "Barrier Function Materials that provide g. Place in same order as Fj_names and hj_names!");
  params.addRequiredParam<Real>("w", "Double well height parameter");
  params.addParam<std::vector<MaterialPropertyName>>("kappa_names",
                                                     std::vector<MaterialPropertyName>(),
                                                     "Vector of kappa names corresponding to "
                                                     "each variable name in interfacial_vars "
                                                     "in the same order.");
  return params;
}