src/gromacs/fft/gpu_3dfft_sycl_mkl.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_SYCL_MKL_H
  46 #define GMX_FFT_GPU_3DFFT_SYCL_MKL_H
  47
  48 #include "gpu_3dfft_impl.h"
  49
  50 #include <oneapi/mkl/dfti.hpp>
  51
  52 #include "gromacs/fft/fft.h"
  53 #include "gromacs/gpu_utils/devicebuffer_datatype.h"
  54 #include "gromacs/gpu_utils/gmxsycl.h"
  55 #include "gromacs/gpu_utils/gputraits.h"
  56 #include "gromacs/utility/gmxmpi.h"
  57
  58 class DeviceContext;
  59 class DeviceStream;
  60
  61 namespace gmx
  62 {
  63
  64 /*! \internal \brief
  65  * A 3D FFT wrapper class for performing R2C/C2R transforms using SYCL + MKL.
  66  */
  67 class Gpu3dFft::ImplSyclMkl : public Gpu3dFft::Impl
  68 {
  69 public:
  70     //! \copydoc Gpu3dFft::Impl::Impl
  71     ImplSyclMkl(bool                 allocateGrids,
  72                 MPI_Comm             comm,
  73                 ArrayRef<const int>  gridSizesInXForEachRank,
  74                 ArrayRef<const int>  gridSizesInYForEachRank,
  75                 int                  nz,
  76                 bool                 performOutOfPlaceFFT,
  77                 const DeviceContext& context,
  78                 const DeviceStream&  pmeStream,
  79                 ivec                 realGridSize,
  80                 ivec                 realGridSizePadded,
  81                 ivec                 complexGridSizePadded,
  82                 DeviceBuffer<float>* realGrid,
  83                 DeviceBuffer<float>* complexGrid);
  84
  85     //! \copydoc Gpu3dFft::Impl::~Impl
  86     ~ImplSyclMkl() override;
  87
  88     //! \copydoc Gpu3dFft::Impl::perform3dFft
  89     void perform3dFft(gmx_fft_direction dir, CommandEvent* timingEvent) override;
  90
  91 private:
  92     // Shorthand for the FFT descriptor (a.k.a. plan) type
  93     using Descriptor =
  94             oneapi::mkl::dft::descriptor<oneapi::mkl::dft::precision::SINGLE, oneapi::mkl::dft::domain::REAL>;
  95
  96     cl::sycl::buffer<float, 1> realGrid_;
  97     cl::sycl::buffer<float, 1> complexGrid_;
  98     cl::sycl::queue            queue_;
  99     Descriptor                 r2cDescriptor_, c2rDescriptor_;
 100
 101     static Descriptor initDescriptor(const ivec realGridSize);
 102 };
 103
 104 } // namespace gmx
 105
 106 #endif