dataManagementTapeInterface.hpp

/*
 * CoDiPack, a Code Differentiation Package
 *
 * Copyright (C) 2015-2024 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, Johannes Blühdorn (SciComp, University of Kaiserslautern-Landau)
 *
 * This file is part of CoDiPack (http://www.scicomp.uni-kl.de/software/codi).
 *
 * CoDiPack is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * CoDiPack 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 General Public License for more details.
 * You should have received a copy of the GNU
 * General Public License along with CoDiPack.
 * If not, see <http://www.gnu.org/licenses/>.
 *
 * For other licensing options please contact us.
 *
 * Authors:
 *  - SciComp, University of Kaiserslautern-Landau:
 *    - Max Sagebaum
 *    - Johannes Blühdorn
 *    - Former members:
 *      - Tim Albring
 */
#pragma once
 
#include <set>
 
#include "../../config.h"
#include "../../traits/realTraits.hpp"
#include "../misc/tapeParameters.hpp"
#include "../misc/vectorAccessInterface.hpp"
 
namespace codi {
 
  template<typename T_Real, typename T_Identifier>
  struct DataManagementTapeInterface {
    public:
 
      using Real = CODI_DD(T_Real, double);           
      using Identifier = CODI_DD(T_Identifier, int);  
 
      /*******************************************************************************/
 
      void writeToFile(std::string const& filename) const;  
      void readFromFile(std::string const& filename);       
      void deleteData();                                    
 
      /*******************************************************************************/
 
      std::set<TapeParameters> const& getAvailableParameters() const;  
      size_t getParameter(TapeParameters parameter) const;             
      bool hasParameter(TapeParameters parameter) const;               
      void setParameter(TapeParameters parameter, size_t value);       
 
      /*******************************************************************************/
 
      VectorAccessInterface<Real, Identifier>* createVectorAccess();  
 
      template<typename Adjoint>
      VectorAccessInterface<Real, Identifier>* createVectorAccessCustomAdjoints(Adjoint* data);
 
      void deleteVectorAccess(VectorAccessInterface<Real, Identifier>* access);  
 
      /*******************************************************************************/
 
      void resizeAdjointVector();    
      void deleteAdjointVector();    
      void beginUseAdjointVector();  
      void endUseAdjointVector();    
 
      /*******************************************************************************/
 
      void swap(DataManagementTapeInterface& other);  
 
      void resetHard();
  };
}