ADWrapperFunctor.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 "MooseFunctor.h"

namespace Moose
{
template <typename T>
class ADWrapperFunctor : public FunctorBase<T>
{
public:
  using typename Moose::FunctorBase<T>::ValueType;
  using typename Moose::FunctorBase<T>::GradientType;
  using typename Moose::FunctorBase<T>::DotType;

  ADWrapperFunctor(const FunctorBase<typename MetaPhysicL::RawType<T>::value_type> & non_ad_functor)
    : FunctorBase<T>(non_ad_functor.functorName() + "_ad_ified", {EXEC_ALWAYS}),
      _non_ad_functor(non_ad_functor)
  {
  }

  virtual bool isExtrapolatedBoundaryFace(const FaceInfo & fi,
                                          const Elem * const elem,
                                          const Moose::StateArg & state) const override
  {
    return _non_ad_functor.isExtrapolatedBoundaryFace(fi, elem, state);
  }
  virtual bool isConstant() const override { return _non_ad_functor.isConstant(); }
  virtual bool hasBlocks(const SubdomainID id) const override
  {
    return _non_ad_functor.hasBlocks(id);
  }
  virtual bool hasFaceSide(const FaceInfo & fi, const bool fi_elem_side) const override
  {
    return _non_ad_functor.hasFaceSide(fi, fi_elem_side);
  }

  bool supportsFaceArg() const override final { return _non_ad_functor.supportsFaceArg(); }
  bool supportsElemSideQpArg() const override final
  {
    return _non_ad_functor.supportsElemSideQpArg();
  }

protected:

  ValueType evaluate(const ElemArg & elem, const StateArg & state) const override
  {
    return _non_ad_functor(elem, state);
  }
  ValueType evaluate(const FaceArg & face, const StateArg & state) const override
  {
    return _non_ad_functor(face, state);
  }
  ValueType evaluate(const ElemQpArg & qp, const StateArg & state) const override
  {
    return _non_ad_functor(qp, state);
  }
  ValueType evaluate(const ElemSideQpArg & qp, const StateArg & state) const override
  {
    return _non_ad_functor(qp, state);
  }
  ValueType evaluate(const ElemPointArg & elem_point, const StateArg & state) const override
  {
    return _non_ad_functor(elem_point, state);
  }
  ValueType evaluate(const NodeArg & node, const StateArg & state) const override
  {
    return _non_ad_functor(node, state);
  }

  GradientType evaluateGradient(const ElemArg & elem, const StateArg & state) const override
  {
    return _non_ad_functor.gradient(elem, state);
  }
  GradientType evaluateGradient(const FaceArg & face, const StateArg & state) const override
  {
    return _non_ad_functor.gradient(face, state);
  }
  GradientType evaluateGradient(const ElemQpArg & qp, const StateArg & state) const override
  {
    return _non_ad_functor.gradient(qp, state);
  }
  GradientType evaluateGradient(const ElemSideQpArg & qp, const StateArg & state) const override
  {
    return _non_ad_functor.gradient(qp, state);
  }
  GradientType evaluateGradient(const ElemPointArg & elem_point,
                                const StateArg & state) const override
  {
    return _non_ad_functor.gradient(elem_point, state);
  }
  GradientType evaluateGradient(const NodeArg & node, const StateArg & state) const override
  {
    return _non_ad_functor.gradient(node, state);
  }

  DotType evaluateDot(const ElemArg & elem, const StateArg & state) const override
  {
    return _non_ad_functor.dot(elem, state);
  }
  DotType evaluateDot(const FaceArg & face, const StateArg & state) const override
  {
    return _non_ad_functor.dot(face, state);
  }
  DotType evaluateDot(const ElemQpArg & qp, const StateArg & state) const override
  {
    return _non_ad_functor.dot(qp, state);
  }
  DotType evaluateDot(const ElemSideQpArg & qp, const StateArg & state) const override
  {
    return _non_ad_functor.dot(qp, state);
  }
  DotType evaluateDot(const ElemPointArg & elem_point, const StateArg & state) const override
  {
    return _non_ad_functor.dot(elem_point, state);
  }
  DotType evaluateDot(const NodeArg & node, const StateArg & state) const override
  {
    return _non_ad_functor.dot(node, state);
  }

  GradientType evaluateGradDot(const ElemArg & elem, const StateArg & state) const override
  {
    return _non_ad_functor.gradDot(elem, state);
  }
  GradientType evaluateGradDot(const FaceArg & face, const StateArg & state) const override
  {
    return _non_ad_functor.gradDot(face, state);
  }
  GradientType evaluateGradDot(const ElemQpArg & qp, const StateArg & state) const override
  {
    return _non_ad_functor.gradDot(qp, state);
  }
  GradientType evaluateGradDot(const ElemSideQpArg & qp, const StateArg & state) const override
  {
    return _non_ad_functor.gradDot(qp, state);
  }
  GradientType evaluateGradDot(const ElemPointArg & elem_point,
                               const StateArg & state) const override
  {
    return _non_ad_functor.gradDot(elem_point, state);
  }
  GradientType evaluateGradDot(const NodeArg & node, const StateArg & state) const override
  {
    return _non_ad_functor.gradDot(node, state);
  }

private:
  const FunctorBase<typename MetaPhysicL::RawType<T>::value_type> & _non_ad_functor;
};
}