2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 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.
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.
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.
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.
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.
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.
37 * \brief Declares the GPU 3D FFT routines.
38 * \author Gaurav Garg <gaugarg@nvidia.com>
42 #ifndef GMX_FFT_GPU_3DFFT_HEFFTE_H
43 #define GMX_FFT_GPU_3DFFT_HEFFTE_H
47 #include "gromacs/fft/fft.h"
48 #include "gromacs/gpu_utils/devicebuffer_datatype.h"
49 #include "gromacs/gpu_utils/hostallocator.h"
50 #include "gromacs/gpu_utils/gputraits.h"
51 #include "gromacs/utility/gmxmpi.h"
52 #include "gpu_3dfft_impl.h"
63 * A 3D FFT wrapper class for performing R2C/C2R transforms using clFFT
65 template<typename backend_tag>
66 class Gpu3dFft::ImplHeFfte : public Gpu3dFft::Impl
69 //! \copydoc Gpu3dFft::Impl::Impl
70 ImplHeFfte(bool allocateGrids,
72 ArrayRef<const int> gridSizesInXForEachRank,
73 ArrayRef<const int> gridSizesInYForEachRank,
75 bool performOutOfPlaceFFT,
76 const DeviceContext& context,
77 const DeviceStream& pmeStream,
79 ivec realGridSizePadded,
80 ivec complexGridSizePadded,
81 DeviceBuffer<float>* realGrid,
82 DeviceBuffer<float>* complexGrid);
84 /*! \brief Destroys the FFT plans. */
85 ~ImplHeFfte() override = default;
87 /*! \brief Performs the FFT transform in given direction
89 * \param[in] dir FFT transform direction specifier
90 * \param[out] timingEvent pointer to the timing event where timing data is recorded
92 void perform3dFft(gmx_fft_direction dir, CommandEvent* timingEvent) override;
95 heffte::gpu::vector<float> localRealGrid_;
96 heffte::gpu::vector<std::complex<float>> localComplexGrid_;
97 heffte::gpu::vector<std::complex<float>> workspace_;
99 std::unique_ptr<heffte::fft3d_r2c<backend_tag, int>> fftPlan_;
101 const DeviceStream& stream_;