www.mooseframework.org
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ADAllenCahn< compute_stage > Class Template Reference

ADAllenCahn uses the Free Energy function and derivatives provided by a DerivativeParsedMaterial to computer the residual for the bulk part of the Allen-Cahn equation. More...

#include <ADAllenCahn.h>

Inheritance diagram for ADAllenCahn< compute_stage >:
[legend]

Public Member Functions

 ADAllenCahn (const InputParameters &parameters)
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Member Functions

virtual ADReal computeDFDOP ()
 Compute the derivative of the bulk free energy w.r.t the order parameter. More...
 
const ADMaterialProperty (Real) &_dFdEta
 
 usingAllenCahnBaseMembers (Real)
 
virtual ADReal precomputeQpResidual ()
 

Protected Attributes

const MaterialPropertyName _f_name
 
 usingKernelValueMembers
 

Detailed Description

template<ComputeStage compute_stage>
class ADAllenCahn< compute_stage >

ADAllenCahn uses the Free Energy function and derivatives provided by a DerivativeParsedMaterial to computer the residual for the bulk part of the Allen-Cahn equation.

Definition at line 17 of file ADAllenCahn.h.

Constructor & Destructor Documentation

◆ ADAllenCahn()

template<ComputeStage compute_stage>
ADAllenCahn< compute_stage >::ADAllenCahn ( const InputParameters &  parameters)

Definition at line 23 of file ADAllenCahn.C.

25  _f_name(adGetParam<MaterialPropertyName>("f_name")),
26  _dFdEta(adGetADMaterialProperty<Real>(this->derivativePropertyNameFirst(_f_name, _var.name())))
27 {
28 }
const MaterialPropertyName _f_name
Definition: ADAllenCahn.h:35

Member Function Documentation

◆ ADMaterialProperty()

template<ComputeStage compute_stage>
const ADAllenCahn< compute_stage >::ADMaterialProperty ( Real  ) &
protected

◆ computeDFDOP()

template<ComputeStage compute_stage>
ADReal ADAllenCahn< compute_stage >::computeDFDOP ( )
protectedvirtual

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

Implements ADAllenCahnBase< compute_stage, Real >.

Definition at line 32 of file ADAllenCahn.C.

33 {
34  return _dFdEta[_qp];
35 }

◆ precomputeQpResidual()

ADReal ADAllenCahnBase< compute_stage, Real >::precomputeQpResidual ( )
protectedvirtualinherited

Definition at line 65 of file ADAllenCahnBase.h.

66 {
67  return _prop_L[_qp] * computeDFDOP();
68 }
virtual ADReal computeDFDOP()=0
Compute the derivative of the bulk free energy w.r.t the order parameter.

◆ usingAllenCahnBaseMembers()

template<ComputeStage compute_stage>
ADAllenCahn< compute_stage >::usingAllenCahnBaseMembers ( Real  )
protected

◆ validParams()

static InputParameters ADAllenCahnBase< compute_stage, Real >::validParams ( )
staticinherited

Member Data Documentation

◆ _f_name

template<ComputeStage compute_stage>
const MaterialPropertyName ADAllenCahn< compute_stage >::_f_name
protected

Definition at line 35 of file ADAllenCahn.h.

◆ usingKernelValueMembers

ADAllenCahnBase< compute_stage, Real >::usingKernelValueMembers
protectedinherited

Definition at line 52 of file ADAllenCahnBase.h.


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