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

#include <KKSPhaseConcentration.h>

Inheritance diagram for KKSPhaseConcentration:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	KKSPhaseConcentration (const InputParameters &parameters)

const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialProperty (const std::string &name)

const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialPropertyByName (const std::string &name)

void	validateDerivativeMaterialPropertyBase (const std::string &base)

const MaterialPropertyName	derivativePropertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	derivativePropertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	derivativePropertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	derivativePropertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

void	validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)

void	validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

void	validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)

void	validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

void	validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

void	validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

const MaterialPropertyName	propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

const MaterialPropertyName	propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

Static Public Member Functions
static InputParameters	validParams ()

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 30 of file KKSPhaseConcentration.h.

Constructor & Destructor Documentation

◆ KKSPhaseConcentration()

KKSPhaseConcentration::KKSPhaseConcentration ( const InputParameters & parameters )

Definition at line 30 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", coupledName("eta", 0)))
 {
 }

Member Function Documentation

◆ computeQpJacobian()

Real KKSPhaseConcentration::computeQpJacobian ( )

protectedvirtual

Definition at line 51 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 57 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 44 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]);
 }

◆ validParams()

InputParameters KKSPhaseConcentration::validParams ( )

static

Definition at line 15 of file KKSPhaseConcentration.C.

 {
   InputParameters params = Kernel::validParams();
   params.addClassDescription("KKS model kernel to enforce the decomposition of concentration into "
                              "phase concentration  $(1-h(\\eta))c_a + h(\\eta)c_b - c = 0$. The "
                              "non-linear variable of this kernel is $c_b$.");
   params.addRequiredCoupledVar("ca", "Phase a concentration");
   params.addRequiredCoupledVar("c", "Real concentration");
   params.addRequiredCoupledVar("eta", "Phase a/b order parameter");
   params.addParam<MaterialPropertyName>(
       "h_name", "h", "Base name for the switching function h(eta)");
   return params;
 }

Member Data Documentation

◆ _c

const VariableValue& KKSPhaseConcentration::_c

private

Definition at line 46 of file KKSPhaseConcentration.h.

Referenced by computeQpResidual().

◆ _c_var

unsigned int KKSPhaseConcentration::_c_var

private

Definition at line 47 of file KKSPhaseConcentration.h.

Referenced by computeQpOffDiagJacobian().

◆ _ca

const VariableValue& KKSPhaseConcentration::_ca

private

Definition at line 43 of file KKSPhaseConcentration.h.

Referenced by computeQpOffDiagJacobian(), and computeQpResidual().

◆ _ca_var

unsigned int KKSPhaseConcentration::_ca_var

private

Definition at line 44 of file KKSPhaseConcentration.h.

Referenced by computeQpOffDiagJacobian().

◆ _eta

const VariableValue& KKSPhaseConcentration::_eta

private

Definition at line 49 of file KKSPhaseConcentration.h.

◆ _eta_var

unsigned int KKSPhaseConcentration::_eta_var

private

Definition at line 50 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 56 of file KKSPhaseConcentration.h.

Referenced by computeQpOffDiagJacobian().

◆ _prop_h

const MaterialProperty<Real>& KKSPhaseConcentration::_prop_h

private

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

Definition at line 53 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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KKSPhaseConcentration()

Member Function Documentation

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

◆ validParams()

Member Data Documentation

◆ _c

◆ _c_var

◆ _ca

◆ _ca_var

◆ _eta

◆ _eta_var

◆ _prop_dh

◆ _prop_h