CHBulk< T > Class Template Reference

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

#include <CHBulk.h>

Inheritance diagram for CHBulk< T >:

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

Static Public Member Functions
static InputParameters	validParams ()

Protected Types
enum	PFFunctionType { Jacobian, Residual }

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

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

Detailed Description

template<typename T>
class CHBulk< T >

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

It is templated on the type of the mobility, which can be either a number (Real) or a tensor (RealValueTensor). See M.R. Tonks et al. / Computational Materials Science 51 (2012) 20-29 for more information. Note that the function computeGradDFDCons MUST be overridden in any kernel that inherits from CHBulk. Use CHMath as an example of how this works.

Definition at line 25 of file CHBulk.h.

Member Enumeration Documentation

PFFunctionType

template<typename T>

enum CHBulk::PFFunctionType

protected

Enumerator
Jacobian
Residual

Definition at line 38 of file CHBulk.h.

  {
    Jacobian,
    Residual
  };

Constructor & Destructor Documentation

CHBulk()

template<typename T >

CHBulk< T >::CHBulk

(

const InputParameters &

parameters

)

Definition at line 57 of file CHBulk.h.

  : DerivativeMaterialInterface<JvarMapKernelInterface<KernelGrad>>(parameters),
    _M(getMaterialProperty<T>("mob_name")),
    _dMdc(getMaterialPropertyDerivative<T>("mob_name", _var.name()))
{
  // Get number of coupled variables
  unsigned int nvar = _coupled_moose_vars.size();
 
  // reserve space for derivatives
  _dMdarg.resize(nvar);
 
  // Iterate over all coupled variables
  for (unsigned int i = 0; i < nvar; ++i)
    _dMdarg[i] = &getMaterialPropertyDerivative<T>("mob_name", _coupled_moose_vars[i]->name());
}

Member Function Documentation

computeGradDFDCons()

template<typename T>

virtual RealGradient CHBulk< T >::computeGradDFDCons ( PFFunctionType  type )

protectedpure virtual

Implemented in CahnHilliardBase< T >, CahnHilliardBase< RealTensorValue >, and CahnHilliardBase< Real >.

computeQpOffDiagJacobian()

template<typename T >

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

protectedvirtual

Reimplemented in KKSCHBulk, CahnHilliardBase< T >, CahnHilliardBase< RealTensorValue >, and CahnHilliardBase< Real >.

Definition at line 110 of file CHBulk.h.

{
  // get the coupled variable jvar is referring to
  const unsigned int cvar = mapJvarToCvar(jvar);
 
  return (*_dMdarg[cvar])[_qp] * _phi[_j][_qp] * computeGradDFDCons(Residual) * _grad_test[_i][_qp];
}

Referenced by CahnHilliardBase< Real >::computeQpOffDiagJacobian().

initialSetup()

template<typename T >

void CHBulk< T >::initialSetup ( )

virtual

Reimplemented in CahnHilliardBase< T >, CahnHilliardBase< RealTensorValue >, and CahnHilliardBase< Real >.

Definition at line 86 of file CHBulk.h.

{
  validateNonlinearCoupling<Real>("mob_name");
}

precomputeQpJacobian()

template<typename T >

RealGradient CHBulk< T >::precomputeQpJacobian ( )

protectedvirtual

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

template<typename T >

RealGradient CHBulk< T >::precomputeQpResidual ( )

protectedvirtual

Definition at line 93 of file CHBulk.h.

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

validParams()

template<typename T >

InputParameters CHBulk< T >::validParams ( )

static

Definition at line 75 of file CHBulk.h.

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

Referenced by CahnHilliardBase< Real >::validParams(), validParams< CHBulkPFCTrad >(), validParams< CHMath >(), and validParams< KKSCHBulk >().

Member Data Documentation

_dMdarg

template<typename T>

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

protected

Mobility derivative w.r.t coupled variables.

Definition at line 53 of file CHBulk.h.

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

_dMdc

template<typename T>

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

protected

Mobility derivative w.r.t. concentration.

Definition at line 50 of file CHBulk.h.

_M

template<typename T>

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

protected

Mobility.

Definition at line 47 of file CHBulk.h.

---

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

• phase_field/include/kernels/CHBulk.h