This is the Cahn-Hilliard equation base class that implements the interfacial or gradient energy term of the equation. More...

#include <CHInterfaceBase.h>

Inheritance diagram for CHInterfaceBase< T >:

[legend]

Public Member Functions
	CHInterfaceBase (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual Real	computeQpResidual ()

virtual Real	computeQpJacobian ()

virtual Real	computeQpOffDiagJacobian (unsigned int jvar)

Protected Attributes
const MaterialProperty< Real > &	_kappa

unsigned int	_nvar
	Number of variables. More...

std::vector< const VariableGradient * >	_coupled_grad_vars
	Coupled variables used in mobility. More...


const MaterialProperty< T > &	_M

const MaterialProperty< T > &	_dMdc

const MaterialProperty< T > &	_d2Mdc2


const VariableSecond &	_second_u

const VariableTestSecond &	_second_test

const VariablePhiSecond &	_second_phi


std::vector< const MaterialProperty< T > * >	_dMdarg

std::vector< const MaterialProperty< T > * >	_d2Mdcdarg

std::vector< std::vector< const MaterialProperty< T > * > >	_d2Mdargdarg

Detailed Description

template<typename T>
class CHInterfaceBase< T >

This is the Cahn-Hilliard equation base class that implements the interfacial or gradient energy term of the equation.

See M.R. Tonks et al. / Computational Materials Science 51 (2012) 20-29 for more information.

Definition at line 23 of file CHInterfaceBase.h.

Constructor & Destructor Documentation

◆ CHInterfaceBase()

template<typename T >

CHInterfaceBase< T >::CHInterfaceBase ( const InputParameters & parameters )

Definition at line 66 of file CHInterfaceBase.h.

   : DerivativeMaterialInterface<JvarMapKernelInterface<Kernel>>(parameters),
     _kappa(getMaterialProperty<Real>("kappa_name")),
     _M(getMaterialProperty<T>("mob_name")),
     _dMdc(getMaterialPropertyDerivative<T>("mob_name", _var.name())),
     _d2Mdc2(getMaterialPropertyDerivative<T>("mob_name", _var.name(), _var.name())),
     _second_u(second()),
     _second_test(secondTest()),
     _second_phi(secondPhi()),
     _nvar(_coupled_moose_vars.size()),
     _dMdarg(_nvar),
     _d2Mdcdarg(_nvar),
     _d2Mdargdarg(_nvar),
     _coupled_grad_vars(_nvar)
 {
   // Iterate over all coupled variables
   for (unsigned int i = 0; i < _nvar; ++i)
   {
     // Set material property values
     _dMdarg[i] = &getMaterialPropertyDerivative<T>("mob_name", _coupled_moose_vars[i]->name());
     _d2Mdcdarg[i] =
         &getMaterialPropertyDerivative<T>("mob_name", _var.name(), _coupled_moose_vars[i]->name());
     _d2Mdargdarg[i].resize(_nvar);
     for (unsigned int j = 0; j < _nvar; ++j)
       _d2Mdargdarg[i][j] = &getMaterialPropertyDerivative<T>(
           "mob_name", _coupled_moose_vars[i]->name(), _coupled_moose_vars[j]->name());
  
     // Set coupled variable gradients
     _coupled_grad_vars[i] = &coupledGradient("args", i);
   }
 }

Member Function Documentation

◆ computeQpJacobian()

template<typename T >

Real CHInterfaceBase< T >::computeQpJacobian ( )

protectedvirtual

Definition at line 124 of file CHInterfaceBase.h.

 {
   // Set the gradient and gradient derivative values
   RealGradient grad_M = _dMdc[_qp] * _grad_u[_qp];
  
   RealGradient dgrad_Mdc =
       _d2Mdc2[_qp] * _phi[_j][_qp] * _grad_u[_qp] + _dMdc[_qp] * _grad_phi[_j][_qp];
  
   for (unsigned int i = 0; i < _nvar; ++i)
   {
     grad_M += (*_dMdarg[i])[_qp] * (*_coupled_grad_vars[i])[_qp];
     dgrad_Mdc += (*_d2Mdcdarg[i])[_qp] * _phi[_j][_qp] * (*_coupled_grad_vars[i])[_qp];
   }
  
   // Jacobian value using product rule
   Real value = _kappa[_qp] * _second_phi[_j][_qp].tr() *
                    ((_M[_qp] * _second_test[_i][_qp]).tr() + grad_M * _grad_test[_i][_qp]) +
                _kappa[_qp] * _second_u[_qp].tr() *
                    ((_dMdc[_qp] * _second_test[_i][_qp]).tr() * _phi[_j][_qp] +
                     dgrad_Mdc * _grad_test[_i][_qp]);
  
   return value;
 }

◆ computeQpOffDiagJacobian()

template<typename T >

Real CHInterfaceBase< T >::computeQpOffDiagJacobian ( unsigned int jvar )

protectedvirtual

Definition at line 150 of file CHInterfaceBase.h.

 {
   // get the coupled variable jvar is referring to
   const unsigned int cvar = mapJvarToCvar(jvar);
  
   // Set the gradient derivative
   RealGradient dgrad_Mdarg = (*_d2Mdcdarg[cvar])[_qp] * _phi[_j][_qp] * _grad_u[_qp] +
                              (*_dMdarg[cvar])[_qp] * _grad_phi[_j][_qp];
  
   for (unsigned int i = 0; i < _nvar; ++i)
     dgrad_Mdarg += (*_d2Mdargdarg[cvar][i])[_qp] * _phi[_j][_qp] * (*_coupled_grad_vars[cvar])[_qp];
  
   // Jacobian value using product rule
   Real value = _kappa[_qp] * _second_u[_qp].tr() *
                (((*_dMdarg[cvar])[_qp] * _second_test[_i][_qp]).tr() * _phi[_j][_qp] +
                 dgrad_Mdarg * _grad_test[_i][_qp]);
  
   return value;
 }

◆ computeQpResidual()

template<typename T >

Real CHInterfaceBase< T >::computeQpResidual ( )

protectedvirtual

Definition at line 112 of file CHInterfaceBase.h.

 {
   RealGradient grad_M = _dMdc[_qp] * _grad_u[_qp];
   for (unsigned int i = 0; i < _nvar; ++i)
     grad_M += (*_dMdarg[i])[_qp] * (*_coupled_grad_vars[i])[_qp];
  
   return _kappa[_qp] * _second_u[_qp].tr() *
          ((_M[_qp] * _second_test[_i][_qp]).tr() + grad_M * _grad_test[_i][_qp]);
 }

◆ validParams()

template<typename T >

InputParameters CHInterfaceBase< T >::validParams ( )

static

Definition at line 100 of file CHInterfaceBase.h.

 {
   InputParameters params = ::validParams<Kernel>();
   params.addClassDescription("Gradient energy Cahn-Hilliard base Kernel");
   params.addRequiredParam<MaterialPropertyName>("kappa_name", "The kappa used with the kernel");
   params.addRequiredParam<MaterialPropertyName>("mob_name", "The mobility used with the kernel");
   params.addCoupledVar("args", "Vector of arguments of the mobility");
   return params;
 }

Referenced by validParams< CHInterface >(), and validParams< CHInterfaceAniso >().

Member Data Documentation

◆ _coupled_grad_vars

template<typename T>

std::vector<const VariableGradient *> CHInterfaceBase< T >::_coupled_grad_vars

protected

Coupled variables used in mobility.

Definition at line 62 of file CHInterfaceBase.h.

Referenced by CHInterfaceBase< Real >::CHInterfaceBase().

◆ _d2Mdargdarg

template<typename T>

std::vector<std::vector<const MaterialProperty<T> *> > CHInterfaceBase< T >::_d2Mdargdarg

protected

Definition at line 58 of file CHInterfaceBase.h.

Referenced by CHInterfaceBase< Real >::CHInterfaceBase().

◆ _d2Mdc2

template<typename T>

const MaterialProperty<T>& CHInterfaceBase< T >::_d2Mdc2

protected

Definition at line 41 of file CHInterfaceBase.h.

◆ _d2Mdcdarg

template<typename T>

std::vector<const MaterialProperty<T> *> CHInterfaceBase< T >::_d2Mdcdarg

protected

Definition at line 57 of file CHInterfaceBase.h.

Referenced by CHInterfaceBase< Real >::CHInterfaceBase().

◆ _dMdarg

template<typename T>

std::vector<const MaterialProperty<T> *> CHInterfaceBase< T >::_dMdarg

protected

Mobility derivatives w.r.t. its dependent variables

Definition at line 56 of file CHInterfaceBase.h.

Referenced by CHInterfaceBase< Real >::CHInterfaceBase().

◆ _dMdc

template<typename T>

const MaterialProperty<T>& CHInterfaceBase< T >::_dMdc

protected

Definition at line 40 of file CHInterfaceBase.h.

◆ _kappa

template<typename T>

const MaterialProperty<Real>& CHInterfaceBase< T >::_kappa

protected

Definition at line 35 of file CHInterfaceBase.h.

◆ _M

template<typename T>

const MaterialProperty<T>& CHInterfaceBase< T >::_M

protected

Mobility material property value and concentration derivatives

Definition at line 39 of file CHInterfaceBase.h.

◆ _nvar

template<typename T>

unsigned int CHInterfaceBase< T >::_nvar

protected

Number of variables.

Definition at line 52 of file CHInterfaceBase.h.

Referenced by CHInterfaceBase< Real >::CHInterfaceBase().

◆ _second_phi

template<typename T>

const VariablePhiSecond& CHInterfaceBase< T >::_second_phi

protected

Definition at line 48 of file CHInterfaceBase.h.

◆ _second_test

template<typename T>

const VariableTestSecond& CHInterfaceBase< T >::_second_test

protected

Definition at line 47 of file CHInterfaceBase.h.

◆ _second_u

template<typename T>

const VariableSecond& CHInterfaceBase< T >::_second_u

protected

Variables for second order derivatives

Definition at line 46 of file CHInterfaceBase.h.

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

phase_field/include/kernels/CHInterfaceBase.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<typename T> class CHInterfaceBase< T >

Constructor & Destructor Documentation

◆ CHInterfaceBase()

Member Function Documentation

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

◆ validParams()

Member Data Documentation

◆ _coupled_grad_vars

◆ _d2Mdargdarg

◆ _d2Mdc2

◆ _d2Mdcdarg

◆ _dMdarg

◆ _dMdc

◆ _kappa

◆ _M

◆ _nvar

◆ _second_phi

◆ _second_test

◆ _second_u

template<typename T>
class CHInterfaceBase< T >