src/gromacs/ewald/pme_gpu_program.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019,2020, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35
  36 /*! \libinternal \file
  37  * \brief
  38  * Declares PmeGpuProgram
  39  * to store data derived from the GPU context or devices for
  40  * PME, such as (compiled) kernel handles and the warp sizes
  41  * they work with.
  42  *
  43  * \author Aleksei Iupinov <a.yupinov@gmail.com>
  44  * \ingroup module_ewald
  45  * \inlibraryapi
  46  */
  47
  48 #ifndef GMX_EWALD_PME_PME_GPU_PROGRAM_H
  49 #define GMX_EWALD_PME_PME_GPU_PROGRAM_H
  50
  51 #include <memory>
  52
  53 class DeviceContext;
  54
  55 struct PmeGpuProgramImpl;
  56 struct DeviceInformation;
  57
  58 /*! \libinternal
  59  * \brief Stores PME data derived from the GPU context or devices.
  60  *
  61  * This includes compiled kernel handles and the warp sizes they
  62  * work with.
  63  */
  64 class PmeGpuProgram
  65 {
  66 public:
  67     /*! \brief Construct a PME GPU program.
  68      *
  69      * \param[in] deviceContext  GPU context.
  70      */
  71     explicit PmeGpuProgram(const DeviceContext& deviceContext);
  72     //! Destructor
  73     ~PmeGpuProgram();
  74
  75     //! Return the warp size for which the kernels were compiled
  76     int warpSize() const;
  77
  78     // TODO: design more getters for information inside, if needed for PME, and make this private?
  79     //! Private impl class
  80     std::unique_ptr<PmeGpuProgramImpl> impl_;
  81 };
  82
  83 /*! \brief This is an owning handle for the compiled PME GPU kernels.
  84  */
  85 using PmeGpuProgramStorage = std::unique_ptr<PmeGpuProgram>;
  86
  87 /*! \brief
  88  * Factory function used to build persistent PME GPU program for the device at once.
  89  */
  90 PmeGpuProgramStorage buildPmeGpuProgram(const DeviceContext& /* deviceContext */);
  91
  92 #endif