ADMathFreeEnergy< compute_stage > Class Template Reference

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

#include <ADMathFreeEnergy.h>

Inheritance diagram for ADMathFreeEnergy< compute_stage >:

Public Member Functions
	ADMathFreeEnergy (const InputParameters &parameters)

Protected Member Functions
virtual void	computeQpProperties ()
	ADMaterialProperty (Real) &_prop_F
	function value More...
	ADMaterialProperty (Real) &_prop_dFdc
	function value derivative More...

Protected Attributes
const ADVariableValue &	_c
	Coupled variable value for the concentration \( c \). More...
const MaterialPropertyName	_f_name
	property name More...
	usingMaterialMembers

Detailed Description

template<ComputeStage compute_stage>
class ADMathFreeEnergy< compute_stage >

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

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

Definition at line 17 of file ADMathFreeEnergy.h.

Constructor & Destructor Documentation

ADMathFreeEnergy()

template<ComputeStage compute_stage>

ADMathFreeEnergy< compute_stage >::ADMathFreeEnergy

(

const InputParameters &

parameters

)

Definition at line 23 of file ADMathFreeEnergy.C.

  : ADMaterial<compute_stage>(parameters),
    _c(adCoupledValue("c")),
    _f_name(getParam<MaterialPropertyName>("f_name")),
    _prop_F(declareADProperty<Real>(_f_name)),
    _prop_dFdc(
        declareADProperty<Real>(derivativePropertyNameFirst(_f_name, this->getVar("c", 0)->name())))
{
}

Member Function Documentation

ADMaterialProperty() [1/2]

template<ComputeStage compute_stage>

ADMathFreeEnergy< compute_stage >::ADMaterialProperty ( Real  ) &

protected

function value derivative

ADMaterialProperty() [2/2]

template<ComputeStage compute_stage>

ADMathFreeEnergy< compute_stage >::ADMaterialProperty ( Real  ) &

protected

function value

computeQpProperties()

template<ComputeStage compute_stage>

void ADMathFreeEnergy< compute_stage >::computeQpProperties ( )

protectedvirtual

Definition at line 35 of file ADMathFreeEnergy.C.

{
  _prop_F[_qp] = 1.0 / 4.0 * (1.0 + _c[_qp]) * (1.0 + _c[_qp]) * (1.0 - _c[_qp]) * (1.0 - _c[_qp]);
  _prop_dFdc[_qp] = _c[_qp] * (_c[_qp] * _c[_qp] - 1.0);
}

Member Data Documentation

_c

template<ComputeStage compute_stage>

const ADVariableValue& ADMathFreeEnergy< compute_stage >::_c

protected

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

Definition at line 36 of file ADMathFreeEnergy.h.

_f_name

template<ComputeStage compute_stage>

const MaterialPropertyName ADMathFreeEnergy< compute_stage >::_f_name

protected

property name

Definition at line 39 of file ADMathFreeEnergy.h.

usingMaterialMembers

template<ComputeStage compute_stage>

ADMathFreeEnergy< compute_stage >::usingMaterialMembers

protected

Definition at line 47 of file ADMathFreeEnergy.h.

---

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

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