adjointInterface.hpp

Go to the documentation of this file.

/*
 * MeDiPack, a Message Differentiation Package
 *
 * Copyright (C) 2015-2023 Chair for Scientific Computing (SciComp), University of Kaiserslautern-Landau
 * Homepage: http://www.scicomp.uni-kl.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://www.scicomp.uni-kl.de/software/codi).
 *
 * 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 {
 
 
  class AdjointInterface {
    public:
 
      virtual int computeElements(int elements) const = 0;
 
      virtual int getVectorSize() const = 0;
 
      virtual void createPrimalTypeBuffer(void* &buf, size_t size) const = 0;
 
      virtual void deletePrimalTypeBuffer(void* &buf) const = 0;
 
      virtual void createAdjointTypeBuffer(void* &buf, size_t size) const = 0;
 
      virtual void deleteAdjointTypeBuffer(void* &buf) const = 0;
 
      virtual void combineAdjoints(void* buf, const int elements, const int ranks) const = 0;
 
      virtual void getAdjoints(const void* indices, void* adjoints, int elements) const = 0;
 
      virtual void updateAdjoints(const void* indices, const void* adjoints, int elements) const = 0;
 
      virtual void getPrimals(const void* indices, const void* primals, int elements) const = 0;
 
      virtual void setPrimals(const void* indices, const void* primals, int elements) const = 0;
  };
}