SplitCHWRes creates the residual of the Cahn-Hilliard equation with a scalar (isotropic) mobility. More...

#include <CahnHilliardAniso.h>

Inheritance diagram for CahnHilliardAniso:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	CahnHilliardAniso (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< RealTensorValue >::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

SplitCHWRes creates the residual of the Cahn-Hilliard equation with a scalar (isotropic) mobility.

Definition at line 18 of file CahnHilliardAniso.h.

Member Typedef Documentation

◆ PFFunctionType

typedef CHBulk<RealTensorValue >::PFFunctionType CahnHilliardBase< RealTensorValue >::PFFunctionType

protectedinherited

Definition at line 29 of file CahnHilliardBase.h.

Constructor & Destructor Documentation

◆ CahnHilliardAniso()

CahnHilliardAniso::CahnHilliardAniso ( const InputParameters & parameters )

Definition at line 23 of file CahnHilliardAniso.C.

  : CahnHilliardBase<RealTensorValue>(parameters)
{
}

Member Function Documentation

◆ computeGradDFDCons()

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

protectedvirtualinherited

Implements CHBulk< T >.

Definition at line 30 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()

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

protectedvirtualinherited

Reimplemented from CHBulk< T >.

Definition at line 31 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()

void CahnHilliardBase< RealTensorValue >::initialSetup ( )

virtualinherited

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 26 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()

InputParameters CahnHilliardAniso::validParams ( )

static

Definition at line 15 of file CahnHilliardAniso.C.

{
  InputParameters params = CahnHilliardBase<RealTensorValue>::validParams();
  params.addClassDescription("Cahn-Hilliard Kernel that uses a DerivativeMaterial Free Energy and "
                             "a tensor (anisotropic) mobility");
  return params;
}

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

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

privateinherited

Definition at line 53 of file CahnHilliardBase.h.

◆ _M

template<typename T >

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

protectedinherited

Mobility.

Definition at line 47 of file CHBulk.h.

◆ _nvar

const unsigned int CahnHilliardBase< RealTensorValue >::_nvar

privateinherited

Definition at line 49 of file CahnHilliardBase.h.

◆ _second_derivatives

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

privateinherited

Definition at line 50 of file CahnHilliardBase.h.

◆ _third_cross_derivatives

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

privateinherited

Definition at line 52 of file CahnHilliardBase.h.

◆ _third_derivatives

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

privateinherited

Definition at line 51 of file CahnHilliardBase.h.

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

phase_field/include/kernels/CahnHilliardAniso.h
phase_field/src/kernels/CahnHilliardAniso.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 Typedef Documentation

◆ PFFunctionType

Constructor & Destructor Documentation

◆ CahnHilliardAniso()

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