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

ACBulk child class that takes all the necessary data from a KKSBaseMaterial and sets up the Allen-Cahn bulk term. More...

#include <KKSACBulkBase.h>

Inheritance diagram for KKSACBulkBase:
[legend]

Public Member Functions

 KKSACBulkBase (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 _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

ACBulk child class that takes all the necessary data from a KKSBaseMaterial and sets up the Allen-Cahn bulk term.

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

Definition at line 24 of file KKSACBulkBase.h.

Member Enumeration Documentation

enum ACBulk::PFFunctionType
protectedinherited

Definition at line 35 of file ACBulk.h.

Constructor & Destructor Documentation

KKSACBulkBase::KKSACBulkBase ( const InputParameters &  parameters)

Definition at line 27 of file KKSACBulkBase.C.

28  : ACBulk<Real>(parameters),
29  // number of coupled variables (ca, args_a[])
30  _nvar(_coupled_moose_vars.size()),
31  _eta_name(_var.name()),
32  _prop_Fa(getMaterialProperty<Real>("fa_name")),
33  _prop_Fb(getMaterialProperty<Real>("fb_name")),
34  _prop_dFa(getMaterialPropertyDerivative<Real>("fa_name", _eta_name)),
35  _prop_dFb(getMaterialPropertyDerivative<Real>("fb_name", _eta_name)),
36  _prop_dh(getMaterialPropertyDerivative<Real>("h_name", _eta_name)),
37  _prop_d2h(getMaterialPropertyDerivative<Real>("h_name", _eta_name, _eta_name))
38 {
39  // reserve space for derivatives
40  _derivatives_Fa.resize(_nvar);
41  _derivatives_Fb.resize(_nvar);
42  _grad_args.resize(_nvar);
43 
44  // Iterate over all coupled variables
45  for (unsigned int i = 0; i < _nvar; ++i)
46  {
47  MooseVariable * cvar = _coupled_moose_vars[i];
48 
49  // get the first derivatives of Fa and Fb material property
50  _derivatives_Fa[i] = &getMaterialPropertyDerivative<Real>("fa_name", cvar->name());
51  _derivatives_Fb[i] = &getMaterialPropertyDerivative<Real>("fb_name", cvar->name());
52 
53  // get the gradient
54  _grad_args[i] = &(cvar->gradSln());
55  }
56 }
const MaterialProperty< Real > & _prop_dFa
Derivative of the free energy function .
Definition: KKSACBulkBase.h:51
const MaterialProperty< Real > & _prop_Fa
Value of the free energy function .
Definition: KKSACBulkBase.h:45
std::vector< const VariableGradient * > _grad_args
Gradients for all coupled variables.
Definition: KKSACBulkBase.h:63
const MaterialProperty< Real > & _prop_Fb
Value of the free energy function .
Definition: KKSACBulkBase.h:48
unsigned int _nvar
Number of coupled variables.
Definition: KKSACBulkBase.h:33
std::vector< const MaterialProperty< Real > * > _derivatives_Fa
Derivatives of with respect to all coupled variables.
Definition: KKSACBulkBase.h:39
const MaterialProperty< Real > & _prop_dFb
Derivative of the free energy function .
Definition: KKSACBulkBase.h:54
const MaterialProperty< Real > & _prop_dh
Derivative of the switching function .
Definition: KKSACBulkBase.h:57
const MaterialProperty< Real > & _prop_d2h
Second derivative of the switching function .
Definition: KKSACBulkBase.h:60
std::vector< const MaterialProperty< Real > * > _derivatives_Fb
Derivatives of with respect to all coupled variables.
Definition: KKSACBulkBase.h:42
VariableName _eta_name
name of the order parameter (needed to retrieve the derivative material properties) ...
Definition: KKSACBulkBase.h:36

Member Function Documentation

virtual Real ACBulk< Real >::computeDFDOP ( PFFunctionType  type)
protectedpure virtualinherited
virtual Real ACBulk< Real >::computeQpOffDiagJacobian ( unsigned int  jvar)
protectedvirtualinherited
void KKSACBulkBase::initialSetup ( )
virtual

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
protected

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

Definition at line 39 of file KKSACBulkBase.h.

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

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

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

Definition at line 42 of file KKSACBulkBase.h.

Referenced by KKSACBulkF::computeQpOffDiagJacobian(), and 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
protected

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
protected

Gradients for all coupled variables.

Definition at line 63 of file KKSACBulkBase.h.

Referenced by KKSACBulkBase().

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

Number of coupled variables.

Definition at line 33 of file KKSACBulkBase.h.

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

const MaterialProperty<Real>& KKSACBulkBase::_prop_d2h
protected

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 KKSACBulkF::computeDFDOP().

const MaterialProperty<Real>& KKSACBulkBase::_prop_dFa
protected

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
protected

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

Definition at line 54 of file KKSACBulkBase.h.

const MaterialProperty<Real>& KKSACBulkBase::_prop_dh
protected

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

Definition at line 57 of file KKSACBulkBase.h.

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

const MaterialProperty<Real>& KKSACBulkBase::_prop_Fa
protected

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

Definition at line 45 of file KKSACBulkBase.h.

Referenced by KKSACBulkF::computeDFDOP().

const MaterialProperty<Real>& KKSACBulkBase::_prop_Fb
protected

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

Definition at line 48 of file KKSACBulkBase.h.

Referenced by KKSACBulkF::computeDFDOP().


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