lowLevelFunctionTapeInterface.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 "../../config.h"
#include "../../misc/byteDataView.hpp"
#include "../../misc/macros.hpp"
#include "../../misc/temporaryMemory.hpp"
#include "../misc/lowLevelFunctionEntry.hpp"
 
namespace codi {
 
  template<typename T_Tape>
  struct ExternalFunction;
 
  template<typename T_Real, typename T_Gradient, typename T_Tape, typename T_Impl>
  struct LhsExpressionInterface;
 
  template<typename T_Real, typename T_Gradient, typename T_Identifier>
  struct LowLevelFunctionTapeInterface {
    public:
 
      using Real = CODI_DD(T_Real, double);           
      using Gradient = CODI_DD(T_Gradient, double);   
      using Identifier = CODI_DD(T_Identifier, int);  
 
      /*******************************************************************************/
 
      TemporaryMemory& getTemporaryMemory();
 
      template<LowLevelFunctionEntryCallKind callType, typename... Args>
      static void callLowLevelFunction(LowLevelFunctionTapeInterface& tape, bool forward, size_t& curLLFByteDataPos,
                                       char* dataPtr, size_t& curLLFInfoDataPos,
                                       Config::LowLevelFunctionToken* const tokenPtr,
                                       Config::LowLevelFunctionDataSize* const dataSizePtr, Args&&... args);
 
      void pushLowLevelFunction(Config::LowLevelFunctionToken token, size_t size, ByteDataView& data);
 
      Config::LowLevelFunctionToken registerLowLevelFunction(
          LowLevelFunctionEntry<LowLevelFunctionTapeInterface, Real, Identifier> const& entry);
  };
}