This kernel adds a contribution \( \left( \frac{\partial F_a}{\partial \eta_{ai}} f_a + \frac{\partial F_b}{\partial \eta_{ai}} f_b + ... \right) \frac{\partial \eta_{ai}}{\partial t} \) where \( a,b,.. \) are the phases, \( h_a, h_b,.. \) are the switching functions, \( \eta_{ai} \) is the order parameter that is the nonlinear variable, \( t \) is time, and \( F_a, F_b,.. \) are functions for each phase. More...

#include <CoupledSwitchingTimeDerivative.h>

Inheritance diagram for CoupledSwitchingTimeDerivative:

[legend]

Public Member Functions
	CoupledSwitchingTimeDerivative (const InputParameters &parameters)

virtual void	initialSetup ()

Protected Member Functions
virtual Real	computeQpResidual ()

virtual Real	computeQpJacobian ()

virtual Real	computeQpOffDiagJacobian (unsigned int jvar)

Protected Attributes
const unsigned int	_nvar
	Number of coupled variables. More...

const VariableName	_v_name
	name of order parameter that derivatives are taken wrt (needed to retrieve the derivative material properties) More...

std::vector< MaterialPropertyName >	_Fj_names
	Names of functions for each phase \( F_j \). More...

const unsigned int	_num_j
	Number of phases. More...

std::vector< const MaterialProperty< Real > * >	_prop_Fj
	Values of the functions for each phase \( F_j \). More...

std::vector< const MaterialProperty< Real > * >	_prop_dFjdv
	Derivatives of the functions wrt the nonlinear variable for this kernel. More...

std::vector< std::vector< const MaterialProperty< Real > * > >	_prop_dFjdarg
	Derivatives of the functions (needed for off-diagonal Jacobians) More...

std::vector< MaterialPropertyName >	_hj_names
	switching function names More...

std::vector< const MaterialProperty< Real > * >	_prop_dhjdetai
	Derivatives of the switching functions wrt the order parameter for this kernel. More...

std::vector< const MaterialProperty< Real > * >	_prop_d2hjdetai2
	Second derivatives of the switching functions wrt the order parameter for this kernel. More...

std::vector< std::vector< const MaterialProperty< Real > * > >	_prop_d2hjdetaidarg
	Second derivatives of the switching functions (needed for off-diagonal Jacobians) More...

Detailed Description

This kernel adds a contribution \( \left( \frac{\partial F_a}{\partial \eta_{ai}} f_a + \frac{\partial F_b}{\partial \eta_{ai}} f_b + ... \right) \frac{\partial \eta_{ai}}{\partial t} \) where \( a,b,.. \) are the phases, \( h_a, h_b,.. \) are the switching functions, \( \eta_{ai} \) is the order parameter that is the nonlinear variable, \( t \) is time, and \( F_a, F_b,.. \) are functions for each phase.

For the grand-potential model susceptibility equation, \( F_a \) etc. are the phase densities.

Definition at line 32 of file CoupledSwitchingTimeDerivative.h.

Constructor & Destructor Documentation

◆ CoupledSwitchingTimeDerivative()

CoupledSwitchingTimeDerivative::CoupledSwitchingTimeDerivative ( const InputParameters & parameters )

Definition at line 30 of file CoupledSwitchingTimeDerivative.C.

   : DerivativeMaterialInterface<JvarMapKernelInterface<CoupledTimeDerivative>>(parameters),
     _nvar(_coupled_moose_vars.size()), // number of coupled variables
     _v_name(getVar("v", 0)->name()),
     _Fj_names(getParam<std::vector<MaterialPropertyName>>("Fj_names")),
     _num_j(_Fj_names.size()),
     _prop_Fj(_num_j),
     _prop_dFjdv(_num_j),
     _prop_dFjdarg(_num_j),
     _hj_names(getParam<std::vector<MaterialPropertyName>>("hj_names")),
     _prop_dhjdetai(_num_j),
     _prop_d2hjdetai2(_num_j),
     _prop_d2hjdetaidarg(_num_j)
 {
   // check passed in parameter vectors
   if (_num_j != _hj_names.size())
     paramError("hj_names", "Need to pass in as many hj_names as Fj_names");
  
   // reserve space and set phase material properties
   for (unsigned int n = 0; n < _num_j; ++n)
   {
     // get phase free energy and derivatives
     _prop_Fj[n] = &getMaterialPropertyByName<Real>(_Fj_names[n]);
     _prop_dFjdv[n] = &getMaterialPropertyDerivative<Real>(_Fj_names[n], _var.name());
     _prop_dFjdarg[n].resize(_nvar);
  
     // get switching function and derivatives wrt eta_i, the nonlinear variable
     _prop_dhjdetai[n] = &getMaterialPropertyDerivative<Real>(_hj_names[n], _v_name);
     _prop_d2hjdetai2[n] = &getMaterialPropertyDerivative<Real>(_hj_names[n], _v_name, _v_name);
     _prop_d2hjdetaidarg[n].resize(_nvar);
  
     for (unsigned int i = 0; i < _nvar; ++i)
     {
       MooseVariableFEBase * cvar = _coupled_moose_vars[i];
       // Get derivatives of all Fj wrt all coupled variables
       _prop_dFjdarg[n][i] = &getMaterialPropertyDerivative<Real>(_Fj_names[n], cvar->name());
  
       // Get second derivatives of all hj wrt eta_i and all coupled variables
       _prop_d2hjdetaidarg[n][i] =
           &getMaterialPropertyDerivative<Real>(_hj_names[n], _v_name, cvar->name());
     }
   }
 }

Member Function Documentation

◆ computeQpJacobian()

Real CoupledSwitchingTimeDerivative::computeQpJacobian ( )

protectedvirtual

Definition at line 95 of file CoupledSwitchingTimeDerivative.C.

 {
   Real sum = 0.0;
   for (unsigned int n = 0; n < _num_j; ++n)
     sum += (*_prop_dhjdetai[n])[_qp] * (*_prop_dFjdv[n])[_qp];
  
   return CoupledTimeDerivative::computeQpResidual() * sum * _phi[_j][_qp];
 }

◆ computeQpOffDiagJacobian()

Real CoupledSwitchingTimeDerivative::computeQpOffDiagJacobian ( unsigned int jvar )

protectedvirtual

Definition at line 105 of file CoupledSwitchingTimeDerivative.C.

 {
   // get the coupled variable jvar is referring to
   const unsigned int cvar = mapJvarToCvar(jvar);
  
   if (jvar == _v_var)
   {
     Real sum = 0.0;
  
     for (unsigned int n = 0; n < _num_j; ++n)
       sum +=
           ((*_prop_d2hjdetai2[n])[_qp] * _v_dot[_qp] + (*_prop_dhjdetai[n])[_qp] * _dv_dot[_qp]) *
           (*_prop_Fj[n])[_qp];
  
     return _phi[_j][_qp] * sum * _test[_i][_qp];
   }
  
   Real sum = 0.0;
   for (unsigned int n = 0; n < _num_j; ++n)
     sum += (*_prop_d2hjdetaidarg[n][cvar])[_qp] * (*_prop_Fj[n])[_qp] +
            (*_prop_dhjdetai[n])[_qp] * (*_prop_dFjdarg[n][cvar])[_qp];
  
   return CoupledTimeDerivative::computeQpResidual() * sum * _phi[_j][_qp];
 }

◆ computeQpResidual()

Real CoupledSwitchingTimeDerivative::computeQpResidual ( )

protectedvirtual

Definition at line 85 of file CoupledSwitchingTimeDerivative.C.

 {
   Real sum = 0.0;
   for (unsigned int n = 0; n < _num_j; ++n)
     sum += (*_prop_dhjdetai[n])[_qp] * (*_prop_Fj[n])[_qp];
  
   return CoupledTimeDerivative::computeQpResidual() * sum;
 }

◆ initialSetup()

void CoupledSwitchingTimeDerivative::initialSetup ( )

virtual

Definition at line 75 of file CoupledSwitchingTimeDerivative.C.

 {
   for (unsigned int n = 0; n < _num_j; ++n)
   {
     validateNonlinearCoupling<Real>(_Fj_names[n]);
     validateNonlinearCoupling<Real>(_hj_names[n]);
   }
 }