CahnHilliardBase implements the residual of the Cahn-Hilliard equation in a general way that can be templated to a scalar or tensor mobility. More...

#include <CahnHilliardBase.h>

Inheritance diagram for CahnHilliardBase< T >:

[legend]

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	CahnHilliardBase (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
typedef CHBulk< T >::PFFunctionType	PFFunctionType

Protected Member Functions
virtual RealGradient	computeGradDFDCons (PFFunctionType type)

virtual Real	computeQpOffDiagJacobian (unsigned int jvar)

virtual RealGradient	precomputeQpResidual ()

virtual RealGradient	precomputeQpJacobian ()

Protected Attributes
const MaterialProperty< T > &	_M
	Mobility.

const MaterialProperty< T > &	_dMdc
	Mobility derivative w.r.t. concentration.

std::vector< const MaterialProperty< T > * >	_dMdarg
	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
const unsigned int	_nvar

std::vector< const MaterialProperty< Real > * >	_second_derivatives

std::vector< const MaterialProperty< Real > * >	_third_derivatives

std::vector< std::vector< const MaterialProperty< Real > * > >	_third_cross_derivatives

std::vector< const VariableGradient * >	_grad_vars

FEProblemBase &	_dmi_fe_problem

Detailed Description

template<typename T>
class CahnHilliardBase< T >

CahnHilliardBase implements the residual of the Cahn-Hilliard equation in a general way that can be templated to a scalar or tensor mobility.

Definition at line 20 of file CahnHilliardBase.h.

Member Typedef Documentation

◆ PFFunctionType

template<typename T >

typedef CHBulk<T>::PFFunctionType CahnHilliardBase< T >::PFFunctionType

protected

Definition at line 29 of file CahnHilliardBase.h.

Constructor & Destructor Documentation

◆ CahnHilliardBase()

template<typename T >

CahnHilliardBase< T >::CahnHilliardBase ( const InputParameters & parameters )

Definition at line 72 of file CahnHilliardBase.h.

  : CHBulk<T>(parameters),
    _nvar(_coupled_moose_vars.size()),
    _second_derivatives(_nvar + 1),
    _third_derivatives(_nvar + 1),
    _third_cross_derivatives(_nvar),
    _grad_vars(_nvar + 1)
{
  // derivatives w.r.t. and gradients of the kernel variable
  _second_derivatives[0] =
      &this->template getMaterialPropertyDerivative<Real>("f_name", _var.name(), _var.name());
  _third_derivatives[0] = &this->template getMaterialPropertyDerivative<Real>(
      "f_name", _var.name(), _var.name(), _var.name());
  _grad_vars[0] = &(_grad_u);
 
  // Iterate over all coupled variables
  for (unsigned int i = 0; i < _nvar; ++i)
  {
    const VariableName iname = _coupled_moose_vars[i]->name();
    if (iname == _var.name())
      this->paramError("coupled_variables",
                       "The kernel variable should not be specified in the coupled "
                       "`coupled_variables` parameter.");
    _second_derivatives[i + 1] =
        &this->template getMaterialPropertyDerivative<Real>("f_name", _var.name(), iname);
    _third_derivatives[i + 1] = &this->template getMaterialPropertyDerivative<Real>(
        "f_name", _var.name(), _var.name(), iname);
 
    _third_cross_derivatives[i].resize(_nvar);
    for (unsigned int j = 0; j < _nvar; ++j)
    {
      VariableName jname = _coupled_moose_vars[j]->name();
      _third_cross_derivatives[i][j] =
          &this->template getMaterialPropertyDerivative<Real>("f_name", _var.name(), iname, jname);
    }
 
    _grad_vars[i + 1] = &_subproblem.getStandardVariable(_tid, iname).gradSln();
  }
}

Member Function Documentation

◆ computeGradDFDCons()

template<typename T >

RealGradient CahnHilliardBase< T >::computeGradDFDCons ( PFFunctionType type )

protectedvirtual

Implements CHBulk< T >.

Definition at line 127 of file CahnHilliardBase.h.

{
  RealGradient res = 0.0;
 
  switch (type)
  {
    case CHBulk<T>::Residual:
      for (unsigned int i = 0; i <= _nvar; ++i)
        res += (*_grad_vars[i])[_qp] * (*_second_derivatives[i])[_qp];
      return res;
 
    case CHBulk<T>::Jacobian:
      res = _grad_phi[_j][_qp] * (*_second_derivatives[0])[_qp];
      for (unsigned int i = 0; i <= _nvar; ++i)
        res += _phi[_j][_qp] * (*_grad_vars[i])[_qp] * (*_third_derivatives[i])[_qp];
      return res;
  }
 
  mooseError("Internal error");
}

◆ computeQpOffDiagJacobian()

template<typename T >

Real CahnHilliardBase< T >::computeQpOffDiagJacobian ( unsigned int jvar )

protectedvirtual

Reimplemented from CHBulk< T >.

Definition at line 150 of file CahnHilliardBase.h.

{
  // get the coupled variable jvar is referring to
  const unsigned int cvar = this->mapJvarToCvar(jvar);
 
  RealGradient J = _grad_u[_qp] * _phi[_j][_qp] * (*_third_derivatives[cvar + 1])[_qp] +
                   _grad_phi[_j][_qp] * (*_second_derivatives[cvar + 1])[_qp];
 
  for (unsigned int i = 0; i < _nvar; ++i)
    J += _phi[_j][_qp] * (*_grad_vars[i + 1])[_qp] * (*_third_cross_derivatives[i][cvar])[_qp];
 
  return CHBulk<T>::computeQpOffDiagJacobian(jvar) + _M[_qp] * _grad_test[_i][_qp] * J;
}

◆ initialSetup()

template<typename T >

void CahnHilliardBase< T >::initialSetup ( )

virtual

Check if both the non-linear as well as the auxiliary variables variables are coupled. Derivatives with respect to both types of variables contribute the residual.

Reimplemented from CHBulk< T >.

Definition at line 114 of file CahnHilliardBase.h.

{
  this->template validateCoupling<Real>("f_name", _var.name());
  this->template validateDerivativeMaterialPropertyBase<Real>("f_name");
}

◆ precomputeQpJacobian()

template<typename T >

RealGradient CHBulk< T >::precomputeQpJacobian ( )

protectedvirtualinherited

Definition at line 100 of file CHBulk.h.

{
  RealGradient grad_value = _M[_qp] * computeGradDFDCons(Jacobian) +
                            _dMdc[_qp] * _phi[_j][_qp] * computeGradDFDCons(Residual);
 
  return grad_value;
}

◆ precomputeQpResidual()

template<typename T >

RealGradient CHBulk< T >::precomputeQpResidual ( )

protectedvirtualinherited

Definition at line 93 of file CHBulk.h.

{
  return _M[_qp] * computeGradDFDCons(Residual);
}

◆ validParams()

template<typename T >

InputParameters CahnHilliardBase< T >::validParams ( )

static

Definition at line 58 of file CahnHilliardBase.h.

{
  InputParameters params = CHBulk<Real>::validParams();
  params.addClassDescription("Cahn-Hilliard Kernel that uses a DerivativeMaterial Free Energy");
  params.addRequiredParam<MaterialPropertyName>(
      "f_name", "Base name of the free energy function F defined in a DerivativeParsedMaterial");
  params.addCoupledVar("displacement_gradients",
                       "Vector of displacement gradient variables (see "
                       "Modules/PhaseField/DisplacementGradients "
                       "action)");
  return params;
}

Referenced by CahnHilliard::validParams(), and CahnHilliardAniso::validParams().

Member Data Documentation

◆ _dMdarg

template<typename T >

std::vector<const MaterialProperty<T> *> CHBulk< T >::_dMdarg

protectedinherited

Mobility derivative w.r.t coupled variables.

Definition at line 53 of file CHBulk.h.

Referenced by CHBulk< T >::CHBulk().

◆ _dMdc

template<typename T >

const MaterialProperty<T>& CHBulk< T >::_dMdc

protectedinherited

Mobility derivative w.r.t. concentration.

Definition at line 50 of file CHBulk.h.

◆ _grad_vars

template<typename T >

std::vector<const VariableGradient *> CahnHilliardBase< T >::_grad_vars

private

Definition at line 53 of file CahnHilliardBase.h.

Referenced by CahnHilliardBase< T >::CahnHilliardBase().

◆ _M

template<typename T >

const MaterialProperty<T>& CHBulk< T >::_M

protectedinherited

Mobility.

Definition at line 47 of file CHBulk.h.

◆ _nvar

template<typename T >

const unsigned int CahnHilliardBase< T >::_nvar

private

Definition at line 49 of file CahnHilliardBase.h.

Referenced by CahnHilliardBase< T >::CahnHilliardBase().

◆ _second_derivatives

template<typename T >

std::vector<const MaterialProperty<Real> *> CahnHilliardBase< T >::_second_derivatives

private

Definition at line 50 of file CahnHilliardBase.h.

Referenced by CahnHilliardBase< T >::CahnHilliardBase().

◆ _third_cross_derivatives

template<typename T >

std::vector<std::vector<const MaterialProperty<Real> *> > CahnHilliardBase< T >::_third_cross_derivatives

private

Definition at line 52 of file CahnHilliardBase.h.

Referenced by CahnHilliardBase< T >::CahnHilliardBase().

◆ _third_derivatives

template<typename T >

std::vector<const MaterialProperty<Real> *> CahnHilliardBase< T >::_third_derivatives

private

Definition at line 51 of file CahnHilliardBase.h.

Referenced by CahnHilliardBase< T >::CahnHilliardBase().

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

phase_field/include/kernels/CahnHilliardBase.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ PFFunctionType

Constructor & Destructor Documentation

◆ CahnHilliardBase()

Member Function Documentation

◆ computeGradDFDCons()

◆ computeQpOffDiagJacobian()

◆ initialSetup()

◆ precomputeQpJacobian()

◆ precomputeQpResidual()

◆ validParams()

Member Data Documentation

◆ _dMdarg

◆ _dMdc

◆ _grad_vars

◆ _M

◆ _nvar

◆ _second_derivatives

◆ _third_cross_derivatives

◆ _third_derivatives