SoretDiffusion Class Reference

SoretDiffusion adds the soret effect in the split form of the Cahn-Hilliard equation. More...

#include <SoretDiffusion.h>

Inheritance diagram for SoretDiffusion:

Public Member Functions
	SoretDiffusion (const InputParameters &parameters)

Protected Member Functions
virtual Real	computeQpResidual ()
virtual Real	computeQpJacobian ()
virtual Real	computeQpOffDiagJacobian (unsigned int jvar)
virtual Real	computeQpCJacobian ()

Protected Attributes
unsigned int	_T_var
	int label for temperature variable More...
const VariableValue &	_T
	Coupled variable for the temperature. More...
const VariableGradient &	_grad_T
	Variable gradient for temperature. More...
const bool	_is_coupled
	is the kernel used in a coupled form? More...
unsigned int	_c_var
	int label for the Concentration More...
const VariableValue &	_c
	Variable value for the concentration. More...
const MaterialProperty< Real > &	_D
	Diffusivity material property. More...
const MaterialProperty< Real > &	_Q
	Heat of transport material property. More...
const Real	_kB
	Boltzmann constant. More...

Detailed Description

SoretDiffusion adds the soret effect in the split form of the Cahn-Hilliard equation.

Definition at line 23 of file SoretDiffusion.h.

Constructor & Destructor Documentation

SoretDiffusion()

SoretDiffusion::SoretDiffusion

(

const InputParameters &

parameters

)

Definition at line 32 of file SoretDiffusion.C.

  : Kernel(parameters),
    _T_var(coupled("T")),
    _T(coupledValue("T")),
    _grad_T(coupledGradient("T")),
    _is_coupled(isCoupled("c")),
    _c_var(_is_coupled ? coupled("c") : _var.number()),
    _c(_is_coupled ? coupledValue("c") : _u),
    _D(getMaterialProperty<Real>("diff_name")),
    _Q(getMaterialProperty<Real>("Q_name")),
    _kB(8.617343e-5) // Boltzmann constant in eV/K
{
}

Member Function Documentation

computeQpCJacobian()

Real SoretDiffusion::computeQpCJacobian ( )

protectedvirtual

Definition at line 76 of file SoretDiffusion.C.

{
  // Calculate the Jacobian for the c variable
  return _D[_qp] * _Q[_qp] * _phi[_j][_qp] * _grad_T[_qp] / (_kB * _T[_qp] * _T[_qp]) *
         _grad_test[_i][_qp];
}

Referenced by computeQpJacobian(), and computeQpOffDiagJacobian().

computeQpJacobian()

Real SoretDiffusion::computeQpJacobian ( )

protectedvirtual

Definition at line 54 of file SoretDiffusion.C.

{
  return (_is_coupled && _c_var != _var.number()) ? 0.0 : computeQpCJacobian();
}

computeQpOffDiagJacobian()

Real SoretDiffusion::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtual

Definition at line 60 of file SoretDiffusion.C.

{
  // c Off-Diagonal Jacobian
  if (_c_var == jvar)
    return computeQpCJacobian();
 
  // T Off-Diagonal Jacobian
  if (_T_var == jvar)
    return _D[_qp] * _Q[_qp] * _c[_qp] * _grad_test[_i][_qp] *
           (_grad_phi[_j][_qp] - 2.0 * _grad_T[_qp] * _phi[_j][_qp] / _T[_qp]) /
           (_kB * _T[_qp] * _T[_qp]);
 
  return 0.0;
}

computeQpResidual()

Real SoretDiffusion::computeQpResidual ( )

protectedvirtual

Definition at line 47 of file SoretDiffusion.C.

{
  const Real T_term = _D[_qp] * _Q[_qp] * _c[_qp] / (_kB * _T[_qp] * _T[_qp]);
  return T_term * _grad_T[_qp] * _grad_test[_i][_qp];
}

Member Data Documentation

_c

const VariableValue& SoretDiffusion::_c

protected

Variable value for the concentration.

Definition at line 50 of file SoretDiffusion.h.

Referenced by computeQpOffDiagJacobian(), and computeQpResidual().

_c_var

unsigned int SoretDiffusion::_c_var

protected

int label for the Concentration

Definition at line 47 of file SoretDiffusion.h.

Referenced by computeQpJacobian(), and computeQpOffDiagJacobian().

_D

const MaterialProperty<Real>& SoretDiffusion::_D

protected

Diffusivity material property.

Definition at line 53 of file SoretDiffusion.h.

Referenced by computeQpCJacobian(), computeQpOffDiagJacobian(), and computeQpResidual().

_grad_T

const VariableGradient& SoretDiffusion::_grad_T

protected

Variable gradient for temperature.

Definition at line 41 of file SoretDiffusion.h.

Referenced by computeQpCJacobian(), computeQpOffDiagJacobian(), and computeQpResidual().

_is_coupled

const bool SoretDiffusion::_is_coupled

protected

is the kernel used in a coupled form?

Definition at line 44 of file SoretDiffusion.h.

Referenced by computeQpJacobian().

_kB

const Real SoretDiffusion::_kB

protected

Boltzmann constant.

Definition at line 59 of file SoretDiffusion.h.

Referenced by computeQpCJacobian(), computeQpOffDiagJacobian(), and computeQpResidual().

_Q

const MaterialProperty<Real>& SoretDiffusion::_Q

protected

Heat of transport material property.

Definition at line 56 of file SoretDiffusion.h.

Referenced by computeQpCJacobian(), computeQpOffDiagJacobian(), and computeQpResidual().

_T

const VariableValue& SoretDiffusion::_T

protected

Coupled variable for the temperature.

Definition at line 38 of file SoretDiffusion.h.

Referenced by computeQpCJacobian(), computeQpOffDiagJacobian(), and computeQpResidual().

_T_var

unsigned int SoretDiffusion::_T_var

protected

int label for temperature variable

Definition at line 35 of file SoretDiffusion.h.

Referenced by computeQpOffDiagJacobian().

---

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

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