src/gromacs/fft/gpu_3dfft.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2017,2018,2019,2021, 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 /*! \internal \file
  37  *  \brief Declares the GPU 3D FFT routines.
  38  *
  39  *  \author Aleksei Iupinov <a.yupinov@gmail.com>
  40  *  \author Mark Abraham <mark.j.abraham@gmail.com>
  41  *  \author Gaurav Garg <gaugarg@nvidia.com>
  42  *  \ingroup module_fft
  43  */
  44
  45 #ifndef GMX_FFT_GPU_3DFFT_H
  46 #define GMX_FFT_GPU_3DFFT_H
  47
  48 #include <memory>
  49
  50 #include "gromacs/fft/fft.h"
  51 #include "gromacs/gpu_utils/devicebuffer_datatype.h"
  52 #include "gromacs/gpu_utils/gputraits.h"
  53 #include "gromacs/utility/gmxmpi.h"
  54
  55 class DeviceContext;
  56 class DeviceStream;
  57
  58 namespace gmx
  59 {
  60
  61 template<typename T>
  62 class ArrayRef;
  63
  64 /*! \internal \brief
  65  * Enum specifying all GPU FFT backends supported by GROMACS
  66  * Some of the backends support only single GPU, some only multi-node, multi-GPU
  67  */
  68 enum class FftBackend
  69 {
  70     Cufft, // supports only single-GPU
  71     Ocl,   // supports only single-GPU
  72     Sycl,  // Not supported currently
  73     Count
  74 };
  75
  76 /*! \internal \brief
  77  * A 3D FFT class for performing R2C/C2R transforms
  78  */
  79 class Gpu3dFft
  80 {
  81 public:
  82     /*! \brief
  83      * Construct 3D FFT object for given backend
  84      *
  85      * \param[in]  backend                      FFT backend to be instantiated
  86      * \param[in]  allocateGrids                True if fft grids are to be allocated, false if pre-allocated
  87      * \param[in]  comm                         MPI communicator, used with distributed-FFT backends
  88      * \param[in]  gridSizesInXForEachRank      Number of grid points used with each rank in X-dimension
  89      * \param[in]  gridSizesInYForEachRank      Number of grid points used with each rank in Y-dimension
  90      * \param[in]  nz                           Grid dimension in Z
  91      * \param[in]  performOutOfPlaceFFT         Whether the FFT will be performed out-of-place
  92      * \param[in]  context                      GPU context.
  93      * \param[in]  pmeStream                    GPU stream for PME.
  94      * \param[in,out]  realGridSize             Dimensions of the local real grid, out if allocateGrids=true
  95      * \param[in,out]  realGridSizePadded       Dimensions of the local real grid with padding, out if allocateGrids=true
  96      * \param[in,out]  complexGridSizePadded    Dimensions of the local complex grid with padding, out if allocateGrids=true
  97      * \param[in,out]  realGrid                 Device buffer of floats for the local real grid, out if allocateGrids=true
  98      * \param[in,out]  complexGrid              Device buffer of complex floats for the local complex grid, out if allocateGrids=true
  99      */
 100     Gpu3dFft(FftBackend           backend,
 101              bool                 allocateGrids,
 102              MPI_Comm             comm,
 103              ArrayRef<const int>  gridSizesInXForEachRank,
 104              ArrayRef<const int>  gridSizesInYForEachRank,
 105              int                  nz,
 106              bool                 performOutOfPlaceFFT,
 107              const DeviceContext& context,
 108              const DeviceStream&  pmeStream,
 109              ivec                 realGridSize,
 110              ivec                 realGridSizePadded,
 111              ivec                 complexGridSizePadded,
 112              DeviceBuffer<float>* realGrid,
 113              DeviceBuffer<float>* complexGrid);
 114
 115     /*! \brief Destroys the FFT plans. */
 116     ~Gpu3dFft();
 117     /*! \brief Performs the FFT transform in given direction
 118      *
 119      * \param[in]  dir           FFT transform direction specifier
 120      * \param[out] timingEvent   pointer to the timing event where timing data is recorded
 121      */
 122     void perform3dFft(gmx_fft_direction dir, CommandEvent* timingEvent);
 123
 124 private:
 125     class Impl;
 126     class ImplCuFft;
 127     class ImplOcl;
 128     class ImplSycl;
 129
 130     std::unique_ptr<Impl> impl_;
 131 };
 132
 133 } // namespace gmx
 134
 135 #endif