SplitCHWRes creates the residual for the chemical potential in the split form of the Cahn-Hilliard equation with a scalar (isotropic) mobility. More...

#include <SplitCHWRes.h>

Inheritance diagram for SplitCHWRes:

[legend]

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

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

virtual Real	computeQpOffDiagJacobian (unsigned int jvar)

Protected Attributes
const MaterialPropertyName	_mob_name

const MaterialProperty< Real > &	_mob

const bool	_is_coupled
	is the kernel used in a coupled form?

unsigned int	_w_var
	int label for the chemical potential

const VariableGradient &	_grad_w
	Variable value for the chemical potential.

std::vector< const MaterialProperty< Real > * >	_dmobdarg
	derivatives of the mobility

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

SplitCHWRes creates the residual for the chemical potential in the split form of the Cahn-Hilliard equation with a scalar (isotropic) mobility.

Definition at line 19 of file SplitCHWRes.h.

Constructor & Destructor Documentation

◆ SplitCHWRes()

SplitCHWRes::SplitCHWRes ( const InputParameters & parameters )

Definition at line 23 of file SplitCHWRes.C.

23: SplitCHWResBase<Real>(parameters) {}

SplitCHWResBase

SplitCHWresBase implements the residual for the chemical potential in the split form of the Cahn-Hill...

Definition SplitCHWResBase.h:24

Member Function Documentation

◆ computeQpJacobian()

Real SplitCHWResBase< Real >::computeQpJacobian ( )

protectedvirtualinherited

Definition at line 32 of file SplitCHWResBase.h.

{
  return (_is_coupled && _w_var != _var.number()) ? 0.0 : computeQpWJacobian();
}

◆ computeQpOffDiagJacobian()

Real SplitCHWResBase< Real >::computeQpOffDiagJacobian ( unsigned int jvar )

protectedvirtualinherited

Definition at line 34 of file SplitCHWResBase.h.

{
  // c Off-Diagonal Jacobian
  if (_w_var == jvar)
    return computeQpWJacobian();
 
  // get the coupled variable jvar is referring to
  const unsigned int cvar = mapJvarToCvar(jvar);
 
  return (*_dmobdarg[cvar])[_qp] * _phi[_j][_qp] * _grad_w[_qp] * _grad_test[_i][_qp];
}

◆ computeQpResidual()

Real SplitCHWResBase< Real >::computeQpResidual ( )

protectedvirtualinherited

Definition at line 31 of file SplitCHWResBase.h.

{
  return _mob[_qp] * _grad_w[_qp] * _grad_test[_i][_qp];
}

◆ computeQpWJacobian()

Real SplitCHWResBase< Real >::computeQpWJacobian ( )

protectedvirtualinherited

Definition at line 33 of file SplitCHWResBase.h.

{
  return _mob[_qp] * _grad_phi[_j][_qp] * _grad_test[_i][_qp];
}

◆ validParams()

InputParameters SplitCHWRes::validParams ( )

static

Definition at line 15 of file SplitCHWRes.C.

{
  InputParameters params = SplitCHWResBase<Real>::validParams();
  params.addClassDescription("Split formulation Cahn-Hilliard Kernel for the chemical potential "
                             "variable with a scalar (isotropic) mobility");
  return params;
}

Member Data Documentation

◆ _dmobdarg

std::vector<const MaterialProperty<Real > *> SplitCHWResBase< Real >::_dmobdarg

protectedinherited

derivatives of the mobility

Definition at line 49 of file SplitCHWResBase.h.

◆ _grad_w

const VariableGradient& SplitCHWResBase< Real >::_grad_w

protectedinherited

Variable value for the chemical potential.

Definition at line 46 of file SplitCHWResBase.h.

◆ _is_coupled

const bool SplitCHWResBase< Real >::_is_coupled

protectedinherited

is the kernel used in a coupled form?

Definition at line 40 of file SplitCHWResBase.h.

◆ _mob

const MaterialProperty<Real >& SplitCHWResBase< Real >::_mob

protectedinherited

Definition at line 37 of file SplitCHWResBase.h.

◆ _mob_name

const MaterialPropertyName SplitCHWResBase< Real >::_mob_name

protectedinherited

Definition at line 36 of file SplitCHWResBase.h.

◆ _w_var

unsigned int SplitCHWResBase< Real >::_w_var

protectedinherited

int label for the chemical potential

Definition at line 43 of file SplitCHWResBase.h.

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

phase_field/include/kernels/SplitCHWRes.h
phase_field/src/kernels/SplitCHWRes.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

◆ SplitCHWRes()

Member Function Documentation

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

◆ computeQpWJacobian()

◆ validParams()

Member Data Documentation

◆ _dmobdarg

◆ _grad_w

◆ _is_coupled

◆ _mob

◆ _mob_name

◆ _w_var