parallelToolbox.hpp

/*
 * CoDiPack, a Code Differentiation Package
 *
 * Copyright (C) 2015-2024 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 "atomicInterface.hpp"
#include "mutexInterface.hpp"
#include "readWriteMutex.hpp"
#include "staticThreadLocalPointerInterface.hpp"
#include "synchronizationInterface.hpp"
#include "threadInformationInterface.hpp"
 
namespace codi {
 
  template<typename T_ThreadInformation, template<typename> class T_Atomic, typename T_Mutex,
           template<typename, typename> class T_StaticThreadLocalPointer, typename T_Synchronization>
  struct ParallelToolbox {
    public:
      using ThreadInformation = CODI_DD(T_ThreadInformation, ThreadInformationInterface);
      template<typename Type>
      using Atomic = CODI_DD(T_Atomic<Type>, CODI_DEFAULT_ATOMIC<Type>);  
      using Mutex = CODI_DD(T_Mutex, MutexInterface);                     
 
      template<typename Type, typename Owner>
      using StaticThreadLocalPointer = CODI_DD(CODI_T(T_StaticThreadLocalPointer<Type, Owner>),
                                               CODI_T(StaticThreadLocalPointerInterface<Type, Owner, CODI_ANY>));
 
      using Synchronization = CODI_DD(T_Synchronization, DefaultSynchronization);   
 
      using Lock = codi::Lock<Mutex>;                                               
      using ReadWriteMutex = codi::ReadWriteMutex<ThreadInformation, Atomic<int>>;  
      using LockForRead = codi::LockForRead<ReadWriteMutex>;                        
      using LockForWrite = codi::LockForWrite<ReadWriteMutex>;                      
  };
 
#if CODI_IDE
  using CODI_DEFAULT_PARALLEL_TOOLBOX =
      ParallelToolbox<DefaultThreadInformation, CODI_DEFAULT_ATOMIC, MutexInterface,
                      CODI_DEFAULT_STATIC_THREAD_LOCAL_POINTER, DefaultSynchronization>;
#endif
}