KKSPhaseChemicalPotential.C File Reference

Go to the source code of this file.

Functions
	registerMooseObject ("PhaseFieldApp", KKSPhaseChemicalPotential)
template<>
InputParameters	validParams< KKSPhaseChemicalPotential > ()

Function Documentation

registerMooseObject()

registerMooseObject	(	"PhaseFieldApp"	,
		KKSPhaseChemicalPotential
	)

validParams< KKSPhaseChemicalPotential >()

template<>

InputParameters validParams< KKSPhaseChemicalPotential >

(

)

Definition at line 19 of file KKSPhaseChemicalPotential.C.

{
  InputParameters params = validParams<Kernel>();
  params.addClassDescription("KKS model kernel to enforce the pointwise equality of phase chemical "
                             "potentials  dFa/dca = dFb/dcb. The non-linear variable of this "
                             "kernel is ca.");
  params.addRequiredCoupledVar(
      "cb", "Phase b concentration"); // note that ca is u, the non-linear variable!
  params.addRequiredParam<MaterialPropertyName>("fa_name",
                                                "Base name of the free energy function "
                                                "Fa (f_name in the corresponding "
                                                "derivative function material)");
  params.addRequiredParam<MaterialPropertyName>("fb_name",
                                                "Base name of the free energy function "
                                                "Fb (f_name in the corresponding "
                                                "derivative function material)");
  params.addParam<Real>("ka",
                        1.0,
                        "Site fraction for the ca variable (specify this if ca is a sublattice "
                        "concentration, and make sure it is a true site fraction eg. 0.6666666) ");
  params.addParam<Real>("kb",
                        1.0,
                        "Site fraction for the cb variable (specify this if ca is a sublattice "
                        "concentration, and make sure it is a true site fraction eg. 0.6666666) ");
  params.addCoupledVar(
      "args_a",
      "Vector of further parameters to Fa (optional, to add in second cross derivatives of Fa)");
  params.addCoupledVar(
      "args_b",
      "Vector of further parameters to Fb (optional, to add in second cross derivatives of Fb)");
  return params;
}