codiOpenMP.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 "../../../../codi.hpp"
#include "../../../expressions/parallelActiveType.hpp"
#include "../../../tapes/indices/parallelReuseIndexManager.hpp"
#include "../../../tapes/misc/threadSafeGlobalAdjoints.hpp"
#include "../../data/direction.hpp"
#include "openMPAtomic.hpp"
#include "openMPMutex.hpp"
#include "openMPReverseAtomic.hpp"
#include "openMPStaticThreadLocalPointer.hpp"
#include "openMPSynchronization.hpp"
#include "openMPThreadInformation.hpp"

namespace codi {

  using OpenMPToolbox = ParallelToolbox<OpenMPThreadInformation, OpenMPAtomic, OpenMPReverseAtomic, OpenMPMutex,
                                        OpenMPStaticThreadLocalPointer, OpenMPSynchronization>;

  template<typename Type>
  using OpenMPExternalFunctionHelper = ExternalFunctionHelper<Type, OpenMPSynchronization, OpenMPThreadInformation>;

  template<typename Gradient, typename Identifier, typename Tape>
  using OpenMPGlobalAdjoints = ThreadSafeGlobalAdjoints<Gradient, Identifier, Tape, OpenMPToolbox>;

  template<typename Real, typename Gradient = OpenMPReverseAtomic<Real>,
           typename IndexManager = ParallelReuseIndexManager<int, OpenMPToolbox>>
  using RealReverseIndexOpenMPGen = ParallelActiveType<
      JacobianReuseTape<JacobianTapeTypes<Real, Gradient, IndexManager, DefaultChunkedData, OpenMPGlobalAdjoints>>,
      OpenMPToolbox>;

  using RealReverseIndexOpenMP = RealReverseIndexOpenMPGen<double>;

  template<size_t dim>
  using RealReverseIndexVecOpenMP = RealReverseIndexOpenMPGen<double, Direction<OpenMPReverseAtomic<double>, dim>>;
}