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  *  \ingroup module_fft
  42  */
  43
  44 #ifndef GMX_FFT_GPU_3DFFT_H
  45 #define GMX_FFT_GPU_3DFFT_H
  46
  47 #include <memory>
  48
  49 #include "gromacs/fft/fft.h"
  50 #include "gromacs/gpu_utils/devicebuffer_datatype.h"
  51 #include "gromacs/gpu_utils/gputraits.h"
  52
  53 class DeviceContext;
  54 class DeviceStream;
  55
  56 namespace gmx
  57 {
  58
  59 /*! \internal \brief
  60  * A 3D FFT class for performing R2C/C2R transforms
  61  * \todo Make this class actually parallel over multiple GPUs
  62  */
  63 class Gpu3dFft
  64 {
  65 public:
  66     /*! \brief
  67      * Constructs GPU FFT plans for performing 3D FFT on a PME grid.
  68      *
  69      * \param[in]  realGridSize           Dimensions of the real grid
  70      * \param[in]  realGridSizePadded     Dimensions of the real grid with padding
  71      * \param[in]  complexGridSizePadded  Dimensions of the real grid with padding
  72      * \param[in]  useDecomposition       Whether PME decomposition will be used
  73      * \param[in]  performOutOfPlaceFFT   Whether the FFT will be performed out-of-place
  74      * \param[in]  context                GPU context.
  75      * \param[in]  pmeStream              GPU stream for PME.
  76      * \param[in]  realGrid               Device buffer of floats for the real grid
  77      * \param[in]  complexGrid            Device buffer of complex floats for the complex grid
  78      */
  79     Gpu3dFft(ivec                 realGridSize,
  80              ivec                 realGridSizePadded,
  81              ivec                 complexGridSizePadded,
  82              bool                 useDecomposition,
  83              bool                 performOutOfPlaceFFT,
  84              const DeviceContext& context,
  85              const DeviceStream&  pmeStream,
  86              DeviceBuffer<float>  realGrid,
  87              DeviceBuffer<float>  complexGrid);
  88
  89     /*! \brief Destroys the FFT plans. */
  90     ~Gpu3dFft();
  91     /*! \brief Performs the FFT transform in given direction
  92      *
  93      * \param[in]  dir           FFT transform direction specifier
  94      * \param[out] timingEvent   pointer to the timing event where timing data is recorded
  95      */
  96     void perform3dFft(gmx_fft_direction dir, CommandEvent* timingEvent);
  97
  98 private:
  99     class Impl;
 100     std::unique_ptr<Impl> impl_;
 101 };
 102
 103 } // namespace gmx
 104
 105 #endif