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

template<>
InputParameters validParams< KKSGlobalFreeEnergy > ( )

Definition at line 11 of file KKSGlobalFreeEnergy.C.

12 {
13  InputParameters params = validParams<TotalFreeEnergyBase>();
14  params.addClassDescription(
15  "Total free energy in KKS system, including chemical, barrier and gradient terms");
16  params.addRequiredParam<MaterialPropertyName>("fa_name",
17  "Base name of the free energy function "
18  "F (f_name in the corresponding "
19  "derivative function material)");
20  params.addRequiredParam<MaterialPropertyName>("fb_name",
21  "Base name of the free energy function "
22  "F (f_name in the corresponding "
23  "derivative function material)");
24  params.addParam<MaterialPropertyName>(
25  "h_name", "h", "Base name for the switching function h(eta)");
26  params.addParam<MaterialPropertyName>(
27  "g_name", "g", "Base name for the double well function g(eta)");
28  params.addRequiredParam<Real>("w", "Double well height parameter");
29  params.addParam<std::vector<MaterialPropertyName>>("kappa_names",
30  std::vector<MaterialPropertyName>(),
31  "Vector of kappa names corresponding to "
32  "each variable name in interfacial_vars "
33  "in the same order. For basic KKS, there "
34  "is 1 kappa, 1 interfacial_var.");
35  return params;
36 }
InputParameters validParams< TotalFreeEnergyBase >()