ADTestDerivativeFunction< compute_stage > Class Template Reference

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

#include <ADTestDerivativeFunction.h>

Inheritance diagram for ADTestDerivativeFunction< compute_stage >:

Public Member Functions
	ADTestDerivativeFunction (const InputParameters &parameters)

Protected Types
enum	FunctionEnum { FunctionEnum::F1, FunctionEnum::F2, FunctionEnum::F3 }

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

Protected Attributes
enum ADTestDerivativeFunction::FunctionEnum	_function
std::vector< const ADVariableValue * >	_op
	Coupled variable value for the order parameter. More...
const MaterialPropertyName	_f_name
	property name More...
std::vector< ADMaterialProperty(Real) * >	_prop_dFdop
	function value derivative More...
	usingMaterialMembers

Detailed Description

template<ComputeStage compute_stage>
class ADTestDerivativeFunction< 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 ADTestDerivativeFunction.h.

Member Enumeration Documentation

FunctionEnum

template<ComputeStage compute_stage>

enum ADTestDerivativeFunction::FunctionEnum

strongprotected

Enumerator
F1
F2
F3

Definition at line 35 of file ADTestDerivativeFunction.h.

  {
    F1,
    F2,
    F3
  } _function;

Constructor & Destructor Documentation

ADTestDerivativeFunction()

template<ComputeStage compute_stage>

ADTestDerivativeFunction< compute_stage >::ADTestDerivativeFunction

(

const InputParameters &

parameters

)

Definition at line 29 of file ADTestDerivativeFunction.C.

  : ADMaterial<compute_stage>(parameters),
    _function(getParam<MooseEnum>("function").template getEnum<FunctionEnum>()),
    _op(coupledComponents("op")),
    _f_name(getParam<MaterialPropertyName>("f_name")),
    _prop_F(declareADProperty<Real>(_f_name)),
    _prop_dFdop(coupledComponents("op"))
{
  for (std::size_t i = 0; i < _op.size(); ++i)
  {
    _op[i] = &adCoupledValue("op", i);
    _prop_dFdop[i] = &declareADProperty<Real>(
        derivativePropertyNameFirst(_f_name, this->getVar("op", i)->name()));
  }
 
  if (_function == FunctionEnum::F1 && _op.size() != 1)
    paramError("op", "Specify exactly one variable to an F1 type function.");
  if (_function == FunctionEnum::F2 && _op.size() != 2)
    paramError("op", "Specify exactly two variables to an F2 type function.");
  if (_function == FunctionEnum::F3 && _op.size() != 2)
    paramError("op", "Specify exactly two variables to an F3 type function.");
}

Member Function Documentation

ADMaterialProperty()

template<ComputeStage compute_stage>

ADTestDerivativeFunction< compute_stage >::ADMaterialProperty ( Real  ) &

protected

function value

computeQpProperties()

template<ComputeStage compute_stage>

void ADTestDerivativeFunction< compute_stage >::computeQpProperties ( )

protectedvirtual

Definition at line 55 of file ADTestDerivativeFunction.C.

{
  const ADReal & a = (*_op[0])[_qp];
 
  switch (_function)
  {
    case FunctionEnum::F1:
      _prop_F[_qp] = 2.0 * a * a * (1.0 - a) * (1.0 - a) - 0.2 * a;
      (*_prop_dFdop[0])[_qp] = 4.0 * a * a * (a - 1.0) + 4.0 * a * (1.0 - a) * (1.0 - a) - 0.2;
      break;
 
    case FunctionEnum::F2:
    {
      const ADReal & b = (*_op[1])[_qp];
      _prop_F[_qp] = 0.1 * a * a + b * b;
      (*_prop_dFdop[0])[_qp] = 0.2 * a;
      (*_prop_dFdop[1])[_qp] = 2.0 * b;
      break;
    }
 
    case FunctionEnum::F3:
    {
      const ADReal & b = (*_op[1])[_qp];
      _prop_F[_qp] = a * b;
      (*_prop_dFdop[0])[_qp] = b;
      (*_prop_dFdop[1])[_qp] = a;
      break;
    }
 
    default:
      mooseError("Invalid function enum value");
  }
}

Member Data Documentation

_f_name

template<ComputeStage compute_stage>

const MaterialPropertyName ADTestDerivativeFunction< compute_stage >::_f_name

protected

property name

Definition at line 46 of file ADTestDerivativeFunction.h.

Referenced by ADTestDerivativeFunction< compute_stage >::ADTestDerivativeFunction().

_function

template<ComputeStage compute_stage>

enum ADTestDerivativeFunction::FunctionEnum ADTestDerivativeFunction< compute_stage >::_function

protected

Referenced by ADTestDerivativeFunction< compute_stage >::ADTestDerivativeFunction().

_op

template<ComputeStage compute_stage>

std::vector<const ADVariableValue *> ADTestDerivativeFunction< compute_stage >::_op

protected

Coupled variable value for the order parameter.

Definition at line 43 of file ADTestDerivativeFunction.h.

Referenced by ADTestDerivativeFunction< compute_stage >::ADTestDerivativeFunction().

_prop_dFdop

template<ComputeStage compute_stage>

std::vector<ADMaterialProperty(Real) *> ADTestDerivativeFunction< compute_stage >::_prop_dFdop

protected

function value derivative

Definition at line 52 of file ADTestDerivativeFunction.h.

Referenced by ADTestDerivativeFunction< compute_stage >::ADTestDerivativeFunction().

usingMaterialMembers

template<ComputeStage compute_stage>

ADTestDerivativeFunction< compute_stage >::usingMaterialMembers

protected

Definition at line 54 of file ADTestDerivativeFunction.h.

---

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

• phase_field/test/include/materials/ADTestDerivativeFunction.h
• phase_field/test/src/materials/ADTestDerivativeFunction.C