KKSGlobalFreeEnergy Class Reference

Compute the global free energy in the KKS Model \( F = hF_a + (1-h)F_b + wg + \frac{\kappa}{2}|\eta|^2 \). More...

#include <KKSGlobalFreeEnergy.h>

Inheritance diagram for KKSGlobalFreeEnergy:

Public Member Functions
	KKSGlobalFreeEnergy (const InputParameters &parameters)

Protected Member Functions
virtual Real	computeValue ()

Protected Attributes
const MaterialProperty< Real > &	_prop_fa
const MaterialProperty< Real > &	_prop_fb
const MaterialProperty< Real > &	_prop_h
const MaterialProperty< Real > &	_prop_g
const Real	_w
	Barrier term height. More...
std::vector< const MaterialProperty< Real > * >	_kappas
	Gradient interface free energy coefficients. More...
unsigned int	_nvars
	Coupled interface variables. More...
std::vector< const VariableValue * >	_vars
std::vector< const VariableGradient * >	_grad_vars
std::vector< MaterialPropertyName >	_kappa_names
	Gradient free energy prefactor kappa. More...
unsigned int	_nkappas
const VariableValue &	_additional_free_energy
	Additional free energy contribution. More...

Detailed Description

Compute the global free energy in the KKS Model \( F = hF_a + (1-h)F_b + wg + \frac{\kappa}{2}|\eta|^2 \).

Definition at line 25 of file KKSGlobalFreeEnergy.h.

Constructor & Destructor Documentation

KKSGlobalFreeEnergy()

KKSGlobalFreeEnergy::KKSGlobalFreeEnergy

(

const InputParameters &

parameters

)

Definition at line 43 of file KKSGlobalFreeEnergy.C.

  : TotalFreeEnergyBase(parameters),
    _prop_fa(getMaterialProperty<Real>("fa_name")),
    _prop_fb(getMaterialProperty<Real>("fb_name")),
    _prop_h(getMaterialProperty<Real>("h_name")),
    _prop_g(getMaterialProperty<Real>("g_name")),
    _w(getParam<Real>("w")),
    _kappas(_nkappas)
{
  // Error check to ensure size of interfacial_vars is the same as kappa_names
  if (_nvars != _nkappas)
    mooseError(
        "Size of interfacial_vars is not equal to the size of kappa_names in KKSGlobalFreeEnergy");
 
  // Assign kappa values
  for (unsigned int i = 0; i < _nkappas; ++i)
    _kappas[i] = &getMaterialPropertyByName<Real>(_kappa_names[i]);
}

Member Function Documentation

computeValue()

Real KKSGlobalFreeEnergy::computeValue ( )

protectedvirtual

Implements TotalFreeEnergyBase.

Definition at line 63 of file KKSGlobalFreeEnergy.C.

{
  const Real h = _prop_h[_qp];
 
  // Include bulk energy and additional contributions
  Real total_energy = _prop_fa[_qp] * (1.0 - h) + _prop_fb[_qp] * h + _w * _prop_g[_qp] +
                      _additional_free_energy[_qp];
 
  // Calculate interfacial energy of each variable
  for (unsigned int i = 0; i < _nvars; ++i)
    total_energy += (*_kappas[i])[_qp] / 2.0 * (*_grad_vars[i])[_qp].norm_sq();
 
  return total_energy;
}

Member Data Documentation

_additional_free_energy

const VariableValue& TotalFreeEnergyBase::_additional_free_energy

protectedinherited

Additional free energy contribution.

Definition at line 42 of file TotalFreeEnergyBase.h.

Referenced by CrossTermGradientFreeEnergy::computeValue(), TotalFreeEnergy::computeValue(), KKSMultiFreeEnergy::computeValue(), and computeValue().

_grad_vars

std::vector<const VariableGradient *> TotalFreeEnergyBase::_grad_vars

protectedinherited

Definition at line 35 of file TotalFreeEnergyBase.h.

Referenced by CrossTermGradientFreeEnergy::computeValue(), TotalFreeEnergy::computeValue(), KKSMultiFreeEnergy::computeValue(), computeValue(), and TotalFreeEnergyBase::TotalFreeEnergyBase().

_kappa_names

std::vector<MaterialPropertyName> TotalFreeEnergyBase::_kappa_names

protectedinherited

Gradient free energy prefactor kappa.

Definition at line 38 of file TotalFreeEnergyBase.h.

Referenced by CrossTermGradientFreeEnergy::CrossTermGradientFreeEnergy(), KKSGlobalFreeEnergy(), KKSMultiFreeEnergy::KKSMultiFreeEnergy(), and TotalFreeEnergy::TotalFreeEnergy().

_kappas

std::vector<const MaterialProperty<Real> *> KKSGlobalFreeEnergy::_kappas

protected

Gradient interface free energy coefficients.

Definition at line 42 of file KKSGlobalFreeEnergy.h.

Referenced by computeValue(), and KKSGlobalFreeEnergy().

_nkappas

unsigned int TotalFreeEnergyBase::_nkappas

protectedinherited

Definition at line 39 of file TotalFreeEnergyBase.h.

Referenced by CrossTermGradientFreeEnergy::CrossTermGradientFreeEnergy(), KKSGlobalFreeEnergy(), KKSMultiFreeEnergy::KKSMultiFreeEnergy(), and TotalFreeEnergy::TotalFreeEnergy().

_nvars

unsigned int TotalFreeEnergyBase::_nvars

protectedinherited

Coupled interface variables.

Definition at line 33 of file TotalFreeEnergyBase.h.

Referenced by CrossTermGradientFreeEnergy::computeValue(), TotalFreeEnergy::computeValue(), KKSMultiFreeEnergy::computeValue(), computeValue(), CrossTermGradientFreeEnergy::CrossTermGradientFreeEnergy(), KKSGlobalFreeEnergy(), KKSMultiFreeEnergy::KKSMultiFreeEnergy(), TotalFreeEnergy::TotalFreeEnergy(), and TotalFreeEnergyBase::TotalFreeEnergyBase().

_prop_fa

const MaterialProperty<Real>& KKSGlobalFreeEnergy::_prop_fa

protected

Definition at line 33 of file KKSGlobalFreeEnergy.h.

Referenced by computeValue().

_prop_fb

const MaterialProperty<Real>& KKSGlobalFreeEnergy::_prop_fb

protected

Definition at line 34 of file KKSGlobalFreeEnergy.h.

Referenced by computeValue().

_prop_g

const MaterialProperty<Real>& KKSGlobalFreeEnergy::_prop_g

protected

Definition at line 36 of file KKSGlobalFreeEnergy.h.

Referenced by computeValue().

_prop_h

const MaterialProperty<Real>& KKSGlobalFreeEnergy::_prop_h

protected

Definition at line 35 of file KKSGlobalFreeEnergy.h.

Referenced by computeValue().

_vars

std::vector<const VariableValue *> TotalFreeEnergyBase::_vars

protectedinherited

Definition at line 34 of file TotalFreeEnergyBase.h.

Referenced by CrossTermGradientFreeEnergy::computeValue(), and TotalFreeEnergyBase::TotalFreeEnergyBase().

_w

const Real KKSGlobalFreeEnergy::_w

protected

Barrier term height.

Definition at line 39 of file KKSGlobalFreeEnergy.h.

Referenced by computeValue().

---

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

• phase_field/include/auxkernels/KKSGlobalFreeEnergy.h
• phase_field/src/auxkernels/KKSGlobalFreeEnergy.C