parallelActiveType.hpp

/*
 * CoDiPack, a Code Differentiation Package
 *
 * Copyright (C) 2015-2025 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, Johannes Blühdorn (SciComp, University of Kaiserslautern-Landau)
 *
 * This file is part of CoDiPack (http://scicomp.rptu.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 "../misc/macros.hpp"
#include "../tapes/interfaces/editingTapeInterface.hpp"
#include "../tools/parallel/parallelToolbox.hpp"
#include "activeTypeBase.hpp"

namespace codi {

  template<typename T_Tape, typename T_ParallelToolbox>
  struct ParallelActiveType : public ActiveTypeBase<T_Tape, ParallelActiveType<T_Tape, T_ParallelToolbox>> {
    public:

      using Tape = CODI_DD(T_Tape, CODI_DEFAULT_PARALLEL_TAPE);
      using ParallelToolbox = CODI_DD(T_ParallelToolbox, CODI_DEFAULT_PARALLEL_TOOLBOX);
 
      using Base = ActiveTypeBase<Tape, ParallelActiveType>;  
 
      using typename Base::Gradient;     
      using typename Base::Identifier;   
      using typename Base::PassiveReal;  
      using typename Base::Real;         
 
      using typename Base::ADLogic;  
      using typename Base::StoreAs;  

      using ThreadLocalTapePointer =
          typename ParallelToolbox::template StaticThreadLocalPointer<Tape, ParallelActiveType>;
 
    private:
 
      static ThreadLocalTapePointer tape;
 
    public:

      CODI_INLINE ParallelActiveType(ParallelActiveType const& v) : Base(static_cast<Base const&>(v)) {}
 
      using Base::Base;  // Use constructors from base class.

      CODI_INLINE ~ParallelActiveType() {}
 
      /*******************************************************************************/

      CODI_INLINE ParallelActiveType& operator=(ParallelActiveType const& v) {
        static_cast<Base&>(*this) = static_cast<Base const&>(v);
        return *this;
      }
 
      using Base::operator=;

      /*******************************************************************************/

      static CODI_INLINE Tape& getTape() {
        return *(tape.get());
      }

      /*******************************************************************************/

      static CODI_INLINE Tape* getTapePtr() {
        return tape.get();
      }

      static CODI_INLINE void setTapePtr(Tape* other) {
        tape.set(other);
      }

  };
 
  template<typename Tape, typename ParallelToolbox>
  typename ParallelActiveType<Tape, ParallelToolbox>::ThreadLocalTapePointer
      ParallelActiveType<Tape, ParallelToolbox>::tape;
 
#if CODI_IDE
  using CODI_DEFAULT_PARALLEL_ACTIVE_TYPE =
      ParallelActiveType<CODI_DEFAULT_PARALLEL_TAPE, CODI_DEFAULT_PARALLEL_TOOLBOX>;
#endif
}