adToolInterface.h

Go to the documentation of this file.

/*
 * MeDiPack, a Message Differentiation Package
 *
 * Copyright (C) 2015-2026 Chair for Scientific Computing (SciComp), University of Kaiserslautern-Landau
 * Homepage: http://scicomp.rptu.de
 * Contact:  Prof. Nicolas R. Gauger (codi@scicomp.uni-kl.de)
 *
 * Lead developers: Max Sagebaum (SciComp, University of Kaiserslautern-Landau)
 *
 * This file is part of MeDiPack (http://scicomp.rptu.de/software/medi).
 *
 * MeDiPack is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation, either
 * version 3 of the License, or (at your option) any later version.
 *
 * MeDiPack is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * See the GNU Lesser General Public License for more details.
 * You should have received a copy of the GNU
 * Lesser General Public License along with MeDiPack.
 * If not, see <http://www.gnu.org/licenses/>.
 *
 * Authors: Max Sagebaum, Tim Albring (SciComp, University of Kaiserslautern-Landau)
 */
 
#pragma once
 
#include "ampi/op.hpp"
#include "typeDefinitions.h"

namespace medi {

  class ADToolInterface {
 
      MPI_Datatype primalMpiType;
      MPI_Datatype adjointMpiType;
 
    public:

      typedef void Type;

      typedef void ModifiedType;

      typedef void AdjointType;

      typedef void PrimalType;

      typedef void IndexType;

      ADToolInterface(MPI_Datatype primalMpiType, MPI_Datatype adjointMpiType) :
        primalMpiType(primalMpiType),
        adjointMpiType(adjointMpiType) {}
 
      virtual ~ADToolInterface() {}
 

      MPI_Datatype getPrimalMpiType() const {
        return primalMpiType;
      }

      MPI_Datatype getAdjointMpiType() const {
        return adjointMpiType;
      }

      virtual bool isActiveType() const = 0;

      virtual bool isHandleRequired() const  = 0;

      virtual bool isModifiedBufferRequired() const = 0;

      virtual bool isOldPrimalsRequired() const = 0;

      virtual void startAssembly(HandleBase* h) const = 0;

      virtual void stopAssembly(HandleBase* h) const = 0;

      virtual void addToolAction(HandleBase* h) const = 0;

      virtual AMPI_Op convertOperator(AMPI_Op op) const = 0;

      virtual void createPrimalTypeBuffer(void* &buf, size_t size) const = 0;

      virtual void createIndexTypeBuffer(void* &buf, size_t size) const = 0;

      virtual void deletePrimalTypeBuffer(void* &buf) const = 0;

      virtual void deleteIndexTypeBuffer(void* &buf) const = 0;

      virtual void iterateIdentifiers(void* indices, int elements, CallbackFunc func, void* userData) const = 0;
 
  };

  struct StaticADToolInterface : public ADToolInterface {

      typedef double Type;

      typedef double ModifiedType;

      typedef double PrimalType;

      typedef double AdjointType;

      typedef int IndexType;

      static void setIntoModifyBuffer(ModifiedType& modValue, const Type& value);

      static void getFromModifyBuffer(const ModifiedType& modValue, Type& value);

      static IndexType getIndex(const Type& value);

      static void registerValue(Type& value, PrimalType& oldPrimal, IndexType& index);

      static void clearIndex(Type& value);

      static void createIndex(Type& value, IndexType& index);

      static PrimalType getValue(const Type& value);
  };
 

  template <typename Impl, typename AdjointTypeB, typename PrimalTypeB, typename IndexTypeB>
  class ADToolBase : public ADToolInterface {
    public:
 
      using CallbackFuncTyped = void (*)(IndexTypeB* id, void* userData);

      ADToolBase(MPI_Datatype primalMpiType, MPI_Datatype adjointMpiType) :
        ADToolInterface(primalMpiType, adjointMpiType) {}
 
      void createPrimalTypeBuffer(void* &buf, size_t size) const {
        cast().createPrimalTypeBuffer(castBuffer<PrimalTypeB>(buf), size);
      }
 
      void createIndexTypeBuffer(void* &buf, size_t size) const {
        cast().createIndexTypeBuffer(castBuffer<IndexTypeB>(buf), size);
      }
 
      void deletePrimalTypeBuffer(void* &buf) const {
        cast().deletePrimalTypeBuffer(castBuffer<PrimalTypeB>(buf));
      }
 
      void deleteIndexTypeBuffer(void* &buf) const {
        cast().deleteIndexTypeBuffer(castBuffer<IndexTypeB>(buf));
      }
 
      void iterateIdentifiers(void* indices, int elements, CallbackFunc func, void* userData) const {
        cast().iterateIdentifiers(castBuffer<IndexTypeB>(indices), elements, (CallbackFuncTyped)func, userData);
      }
 
 
    private:
 
      inline Impl& cast() {
        return *reinterpret_cast<Impl*>(this);
      }
 
      inline const Impl& cast() const {
        return *reinterpret_cast<const Impl*>(this);
      }
 
      template <typename T>
      inline T*& castBuffer(void*& buf) const {
        return reinterpret_cast<T*&>(buf);
      }
 
      template <typename T>
      inline const T*& castBuffer(const void* &buf) const {
        return reinterpret_cast<const T*&>(buf);
      }
  };
 
  inline ADToolInterface const* selectADTool(ADToolInterface const& tool) {
    return &tool;
  }
 
  inline ADToolInterface const* selectADTool(ADToolInterface const& toolA, ADToolInterface const& toolB) {
    return toolA.isActiveType() ? &toolA : &toolB;
  }
}