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

KKSACBulkBase child class for the free energy difference term \( -\frac{dh}{d\eta}(F_a-F_b)+w\frac{dg}{d\eta} \) in the the Allen-Cahn bulk residual. More...

#include <KKSACBulkF.h>

Inheritance diagram for KKSACBulkF:
[legend]

Public Member Functions

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

Protected Attributes

Real _w
 double well height parameter More...
 
const MaterialProperty< Real > & _prop_dg
 Derivative of the double well function \( \frac d{d\eta} g(\eta) \). More...
 
const MaterialProperty< Real > & _prop_d2g
 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 _eta_name
 name of the order parameter (needed to retrieve the derivative material properties) More...
 
std::vector< const MaterialProperty< Real > * > _derivatives_Fa
 Derivatives of \( F_a \) with respect to all coupled variables. More...
 
std::vector< const MaterialProperty< Real > * > _derivatives_Fb
 Derivatives of \( F_b \) with respect to all coupled variables. More...
 
const MaterialProperty< Real > & _prop_Fa
 Value of the free energy function \( F_a \). More...
 
const MaterialProperty< Real > & _prop_Fb
 Value of the free energy function \( F_b \). More...
 
const MaterialProperty< Real > & _prop_dFa
 Derivative of the free energy function \( \frac d{d\eta} F_a \). More...
 
const MaterialProperty< Real > & _prop_dFb
 Derivative of the free energy function \( \frac d{d\eta} F_b \). More...
 
const MaterialProperty< Real > & _prop_dh
 Derivative of the switching function \( \frac d{d\eta} h(\eta) \). More...
 
const MaterialProperty< Real > & _prop_d2h
 Second derivative of the switching function \( \frac {d^2}{d\eta^2} h(\eta) \). More...
 
std::vector< const VariableGradient * > _grad_args
 Gradients for all coupled variables. 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

KKSACBulkBase child class for the free energy difference term \( -\frac{dh}{d\eta}(F_a-F_b)+w\frac{dg}{d\eta} \) in the the Allen-Cahn bulk residual.

The non-linear variable for this Kernel is the order parameter 'eta'.

Definition at line 25 of file KKSACBulkF.h.

Member Enumeration Documentation

enum ACBulk::PFFunctionType
protectedinherited

Definition at line 35 of file ACBulk.h.

Constructor & Destructor Documentation

KKSACBulkF::KKSACBulkF ( const InputParameters &  parameters)

Definition at line 22 of file KKSACBulkF.C.

23  : KKSACBulkBase(parameters),
24  _w(getParam<Real>("w")),
25  _prop_dg(getMaterialPropertyDerivative<Real>("g_name", _eta_name)),
26  _prop_d2g(getMaterialPropertyDerivative<Real>("g_name", _eta_name, _eta_name))
27 {
28 }
KKSACBulkBase(const InputParameters &parameters)
Definition: KKSACBulkBase.C:27
Real _w
double well height parameter
Definition: KKSACBulkF.h:35
const MaterialProperty< Real > & _prop_dg
Derivative of the double well function .
Definition: KKSACBulkF.h:38
const MaterialProperty< Real > & _prop_d2g
Second derivative of the double well function .
Definition: KKSACBulkF.h:41
VariableName _eta_name
name of the order parameter (needed to retrieve the derivative material properties) ...
Definition: KKSACBulkBase.h:36

Member Function Documentation

Real KKSACBulkF::computeDFDOP ( PFFunctionType  type)
protectedvirtual

Implements ACBulk< Real >.

Definition at line 31 of file KKSACBulkF.C.

32 {
33  Real res = 0.0;
34  Real A1 = _prop_Fa[_qp] - _prop_Fb[_qp];
35 
36  switch (type)
37  {
38  case Residual:
39  return -_prop_dh[_qp] * A1 + _w * _prop_dg[_qp];
40 
41  case Jacobian:
42  {
43  res = -_prop_d2h[_qp] * A1 + _w * _prop_d2g[_qp];
44 
45  return _phi[_j][_qp] * res;
46  }
47  }
48 
49  mooseError("Invalid type passed in");
50 }
const MaterialProperty< Real > & _prop_Fa
Value of the free energy function .
Definition: KKSACBulkBase.h:45
Real _w
double well height parameter
Definition: KKSACBulkF.h:35
const MaterialProperty< Real > & _prop_dg
Derivative of the double well function .
Definition: KKSACBulkF.h:38
const MaterialProperty< Real > & _prop_Fb
Value of the free energy function .
Definition: KKSACBulkBase.h:48
const MaterialProperty< Real > & _prop_dh
Derivative of the switching function .
Definition: KKSACBulkBase.h:57
const MaterialProperty< Real > & _prop_d2g
Second derivative of the double well function .
Definition: KKSACBulkF.h:41
const MaterialProperty< Real > & _prop_d2h
Second derivative of the switching function .
Definition: KKSACBulkBase.h:60
Real KKSACBulkF::computeQpOffDiagJacobian ( unsigned int  jvar)
protectedvirtual

Reimplemented from ACBulk< Real >.

Definition at line 53 of file KKSACBulkF.C.

54 {
55  // get the coupled variable jvar is referring to
56  const unsigned int cvar = mapJvarToCvar(jvar);
57 
58  // first get dependence of mobility _L on other variables using parent class
59  // member function
61 
62  // Then add dependence of KKSACBulkF on other variables
63  res -= _L[_qp] * _prop_dh[_qp] * ((*_derivatives_Fa[cvar])[_qp] - (*_derivatives_Fb[cvar])[_qp]) *
64  _phi[_j][_qp] * _test[_i][_qp];
65 
66  return res;
67 }
const MaterialProperty< Real > & _L
Mobility.
Definition: ACBulk.h:44
std::vector< const MaterialProperty< Real > * > _derivatives_Fa
Derivatives of with respect to all coupled variables.
Definition: KKSACBulkBase.h:39
const MaterialProperty< Real > & _prop_dh
Derivative of the switching function .
Definition: KKSACBulkBase.h:57
virtual Real computeQpOffDiagJacobian(unsigned int jvar)
Definition: ACBulk.h:114
std::vector< const MaterialProperty< Real > * > _derivatives_Fb
Derivatives of with respect to all coupled variables.
Definition: KKSACBulkBase.h:42
void KKSACBulkBase::initialSetup ( )
virtualinherited

Reimplemented from ACBulk< Real >.

Definition at line 59 of file KKSACBulkBase.C.

60 {
62  validateNonlinearCoupling<Real>("fa_name");
63  validateNonlinearCoupling<Real>("fb_name");
64 }
virtual void initialSetup()
Definition: ACBulk.h:83
virtual Real ACBulk< Real >::precomputeQpJacobian ( )
protectedvirtualinherited
virtual Real ACBulk< Real >::precomputeQpResidual ( )
protectedvirtualinherited
static InputParameters ACBulk< Real >::validParams ( )
staticinherited

Member Data Documentation

std::vector<const MaterialProperty<Real> *> KKSACBulkBase::_derivatives_Fa
protectedinherited

Derivatives of \( F_a \) with respect to all coupled variables.

Definition at line 39 of file KKSACBulkBase.h.

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

std::vector<const MaterialProperty<Real> *> KKSACBulkBase::_derivatives_Fb
protectedinherited

Derivatives of \( F_b \) with respect to all coupled variables.

Definition at line 42 of file KKSACBulkBase.h.

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

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

Mobility derivative w.r.t coupled variables.

Definition at line 50 of file ACBulk.h.

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

Mobility derivative w.r.t. order parameter.

Definition at line 47 of file ACBulk.h.

VariableName KKSACBulkBase::_eta_name
protectedinherited

name of the order parameter (needed to retrieve the derivative material properties)

Definition at line 36 of file KKSACBulkBase.h.

std::vector<const VariableGradient *> KKSACBulkBase::_grad_args
protectedinherited

Gradients for all coupled variables.

Definition at line 63 of file KKSACBulkBase.h.

Referenced by KKSACBulkBase::KKSACBulkBase().

const MaterialProperty<Real >& ACBulk< Real >::_L
protectedinherited
unsigned int KKSACBulkBase::_nvar
protectedinherited

Number of coupled variables.

Definition at line 33 of file KKSACBulkBase.h.

Referenced by KKSACBulkBase::KKSACBulkBase(), and KKSACBulkC::KKSACBulkC().

const MaterialProperty<Real>& KKSACBulkF::_prop_d2g
protected

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

Definition at line 41 of file KKSACBulkF.h.

Referenced by computeDFDOP().

const MaterialProperty<Real>& KKSACBulkBase::_prop_d2h
protectedinherited

Second derivative of the switching function \( \frac {d^2}{d\eta^2} h(\eta) \).

Definition at line 60 of file KKSACBulkBase.h.

Referenced by KKSACBulkC::computeDFDOP(), and computeDFDOP().

const MaterialProperty<Real>& KKSACBulkBase::_prop_dFa
protectedinherited

Derivative of the free energy function \( \frac d{d\eta} F_a \).

Definition at line 51 of file KKSACBulkBase.h.

const MaterialProperty<Real>& KKSACBulkBase::_prop_dFb
protectedinherited

Derivative of the free energy function \( \frac d{d\eta} F_b \).

Definition at line 54 of file KKSACBulkBase.h.

const MaterialProperty<Real>& KKSACBulkF::_prop_dg
protected

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

Definition at line 38 of file KKSACBulkF.h.

Referenced by computeDFDOP().

const MaterialProperty<Real>& KKSACBulkBase::_prop_dh
protectedinherited

Derivative of the switching function \( \frac d{d\eta} h(\eta) \).

Definition at line 57 of file KKSACBulkBase.h.

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

const MaterialProperty<Real>& KKSACBulkBase::_prop_Fa
protectedinherited

Value of the free energy function \( F_a \).

Definition at line 45 of file KKSACBulkBase.h.

Referenced by computeDFDOP().

const MaterialProperty<Real>& KKSACBulkBase::_prop_Fb
protectedinherited

Value of the free energy function \( F_b \).

Definition at line 48 of file KKSACBulkBase.h.

Referenced by computeDFDOP().

Real KKSACBulkF::_w
protected

double well height parameter

Definition at line 35 of file KKSACBulkF.h.

Referenced by computeDFDOP().


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