src/gromacs/ewald/pme-3dfft.cuh

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2017, 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 Defines the CUDA 3D-FFT functions for PME.
  38  *
  39  *  \author Aleksei Iupinov <a.yupinov@gmail.com>
  40  */
  41
  42 #ifndef GMX_EWALD_PME_3DFFT_CUH
  43 #define GMX_EWALD_PME_3DFFT_CUH
  44
  45 #include <cufft.h>                  // for the cufft types
  46
  47 #include "gromacs/fft/fft.h"        // for the enum gmx_fft_direction
  48
  49 struct pme_gpu_t;
  50
  51 /*! \brief \internal A 3D FFT class for performing R2C/C2R transforms
  52  * \todo Make this class actually parallel over multiple GPUs
  53  */
  54 class GpuParallel3dFft
  55 {
  56     cufftHandle   planR2C_;
  57     cufftHandle   planC2R_;
  58     cufftReal    *realGrid_;
  59     cufftComplex *complexGrid_;
  60
  61     public:
  62         /*! \brief
  63          * Constructs CUDA FFT plans for performing 3D FFT on a PME grid.
  64          *
  65          * \param[in] pmeGPU                  The PME GPU structure.
  66          */
  67         GpuParallel3dFft(const pme_gpu_t *pmeGPU);
  68         /*! \brief Destroys CUDA FFT plans. */
  69         ~GpuParallel3dFft();
  70         /*! \brief Performs the FFT transform in given direction */
  71         void perform3dFft(gmx_fft_direction dir);
  72 };
  73
  74 #endif