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

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 28 of file KKSMultiACBulkBase.h.

Member Enumeration Documentation

◆ PFFunctionType

enum ACBulk::PFFunctionType
protectedinherited

Definition at line 38 of file ACBulk.h.

Constructor & Destructor Documentation

◆ KKSMultiACBulkBase()

KKSMultiACBulkBase::KKSMultiACBulkBase ( const InputParameters &  parameters)

Definition at line 29 of file KKSMultiACBulkBase.C.

30  : ACBulk<Real>(parameters),
31  _nvar(_coupled_moose_vars.size()), // number of coupled variables
32  _etai_name(getVar("eta_i", 0)->name()),
33  _etai_var(coupled("eta_i", 0)),
34  _Fj_names(getParam<std::vector<MaterialPropertyName>>("Fj_names")),
35  _num_j(_Fj_names.size()),
38  _hj_names(getParam<std::vector<MaterialPropertyName>>("hj_names")),
43 {
44  // check passed in parameter vectors
45  if (_num_j != _hj_names.size())
46  paramError("hj_names", "Need to pass in as many hj_names as Fj_names");
47 
48  // reserve space and set phase material properties
49  for (unsigned int n = 0; n < _num_j; ++n)
50  {
51  // get phase free energy
52  _prop_Fj[n] = &getMaterialPropertyByName<Real>(_Fj_names[n]);
53  _prop_dFjdarg[n].resize(_nvar);
54 
55  // get switching function and derivatives wrt eta_i, the nonlinear variable
56  _prop_hj[n] = &getMaterialPropertyByName<Real>(_hj_names[n]);
57  _prop_dhjdetai[n] = &getMaterialPropertyDerivative<Real>(_hj_names[n], _etai_name);
58  _prop_d2hjdetai2[n] =
59  &getMaterialPropertyDerivative<Real>(_hj_names[n], _etai_name, _etai_name);
60  _prop_d2hjdetaidarg[n].resize(_nvar);
61 
62  for (unsigned int i = 0; i < _nvar; ++i)
63  {
64  MooseVariableFEBase * cvar = _coupled_moose_vars[i];
65  // Get derivatives of all Fj wrt all coupled variables
66  _prop_dFjdarg[n][i] = &getMaterialPropertyDerivative<Real>(_Fj_names[n], cvar->name());
67 
68  // Get second derivatives of all hj wrt eta_i and all coupled variables
69  _prop_d2hjdetaidarg[n][i] =
70  &getMaterialPropertyDerivative<Real>(_hj_names[n], _etai_name, cvar->name());
71  }
72  }
73 }
unsigned int _nvar
Number of coupled variables.
std::vector< MaterialPropertyName > _Fj_names
Names of free energy functions for each phase .
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< MaterialPropertyName > _hj_names
switching function names
std::vector< const MaterialProperty< Real > * > _prop_hj
Values of the switching functions for each phase .
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.
VariableName _etai_name
name of order parameter that derivatives are taken wrt (needed to retrieve the derivative material pr...
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)

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 117 of file ACBulk.h.

118 {
119  // Get the coupled variable jvar is referring to
120  const unsigned int cvar = mapJvarToCvar(jvar);
121 
122  // Set off-diagonal Jacobian term from mobility derivatives
123  return (*_dLdarg[cvar])[_qp] * _phi[_j][_qp] * computeDFDOP(Residual) * _test[_i][_qp];
124 }
virtual Real computeDFDOP(PFFunctionType type)=0
std::vector< const MaterialProperty< Real > *> _dLdarg
Mobility derivative w.r.t coupled variables.
Definition: ACBulk.h:53

◆ initialSetup()

void KKSMultiACBulkBase::initialSetup ( )
virtual

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
protected

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().

◆ _etai_var

unsigned int KKSMultiACBulkBase::_etai_var
protected

index of order parameter that derivatives are taken wrt

Definition at line 43 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 46 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 56 of file KKSMultiACBulkBase.h.

Referenced by initialSetup(), and KKSMultiACBulkBase().

◆ _L

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

◆ _num_j

unsigned int KKSMultiACBulkBase::_num_j
protected

◆ _nvar

unsigned int KKSMultiACBulkBase::_nvar
protected

Number of coupled variables.

Definition at line 37 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 65 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 68 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 53 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 62 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 50 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 59 of file KKSMultiACBulkBase.h.

Referenced by KKSMultiACBulkBase().


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