src/gromacs/ewald/pme_gpu_3dfft.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2017,2018,2019,2020, by the GROMACS development team.
   5  * Copyright (c) 2021, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36
  37 /*! \internal \file
  38  *  \brief Declares the 3D FFT class for PME.
  39  *
  40  *  \author Aleksei Iupinov <a.yupinov@gmail.com>
  41  *  \ingroup module_ewald
  42  */
  43
  44 #ifndef GMX_EWALD_PME_GPU_3DFFT_H
  45 #define GMX_EWALD_PME_GPU_3DFFT_H
  46
  47 #include "config.h"
  48
  49 #include <vector>
  50
  51 #if GMX_GPU_CUDA
  52 #    include <cufft.h>
  53
  54 #    include "gromacs/gpu_utils/gputraits.cuh"
  55 #elif GMX_GPU_OPENCL
  56 #    include <clFFT.h>
  57
  58 #    include "gromacs/gpu_utils/gmxopencl.h"
  59 #    include "gromacs/gpu_utils/gputraits_ocl.h"
  60 #elif GMX_GPU_SYCL
  61 #    include "gromacs/gpu_utils/gputraits_sycl.h"
  62 #endif
  63
  64 #include "gromacs/fft/fft.h" // for the enum gmx_fft_direction
  65
  66 struct PmeGpu;
  67
  68 /*! \internal \brief
  69  * A 3D FFT class for performing R2C/C2R transforms
  70  * \todo Make this class actually parallel over multiple GPUs
  71  */
  72 class GpuParallel3dFft
  73 {
  74 public:
  75     /*! \brief
  76      * Constructs CUDA/OpenCL FFT plans for performing 3D FFT on a PME grid.
  77      *
  78      * \param[in] pmeGpu                  The PME GPU structure.
  79      * \param[in] gridIndex               The index of the grid on which to perform the calculations.
  80      */
  81     GpuParallel3dFft(const PmeGpu* pmeGpu, int gridIndex);
  82     /*! \brief Destroys the FFT plans. */
  83     ~GpuParallel3dFft();
  84     /*! \brief Performs the FFT transform in given direction
  85      *
  86      * \param[in]  dir           FFT transform direction specifier
  87      * \param[out] timingEvent   pointer to the timing event where timing data is recorded
  88      */
  89     void perform3dFft(gmx_fft_direction dir, CommandEvent* timingEvent);
  90
  91 private:
  92 #if GMX_GPU_CUDA
  93     cufftHandle   planR2C_;
  94     cufftHandle   planC2R_;
  95     cufftReal*    realGrid_;
  96     cufftComplex* complexGrid_;
  97 #elif GMX_GPU_OPENCL
  98     clfftPlanHandle               planR2C_;
  99     clfftPlanHandle               planC2R_;
 100     std::vector<cl_command_queue> deviceStreams_;
 101     cl_mem                        realGrid_;
 102     cl_mem                        complexGrid_;
 103 #endif
 104 };
 105
 106 #endif