TotalFreeEnergy 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 <TotalFreeEnergy.h>

Inheritance diagram for TotalFreeEnergy:

Public Member Functions
	TotalFreeEnergy (const InputParameters &parameters)

Protected Member Functions
virtual Real	computeValue ()

Protected Attributes
const MaterialProperty< Real > &	_F
	Bulk free energy material property. 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

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 TotalFreeEnergy.h.

Constructor & Destructor Documentation

TotalFreeEnergy()

TotalFreeEnergy::TotalFreeEnergy

(

const InputParameters &

parameters

)

Definition at line 30 of file TotalFreeEnergy.C.

  : TotalFreeEnergyBase(parameters), _F(getMaterialProperty<Real>("f_name")), _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 TotalFreeEnergy");
 
  // Assign kappa values
  for (unsigned int i = 0; i < _nkappas; ++i)
    _kappas[i] = &getMaterialPropertyByName<Real>(_kappa_names[i]);
}

Member Function Documentation

computeValue()

Real TotalFreeEnergy::computeValue ( )

protectedvirtual

Implements TotalFreeEnergyBase.

Definition at line 44 of file TotalFreeEnergy.C.

{
  // Include bulk energy contribution and additional contributions
  Real total_energy = _F[_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(), computeValue(), KKSMultiFreeEnergy::computeValue(), and KKSGlobalFreeEnergy::computeValue().

_F

const MaterialProperty<Real>& TotalFreeEnergy::_F

protected

Bulk free energy material property.

Definition at line 33 of file TotalFreeEnergy.h.

Referenced by computeValue().

_grad_vars

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

protectedinherited

Definition at line 35 of file TotalFreeEnergyBase.h.

Referenced by CrossTermGradientFreeEnergy::computeValue(), computeValue(), KKSMultiFreeEnergy::computeValue(), KKSGlobalFreeEnergy::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::KKSGlobalFreeEnergy(), KKSMultiFreeEnergy::KKSMultiFreeEnergy(), and TotalFreeEnergy().

_kappas

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

protected

Gradient interface free energy coefficients.

Definition at line 36 of file TotalFreeEnergy.h.

Referenced by computeValue(), and TotalFreeEnergy().

_nkappas

unsigned int TotalFreeEnergyBase::_nkappas

protectedinherited

Definition at line 39 of file TotalFreeEnergyBase.h.

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

_nvars

unsigned int TotalFreeEnergyBase::_nvars

protectedinherited

Coupled interface variables.

Definition at line 33 of file TotalFreeEnergyBase.h.

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

_vars

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

protectedinherited

Definition at line 34 of file TotalFreeEnergyBase.h.

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

---

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

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