KKSACBulkBase child class for the free energy difference term \( -\frac{dh}{d\eta}(F_a-F_b)+w\frac{dg}{d\eta} \) in the the Allen-Cahn bulk residual. More...

#include <KKSACBulkF.h>

Inheritance diagram for KKSACBulkF:

[legend]

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	KKSACBulkF (const InputParameters &parameters)

virtual void	initialSetup ()

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 Types
enum	PFFunctionType

Protected Member Functions
virtual Real	computeDFDOP (PFFunctionType type)

virtual Real	computeQpOffDiagJacobian (unsigned int jvar)

virtual Real	precomputeQpResidual ()

virtual Real	precomputeQpJacobian ()

virtual Real	computeDFDOP (PFFunctionType type)=0

Protected Attributes
Real	_w
	double well height parameter

const MaterialProperty< Real > &	_prop_dg
	Derivative of the double well function \( \frac d{d\eta} g(\eta) \).

const MaterialProperty< Real > &	_prop_d2g
	Second derivative of the double well function \( \frac {d^2}{d\eta^2} g(\eta) \).

const MaterialProperty< Real > &	_prop_Fb
	Value of the free energy function \( F_b \).

const MaterialProperty< Real > &	_prop_dFb
	Derivative of the free energy function \( \frac d{d\eta} F_b \).

VariableName	_eta_name
	name of the order parameter (needed to retrieve the derivative material properties)

std::vector< const MaterialProperty< Real > * >	_derivatives_Fa
	Derivatives of \( F_a \) with respect to all coupled variables.

std::vector< const MaterialProperty< Real > * >	_derivatives_Fb
	Derivatives of \( F_b \) with respect to all coupled variables.

const MaterialProperty< Real > &	_prop_Fa
	Value of the free energy function \( F_a \).

const MaterialProperty< Real > &	_prop_dFa
	Derivative of the free energy function \( \frac d{d\eta} F_a \).

const MaterialProperty< Real > &	_prop_dh
	Derivative of the switching function \( \frac d{d\eta} h(\eta) \).

const MaterialProperty< Real > &	_prop_d2h
	Second derivative of the switching function \( \frac {d^2}{d\eta^2} h(\eta) \).

std::vector< const VariableGradient * >	_grad_args
	Gradients for all coupled variables.

const MaterialProperty< Real > &	_L
	Mobility.

const MaterialProperty< Real > &	_dLdop
	Mobility derivative w.r.t. order parameter.

std::vector< const MaterialProperty< Real > * >	_dLdarg
	Mobility derivative w.r.t coupled variables.

Private Member Functions
bool	haveMaterialProperty (const std::string &prop_name)

std::vector< VariableName >	buildVariableVector (const VariableName &c1, const VariableName &c2, const VariableName &c3)

void	validateCouplingHelper (const MaterialPropertyName &base, const std::vector< VariableName > &c, const System &system, std::vector< VariableName > &missing)

bool	isNotObjectVariable (const VariableName &name)

Private Attributes
FEProblemBase &	_dmi_fe_problem

Detailed Description

KKSACBulkBase child class for the free energy difference term \( -\frac{dh}{d\eta}(F_a-F_b)+w\frac{dg}{d\eta} \) in the the Allen-Cahn bulk residual.

The non-linear variable for this Kernel is the order parameter 'eta'.

Definition at line 23 of file KKSACBulkF.h.

Member Enumeration Documentation

◆ PFFunctionType

enum ACBulk::PFFunctionType

protectedinherited

Definition at line 37 of file ACBulk.h.

  {
    Jacobian,
    Residual
  };

Constructor & Destructor Documentation

◆ KKSACBulkF()

KKSACBulkF::KKSACBulkF ( const InputParameters & parameters )

Definition at line 29 of file KKSACBulkF.C.

  : KKSACBulkBase(parameters),
    _w(getParam<Real>("w")),
    _prop_dg(getMaterialPropertyDerivative<Real>("g_name", _eta_name)),
    _prop_d2g(getMaterialPropertyDerivative<Real>("g_name", _eta_name, _eta_name)),
    _prop_Fb(getMaterialProperty<Real>("fb_name")),
    _prop_dFb(getMaterialPropertyDerivative<Real>("fb_name", _eta_name))
{
}

Member Function Documentation

◆ computeDFDOP() [1/2]

Real KKSACBulkF::computeDFDOP ( PFFunctionType type )

protectedvirtual

Definition at line 40 of file KKSACBulkF.C.

{
  const Real A1 = _prop_Fa[_qp] - _prop_Fb[_qp];
  switch (type)
  {
    case Residual:
      return -_prop_dh[_qp] * A1 + _w * _prop_dg[_qp];
 
    case Jacobian:
      return _phi[_j][_qp] * (-_prop_d2h[_qp] * A1 + _w * _prop_d2g[_qp]);
  }
 
  mooseError("Invalid type passed in");
}

◆ computeDFDOP() [2/2]

virtual Real ACBulk< Real >::computeDFDOP ( PFFunctionType type )

protectedpure virtualinherited

◆ computeQpOffDiagJacobian()

Real KKSACBulkF::computeQpOffDiagJacobian ( unsigned int jvar )

protectedvirtual

Reimplemented from ACBulk< Real >.

Definition at line 56 of file KKSACBulkF.C.

{
  // get the coupled variable jvar is referring to
  const unsigned int cvar = mapJvarToCvar(jvar);
 
  // first get dependence of mobility _L on other variables using parent class
  // member function
  Real res = ACBulk<Real>::computeQpOffDiagJacobian(jvar);
 
  return res - _L[_qp] * _prop_dh[_qp] *
                   ((*_derivatives_Fa[cvar])[_qp] - (*_derivatives_Fb[cvar])[_qp]) * _phi[_j][_qp] *
                   _test[_i][_qp];
}

◆ initialSetup()

void KKSACBulkBase::initialSetup ( )

virtualinherited

Reimplemented from ACBulk< Real >.

Definition at line 53 of file KKSACBulkBase.C.

{
  ACBulk<Real>::initialSetup();
  validateNonlinearCoupling<Real>("fa_name");
  validateNonlinearCoupling<Real>("fb_name");
}

◆ precomputeQpJacobian()

Real ACBulk< Real >::precomputeQpJacobian ( )

protectedvirtualinherited

Definition at line 34 of file ACBulk.h.

{
  // Get free energy derivative and Jacobian
  Real dFdop = computeDFDOP(Residual);
 
  Real JdFdop = computeDFDOP(Jacobian);
 
  // Set Jacobian value using product rule
  return _L[_qp] * JdFdop + _dLdop[_qp] * _phi[_j][_qp] * dFdop;
}

◆ precomputeQpResidual()

Real ACBulk< Real >::precomputeQpResidual ( )

protectedvirtualinherited

Definition at line 33 of file ACBulk.h.

{
  // Get free energy derivative from function
  Real dFdop = computeDFDOP(Residual);
 
  // Set residual
  return _L[_qp] * dFdop;
}

◆ validParams()

InputParameters KKSACBulkF::validParams ( )

static

Definition at line 15 of file KKSACBulkF.C.

{
  InputParameters params = KKSACBulkBase::validParams();
  params.addClassDescription("KKS model kernel (part 1 of 2) for the Bulk Allen-Cahn. This "
                             "includes all terms NOT dependent on chemical potential.");
  params.addRequiredParam<Real>("w", "Double well height parameter");
  params.addParam<MaterialPropertyName>(
      "g_name", "g", "Base name for the double well function g(eta)");
  params.addRequiredParam<MaterialPropertyName>(
      "fb_name",
      "Base name of the free energy function F (f_base in the corresponding KKSBaseMaterial)");
  return params;
}

Member Data Documentation

◆ _derivatives_Fa

std::vector<const MaterialProperty<Real> *> KKSACBulkBase::_derivatives_Fa

protectedinherited

Derivatives of \( F_a \) with respect to all coupled variables.

Definition at line 36 of file KKSACBulkBase.h.

Referenced by computeQpOffDiagJacobian(), and KKSACBulkBase::KKSACBulkBase().

◆ _derivatives_Fb

std::vector<const MaterialProperty<Real> *> KKSACBulkBase::_derivatives_Fb

protectedinherited

Derivatives of \( F_b \) with respect to all coupled variables.

Definition at line 39 of file KKSACBulkBase.h.

Referenced by computeQpOffDiagJacobian(), and KKSACBulkBase::KKSACBulkBase().

◆ _dLdarg

std::vector<const MaterialProperty<Real > *> ACBulk< Real >::_dLdarg

protectedinherited

Mobility derivative w.r.t coupled variables.

Definition at line 52 of file ACBulk.h.

◆ _dLdop

const MaterialProperty<Real >& ACBulk< Real >::_dLdop

protectedinherited

Mobility derivative w.r.t. order parameter.

Definition at line 49 of file ACBulk.h.

◆ _eta_name

VariableName KKSACBulkBase::_eta_name

protectedinherited

name of the order parameter (needed to retrieve the derivative material properties)

Definition at line 33 of file KKSACBulkBase.h.

◆ _grad_args

std::vector<const VariableGradient *> KKSACBulkBase::_grad_args

protectedinherited

Gradients for all coupled variables.

Definition at line 54 of file KKSACBulkBase.h.

Referenced by KKSACBulkBase::KKSACBulkBase().

◆ _L

const MaterialProperty<Real >& ACBulk< Real >::_L

protectedinherited

Mobility.

Definition at line 46 of file ACBulk.h.

◆ _prop_d2g

const MaterialProperty<Real>& KKSACBulkF::_prop_d2g

protected

Second derivative of the double well function \( \frac {d^2}{d\eta^2} g(\eta) \).

Definition at line 41 of file KKSACBulkF.h.

Referenced by computeDFDOP().

◆ _prop_d2h

const MaterialProperty<Real>& KKSACBulkBase::_prop_d2h

protectedinherited

Second derivative of the switching function \( \frac {d^2}{d\eta^2} h(\eta) \).

Definition at line 51 of file KKSACBulkBase.h.

Referenced by KKSACBulkC::computeDFDOP(), computeDFDOP(), NestedKKSACBulkC::computeDFDOP(), and NestedKKSACBulkF::computeDFDOP().

◆ _prop_dFa

const MaterialProperty<Real>& KKSACBulkBase::_prop_dFa

protectedinherited

Derivative of the free energy function \( \frac d{d\eta} F_a \).

Definition at line 45 of file KKSACBulkBase.h.

◆ _prop_dFb

const MaterialProperty<Real>& KKSACBulkF::_prop_dFb

protected

Derivative of the free energy function \( \frac d{d\eta} F_b \).

Definition at line 47 of file KKSACBulkF.h.

◆ _prop_dg

const MaterialProperty<Real>& KKSACBulkF::_prop_dg

protected

Derivative of the double well function \( \frac d{d\eta} g(\eta) \).

Definition at line 38 of file KKSACBulkF.h.

Referenced by computeDFDOP().

◆ _prop_dh

const MaterialProperty<Real>& KKSACBulkBase::_prop_dh

protectedinherited

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

Definition at line 48 of file KKSACBulkBase.h.

Referenced by KKSACBulkC::computeDFDOP(), computeDFDOP(), NestedKKSACBulkC::computeDFDOP(), NestedKKSACBulkF::computeDFDOP(), KKSACBulkC::computeQpOffDiagJacobian(), computeQpOffDiagJacobian(), NestedKKSACBulkC::computeQpOffDiagJacobian(), and NestedKKSACBulkF::computeQpOffDiagJacobian().

◆ _prop_Fa

const MaterialProperty<Real>& KKSACBulkBase::_prop_Fa

protectedinherited

Value of the free energy function \( F_a \).

Definition at line 42 of file KKSACBulkBase.h.

Referenced by computeDFDOP().

◆ _prop_Fb

const MaterialProperty<Real>& KKSACBulkF::_prop_Fb

protected

Value of the free energy function \( F_b \).

Definition at line 44 of file KKSACBulkF.h.

Referenced by computeDFDOP().

◆ _w

Real KKSACBulkF::_w

protected

double well height parameter

Definition at line 35 of file KKSACBulkF.h.

Referenced by computeDFDOP().

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

phase_field/include/kernels/KKSACBulkF.h
phase_field/src/kernels/KKSACBulkF.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ PFFunctionType

Constructor & Destructor Documentation

◆ KKSACBulkF()

Member Function Documentation

◆ computeDFDOP() [1/2]

◆ computeDFDOP() [2/2]

◆ computeQpOffDiagJacobian()

◆ initialSetup()

◆ precomputeQpJacobian()

◆ precomputeQpResidual()

◆ validParams()

Member Data Documentation

◆ _derivatives_Fa

◆ _derivatives_Fb

◆ _dLdarg

◆ _dLdop

◆ _eta_name

◆ _grad_args

◆ _L

◆ _prop_d2g

◆ _prop_d2h

◆ _prop_dFa

◆ _prop_dFb

◆ _prop_dg

◆ _prop_dh

◆ _prop_Fa

◆ _prop_Fb

◆ _w