KKSGlobalFreeEnergy.h File Reference

Go to the source code of this file.

Classes
class	KKSGlobalFreeEnergy
	Compute the global free energy in the KKS Model \( F = hF_a + (1-h)F_b + wg + \frac{\kappa}{2}|\eta|^2 \). More...

Functions
template<>
InputParameters	validParams< KKSGlobalFreeEnergy > ()

Function Documentation

validParams< KKSGlobalFreeEnergy >()

template<>

InputParameters validParams< KKSGlobalFreeEnergy >

(

)

Definition at line 16 of file KKSGlobalFreeEnergy.C.

{
  InputParameters params = validParams<TotalFreeEnergyBase>();
  params.addClassDescription(
      "Total free energy in KKS system, including chemical, barrier and gradient terms");
  params.addRequiredParam<MaterialPropertyName>("fa_name",
                                                "Base name of the free energy function "
                                                "F (f_name in the corresponding "
                                                "derivative function material)");
  params.addRequiredParam<MaterialPropertyName>("fb_name",
                                                "Base name of the free energy function "
                                                "F (f_name in the corresponding "
                                                "derivative function material)");
  params.addParam<MaterialPropertyName>(
      "h_name", "h", "Base name for the switching function h(eta)");
  params.addParam<MaterialPropertyName>(
      "g_name", "g", "Base name for the double well function g(eta)");
  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. For basic KKS, there "
                                                     "is 1 kappa, 1 interfacial_var.");
  return params;
}