adToolImplCommon.hpp

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 "typeDefinitions.h"
#include "adToolInterface.h"

namespace medi {
 
  template <typename Impl, bool restorePrimal, bool modifiedBuffer, typename Type, typename AdjointType, typename PrimalType, typename IndexType>
  class ADToolImplCommon : public ADToolBase<Impl, AdjointType, PrimalType, IndexType> {
    public:
 
      using Base = ADToolBase<Impl, AdjointType, PrimalType, IndexType>;
 
      using CallbackFuncTyped = typename Base::CallbackFuncTyped;
 
      ADToolImplCommon(MPI_Datatype primalMpiType, MPI_Datatype adjointMpiType) :
        Base(primalMpiType, adjointMpiType) {}
 
      inline bool isActiveType() const {
        return true;
      }
 
      inline bool isModifiedBufferRequired() const {
        return modifiedBuffer;
      }
 
      inline bool isOldPrimalsRequired() const {
        return restorePrimal;
      }
 
      inline void createPrimalTypeBuffer(PrimalType* &buf, size_t size) const {
        buf = new PrimalType[size];
      }
 
      using Base::createIndexTypeBuffer;
      inline void createIndexTypeBuffer(IndexType* &buf, size_t size) const {
        buf = new IndexType[size];
      }
 
      inline void deletePrimalTypeBuffer(PrimalType* &buf) const {
        if(NULL != buf) {
          delete [] buf;
          buf = NULL;
        }
      }
 
      using Base::deleteIndexTypeBuffer;
      inline void deleteIndexTypeBuffer(IndexType* &buf) const {
        if(NULL != buf) {
          delete [] buf;
          buf = NULL;
        }
      }
 
      using Base::iterateIdentifiers;
      void iterateIdentifiers(IndexType* indices, int elements, CallbackFuncTyped func, void* userData) const {
        for(int i = 0; i < elements; i += 1) {
          func(&indices[i], userData);
        }
      }
  };
}