MathFreeEnergy Class Reference

Material class that creates the math free energy and its derivatives for use with CHParsed and SplitCHParsed. More...

#include <MathFreeEnergy.h>

Inheritance diagram for MathFreeEnergy:

Public Member Functions
	MathFreeEnergy (const InputParameters &parameters)

Protected Member Functions
virtual Real	computeF ()
virtual Real	computeDF (unsigned int j_var)
virtual Real	computeD2F (unsigned int j_var, unsigned int k_var)
virtual Real	computeD3F (unsigned int j_var, unsigned int k_var, unsigned int l_var)

Private Attributes
const VariableValue &	_c
	Coupled variable value for the concentration \( c \). More...
unsigned int	_c_var

Detailed Description

Material class that creates the math free energy and its derivatives for use with CHParsed and SplitCHParsed.

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

Definition at line 24 of file MathFreeEnergy.h.

Constructor & Destructor Documentation

MathFreeEnergy()

MathFreeEnergy::MathFreeEnergy

(

const InputParameters &

parameters

)

Definition at line 25 of file MathFreeEnergy.C.

  : DerivativeFunctionMaterialBase(parameters), _c(coupledValue("c")), _c_var(coupled("c"))
{
}

Member Function Documentation

computeD2F()

Real MathFreeEnergy::computeD2F ( unsigned int  j_var, unsigned int  k_var  )

protectedvirtual

Definition at line 47 of file MathFreeEnergy.C.

{
  if ((j_var == _c_var) && (k_var == _c_var))
    return 3 * _c[_qp] * _c[_qp] - 1.0;
  else
    return 0.0;
}

computeD3F()

Real MathFreeEnergy::computeD3F ( unsigned int  j_var, unsigned int  k_var, unsigned int  l_var  )

protectedvirtual

Definition at line 56 of file MathFreeEnergy.C.

{
  if ((j_var == _c_var) && (k_var == _c_var) && (l_var == _c_var))
    return 6 * _c[_qp];
  else
    return 0.0;
}

computeDF()

Real MathFreeEnergy::computeDF ( unsigned int  j_var )

protectedvirtual

Definition at line 37 of file MathFreeEnergy.C.

{
  if (j_var == _c_var) // Note that these checks are only really necessary when the material has
                       // more than one coupled variable
    return _c[_qp] * (_c[_qp] * _c[_qp] - 1.0);
  else
    return 0.0;
}

computeF()

Real MathFreeEnergy::computeF ( )

protectedvirtual

Definition at line 31 of file MathFreeEnergy.C.

{
  return 1.0 / 4.0 * (1.0 + _c[_qp]) * (1.0 + _c[_qp]) * (1.0 - _c[_qp]) * (1.0 - _c[_qp]);
}

Member Data Documentation

_c

const VariableValue& MathFreeEnergy::_c

private

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

Definition at line 37 of file MathFreeEnergy.h.

Referenced by computeD2F(), computeD3F(), computeDF(), and computeF().

_c_var

unsigned int MathFreeEnergy::_c_var

private

Definition at line 38 of file MathFreeEnergy.h.

Referenced by computeD2F(), computeD3F(), and computeDF().

---

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

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