KKSPhaseConcentration Class Reference

Enforce sum of phase concentrations to be the real concentration. More...

#include <KKSPhaseConcentration.h>

Inheritance diagram for KKSPhaseConcentration:

Public Member Functions
	KKSPhaseConcentration (const InputParameters &parameters)

Protected Member Functions
virtual Real	computeQpResidual ()
virtual Real	computeQpJacobian ()
virtual Real	computeQpOffDiagJacobian (unsigned int jvar)

Private Attributes
const VariableValue &	_ca
unsigned int	_ca_var
const VariableValue &	_c
unsigned int	_c_var
const VariableValue &	_eta
unsigned int	_eta_var
const MaterialProperty< Real > &	_prop_h
	Switching function \( h(\eta) \). More...
const MaterialProperty< Real > &	_prop_dh
	Derivative of the switching function \( \frac d{d\eta} h(\eta) \). More...

Detailed Description

Enforce sum of phase concentrations to be the real concentration.

\( c=h(\eta)c_a+\left(1-h(\eta)\right)c_b\)

The non-linear variable for this Kernel is the concentration \( c_b \), while \( c_a \) and \( c \) are supplied as coupled variables. (compare this to KKSPhaseChemicalPotential, where the non-linear variable is the other phase concentration \( c_a \)!)

See also

KKSPhaseChemicalPotential

KKSHEtaPolyMaterial

Definition at line 34 of file KKSPhaseConcentration.h.

Constructor & Destructor Documentation

KKSPhaseConcentration()

KKSPhaseConcentration::KKSPhaseConcentration

(

const InputParameters &

parameters

)

Definition at line 32 of file KKSPhaseConcentration.C.

  : DerivativeMaterialInterface<Kernel>(parameters),
    _ca(coupledValue("ca")),
    _ca_var(coupled("ca")),
    _c(coupledValue("c")),
    _c_var(coupled("c")),
    _eta(coupledValue("eta")),
    _eta_var(coupled("eta")),
    _prop_h(getMaterialProperty<Real>("h_name")),
    _prop_dh(getMaterialPropertyDerivative<Real>("h_name", getVar("eta", 0)->name()))
{
}

Member Function Documentation

computeQpJacobian()

Real KKSPhaseConcentration::computeQpJacobian ( )

protectedvirtual

Definition at line 53 of file KKSPhaseConcentration.C.

{
  return _test[_i][_qp] * _prop_h[_qp] * _phi[_j][_qp];
}

computeQpOffDiagJacobian()

Real KKSPhaseConcentration::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtual

Definition at line 59 of file KKSPhaseConcentration.C.

{
  if (jvar == _ca_var)
    return _test[_i][_qp] * (1.0 - _prop_h[_qp]) * _phi[_j][_qp];
 
  else if (jvar == _c_var)
    return -_test[_i][_qp] * _phi[_j][_qp];
 
  else if (jvar == _eta_var)
    return _test[_i][_qp] * (_u[_qp] - _ca[_qp]) * _prop_dh[_qp] * _phi[_j][_qp];
 
  return 0.0;
}

computeQpResidual()

Real KKSPhaseConcentration::computeQpResidual ( )

protectedvirtual

Definition at line 46 of file KKSPhaseConcentration.C.

{
  // R = (1-h(eta))*ca + h(eta)*cb - c
  return _test[_i][_qp] * ((1.0 - _prop_h[_qp]) * _ca[_qp] + _prop_h[_qp] * _u[_qp] - _c[_qp]);
}

Member Data Documentation

_c

const VariableValue& KKSPhaseConcentration::_c

private

Definition at line 48 of file KKSPhaseConcentration.h.

Referenced by computeQpResidual().

_c_var

unsigned int KKSPhaseConcentration::_c_var

private

Definition at line 49 of file KKSPhaseConcentration.h.

Referenced by computeQpOffDiagJacobian().

_ca

const VariableValue& KKSPhaseConcentration::_ca

private

Definition at line 45 of file KKSPhaseConcentration.h.

Referenced by computeQpOffDiagJacobian(), and computeQpResidual().

_ca_var

unsigned int KKSPhaseConcentration::_ca_var

private

Definition at line 46 of file KKSPhaseConcentration.h.

Referenced by computeQpOffDiagJacobian().

_eta

const VariableValue& KKSPhaseConcentration::_eta

private

Definition at line 51 of file KKSPhaseConcentration.h.

_eta_var

unsigned int KKSPhaseConcentration::_eta_var

private

Definition at line 52 of file KKSPhaseConcentration.h.

Referenced by computeQpOffDiagJacobian().

_prop_dh

const MaterialProperty<Real>& KKSPhaseConcentration::_prop_dh

private

Derivative of the switching function \( \frac d{d\eta} h(\eta) \).

Definition at line 58 of file KKSPhaseConcentration.h.

Referenced by computeQpOffDiagJacobian().

_prop_h

const MaterialProperty<Real>& KKSPhaseConcentration::_prop_h

private

Switching function \( h(\eta) \).

Definition at line 55 of file KKSPhaseConcentration.h.

Referenced by computeQpJacobian(), computeQpOffDiagJacobian(), and computeQpResidual().

---

The documentation for this class was generated from the following files:

• phase_field/include/kernels/KKSPhaseConcentration.h
• phase_field/src/kernels/KKSPhaseConcentration.C