This kernel implements a term in the variationally-derived equivalent form of Poisson's equation for the electrochemical grand potential sintering model with dilute solution energetics. More...

#include <MaskedExponential.h>

Inheritance diagram for MaskedExponential:

[legend]

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	MaskedExponential (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 Member Functions
virtual Real	computeQpResidual ()

virtual Real	computeQpJacobian ()

virtual Real	computeQpOffDiagJacobian (unsigned int jvar)

Protected Attributes
unsigned int	_w_var
	Chemical potential.

const VariableValue &	_w

std::string	_temp_name
	Temperature.

unsigned int	_temp_var

const VariableValue &	_temp

const MaterialProperty< Real > &	_mask
	Mask.

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

const MaterialProperty< Real > &	_n_eq
	Equilibrium defect concentration.

const MaterialProperty< Real > &	_prop_dn_eqdT

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

const int	_z
	Species charge.

const Real	_kB
	Boltzmann constant.

const Real	_e
	Electron charge.

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

This kernel implements a term in the variationally-derived equivalent form of Poisson's equation for the electrochemical grand potential sintering model with dilute solution energetics.

It acts on the electric potential.

Definition at line 21 of file MaskedExponential.h.

Constructor & Destructor Documentation

◆ MaskedExponential()

MaskedExponential::MaskedExponential ( const InputParameters & parameters )

Definition at line 31 of file MaskedExponential.C.

  : DerivativeMaterialInterface<JvarMapKernelInterface<Kernel>>(parameters),
    _w_var(coupled("w")),
    _w(coupledValue("w")),
    _temp_name(coupledName("T", 0)),
    _temp_var(coupled("T")),
    _temp(coupledValue("T")),
    _mask(getMaterialProperty<Real>("mask")),
    _prop_dmaskdarg(_n_args),
    _n_eq(getMaterialProperty<Real>("n_eq")),
    _prop_dn_eqdT(getMaterialPropertyDerivative<Real>("n_eq", _temp_name)),
    _prop_dn_eqdarg(_n_args),
    _z(getParam<int>("species_charge")),
    _kB(8.617343e-5), // eV/K
    _e(1.0)           // To put energy units in eV
{
  // Get derivatives of mask and equilibrium defect concentration
  for (unsigned int i = 0; i < _n_args; ++i)
  {
    _prop_dmaskdarg[i] = &getMaterialPropertyDerivative<Real>("mask", i);
    _prop_dn_eqdarg[i] = &getMaterialPropertyDerivative<Real>("n_eq", i);
  }
}

Member Function Documentation

◆ computeQpJacobian()

Real MaskedExponential::computeQpJacobian ( )

protectedvirtual

Definition at line 70 of file MaskedExponential.C.

{
  return -_mask[_qp] * _z * _z * _e * _e / _kB / _temp[_qp] * _n_eq[_qp] * _test[_i][_qp] *
         _phi[_j][_qp] * std::exp((_w[_qp] - _z * _e * _u[_qp]) / _kB / _temp[_qp]);
}

◆ computeQpOffDiagJacobian()

Real MaskedExponential::computeQpOffDiagJacobian ( unsigned int jvar )

protectedvirtual

Definition at line 77 of file MaskedExponential.C.

{
  // Handle chemical potential explicitly since it appears in the residual
  if (jvar == _w_var)
    return _mask[_qp] * _z * _e * _n_eq[_qp] / _kB / _temp[_qp] *
           std::exp((_w[_qp] - _z * _e * _u[_qp]) / _kB / _temp[_qp]) * _phi[_j][_qp] *
           _test[_i][_qp];
 
  // Handle temperature explicitly since it appears in the residual
  if (jvar == _temp_var)
    return _mask[_qp] * _z * _e * std::exp((_w[_qp] - _z * _e * _u[_qp]) / _kB / _temp[_qp]) *
           (_prop_dn_eqdT[_qp] -
            _n_eq[_qp] * (_w[_qp] - _z * _e * _u[_qp]) / _kB / _temp[_qp] / _temp[_qp]) *
           _phi[_j][_qp] * _test[_i][_qp];
 
  // General expression for remaining variable dependencies that don't appear in the residual
  //  for all other vars get the coupled variable jvar is referring to
  const unsigned int cvar = mapJvarToCvar(jvar);
 
  return _z * _e * std::exp((_w[_qp] - _z * _e * _u[_qp]) / _kB / _temp[_qp]) *
         ((*_prop_dmaskdarg[cvar])[_qp] + (*_prop_dn_eqdarg[cvar])[_qp]) * _test[_i][_qp] *
         _phi[_j][_qp];
}

◆ computeQpResidual()

Real MaskedExponential::computeQpResidual ( )

protectedvirtual

Definition at line 63 of file MaskedExponential.C.

{
  return _mask[_qp] * _z * _e * _n_eq[_qp] * _test[_i][_qp] *
         std::exp((_w[_qp] - _z * _e * _u[_qp]) / _kB / _temp[_qp]);
}

◆ initialSetup()

void MaskedExponential::initialSetup ( )

virtual

Definition at line 56 of file MaskedExponential.C.

{
  validateNonlinearCoupling<Real>("mask");
  validateNonlinearCoupling<Real>("n_eq");
}

◆ validParams()

InputParameters MaskedExponential::validParams ( )

static

Definition at line 15 of file MaskedExponential.C.

{
  InputParameters params = Kernel::validParams();
  params.addRequiredCoupledVar("w", "Chemical potential for the defect species");
  params.addRequiredCoupledVar("T", "Temperature");
  params.addClassDescription(
      "Kernel to add dilute solution term to Poisson's equation for electrochemical sintering");
  params.addParam<MaterialPropertyName>(
      "mask", "hm", "Mask function that specifies where this kernel is active");
  params.addRequiredParam<MaterialPropertyName>("n_eq", "Equilibrium defect concentration");
  params.addRequiredParam<int>("species_charge", "Charge of species this kernel is being used for");
  params.addCoupledVar("coupled_variables",
                       "Vector of nonlinear variable arguments this object depends on");
  return params;
}

Member Data Documentation

◆ _e

const Real MaskedExponential::_e

protected

Electron charge.

Definition at line 59 of file MaskedExponential.h.

Referenced by computeQpJacobian(), computeQpOffDiagJacobian(), and computeQpResidual().

◆ _kB

const Real MaskedExponential::_kB

protected

Boltzmann constant.

Definition at line 56 of file MaskedExponential.h.

Referenced by computeQpJacobian(), computeQpOffDiagJacobian(), and computeQpResidual().

◆ _mask

const MaterialProperty<Real>& MaskedExponential::_mask

protected

Mask.

Definition at line 44 of file MaskedExponential.h.

Referenced by computeQpJacobian(), computeQpOffDiagJacobian(), and computeQpResidual().

◆ _n_eq

const MaterialProperty<Real>& MaskedExponential::_n_eq

protected

Equilibrium defect concentration.

Definition at line 48 of file MaskedExponential.h.

Referenced by computeQpJacobian(), computeQpOffDiagJacobian(), and computeQpResidual().

◆ _prop_dmaskdarg

std::vector<const MaterialProperty<Real> *> MaskedExponential::_prop_dmaskdarg

protected

Definition at line 45 of file MaskedExponential.h.

Referenced by computeQpOffDiagJacobian(), and MaskedExponential().

◆ _prop_dn_eqdarg

std::vector<const MaterialProperty<Real> *> MaskedExponential::_prop_dn_eqdarg

protected

Definition at line 50 of file MaskedExponential.h.

Referenced by computeQpOffDiagJacobian(), and MaskedExponential().

◆ _prop_dn_eqdT

const MaterialProperty<Real>& MaskedExponential::_prop_dn_eqdT

protected

Definition at line 49 of file MaskedExponential.h.

Referenced by computeQpOffDiagJacobian().

◆ _temp

const VariableValue& MaskedExponential::_temp

protected

Definition at line 41 of file MaskedExponential.h.

Referenced by computeQpJacobian(), computeQpOffDiagJacobian(), and computeQpResidual().

◆ _temp_name

std::string MaskedExponential::_temp_name

protected

Temperature.

Definition at line 39 of file MaskedExponential.h.

◆ _temp_var

unsigned int MaskedExponential::_temp_var

protected

Definition at line 40 of file MaskedExponential.h.

Referenced by computeQpOffDiagJacobian().

◆ _w

const VariableValue& MaskedExponential::_w

protected

Definition at line 36 of file MaskedExponential.h.

Referenced by computeQpJacobian(), computeQpOffDiagJacobian(), and computeQpResidual().

◆ _w_var

unsigned int MaskedExponential::_w_var

protected

Chemical potential.

Definition at line 35 of file MaskedExponential.h.

Referenced by computeQpOffDiagJacobian().

◆ _z

const int MaskedExponential::_z

protected

Species charge.

Definition at line 53 of file MaskedExponential.h.

Referenced by computeQpJacobian(), computeQpOffDiagJacobian(), and computeQpResidual().

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

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

◆ MaskedExponential()

Member Function Documentation

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

◆ initialSetup()

◆ validParams()

Member Data Documentation

◆ _e

◆ _kB

◆ _mask

◆ _n_eq

◆ _prop_dmaskdarg

◆ _prop_dn_eqdarg

◆ _prop_dn_eqdT

◆ _temp

◆ _temp_name

◆ _temp_var

◆ _w

◆ _w_var

◆ _z