TotalFreeEnergyBase Class Reference

Total free energy (both the bulk and gradient parts), where the bulk free energy has been defined in a material and called f_name. More...

#include <TotalFreeEnergyBase.h>

Inheritance diagram for TotalFreeEnergyBase:

Public Member Functions
	TotalFreeEnergyBase (const InputParameters &parameters)

Protected Member Functions
virtual Real	computeValue ()=0

Protected Attributes
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

Total free energy (both the bulk and gradient parts), where the bulk free energy has been defined in a material and called f_name.

Definition at line 24 of file TotalFreeEnergyBase.h.

Constructor & Destructor Documentation

TotalFreeEnergyBase()

TotalFreeEnergyBase::TotalFreeEnergyBase

(

const InputParameters &

parameters

)

Definition at line 25 of file TotalFreeEnergyBase.C.

  : AuxKernel(parameters),
    _nvars(coupledComponents("interfacial_vars")),
    _vars(_nvars),
    _grad_vars(_nvars),
    _kappa_names(getParam<std::vector<MaterialPropertyName>>("kappa_names")),
    _nkappas(_kappa_names.size()),
    _additional_free_energy(coupledValue("additional_free_energy"))
{
  // Fetch coupled variables and their gradients
  for (unsigned int i = 0; i < _nvars; ++i)
  {
    _vars[i] = &coupledValue("interfacial_vars", i);
    _grad_vars[i] = &coupledGradient("interfacial_vars", i);
  }
}

Member Function Documentation

computeValue()

virtual Real TotalFreeEnergyBase::computeValue ( )

protectedpure virtual

Implemented in KKSGlobalFreeEnergy, KKSMultiFreeEnergy, TotalFreeEnergy, and CrossTermGradientFreeEnergy.

Member Data Documentation

_additional_free_energy

const VariableValue& TotalFreeEnergyBase::_additional_free_energy

protected

Additional free energy contribution.

Definition at line 42 of file TotalFreeEnergyBase.h.

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

_grad_vars

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

protected

Definition at line 35 of file TotalFreeEnergyBase.h.

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

_kappa_names

std::vector<MaterialPropertyName> TotalFreeEnergyBase::_kappa_names

protected

Gradient free energy prefactor kappa.

Definition at line 38 of file TotalFreeEnergyBase.h.

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

_nkappas

unsigned int TotalFreeEnergyBase::_nkappas

protected

Definition at line 39 of file TotalFreeEnergyBase.h.

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

_nvars

unsigned int TotalFreeEnergyBase::_nvars

protected

Coupled interface variables.

Definition at line 33 of file TotalFreeEnergyBase.h.

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

_vars

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

protected

Definition at line 34 of file TotalFreeEnergyBase.h.

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

---

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

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