SwitchingFunctionConstraintEta.h File Reference

Go to the source code of this file.

Classes
class	SwitchingFunctionConstraintEta
	SwitchingFunctionConstraintEta is a constraint kernel that acts on the lambda lagrange multiplier non-linear variables to enforce \( \sum_n h_i(\eta_i) \equiv 1 \). More...

Functions
template<>
InputParameters	validParams< SwitchingFunctionConstraintEta > ()

Function Documentation

validParams< SwitchingFunctionConstraintEta >()

template<>

InputParameters validParams< SwitchingFunctionConstraintEta >

(

)

Definition at line 16 of file SwitchingFunctionConstraintEta.C.

{
  InputParameters params = validParams<Kernel>();
  params.addClassDescription("Lagrange multiplier kernel to constrain the sum of all switching "
                             "functions in a multiphase system. This kernel acts on a "
                             "non-conserved order parameter eta_i.");
  params.addParam<MaterialPropertyName>("h_name",
                                        "Switching Function Materials that provides h(eta_i)");
  params.addRequiredCoupledVar("lambda", "Lagrange multiplier");
  params.addCoupledVar("args", "Further arguments to the switching function");
  return params;
}