ADAllenCahnBase< compute_stage, T > Class Template Reference

This is the Allen-Cahn equation base class that implements the bulk or local energy term of the equation. More...

#include <ADAllenCahnBase.h>

Inheritance diagram for ADAllenCahnBase< compute_stage, T >:

Public Member Functions
	ADAllenCahnBase (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual ADReal	precomputeQpResidual ()
virtual ADReal	computeDFDOP ()=0
	Compute the derivative of the bulk free energy w.r.t the order parameter. More...
const	ADMaterialProperty (T) &_prop_L
	Mobility. More...

Protected Attributes
	usingKernelValueMembers

Detailed Description

template<ComputeStage compute_stage, typename T>
class ADAllenCahnBase< compute_stage, T >

This is the Allen-Cahn equation base class that implements the bulk or local energy term of the equation.

It is templated on the type of the mobility, which can be either a number (Real) or a tensor (RealValueTensor). Note that the function computeDFDOP MUST be overridden in any kernel that inherits from ADAllenCahnBase. This is the AD equivalent of ACBulk<>.

Definition at line 23 of file ADAllenCahnBase.h.

Constructor & Destructor Documentation

ADAllenCahnBase()

template<ComputeStage compute_stage, typename T >

ADAllenCahnBase< compute_stage, T >::ADAllenCahnBase

(

const InputParameters &

parameters

)

Definition at line 56 of file ADAllenCahnBase.h.

  : ADKernelValue<compute_stage>(parameters),
    DerivativeMaterialPropertyNameInterface(),
    _prop_L(adGetADMaterialProperty<T>("mob_name"))
{
}

Member Function Documentation

ADMaterialProperty()

template<ComputeStage compute_stage, typename T>

const ADAllenCahnBase< compute_stage, T >::ADMaterialProperty ( T  ) &

protected

Mobility.

computeDFDOP()

template<ComputeStage compute_stage, typename T>

virtual ADReal ADAllenCahnBase< compute_stage, T >::computeDFDOP ( )

protectedpure virtual

Compute the derivative of the bulk free energy w.r.t the order parameter.

Implemented in ADAllenCahn< compute_stage >.

precomputeQpResidual()

template<ComputeStage compute_stage, typename T >

ADReal ADAllenCahnBase< compute_stage, T >::precomputeQpResidual ( )

protectedvirtual

Definition at line 65 of file ADAllenCahnBase.h.

{
  return _prop_L[_qp] * computeDFDOP();
}

validParams()

template<ComputeStage compute_stage, typename T>

static InputParameters ADAllenCahnBase< compute_stage, T >::validParams ( )

static

Member Data Documentation

usingKernelValueMembers

template<ComputeStage compute_stage, typename T>

ADAllenCahnBase< compute_stage, T >::usingKernelValueMembers

protected

Definition at line 52 of file ADAllenCahnBase.h.

---

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

• phase_field/include/kernels/ADAllenCahnBase.h