src/gromacs/ewald/pme-gpu-program.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018, 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, which wrap arounds PmeGpuProgramImpl
  39  * to store permanent PME GPU context-derived data,
  40  * such as (compiled) kernel handles.
  41  *
  42  * \author Aleksei Iupinov <a.yupinov@gmail.com>
  43  * \ingroup module_ewald
  44  * \inlibraryapi
  45  */
  46
  47 #ifndef GMX_EWALD_PME_PME_GPU_PROGRAM_H
  48 #define GMX_EWALD_PME_PME_GPU_PROGRAM_H
  49
  50 #include <memory>
  51
  52 struct PmeGpuProgramImpl;
  53 struct gmx_device_info_t;
  54
  55 class PmeGpuProgram
  56 {
  57     public:
  58         explicit PmeGpuProgram(const gmx_device_info_t *deviceInfo);
  59         ~PmeGpuProgram();
  60
  61         // TODO: design getters for information inside, if needed for PME, and make this private?
  62         std::unique_ptr<PmeGpuProgramImpl> impl_;
  63 };
  64
  65 /*! \brief This is an owning handle for the compiled PME GPU kernels.
  66  */
  67 using PmeGpuProgramStorage = std::unique_ptr<PmeGpuProgram>;
  68
  69 /*! \brief This is a handle for passing references to PME GPU program data.
  70  * TODO: it should be a const reference, but for that the PmeGpu types need to be C++
  71  */
  72 using PmeGpuProgramHandle = const PmeGpuProgram *;
  73
  74 /*! \brief
  75  * Factory function used to build persistent PME GPU program for the device at once.
  76  */
  77 PmeGpuProgramStorage buildPmeGpuProgram(const gmx_device_info_t *);
  78
  79 #endif