Enforce sum of phase concentrations to be the real concentration. More...

#include <KKSMultiPhaseConcentration.h>

Inheritance diagram for KKSMultiPhaseConcentration:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

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

virtual Real	precomputeQpJacobian ()

virtual Real	computeQpOffDiagJacobian (unsigned int jvar)

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	_num_j

const std::vector< const VariableValue * >	_cj

const JvarMap &	_cj_map

int	_k
	Position of the nonlinear variable in the list of cj's.

const VariableValue &	_c

unsigned int	_c_var

std::vector< MaterialPropertyName >	_hj_names
	Switching functions for each phase \( h_j \).

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

std::vector< VariableName >	_eta_names
	Order parameters for each phase \( \eta_j \).

const JvarMap &	_eta_map

std::vector< std::vector< const MaterialProperty< Real > * > >	_prop_dhjdetai
	Derivative of the switching function \( \frac d{d\eta} h(\eta) \).

FEProblemBase &	_dmi_fe_problem

Detailed Description

Enforce sum of phase concentrations to be the real concentration.

\( c = h_1(\eta_1,\eta_2,\eta_3,...) c_1 + h_2(\eta_1,\eta_2,\eta_3,...) c_2 + h_3(\eta_1,\eta_2,\eta_3,..) c_3 + ... \)

The non-linear variable for this Kernel is one of the concentrations \( c_i \), while \( c_j \neq c_i \) and \( c \) are supplied as coupled variables. The other phase concentrations are set as non-linear variables using multiple KKSPhaseChemicalPotential kernels.

See also: KKSPhaseChemicalPotential

Definition at line 31 of file KKSMultiPhaseConcentration.h.

Constructor & Destructor Documentation

◆ KKSMultiPhaseConcentration()

KKSMultiPhaseConcentration::KKSMultiPhaseConcentration ( const InputParameters & parameters )

Definition at line 32 of file KKSMultiPhaseConcentration.C.

  : DerivativeMaterialInterface<JvarMapKernelInterface<KernelValue>>(parameters),
    _num_j(coupledComponents("cj")),
    _cj(coupledValues("cj")),
    _cj_map(getParameterJvarMap("cj")),
    _k(-1),
    _c(coupledValue("c")),
    _c_var(coupled("c")),
    _hj_names(getParam<std::vector<MaterialPropertyName>>("hj_names")),
    _prop_hj(_hj_names.size()),
    _eta_names(coupledComponents("etas")),
    _eta_map(getParameterJvarMap("etas")),
    _prop_dhjdetai(_num_j)
{
  // Check to make sure the the number of hj's is the same as the number of cj's
  if (_num_j != _hj_names.size())
    paramError("hj_names", "Need to pass in as many hj_names as cjs");
  // Check to make sure the the number of etas is the same as the number of cj's
  if (_num_j != _eta_names.size())
    paramError("etas", "Need to pass in as many etas as cjs");
 
  if (_num_j == 0)
    mooseError("Need to supply at least 1 phase concentration cj in KKSMultiPhaseConcentration",
               name());
 
  // get order parameter names and variable indices
  for (unsigned int i = 0; i < _num_j; ++i)
    _eta_names[i] = coupledName("etas", i);
 
  // Load concentration variables into the arrays
  for (unsigned int m = 0; m < _num_j; ++m)
  {
    _prop_hj[m] = &getMaterialPropertyByName<Real>(_hj_names[m]);
    _prop_dhjdetai[m].resize(_num_j);
    // Set _k to the position of the nonlinear variable in the list of cj's
    if (coupled("cj", m) == _var.number())
      _k = m;
 
    // Get derivatives of switching functions wrt order parameters
    for (unsigned int n = 0; n < _num_j; ++n)
      _prop_dhjdetai[m][n] = &getMaterialPropertyDerivative<Real>(_hj_names[m], _eta_names[n]);
  }
 
  // Check to make sure the nonlinear variable is set to one of the cj's
  if (_k < 0)
    mooseError("Need to set nonlinear variable to one of the cj's in KKSMultiPhaseConcentration",
               name());
}

Member Function Documentation

◆ computeQpOffDiagJacobian()

Real KKSMultiPhaseConcentration::computeQpOffDiagJacobian ( unsigned int jvar )

protectedvirtual

Definition at line 99 of file KKSMultiPhaseConcentration.C.

{
  if (jvar == _c_var)
    return -_test[_i][_qp] * _phi[_j][_qp];
 
  auto cjvar = mapJvarToCvar(jvar, _cj_map);
  if (cjvar >= 0)
    return _test[_i][_qp] * (*_prop_hj[cjvar])[_qp] * _phi[_j][_qp];
 
  auto etavar = mapJvarToCvar(jvar, _eta_map);
  if (etavar >= 0)
  {
    Real sum = 0.0;
 
    for (unsigned int n = 0; n < _num_j; ++n)
      sum += (*_prop_dhjdetai[n][etavar])[_qp] * (*_cj[n])[_qp];
 
    return _test[_i][_qp] * sum * _phi[_j][_qp];
  }
 
  return 0.0;
}

◆ precomputeQpJacobian()

Real KKSMultiPhaseConcentration::precomputeQpJacobian ( )

protectedvirtual

Definition at line 93 of file KKSMultiPhaseConcentration.C.

{
  return (*_prop_hj[_k])[_qp] * _phi[_j][_qp];
}

◆ precomputeQpResidual()

Real KKSMultiPhaseConcentration::precomputeQpResidual ( )

protectedvirtual

Definition at line 82 of file KKSMultiPhaseConcentration.C.

{
  // R = sum_i (h_i * c_i) - c
  Real sum_ch = 0.0;
  for (unsigned int m = 0; m < _num_j; ++m)
    sum_ch += (*_cj[m])[_qp] * (*_prop_hj[m])[_qp];
 
  return sum_ch - _c[_qp];
}

◆ validParams()

InputParameters KKSMultiPhaseConcentration::validParams ( )

static

Definition at line 15 of file KKSMultiPhaseConcentration.C.

{
  InputParameters params = KernelValue::validParams();
  params.addClassDescription(
      "KKS multi-phase model kernel to enforce $c = h_1c_1 + h_2c_2 + h_3c_3 + \\dots$"
      ". The non-linear variable of this kernel is $c_n$, the final phase "
      "concentration in the list.");
  params.addRequiredCoupledVar(
      "cj", "Array of phase concentrations cj. Place in same order as hj_names!");
  params.addRequiredCoupledVar("c", "Physical concentration");
  params.addCoupledVar("etas", "Order parameters for all phases");
  params.addRequiredParam<std::vector<MaterialPropertyName>>(
      "hj_names", "Switching Function Materials that provide $h(\\eta_1, \\eta_2,\\dots)$");
  return params;
}