CahnHilliard Class Reference

SplitCHWRes creates the residual of the Cahn-Hilliard equation with a scalar (isotropic) mobility. More...

#include <CahnHilliard.h>

Inheritance diagram for CahnHilliard:

Public Member Functions
	CahnHilliard (const InputParameters &parameters)
virtual void	initialSetup ()

Static Public Member Functions
static InputParameters	validParams ()

Protected Types
typedef CHBulk< Real >::PFFunctionType	PFFunctionType

Protected Member Functions
virtual RealGradient	computeGradDFDCons (PFFunctionType type)
virtual Real	computeQpOffDiagJacobian (unsigned int jvar)
virtual RealGradient	precomputeQpResidual ()
virtual RealGradient	precomputeQpJacobian ()

Protected Attributes
const MaterialProperty< Real > &	_M
	Mobility. More...
const MaterialProperty< Real > &	_dMdc
	Mobility derivative w.r.t. concentration. More...
std::vector< const MaterialProperty< Real > * >	_dMdarg
	Mobility derivative w.r.t coupled variables. More...

Private Attributes
const unsigned int	_nvar
std::vector< const MaterialProperty< Real > * >	_second_derivatives
std::vector< const MaterialProperty< Real > * >	_third_derivatives
std::vector< std::vector< const MaterialProperty< Real > * > >	_third_cross_derivatives
std::vector< const VariableGradient * >	_grad_vars

Detailed Description

SplitCHWRes creates the residual of the Cahn-Hilliard equation with a scalar (isotropic) mobility.

Definition at line 18 of file CahnHilliard.h.

Member Typedef Documentation

PFFunctionType

typedef CHBulk<Real >::PFFunctionType CahnHilliardBase< Real >::PFFunctionType

protectedinherited

Definition at line 29 of file CahnHilliardBase.h.

Constructor & Destructor Documentation

CahnHilliard()

CahnHilliard::CahnHilliard

(

const InputParameters &

parameters

)

Definition at line 24 of file CahnHilliard.C.

                                                             : CahnHilliardBase<Real>(parameters)
{
}

Member Function Documentation

computeGradDFDCons()

RealGradient CahnHilliardBase< Real >::computeGradDFDCons ( PFFunctionType  type )

protectedvirtualinherited

Implements CHBulk< Real >.

Definition at line 127 of file CahnHilliardBase.h.

{
  RealGradient res = 0.0;
 
  switch (type)
  {
    case CHBulk<T>::Residual:
      for (unsigned int i = 0; i <= _nvar; ++i)
        res += (*_grad_vars[i])[_qp] * (*_second_derivatives[i])[_qp];
      return res;
 
    case CHBulk<T>::Jacobian:
      res = _grad_phi[_j][_qp] * (*_second_derivatives[0])[_qp];
      for (unsigned int i = 0; i <= _nvar; ++i)
        res += _phi[_j][_qp] * (*_grad_vars[i])[_qp] * (*_third_derivatives[i])[_qp];
      return res;
  }
 
  mooseError("Internal error");
}

computeQpOffDiagJacobian()

Real CahnHilliardBase< Real >::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtualinherited

Reimplemented from CHBulk< Real >.

Definition at line 150 of file CahnHilliardBase.h.

{
  // get the coupled variable jvar is referring to
  const unsigned int cvar = this->mapJvarToCvar(jvar);
 
  RealGradient J = _grad_u[_qp] * _phi[_j][_qp] * (*_third_derivatives[cvar + 1])[_qp] +
                   _grad_phi[_j][_qp] * (*_second_derivatives[cvar + 1])[_qp];
 
  for (unsigned int i = 0; i < _nvar; ++i)
    J += _phi[_j][_qp] * (*_grad_vars[i + 1])[_qp] * (*_third_cross_derivatives[i][cvar])[_qp];
 
  return CHBulk<T>::computeQpOffDiagJacobian(jvar) + _M[_qp] * _grad_test[_i][_qp] * J;
}

initialSetup()

void CahnHilliardBase< Real >::initialSetup ( )

virtualinherited

Check if both the non-linear as well as the auxiliary variables variables are coupled. Derivatives with respect to both types of variables contribute the residual.

Reimplemented from CHBulk< Real >.

Definition at line 114 of file CahnHilliardBase.h.

{
  this->template validateCoupling<Real>("f_name", _var.name());
  this->template validateDerivativeMaterialPropertyBase<Real>("f_name");
}

precomputeQpJacobian()

RealGradient CHBulk< Real >::precomputeQpJacobian ( )

protectedvirtualinherited

Definition at line 100 of file CHBulk.h.

{
  RealGradient grad_value = _M[_qp] * computeGradDFDCons(Jacobian) +
                            _dMdc[_qp] * _phi[_j][_qp] * computeGradDFDCons(Residual);
 
  return grad_value;
}

precomputeQpResidual()

RealGradient CHBulk< Real >::precomputeQpResidual ( )

protectedvirtualinherited

Definition at line 93 of file CHBulk.h.

{
  return _M[_qp] * computeGradDFDCons(Residual);
}

validParams()

InputParameters CahnHilliardBase< Real >::validParams ( )

staticinherited

Definition at line 58 of file CahnHilliardBase.h.

{
  InputParameters params = CHBulk<Real>::validParams();
  params.addClassDescription("Cahn-Hilliard Kernel that uses a DerivativeMaterial Free Energy");
  params.addRequiredParam<MaterialPropertyName>(
      "f_name", "Base name of the free energy function F defined in a DerivativeParsedMaterial");
  params.addCoupledVar("displacement_gradients",
                       "Vector of displacement gradient variables (see "
                       "Modules/PhaseField/DisplacementGradients "
                       "action)");
  return params;
}

Member Data Documentation

_dMdarg

std::vector<const MaterialProperty<Real > *> CHBulk< Real >::_dMdarg

protectedinherited

Mobility derivative w.r.t coupled variables.

Definition at line 53 of file CHBulk.h.

_dMdc

const MaterialProperty<Real >& CHBulk< Real >::_dMdc

protectedinherited

Mobility derivative w.r.t. concentration.

Definition at line 50 of file CHBulk.h.

_grad_vars

std::vector<const VariableGradient *> CahnHilliardBase< Real >::_grad_vars

privateinherited

Definition at line 53 of file CahnHilliardBase.h.

_M

const MaterialProperty<Real >& CHBulk< Real >::_M

protectedinherited

Mobility.

Definition at line 47 of file CHBulk.h.

_nvar

const unsigned int CahnHilliardBase< Real >::_nvar

privateinherited

Definition at line 49 of file CahnHilliardBase.h.

_second_derivatives

std::vector<const MaterialProperty<Real> *> CahnHilliardBase< Real >::_second_derivatives

privateinherited

Definition at line 50 of file CahnHilliardBase.h.

_third_cross_derivatives

std::vector<std::vector<const MaterialProperty<Real> *> > CahnHilliardBase< Real >::_third_cross_derivatives

privateinherited

Definition at line 52 of file CahnHilliardBase.h.

_third_derivatives

std::vector<const MaterialProperty<Real> *> CahnHilliardBase< Real >::_third_derivatives

privateinherited

Definition at line 51 of file CahnHilliardBase.h.

---

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

• phase_field/include/kernels/CahnHilliard.h
• phase_field/src/kernels/CahnHilliard.C