ACBulk child class that sets up necessary variables and materials for calculation of residual contribution \( \frac{\partial f}{\partial \eta_i} \) by child classes KKSMultiACBulkF and KKSMultiACBulkC. More...

#include <KKSMultiACBulkBase.h>

Inheritance diagram for KKSMultiACBulkBase:

[legend]

Public Member Functions
	KKSMultiACBulkBase (const InputParameters &parameters)

virtual void	initialSetup ()

Static Public Member Functions
static InputParameters	validParams ()

Protected Types
enum	PFFunctionType

Protected Member Functions
virtual Real	precomputeQpResidual ()

virtual Real	precomputeQpJacobian ()

virtual Real	computeQpOffDiagJacobian (unsigned int jvar)

virtual Real	computeDFDOP (PFFunctionType type)=0

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

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

unsigned int	_etai_var
	index of order parameter that derivatives are taken wrt More...

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

unsigned int	_num_j

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

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

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

std::vector< const MaterialProperty< Real > * >	_prop_hj
	Values of the switching functions for each phase \( h_j \). 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...

const MaterialProperty< Real > &	_L
	Mobility. More...

const MaterialProperty< Real > &	_dLdop
	Mobility derivative w.r.t. order parameter. More...

std::vector< const MaterialProperty< Real > * >	_dLdarg
	Mobility derivative w.r.t coupled variables. More...

Detailed Description

ACBulk child class that sets up necessary variables and materials for calculation of residual contribution \( \frac{\partial f}{\partial \eta_i} \) by child classes KKSMultiACBulkF and KKSMultiACBulkC.

The non-linear variable for this Kernel is the order parameter \( \eta_i \).

Definition at line 27 of file KKSMultiACBulkBase.h.

Member Enumeration Documentation

◆ PFFunctionType

enum ACBulk::PFFunctionType

protectedinherited

Definition at line 37 of file ACBulk.h.

   {
     Jacobian,
     Residual
   };

Constructor & Destructor Documentation

◆ KKSMultiACBulkBase()

KKSMultiACBulkBase::KKSMultiACBulkBase ( const InputParameters & parameters )

Definition at line 29 of file KKSMultiACBulkBase.C.

   : ACBulk<Real>(parameters),
     _nvar(_coupled_moose_vars.size()), // number of coupled variables
     _etai_name(getVar("eta_i", 0)->name()),
     _etai_var(coupled("eta_i", 0)),
     _Fj_names(getParam<std::vector<MaterialPropertyName>>("Fj_names")),
     _num_j(_Fj_names.size()),
     _prop_Fj(_num_j),
     _prop_dFjdarg(_num_j),
     _hj_names(getParam<std::vector<MaterialPropertyName>>("hj_names")),
     _prop_hj(_num_j),
     _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
     _prop_Fj[n] = &getMaterialPropertyByName<Real>(_Fj_names[n]);
     _prop_dFjdarg[n].resize(_nvar);
  
     // get switching function and derivatives wrt eta_i, the nonlinear variable
     _prop_hj[n] = &getMaterialPropertyByName<Real>(_hj_names[n]);
     _prop_dhjdetai[n] = &getMaterialPropertyDerivative<Real>(_hj_names[n], _etai_name);
     _prop_d2hjdetai2[n] =
         &getMaterialPropertyDerivative<Real>(_hj_names[n], _etai_name, _etai_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], _etai_name, cvar->name());
     }
   }
 }

Member Function Documentation

◆ computeDFDOP()

virtual Real ACBulk< Real >::computeDFDOP ( PFFunctionType type )

protectedpure virtualinherited

◆ computeQpOffDiagJacobian()

Real ACBulk< Real >::computeQpOffDiagJacobian ( unsigned int jvar )

protectedvirtualinherited

Reimplemented in CoupledAllenCahn, AllenCahn, KKSACBulkC, KKSACBulkF, KKSMultiACBulkC, KKSMultiACBulkF, ACGrGrMulti, ACGrGrPoly, ACBarrierFunction, and ACGBPoly.

Definition at line 116 of file ACBulk.h.

 {
   // Get the coupled variable jvar is referring to
   const unsigned int cvar = mapJvarToCvar(jvar);
  
   // Set off-diagonal Jacobian term from mobility derivatives
   return (*_dLdarg[cvar])[_qp] * _phi[_j][_qp] * computeDFDOP(Residual) * _test[_i][_qp];
 }

◆ initialSetup()

void KKSMultiACBulkBase::initialSetup ( )

virtual

Reimplemented from ACBulk< Real >.

Definition at line 76 of file KKSMultiACBulkBase.C.

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

◆ precomputeQpJacobian()

Real ACBulk< Real >::precomputeQpJacobian ( )

protectedvirtualinherited

Definition at line 103 of file ACBulk.h.

 {
   // Get free energy derivative and Jacobian
   Real dFdop = computeDFDOP(Residual);
  
   Real JdFdop = computeDFDOP(Jacobian);
  
   // Set Jacobian value using product rule
   return _L[_qp] * JdFdop + _dLdop[_qp] * _phi[_j][_qp] * dFdop;
 }

◆ precomputeQpResidual()

Real ACBulk< Real >::precomputeQpResidual ( )

protectedvirtualinherited

Definition at line 92 of file ACBulk.h.

 {
   // Get free energy derivative from function
   Real dFdop = computeDFDOP(Residual);
  
   // Set residual
   return _L[_qp] * dFdop;
 }

◆ validParams()

InputParameters ACBulk< Real >::validParams ( )

staticinherited

Definition at line 74 of file ACBulk.h.

 {
   InputParameters params = ::validParams<KernelValue>();
   params.addClassDescription("Allen-Cahn base Kernel");
   params.addParam<MaterialPropertyName>("mob_name", "L", "The mobility used with the kernel");
   params.addCoupledVar("args", "Vector of arguments of the mobility");
   return params;
 }

Member Data Documentation

◆ _dLdarg

std::vector<const MaterialProperty<Real > *> ACBulk< Real >::_dLdarg

protectedinherited

Mobility derivative w.r.t coupled variables.

Definition at line 52 of file ACBulk.h.

◆ _dLdop

const MaterialProperty<Real >& ACBulk< Real >::_dLdop

protectedinherited

Mobility derivative w.r.t. order parameter.

Definition at line 49 of file ACBulk.h.

◆ _etai_name

VariableName KKSMultiACBulkBase::_etai_name

protected

name of order parameter that derivatives are taken wrt (needed to retrieve the derivative material properties)

Definition at line 39 of file KKSMultiACBulkBase.h.

Referenced by KKSMultiACBulkBase().

◆ _etai_var

unsigned int KKSMultiACBulkBase::_etai_var

protected

index of order parameter that derivatives are taken wrt

Definition at line 42 of file KKSMultiACBulkBase.h.

Referenced by KKSMultiACBulkC::computeDFDOP(), KKSMultiACBulkF::computeDFDOP(), and KKSMultiACBulkF::computeQpOffDiagJacobian().

◆ _Fj_names

std::vector<MaterialPropertyName> KKSMultiACBulkBase::_Fj_names

protected

Names of free energy functions for each phase \( F_j \).

Definition at line 45 of file KKSMultiACBulkBase.h.

Referenced by initialSetup(), KKSMultiACBulkBase(), and KKSMultiACBulkC::KKSMultiACBulkC().

◆ _hj_names

std::vector<MaterialPropertyName> KKSMultiACBulkBase::_hj_names

protected

switching function names

Definition at line 55 of file KKSMultiACBulkBase.h.

Referenced by initialSetup(), and KKSMultiACBulkBase().

◆ _L

const MaterialProperty<Real >& ACBulk< Real >::_L

protectedinherited

Mobility.

Definition at line 46 of file ACBulk.h.

◆ _num_j

unsigned int KKSMultiACBulkBase::_num_j

protected

Definition at line 46 of file KKSMultiACBulkBase.h.

Referenced by KKSMultiACBulkC::computeDFDOP(), KKSMultiACBulkF::computeDFDOP(), KKSMultiACBulkC::computeQpOffDiagJacobian(), KKSMultiACBulkF::computeQpOffDiagJacobian(), initialSetup(), KKSMultiACBulkBase(), and KKSMultiACBulkC::KKSMultiACBulkC().

◆ _nvar

unsigned int KKSMultiACBulkBase::_nvar

protected

Number of coupled variables.

Definition at line 36 of file KKSMultiACBulkBase.h.

Referenced by KKSMultiACBulkBase(), and KKSMultiACBulkC::KKSMultiACBulkC().

◆ _prop_d2hjdetai2

std::vector<const MaterialProperty<Real> *> KKSMultiACBulkBase::_prop_d2hjdetai2

protected

Second derivatives of the switching functions wrt the order parameter for this kernel.

Definition at line 64 of file KKSMultiACBulkBase.h.

Referenced by KKSMultiACBulkC::computeDFDOP(), KKSMultiACBulkF::computeDFDOP(), and KKSMultiACBulkBase().

◆ _prop_d2hjdetaidarg

std::vector<std::vector<const MaterialProperty<Real> *> > KKSMultiACBulkBase::_prop_d2hjdetaidarg

protected

Second derivatives of the switching functions (needed for off-diagonal Jacobians)

Definition at line 67 of file KKSMultiACBulkBase.h.

Referenced by KKSMultiACBulkC::computeQpOffDiagJacobian(), KKSMultiACBulkF::computeQpOffDiagJacobian(), and KKSMultiACBulkBase().

◆ _prop_dFjdarg

std::vector<std::vector<const MaterialProperty<Real> *> > KKSMultiACBulkBase::_prop_dFjdarg

protected

Derivatives of the free energy functions (needed for off-diagonal Jacobians)

Definition at line 52 of file KKSMultiACBulkBase.h.

Referenced by KKSMultiACBulkF::computeQpOffDiagJacobian(), and KKSMultiACBulkBase().

◆ _prop_dhjdetai

std::vector<const MaterialProperty<Real> *> KKSMultiACBulkBase::_prop_dhjdetai

protected

Derivatives of the switching functions wrt the order parameter for this kernel.

Definition at line 61 of file KKSMultiACBulkBase.h.

Referenced by KKSMultiACBulkC::computeDFDOP(), KKSMultiACBulkF::computeDFDOP(), KKSMultiACBulkF::computeQpOffDiagJacobian(), KKSMultiACBulkC::computeQpOffDiagJacobian(), and KKSMultiACBulkBase().

◆ _prop_Fj

std::vector<const MaterialProperty<Real> *> KKSMultiACBulkBase::_prop_Fj

protected

Values of the free energy functions for each phase \( F_j \).

Definition at line 49 of file KKSMultiACBulkBase.h.

Referenced by KKSMultiACBulkF::computeDFDOP(), KKSMultiACBulkF::computeQpOffDiagJacobian(), and KKSMultiACBulkBase().

◆ _prop_hj

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

protected

Values of the switching functions for each phase \( h_j \).

Definition at line 58 of file KKSMultiACBulkBase.h.

Referenced by KKSMultiACBulkBase().

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

phase_field/include/kernels/KKSMultiACBulkBase.h
phase_field/src/kernels/KKSMultiACBulkBase.C

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ PFFunctionType

Constructor & Destructor Documentation

◆ KKSMultiACBulkBase()

Member Function Documentation

◆ computeDFDOP()

◆ computeQpOffDiagJacobian()

◆ initialSetup()

◆ precomputeQpJacobian()

◆ precomputeQpResidual()

◆ validParams()

Member Data Documentation

◆ _dLdarg

◆ _dLdop

◆ _etai_name

◆ _etai_var

◆ _Fj_names

◆ _hj_names

◆ _L

◆ _num_j

◆ _nvar

◆ _prop_d2hjdetai2

◆ _prop_d2hjdetaidarg

◆ _prop_dFjdarg

◆ _prop_dhjdetai

◆ _prop_Fj

◆ _prop_hj