www.mooseframework.org
Classes | Functions
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

template<>
InputParameters validParams< KKSMultiFreeEnergy > ( )

Definition at line 11 of file KKSMultiFreeEnergy.C.

12 {
13  InputParameters params = validParams<TotalFreeEnergyBase>();
14  params.addClassDescription("Total free energy in multi-phase KKS system, including chemical, "
15  "barrier and gradient terms");
16  params.addRequiredParam<std::vector<MaterialPropertyName>>(
17  "Fj_names",
18  "List of free energies for each phase. Place in same order as hj_names and gj_names!");
19  params.addRequiredParam<std::vector<MaterialPropertyName>>(
20  "hj_names",
21  "Switching Function Materials that provide h. Place in same order as Fj_names and gj_names!");
22  params.addRequiredParam<std::vector<MaterialPropertyName>>(
23  "gj_names",
24  "Barrier Function Materials that provide g. Place in same order as Fj_names and hj_names!");
25  params.addRequiredParam<Real>("w", "Double well height parameter");
26  params.addParam<std::vector<MaterialPropertyName>>("kappa_names",
27  std::vector<MaterialPropertyName>(),
28  "Vector of kappa names corresponding to "
29  "each variable name in interfacial_vars "
30  "in the same order.");
31  return params;
32 }
InputParameters validParams< TotalFreeEnergyBase >()