Cross term gradient free energy contribution used by ACMultiInterface. More...

#include <CrossTermGradientFreeEnergy.h>

Inheritance diagram for CrossTermGradientFreeEnergy:

Public Member Functions
	CrossTermGradientFreeEnergy (const InputParameters &parameters)

Protected Member Functions
virtual Real	computeValue ()

Protected Attributes
std::vector< std::vector< const MaterialProperty< Real > * > >	_kappas

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

Cross term gradient free energy contribution used by ACMultiInterface.

Definition at line 23 of file CrossTermGradientFreeEnergy.h.

Constructor & Destructor Documentation

◆ CrossTermGradientFreeEnergy()

CrossTermGradientFreeEnergy::CrossTermGradientFreeEnergy ( const InputParameters & parameters )

Definition at line 27 of file CrossTermGradientFreeEnergy.C.

   : TotalFreeEnergyBase(parameters), _kappas(_nvars)
 {
   // Error check to ensure size of interfacial_vars is the same as kappa_names
   if (_nvars * _nvars != _nkappas)
     paramError("kappa_names",
                "Size of interfacial_vars squared is not equal to the size of kappa_names in "
                "CrossTermGradientFreeEnergy");
  
   // Assign kappa values
   for (unsigned int i = 0; i < _nvars; ++i)
   {
     _kappas[i].resize(_nvars);
  
     for (unsigned int j = 0; j < _nvars; ++j)
       _kappas[i][j] = &getMaterialPropertyByName<Real>(_kappa_names[i * _nvars + j]);
   }
 }

Member Function Documentation

◆ computeValue()

Real CrossTermGradientFreeEnergy::computeValue ( )

protectedvirtual

Implements TotalFreeEnergyBase.

Definition at line 47 of file CrossTermGradientFreeEnergy.C.

 {
   // This kernel does _not_ include the bulk energy contribution.
   // It is to be used as an additional free energy component in TotalFreeEnergy.
   // additional_free_energy can be used to daisy chain contributions!
   Real total_energy = _additional_free_energy[_qp];
  
   // Calculate interfacial energy of each variable combination
   for (unsigned int i = 0; i < _nvars; ++i)
     for (unsigned int j = 0; j < i; ++j)
     {
       const RealGradient cross =
           (*_vars[i])[_qp] * (*_grad_vars[j])[_qp] + (*_vars[j])[_qp] * (*_grad_vars[i])[_qp];
       total_energy += (*_kappas[i][j])[_qp] / 2.0 * cross * cross;
     }
   return total_energy;
 }