ADAllenCahnBase.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* 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 "DerivativeMaterialPropertyNameInterface.h"

#define usingAllenCahnBaseMembers(T)                                                               \
  usingKernelValueMembers;                                                                         \
  using ADAllenCahnBase<compute_stage, T>::_prop_L;                                                \
  using ADAllenCahnBase<compute_stage, T>::computeDFDOP

// Forward declarations
template <ComputeStage compute_stage, typename T = void>
class ADAllenCahnBase;

declareADValidParams(ADAllenCahnBase);

template <ComputeStage compute_stage, typename T>
class ADAllenCahnBase : public ADKernelValue<compute_stage>,
                        public DerivativeMaterialPropertyNameInterface
{
public:
  ADAllenCahnBase(const InputParameters & parameters);

  static InputParameters validParams();

protected:
  virtual ADReal precomputeQpResidual();

  virtual ADReal computeDFDOP() = 0;

  const ADMaterialProperty(T) & _prop_L;

  usingKernelValueMembers;
};

template <ComputeStage compute_stage, typename T>
ADAllenCahnBase<compute_stage, T>::ADAllenCahnBase(const InputParameters & parameters)
  : ADKernelValue<compute_stage>(parameters),
    DerivativeMaterialPropertyNameInterface(),
    _prop_L(adGetADMaterialProperty<T>("mob_name"))
{
}

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