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

#include <KKSMultiPhaseConcentration.h>

Inheritance diagram for KKSMultiPhaseConcentration:

Public Member Functions
	KKSMultiPhaseConcentration (const InputParameters &parameters)

Protected Member Functions
virtual Real	precomputeQpResidual ()

virtual Real	precomputeQpJacobian ()

virtual Real	computeQpOffDiagJacobian (unsigned int jvar)

Private Attributes
const unsigned int	_num_j

std::vector< const VariableValue * >	_cj

const JvarMap &	_cj_map

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

const VariableValue &	_c

unsigned int	_c_var

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

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

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

const JvarMap &	_eta_map

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

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 35 of file KKSMultiPhaseConcentration.h.

Constructor & Destructor Documentation

◆ KKSMultiPhaseConcentration()

KKSMultiPhaseConcentration::KKSMultiPhaseConcentration ( const InputParameters & parameters )

Definition at line 33 of file KKSMultiPhaseConcentration.C.

   : DerivativeMaterialInterface<JvarMapKernelInterface<KernelValue>>(parameters),
     _num_j(coupledComponents("cj")),
     _cj(_num_j),
     _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] = getVar("etas", i)->name();
  
   // Load concentration variables into the arrays
   for (unsigned int m = 0; m < _num_j; ++m)
   {
     _cj[m] = &coupledValue("cj", 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 101 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 95 of file KKSMultiPhaseConcentration.C.

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

◆ precomputeQpResidual()

Real KKSMultiPhaseConcentration::precomputeQpResidual ( )

protectedvirtual

Definition at line 84 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];
 }