www.mooseframework.org
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TotalFreeEnergyBase Class Referenceabstract

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:
[legend]

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 25 of file TotalFreeEnergyBase.h.

Constructor & Destructor Documentation

◆ TotalFreeEnergyBase()

TotalFreeEnergyBase::TotalFreeEnergyBase ( const InputParameters &  parameters)

Definition at line 25 of file TotalFreeEnergyBase.C.

26  : AuxKernel(parameters),
27  _nvars(coupledComponents("interfacial_vars")),
28  _vars(_nvars),
30  _kappa_names(getParam<std::vector<MaterialPropertyName>>("kappa_names")),
31  _nkappas(_kappa_names.size()),
32  _additional_free_energy(coupledValue("additional_free_energy"))
33 {
34  // Fetch coupled variables and their gradients
35  for (unsigned int i = 0; i < _nvars; ++i)
36  {
37  _vars[i] = &coupledValue("interfacial_vars", i);
38  _grad_vars[i] = &coupledGradient("interfacial_vars", i);
39  }
40 }
unsigned int _nvars
Coupled interface variables.
const VariableValue & _additional_free_energy
Additional free energy contribution.
std::vector< const VariableGradient * > _grad_vars
std::vector< const VariableValue * > _vars
std::vector< MaterialPropertyName > _kappa_names
Gradient free energy prefactor kappa.

Member Function Documentation

◆ computeValue()

virtual Real TotalFreeEnergyBase::computeValue ( )
protectedpure virtual

Member Data Documentation

◆ _additional_free_energy

const VariableValue& TotalFreeEnergyBase::_additional_free_energy
protected

◆ _grad_vars

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

◆ _kappa_names

std::vector<MaterialPropertyName> TotalFreeEnergyBase::_kappa_names
protected

◆ _nkappas

unsigned int TotalFreeEnergyBase::_nkappas
protected

◆ _nvars

unsigned int TotalFreeEnergyBase::_nvars
protected

◆ _vars

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

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