Solves Cahn-Hilliard equation using chemical potential as non-linear variable. More...

#include <CHSplitConcentration.h>

Inheritance diagram for CHSplitConcentration:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	CHSplitConcentration (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)

Protected Attributes
MaterialPropertyName	_mobility_name
	Mobility property name.

const MaterialProperty< RealTensorValue > &	_mobility

const MaterialProperty< RealTensorValue > &	_dmobility_dc

const unsigned int	_mu_var
	Chemical potential variable.

const VariableGradient &	_grad_mu

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

Solves Cahn-Hilliard equation using chemical potential as non-linear variable.

Definition at line 19 of file CHSplitConcentration.h.

Constructor & Destructor Documentation

◆ CHSplitConcentration()

CHSplitConcentration::CHSplitConcentration ( const InputParameters & parameters )

Definition at line 25 of file CHSplitConcentration.C.

  : DerivativeMaterialInterface<Kernel>(parameters),
    _mobility_name(getParam<MaterialPropertyName>("mobility")),
    _mobility(getMaterialProperty<RealTensorValue>(_mobility_name)),
    _dmobility_dc(getMaterialPropertyDerivative<RealTensorValue>(_mobility_name, name())),
    _mu_var(coupled("chemical_potential_var")),
    _grad_mu(coupledGradient("chemical_potential_var"))
{
}

Member Function Documentation

◆ computeQpJacobian()

Real CHSplitConcentration::computeQpJacobian ( )

protectedvirtual

Definition at line 43 of file CHSplitConcentration.C.

{
  const RealVectorValue a = _dmobility_dc[_qp] * _grad_mu[_qp];
  return _grad_test[_i][_qp] * a * _phi[_j][_qp];
}

◆ computeQpOffDiagJacobian()

Real CHSplitConcentration::computeQpOffDiagJacobian ( unsigned int jvar )

protectedvirtual

Definition at line 50 of file CHSplitConcentration.C.

{
  if (jvar == _mu_var)
  {
    const RealVectorValue a = _mobility[_qp] * _grad_phi[_j][_qp];
    return _grad_test[_i][_qp] * a;
  }
  else
    return 0.0;
}

◆ computeQpResidual()

Real CHSplitConcentration::computeQpResidual ( )

protectedvirtual

Definition at line 36 of file CHSplitConcentration.C.

{
  const RealVectorValue a = _mobility[_qp] * _grad_mu[_qp];
  return _grad_test[_i][_qp] * a;
}

◆ validParams()

InputParameters CHSplitConcentration::validParams ( )

static

Definition at line 15 of file CHSplitConcentration.C.

{
  InputParameters params = Kernel::validParams();
  params.addClassDescription(
      "Concentration kernel in Split Cahn-Hilliard that solves chemical potential in a weak form");
  params.addRequiredParam<MaterialPropertyName>("mobility", "Mobility property name");
  params.addRequiredCoupledVar("chemical_potential_var", "Chemical potential variable");
  return params;
}

Member Data Documentation

◆ _dmobility_dc

const MaterialProperty<RealTensorValue>& CHSplitConcentration::_dmobility_dc

protected

Definition at line 35 of file CHSplitConcentration.h.

Referenced by computeQpJacobian().

◆ _grad_mu

const VariableGradient& CHSplitConcentration::_grad_mu

protected

Definition at line 39 of file CHSplitConcentration.h.

Referenced by computeQpJacobian(), and computeQpResidual().

◆ _mobility

const MaterialProperty<RealTensorValue>& CHSplitConcentration::_mobility

protected

Definition at line 34 of file CHSplitConcentration.h.

Referenced by computeQpOffDiagJacobian(), and computeQpResidual().

◆ _mobility_name

MaterialPropertyName CHSplitConcentration::_mobility_name

protected

Mobility property name.

Definition at line 32 of file CHSplitConcentration.h.

◆ _mu_var

const unsigned int CHSplitConcentration::_mu_var

protected

Chemical potential variable.

Definition at line 38 of file CHSplitConcentration.h.

Referenced by computeQpOffDiagJacobian().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CHSplitConcentration()

Member Function Documentation

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

◆ validParams()

Member Data Documentation

◆ _dmobility_dc

◆ _grad_mu

◆ _mobility

◆ _mobility_name

◆ _mu_var