Compute the free energy in the multi-phase KKS Model \( F = \sum_i h_i F_i + + wg_i + \frac{\kappa}{2}|\eta_i|^2 \). More...

#include <KKSMultiFreeEnergy.h>

Inheritance diagram for KKSMultiFreeEnergy:

[legend]

Public Member Functions
	KKSMultiFreeEnergy (const InputParameters &parameters)

Protected Member Functions
virtual Real	computeValue ()

Protected Attributes
std::vector< MaterialPropertyName >	_Fj_names
	Names of free energy functions for each phase \( F_j \). More...

const unsigned int	_num_j

std::vector< const MaterialProperty< Real > * >	_prop_Fj
	Values of the free energy functions for each phase \( F_j \). More...

std::vector< MaterialPropertyName >	_hj_names
	Switching function names. More...

std::vector< const MaterialProperty< Real > * >	_prop_hj
	Values of the switching functions for each phase \( h_j \). More...

std::vector< MaterialPropertyName >	_gj_names
	Barrier function names. More...

std::vector< const MaterialProperty< Real > * >	_prop_gj
	Values of the barrier functions for each phase \( g_j \). More...

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 free energy in the multi-phase KKS Model \( F = \sum_i h_i F_i + + wg_i + \frac{\kappa}{2}|\eta_i|^2 \).

Definition at line 25 of file KKSMultiFreeEnergy.h.

Constructor & Destructor Documentation

◆ KKSMultiFreeEnergy()

KKSMultiFreeEnergy::KKSMultiFreeEnergy ( const InputParameters & parameters )

Definition at line 39 of file KKSMultiFreeEnergy.C.

   : TotalFreeEnergyBase(parameters),
     _Fj_names(getParam<std::vector<MaterialPropertyName>>("Fj_names")),
     _num_j(_Fj_names.size()),
     _prop_Fj(_num_j),
     _hj_names(getParam<std::vector<MaterialPropertyName>>("hj_names")),
     _prop_hj(_num_j),
     _gj_names(getParam<std::vector<MaterialPropertyName>>("gj_names")),
     _prop_gj(_num_j),
     _w(getParam<Real>("w")),
     _kappas(_nkappas)
 {
   // Check that same number of Fj, hj, and gj are passed in
   if (_hj_names.size() != _num_j)
     mooseError("Size of hj_names is not equal to size of Fj_names in KKSMultiFreeEnergy AuxKernel ",
                name());
   if (_gj_names.size() != _num_j)
     mooseError("Size of gj_names is not equal to size of Fj_names in KKSMultiFreeEnergy AuxKernel ",
                name());
  
   // get bulk properties
   for (unsigned int i = 0; i < _num_j; ++i)
   {
     _prop_Fj[i] = &getMaterialPropertyByName<Real>(_Fj_names[i]);
     _prop_hj[i] = &getMaterialPropertyByName<Real>(_hj_names[i]);
     _prop_gj[i] = &getMaterialPropertyByName<Real>(_gj_names[i]);
   }
  
   // 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 "
                "KKSMultiFreeEnergy AuxKernel ",
                name());
  
   // Assign kappa values
   for (unsigned int i = 0; i < _nkappas; ++i)
     _kappas[i] = &getMaterialPropertyByName<Real>(_kappa_names[i]);
 }

Member Function Documentation

◆ computeValue()

Real KKSMultiFreeEnergy::computeValue ( )

protectedvirtual

Implements TotalFreeEnergyBase.

Definition at line 79 of file KKSMultiFreeEnergy.C.

 {
   // Start with any additional energy contribution, which is 0 if not supplied
   Real total_energy = _additional_free_energy[_qp];
   // Add bulk energy contributions
   for (unsigned int i = 0; i < _num_j; ++i)
     total_energy += (*_prop_hj[i])[_qp] * (*_prop_Fj[i])[_qp] + _w * (*_prop_gj[i])[_qp];
  
   // Add 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(), computeValue(), and KKSGlobalFreeEnergy::computeValue().

◆ _Fj_names

std::vector<MaterialPropertyName> KKSMultiFreeEnergy::_Fj_names

protected

Names of free energy functions for each phase \( F_j \).

Definition at line 34 of file KKSMultiFreeEnergy.h.

Referenced by KKSMultiFreeEnergy().

◆ _gj_names

std::vector<MaterialPropertyName> KKSMultiFreeEnergy::_gj_names

protected

Barrier function names.

Definition at line 47 of file KKSMultiFreeEnergy.h.

Referenced by KKSMultiFreeEnergy().

◆ _grad_vars

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

protectedinherited

Definition at line 35 of file TotalFreeEnergyBase.h.

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

◆ _hj_names

std::vector<MaterialPropertyName> KKSMultiFreeEnergy::_hj_names

protected

Switching function names.

Definition at line 41 of file KKSMultiFreeEnergy.h.

Referenced by KKSMultiFreeEnergy().

◆ _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(), and TotalFreeEnergy::TotalFreeEnergy().

◆ _kappas

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

protected

Gradient interface free energy coefficients.

Definition at line 56 of file KKSMultiFreeEnergy.h.

Referenced by computeValue(), and KKSMultiFreeEnergy().

◆ _nkappas

unsigned int TotalFreeEnergyBase::_nkappas

protectedinherited

Definition at line 39 of file TotalFreeEnergyBase.h.

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

◆ _num_j

const unsigned int KKSMultiFreeEnergy::_num_j

protected

Definition at line 35 of file KKSMultiFreeEnergy.h.

Referenced by computeValue(), and KKSMultiFreeEnergy().

◆ _nvars

unsigned int TotalFreeEnergyBase::_nvars

protectedinherited

Coupled interface variables.

Definition at line 33 of file TotalFreeEnergyBase.h.

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

◆ _prop_Fj

std::vector<const MaterialProperty<Real> *> KKSMultiFreeEnergy::_prop_Fj

protected

Values of the free energy functions for each phase \( F_j \).

Definition at line 38 of file KKSMultiFreeEnergy.h.

Referenced by computeValue(), and KKSMultiFreeEnergy().

◆ _prop_gj

std::vector<const MaterialProperty<Real> *> KKSMultiFreeEnergy::_prop_gj

protected

Values of the barrier functions for each phase \( g_j \).

Definition at line 50 of file KKSMultiFreeEnergy.h.

Referenced by computeValue(), and KKSMultiFreeEnergy().

◆ _prop_hj

std::vector<const MaterialProperty<Real> *> KKSMultiFreeEnergy::_prop_hj

protected

Values of the switching functions for each phase \( h_j \).

Definition at line 44 of file KKSMultiFreeEnergy.h.

Referenced by computeValue(), and KKSMultiFreeEnergy().

◆ _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 KKSMultiFreeEnergy::_w

protected

Barrier term height.

Definition at line 53 of file KKSMultiFreeEnergy.h.

Referenced by computeValue().

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

phase_field/include/auxkernels/KKSMultiFreeEnergy.h
phase_field/src/auxkernels/KKSMultiFreeEnergy.C

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KKSMultiFreeEnergy()

Member Function Documentation

◆ computeValue()

Member Data Documentation

◆ _additional_free_energy

◆ _Fj_names

◆ _gj_names

◆ _grad_vars

◆ _hj_names

◆ _kappa_names

◆ _kappas

◆ _nkappas

◆ _num_j

◆ _nvars

◆ _prop_Fj

◆ _prop_gj

◆ _prop_hj

◆ _vars

◆ _w