ADGrainGrowthBase< compute_stage > Class Template Reference

This is the base class for kernels that calculate the residual for grain growth. More...

#include <ADGrainGrowthBase.h>

Inheritance diagram for ADGrainGrowthBase< compute_stage >:

Public Member Functions
	ADGrainGrowthBase (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

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

Protected Attributes
const unsigned int	_op_num
std::vector< const ADVariableValue * >	_vals
	usingKernelValueMembers

Detailed Description

template<ComputeStage compute_stage>
class ADGrainGrowthBase< compute_stage >

This is the base class for kernels that calculate the residual for grain growth.

It calculates the residual of the ith order parameter, and the values of all other order parameters are coupled variables and are stored in vals. This is the AD equivalent of the ADGrainGrowthBase class.

Definition at line 22 of file ADGrainGrowthBase.h.

Constructor & Destructor Documentation

ADGrainGrowthBase()

template<ComputeStage compute_stage>

ADGrainGrowthBase< compute_stage >::ADGrainGrowthBase

(

const InputParameters &

parameters

)

Definition at line 18 of file ADGrainGrowthBase.C.

  : ADAllenCahnBase<compute_stage, Real>(parameters),
    _op_num(coupledComponents("v")),
    _vals(_op_num),
    _mu(getADMaterialProperty<Real>("mu"))
{
  // Loop through grains and load coupled variables into the arrays
  for (unsigned int i = 0; i < _op_num; ++i)
    _vals[i] = &adCoupledValue("v", i);
}

Member Function Documentation

ADMaterialProperty()

template<ComputeStage compute_stage>

const ADGrainGrowthBase< compute_stage >::ADMaterialProperty ( Real  ) &

protected

computeDFDOP()

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

protectedpure virtualinherited

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

Implemented in ADGrainGrowth< compute_stage >, and ADAllenCahn< compute_stage >.

precomputeQpResidual()

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

protectedvirtualinherited

Definition at line 64 of file ADAllenCahnBase.h.

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

usingAllenCahnBaseMembers()

template<ComputeStage compute_stage>

ADGrainGrowthBase< compute_stage >::usingAllenCahnBaseMembers ( Real  )

protected

validParams()

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

staticinherited

Member Data Documentation

_op_num

template<ComputeStage compute_stage>

const unsigned int ADGrainGrowthBase< compute_stage >::_op_num

protected

Definition at line 39 of file ADGrainGrowthBase.h.

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

_vals

template<ComputeStage compute_stage>

std::vector<const ADVariableValue *> ADGrainGrowthBase< compute_stage >::_vals

protected

Definition at line 40 of file ADGrainGrowthBase.h.

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

usingKernelValueMembers

ADAllenCahnBase< compute_stage, Real >::usingKernelValueMembers

protectedinherited

Definition at line 51 of file ADAllenCahnBase.h.

---

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

• phase_field/include/kernels/ADGrainGrowthBase.h
• phase_field/src/kernels/ADGrainGrowthBase.C