SLKKSMultiPhaseBase Class Reference

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

#include <SLKKSMultiPhaseBase.h>

Inheritance diagram for SLKKSMultiPhaseBase:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	SLKKSMultiPhaseBase (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 Attributes
std::vector< unsigned int >	_ns
	Number of sublattices per phase. More...
std::vector< Real >	_a_cs
	Sublattice site numbers. More...
std::vector< unsigned int >	_phase
	phase index of each cs entry More...
const VariableValue &	_c
	Physical concentration. More...
const unsigned int	_c_var
const std::size_t	_ncs
	Sublattice concentrations. More...
std::vector< const VariableValue * >	_cs
const JvarMap &	_cs_map
const std::size_t	_neta
	Order parameters for each phase \( \eta_j \). More...
std::vector< VariableName >	_eta_names
const JvarMap &	_eta_map
std::vector< MaterialPropertyName >	_h_names
	Switching function names. More...
const std::size_t	_nh

Detailed Description

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

D. Schwen et al. https://doi.org/10.1016/j.commatsci.2021.110466

See also

SLKKSPhaseChemicalPotential

Definition at line 22 of file SLKKSMultiPhaseBase.h.

Constructor & Destructor Documentation

SLKKSMultiPhaseBase()

SLKKSMultiPhaseBase::SLKKSMultiPhaseBase

(

const InputParameters &

parameters

)

Definition at line 26 of file SLKKSMultiPhaseBase.C.

  : DerivativeMaterialInterface<JvarMapKernelInterface<KernelValue>>(parameters),
    _ncs(coupledComponents("cs")),
    _cs(_ncs),
    _cs_map(getParameterJvarMap("cs")),
    _ns(getParam<std::vector<unsigned int>>("ns")),
    _neta(coupledComponents("eta")),
    _eta_names(_neta),
    _eta_map(getParameterJvarMap("eta")),
    _a_cs(getParam<std::vector<Real>>("as")),
    _h_names(getParam<std::vector<MaterialPropertyName>>("h_names")),
    _nh(_h_names.size()),
    _phase(_ncs),
    _c(coupledValue("c")),
    _c_var(coupled("c"))
{
  // consistent number of phases?
  if (_ns.size() != _nh)
    paramError("ns",
               "Need to pass in as many switching functions (parameter `h_names`) as size of "
               "number of sublattices in each phase (parameter `ns`)");

  // sum up ns numbers
  unsigned int nssum = 0;
  for (auto i : _ns)
  {
    if (i == 0)
      paramError("ns", "All sublattice counts must be larger than zero");
    nssum += i;
  }

  if (nssum != _ncs)
    paramError("ns", "Numbers need to sum up to the number of passed in cs variables");
  if (_ncs == 0)
    paramError("cs", "Need to supply at least 1 phase sublattice concentration");

  // get order parameter names
  for (std::size_t i = 0; i < _neta; ++i)
    _eta_names[i] = coupledName("eta", i);

  // Load concentration variables into the arrays
  for (std::size_t i = 0; i < _ncs; ++i)
    _cs[i] = &coupledValue("cs", i);

  // normalize sublattice counts within each phase
  std::size_t k = 0;
  for (std::size_t i = 0; i < _nh; ++i)
  {
    // sum site counts
    Real sum = _a_cs[k];
    for (unsigned int j = 1; j < _ns[i]; ++j)
      sum += _a_cs[j + k];
    if (sum <= 0)
      paramError("as", "Sum of sublattice site counts in each phase must be larger than zero");

    // normalize
    for (unsigned int j = 0; j < _ns[i]; ++j)
    {
      _a_cs[j + k] /= sum;

      // remember phase index
      _phase[j + k] = i;
    }

    // next phase
    k += _ns[i];
  }

  // consistency checks
  if (k != _ncs)
    mooseError("Internal error");
}

Member Function Documentation

validParams()

InputParameters SLKKSMultiPhaseBase::validParams ( )

static

Definition at line 13 of file SLKKSMultiPhaseBase.C.

Referenced by SLKKSMultiPhaseConcentration::validParams(), and SLKKSMultiACBulkC::validParams().

{
  auto params = Kernel::validParams();
  params.addRequiredCoupledVar("cs", "Array of sublattice concentrations phase for all phases");
  params.addCoupledVar("eta", "Order parameters for all phases");
  params.addRequiredParam<std::vector<unsigned int>>("ns", "Number of sublattices in each phase");
  params.addRequiredParam<std::vector<Real>>("as", "Sublattice site fractions n all phases");
  params.addRequiredParam<std::vector<MaterialPropertyName>>(
      "h_names", "Switching Function Materials for all phases");
  return params;
}

Member Data Documentation

_a_cs

std::vector<Real> SLKKSMultiPhaseBase::_a_cs

protected

Sublattice site numbers.

Definition at line 46 of file SLKKSMultiPhaseBase.h.

Referenced by SLKKSMultiPhaseConcentration::computeQpOffDiagJacobian(), SLKKSMultiACBulkC::computeQpOffDiagJacobian(), SLKKSMultiPhaseConcentration::precomputeQpJacobian(), SLKKSMultiACBulkC::precomputeQpJacobian(), SLKKSMultiPhaseConcentration::precomputeQpResidual(), SLKKSMultiACBulkC::precomputeQpResidual(), and SLKKSMultiPhaseBase().

_c

const VariableValue& SLKKSMultiPhaseBase::_c

protected

Physical concentration.

Definition at line 57 of file SLKKSMultiPhaseBase.h.

Referenced by SLKKSMultiPhaseConcentration::precomputeQpResidual().

_c_var

const unsigned int SLKKSMultiPhaseBase::_c_var

protected

Definition at line 58 of file SLKKSMultiPhaseBase.h.

Referenced by SLKKSMultiPhaseConcentration::computeQpOffDiagJacobian(), and SLKKSMultiACBulkC::SLKKSMultiACBulkC().

_cs

std::vector<const VariableValue *> SLKKSMultiPhaseBase::_cs

protected

Definition at line 32 of file SLKKSMultiPhaseBase.h.

Referenced by SLKKSMultiPhaseConcentration::computeQpOffDiagJacobian(), SLKKSMultiACBulkC::computeQpOffDiagJacobian(), SLKKSMultiACBulkC::precomputeQpJacobian(), SLKKSMultiPhaseConcentration::precomputeQpResidual(), SLKKSMultiACBulkC::precomputeQpResidual(), and SLKKSMultiPhaseBase().

_cs_map

const JvarMap& SLKKSMultiPhaseBase::_cs_map

protected

Definition at line 33 of file SLKKSMultiPhaseBase.h.

Referenced by SLKKSMultiPhaseConcentration::computeQpOffDiagJacobian(), and SLKKSMultiACBulkC::computeQpOffDiagJacobian().

_eta_map

const JvarMap& SLKKSMultiPhaseBase::_eta_map

protected

Definition at line 42 of file SLKKSMultiPhaseBase.h.

Referenced by SLKKSMultiPhaseConcentration::computeQpOffDiagJacobian(), and SLKKSMultiACBulkC::computeQpOffDiagJacobian().

_eta_names

std::vector<VariableName> SLKKSMultiPhaseBase::_eta_names

protected

Definition at line 41 of file SLKKSMultiPhaseBase.h.

Referenced by SLKKSMultiACBulkC::SLKKSMultiACBulkC(), SLKKSMultiPhaseBase(), and SLKKSMultiPhaseConcentration::SLKKSMultiPhaseConcentration().

_h_names

std::vector<MaterialPropertyName> SLKKSMultiPhaseBase::_h_names

protected

Switching function names.

Definition at line 49 of file SLKKSMultiPhaseBase.h.

Referenced by SLKKSMultiACBulkC::SLKKSMultiACBulkC(), and SLKKSMultiPhaseConcentration::SLKKSMultiPhaseConcentration().

_ncs

const std::size_t SLKKSMultiPhaseBase::_ncs

protected

Sublattice concentrations.

Definition at line 31 of file SLKKSMultiPhaseBase.h.

Referenced by SLKKSMultiPhaseConcentration::computeQpOffDiagJacobian(), SLKKSMultiACBulkC::SLKKSMultiACBulkC(), SLKKSMultiPhaseBase(), and SLKKSMultiPhaseConcentration::SLKKSMultiPhaseConcentration().

_neta

const std::size_t SLKKSMultiPhaseBase::_neta

protected

Order parameters for each phase \( \eta_j \).

Definition at line 40 of file SLKKSMultiPhaseBase.h.

Referenced by SLKKSMultiACBulkC::SLKKSMultiACBulkC(), SLKKSMultiPhaseBase(), and SLKKSMultiPhaseConcentration::SLKKSMultiPhaseConcentration().

_nh

const std::size_t SLKKSMultiPhaseBase::_nh

protected

Definition at line 50 of file SLKKSMultiPhaseBase.h.

Referenced by SLKKSMultiACBulkC::computeQpOffDiagJacobian(), SLKKSMultiACBulkC::precomputeQpJacobian(), SLKKSMultiPhaseConcentration::precomputeQpResidual(), SLKKSMultiACBulkC::precomputeQpResidual(), SLKKSMultiACBulkC::SLKKSMultiACBulkC(), SLKKSMultiPhaseBase(), and SLKKSMultiPhaseConcentration::SLKKSMultiPhaseConcentration().

_ns

std::vector<unsigned int> SLKKSMultiPhaseBase::_ns

protected

Number of sublattices per phase.

Definition at line 37 of file SLKKSMultiPhaseBase.h.

Referenced by SLKKSMultiACBulkC::computeQpOffDiagJacobian(), SLKKSMultiACBulkC::precomputeQpJacobian(), SLKKSMultiPhaseConcentration::precomputeQpResidual(), SLKKSMultiACBulkC::precomputeQpResidual(), and SLKKSMultiPhaseBase().

_phase

std::vector<unsigned int> SLKKSMultiPhaseBase::_phase

protected

phase index of each cs entry

Definition at line 54 of file SLKKSMultiPhaseBase.h.

Referenced by SLKKSMultiPhaseConcentration::computeQpOffDiagJacobian(), SLKKSMultiACBulkC::computeQpOffDiagJacobian(), SLKKSMultiPhaseConcentration::precomputeQpJacobian(), SLKKSMultiACBulkC::SLKKSMultiACBulkC(), and SLKKSMultiPhaseBase().

---

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

• phase_field/include/kernels/SLKKSMultiPhaseBase.h
• phase_field/src/kernels/SLKKSMultiPhaseBase.C