www.mooseframework.org
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
KKSMultiACBulkF Class Referenceabstract

KKSMultiACBulkBase child class for the free energy term \( \sum_j \frac{\partial h_j}{\partial \eta_i} F_j + w_i \frac{dg}{d\eta_i} \) in the the Allen-Cahn bulk residual. More...

#include <KKSMultiACBulkF.h>

Inheritance diagram for KKSMultiACBulkF:
[legend]

Public Member Functions

 KKSMultiACBulkF (const InputParameters &parameters)
 
virtual void initialSetup ()
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Types

enum  PFFunctionType
 

Protected Member Functions

virtual Real computeDFDOP (PFFunctionType type)
 
virtual Real computeQpOffDiagJacobian (unsigned int jvar)
 
virtual Real precomputeQpResidual ()
 
virtual Real precomputeQpJacobian ()
 
virtual Real computeDFDOP (PFFunctionType type)=0
 

Protected Attributes

Real _wi
 double well height parameter More...
 
const MaterialProperty< Real > & _prop_dgi
 Derivative of the double well function \( \frac d{d\eta} g(\eta) \). More...
 
const MaterialProperty< Real > & _prop_d2gi
 Second derivative of the double well function \( \frac {d^2}{d\eta^2} g(\eta) \). More...
 
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

KKSMultiACBulkBase child class for the free energy term \( \sum_j \frac{\partial h_j}{\partial \eta_i} F_j + w_i \frac{dg}{d\eta_i} \) in the the Allen-Cahn bulk residual.

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

Definition at line 28 of file KKSMultiACBulkF.h.

Member Enumeration Documentation

◆ PFFunctionType

enum ACBulk::PFFunctionType
protectedinherited

Definition at line 38 of file ACBulk.h.

Constructor & Destructor Documentation

◆ KKSMultiACBulkF()

KKSMultiACBulkF::KKSMultiACBulkF ( const InputParameters &  parameters)

Definition at line 27 of file KKSMultiACBulkF.C.

28  : KKSMultiACBulkBase(parameters),
29  _wi(getParam<Real>("wi")),
30  _prop_dgi(getMaterialPropertyDerivative<Real>("gi_name", _etai_name)),
31  _prop_d2gi(getMaterialPropertyDerivative<Real>("gi_name", _etai_name, _etai_name))
32 {
33 }
const MaterialProperty< Real > & _prop_dgi
Derivative of the double well function .
const MaterialProperty< Real > & _prop_d2gi
Second derivative of the double well function .
Real _wi
double well height parameter
VariableName _etai_name
name of order parameter that derivatives are taken wrt (needed to retrieve the derivative material pr...
KKSMultiACBulkBase(const InputParameters &parameters)

Member Function Documentation

◆ computeDFDOP() [1/2]

Real KKSMultiACBulkF::computeDFDOP ( PFFunctionType  type)
protectedvirtual

Definition at line 36 of file KKSMultiACBulkF.C.

37 {
38  Real sum = 0.0;
39 
40  switch (type)
41  {
42  case Residual:
43  for (unsigned int n = 0; n < _num_j; ++n)
44  sum += (*_prop_dhjdetai[n])[_qp] * (*_prop_Fj[n])[_qp];
45 
46  return sum + _wi * _prop_dgi[_qp];
47 
48  case Jacobian:
49  // For when this kernel is used in the Lagrange multiplier equation
50  // In that case the Lagrange multiplier is the nonlinear variable
51  if (_etai_var != _var.number())
52  return 0.0;
53 
54  // For when eta_i is the nonlinear variable
55  for (unsigned int n = 0; n < _num_j; ++n)
56  sum += (*_prop_d2hjdetai2[n])[_qp] * (*_prop_Fj[n])[_qp];
57 
58  return _phi[_j][_qp] * (sum + _wi * _prop_d2gi[_qp]);
59  }
60 
61  mooseError("Invalid type passed in");
62 }
const MaterialProperty< Real > & _prop_dgi
Derivative of the double well function .
const MaterialProperty< Real > & _prop_d2gi
Second derivative of the double well function .
Real _wi
double well height parameter
std::vector< const MaterialProperty< Real > * > _prop_dhjdetai
Derivatives of the switching functions wrt the order parameter for this kernel.
std::vector< const MaterialProperty< Real > * > _prop_Fj
Values of the free energy functions for each phase .
std::vector< const MaterialProperty< Real > * > _prop_d2hjdetai2
Second derivatives of the switching functions wrt the order parameter for this kernel.
unsigned int _etai_var
index of order parameter that derivatives are taken wrt

◆ computeDFDOP() [2/2]

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

◆ computeQpOffDiagJacobian()

Real KKSMultiACBulkF::computeQpOffDiagJacobian ( unsigned int  jvar)
protectedvirtual

Reimplemented from ACBulk< Real >.

Definition at line 65 of file KKSMultiACBulkF.C.

66 {
67  // get the coupled variable jvar is referring to
68  const unsigned int cvar = mapJvarToCvar(jvar);
69 
70  // first get dependence of mobility _L on other variables using parent class
71  // member function
73 
74  // Then add dependence of KKSMultiACBulkF on other variables
75  Real sum = 0.0;
76  for (unsigned int n = 0; n < _num_j; ++n)
77  sum += (*_prop_d2hjdetaidarg[n][cvar])[_qp] * (*_prop_Fj[n])[_qp] +
78  (*_prop_dhjdetai[n])[_qp] * (*_prop_dFjdarg[n][cvar])[_qp];
79 
80  // Handle the case when this kernel is used in the Lagrange multiplier equation
81  // In this case the second derivative of the barrier function contributes
82  // to the off-diagonal Jacobian
83  if (jvar == _etai_var)
84  sum += _wi * _prop_d2gi[_qp];
85 
86  res += _L[_qp] * sum * _phi[_j][_qp] * _test[_i][_qp];
87 
88  return res;
89 }
const MaterialProperty< Real > & _prop_d2gi
Second derivative of the double well function .
const MaterialProperty< Real > & _L
Mobility.
Definition: ACBulk.h:47
Real _wi
double well height parameter
std::vector< std::vector< const MaterialProperty< Real > * > > _prop_d2hjdetaidarg
Second derivatives of the switching functions (needed for off-diagonal Jacobians) ...
std::vector< const MaterialProperty< Real > * > _prop_dhjdetai
Derivatives of the switching functions wrt the order parameter for this kernel.
std::vector< const MaterialProperty< Real > * > _prop_Fj
Values of the free energy functions for each phase .
virtual Real computeQpOffDiagJacobian(unsigned int jvar)
Definition: ACBulk.h:117
unsigned int _etai_var
index of order parameter that derivatives are taken wrt
std::vector< std::vector< const MaterialProperty< Real > * > > _prop_dFjdarg
Derivatives of the free energy functions (needed for off-diagonal Jacobians)

◆ initialSetup()

void KKSMultiACBulkBase::initialSetup ( )
virtualinherited

Reimplemented from ACBulk< Real >.

Definition at line 76 of file KKSMultiACBulkBase.C.

77 {
79 
80  for (unsigned int n = 0; n < _num_j; ++n)
81  {
82  validateNonlinearCoupling<Real>(_Fj_names[n]);
83  validateNonlinearCoupling<Real>(_hj_names[n]);
84  }
85 }
virtual void initialSetup()
Definition: ACBulk.h:86
std::vector< MaterialPropertyName > _Fj_names
Names of free energy functions for each phase .
std::vector< MaterialPropertyName > _hj_names
switching function names

◆ precomputeQpJacobian()

Real ACBulk< Real >::precomputeQpJacobian ( )
protectedvirtualinherited

Definition at line 104 of file ACBulk.h.

105 {
106  // Get free energy derivative and Jacobian
107  Real dFdop = computeDFDOP(Residual);
108 
109  Real JdFdop = computeDFDOP(Jacobian);
110 
111  // Set Jacobian value using product rule
112  return _L[_qp] * JdFdop + _dLdop[_qp] * _phi[_j][_qp] * dFdop;
113 }
const MaterialProperty< Real > & _L
Mobility.
Definition: ACBulk.h:47
virtual Real computeDFDOP(PFFunctionType type)=0
const MaterialProperty< Real > & _dLdop
Mobility derivative w.r.t. order parameter.
Definition: ACBulk.h:50

◆ precomputeQpResidual()

Real ACBulk< Real >::precomputeQpResidual ( )
protectedvirtualinherited

Definition at line 93 of file ACBulk.h.

94 {
95  // Get free energy derivative from function
96  Real dFdop = computeDFDOP(Residual);
97 
98  // Set residual
99  return _L[_qp] * dFdop;
100 }
const MaterialProperty< Real > & _L
Mobility.
Definition: ACBulk.h:47
virtual Real computeDFDOP(PFFunctionType type)=0

◆ validParams()

InputParameters ACBulk< Real >::validParams ( )
staticinherited

Definition at line 75 of file ACBulk.h.

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

Member Data Documentation

◆ _dLdarg

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

Mobility derivative w.r.t coupled variables.

Definition at line 53 of file ACBulk.h.

◆ _dLdop

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

Mobility derivative w.r.t. order parameter.

Definition at line 50 of file ACBulk.h.

◆ _etai_name

VariableName KKSMultiACBulkBase::_etai_name
protectedinherited

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

Definition at line 40 of file KKSMultiACBulkBase.h.

Referenced by KKSMultiACBulkBase::KKSMultiACBulkBase().

◆ _etai_var

unsigned int KKSMultiACBulkBase::_etai_var
protectedinherited

index of order parameter that derivatives are taken wrt

Definition at line 43 of file KKSMultiACBulkBase.h.

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

◆ _Fj_names

std::vector<MaterialPropertyName> KKSMultiACBulkBase::_Fj_names
protectedinherited

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

Definition at line 46 of file KKSMultiACBulkBase.h.

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

◆ _hj_names

std::vector<MaterialPropertyName> KKSMultiACBulkBase::_hj_names
protectedinherited

switching function names

Definition at line 56 of file KKSMultiACBulkBase.h.

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

◆ _L

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

◆ _num_j

unsigned int KKSMultiACBulkBase::_num_j
protectedinherited

◆ _nvar

unsigned int KKSMultiACBulkBase::_nvar
protectedinherited

Number of coupled variables.

Definition at line 37 of file KKSMultiACBulkBase.h.

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

◆ _prop_d2gi

const MaterialProperty<Real>& KKSMultiACBulkF::_prop_d2gi
protected

Second derivative of the double well function \( \frac {d^2}{d\eta^2} g(\eta) \).

Definition at line 44 of file KKSMultiACBulkF.h.

Referenced by computeDFDOP(), and computeQpOffDiagJacobian().

◆ _prop_d2hjdetai2

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

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

Definition at line 65 of file KKSMultiACBulkBase.h.

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

◆ _prop_d2hjdetaidarg

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

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

Definition at line 68 of file KKSMultiACBulkBase.h.

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

◆ _prop_dFjdarg

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

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

Definition at line 53 of file KKSMultiACBulkBase.h.

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

◆ _prop_dgi

const MaterialProperty<Real>& KKSMultiACBulkF::_prop_dgi
protected

Derivative of the double well function \( \frac d{d\eta} g(\eta) \).

Definition at line 41 of file KKSMultiACBulkF.h.

Referenced by computeDFDOP().

◆ _prop_dhjdetai

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

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

Definition at line 62 of file KKSMultiACBulkBase.h.

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

◆ _prop_Fj

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

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

Definition at line 50 of file KKSMultiACBulkBase.h.

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

◆ _prop_hj

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

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

Definition at line 59 of file KKSMultiACBulkBase.h.

Referenced by KKSMultiACBulkBase::KKSMultiACBulkBase().

◆ _wi

Real KKSMultiACBulkF::_wi
protected

double well height parameter

Definition at line 38 of file KKSMultiACBulkF.h.

Referenced by computeDFDOP(), and computeQpOffDiagJacobian().


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