ADAllenCahnBase.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "ADKernelValue.h"
#include "JvarMapInterface.h"
#include "DerivativeMaterialInterface.h"

template <typename T>
class ADAllenCahnBase : public DerivativeMaterialInterface<JvarMapKernelInterface<ADKernelValue>>
{
public:
  ADAllenCahnBase(const InputParameters & parameters);

  static InputParameters validParams();

protected:
  virtual ADReal precomputeQpResidual();

  virtual ADReal computeDFDOP() = 0;

  const ADMaterialProperty<T> & _prop_L;
};

template <typename T>
InputParameters
ADAllenCahnBase<T>::validParams()
{
  InputParameters params = ADKernelValue::validParams();
  params.addClassDescription(
      "Allen-Cahn bulk contribution Kernel with forward mode automatic differentiation");
  params.addParam<MaterialPropertyName>("mob_name", "L", "The mobility used with the kernel");
  return params;
}

template <typename T>
ADAllenCahnBase<T>::ADAllenCahnBase(const InputParameters & parameters)
  : DerivativeMaterialInterface<JvarMapKernelInterface<ADKernelValue>>(parameters),
    _prop_L(getADMaterialProperty<T>("mob_name"))
{
}

template <typename T>
ADReal
ADAllenCahnBase<T>::precomputeQpResidual()
{
  return _prop_L[_qp] * computeDFDOP();
}