MathEBFreeEnergy Class Reference

Material class that creates the math free energy with the expression builder and uses automatic differentiation to get the derivatives. More...

#include <MathEBFreeEnergy.h>

Inheritance diagram for MathEBFreeEnergy:

Public Types
typedef std::vector< EBTerm >	EBTermList
typedef std::vector< EBTermNode * >	EBTermNodeList
typedef std::vector< const EBSubstitutionRule * >	EBSubstitutionRuleList

Public Member Functions
	MathEBFreeEnergy (const InputParameters &parameters)
	BINARYFUNC_OP_IMPLEMENT (+, ADD) BINARYFUNC_OP_IMPLEMENT(-
SUB BINARYFUNC_OP_IMPLEMENT MUL	BINARYFUNC_OP_IMPLEMENT (/, DIV) BINARYFUNC_OP_IMPLEMENT(%
SUB BINARYFUNC_OP_IMPLEMENT MUL MOD	BINARYFUNC_OP_IMPLEMENT (<, LESS) BINARYFUNC_OP_IMPLEMENT(>
SUB BINARYFUNC_OP_IMPLEMENT MUL MOD GREATER	BINARYFUNC_OP_IMPLEMENT (<=, LESSEQ) BINARYFUNC_OP_IMPLEMENT(>
SUB BINARYFUNC_OP_IMPLEMENT MUL MOD GREATER GREATEREQ	BINARYFUNC_OP_IMPLEMENT (==, EQ) BINARYFUNC_OP_IMPLEMENT(!

Protected Attributes
EBTerm	_c
	Coupled variable value for the concentration \( c \). More...

Detailed Description

Material class that creates the math free energy with the expression builder and uses automatic differentiation to get the derivatives.

\( F = \frac14 (1 + c)^2 (1 - c)^2 \).

Definition at line 26 of file MathEBFreeEnergy.h.

Member Typedef Documentation

EBSubstitutionRuleList

typedef std::vector<const EBSubstitutionRule *> ExpressionBuilder::EBSubstitutionRuleList

inherited

Definition at line 59 of file ExpressionBuilder.h.

EBTermList

typedef std::vector<EBTerm> ExpressionBuilder::EBTermList

inherited

Definition at line 56 of file ExpressionBuilder.h.

EBTermNodeList

typedef std::vector<EBTermNode *> ExpressionBuilder::EBTermNodeList

inherited

Definition at line 58 of file ExpressionBuilder.h.

Constructor & Destructor Documentation

MathEBFreeEnergy()

MathEBFreeEnergy::MathEBFreeEnergy

(

const InputParameters &

parameters

)

Definition at line 25 of file MathEBFreeEnergy.C.

  : DerivativeParsedMaterialHelper(parameters), _c("c")
{
  EBFunction free_energy;
  // Definition of the free energy for the expression builder
  free_energy(_c) = 1.0 / 4.0 * (1.0 + _c) * (1.0 + _c) * (1.0 - _c) * (1.0 - _c);
 
  // Parse function for automatic differentiation
  functionParse(free_energy);
}

Member Function Documentation

BINARYFUNC_OP_IMPLEMENT() [1/5]

ExpressionBuilder::BINARYFUNC_OP_IMPLEMENT ( +  , ADD    )

inherited

BINARYFUNC_OP_IMPLEMENT() [2/5]

SUB BINARYFUNC_OP_IMPLEMENT MUL ExpressionBuilder::BINARYFUNC_OP_IMPLEMENT ( /  , DIV    )

inherited

BINARYFUNC_OP_IMPLEMENT() [3/5]

SUB BINARYFUNC_OP_IMPLEMENT MUL MOD ExpressionBuilder::BINARYFUNC_OP_IMPLEMENT ( )

inherited

BINARYFUNC_OP_IMPLEMENT() [4/5]

SUB BINARYFUNC_OP_IMPLEMENT MUL MOD GREATER ExpressionBuilder::BINARYFUNC_OP_IMPLEMENT ( <=  , LESSEQ    )

inherited

BINARYFUNC_OP_IMPLEMENT() [5/5]

SUB BINARYFUNC_OP_IMPLEMENT MUL MOD GREATER GREATEREQ ExpressionBuilder::BINARYFUNC_OP_IMPLEMENT ( EQ  )

inherited

Member Data Documentation

_c

EBTerm MathEBFreeEnergy::_c

protected

Coupled variable value for the concentration \( c \).

Definition at line 33 of file MathEBFreeEnergy.h.

Referenced by MathEBFreeEnergy().

---

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

• phase_field/include/materials/MathEBFreeEnergy.h
• phase_field/src/materials/MathEBFreeEnergy.C