ac2c3a359ee114065303ee129f6cd3e443863f1e
[alexxy/gromacs.git] / src / gromacs / ewald / pme-gpu-program-impl.cu
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2018, 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
38  * Implements PmeGpuProgramImpl, which stores permanent PME GPU context-derived data,
39  * such as (compiled) kernel handles.
40  *
41  * \author Aleksei Iupinov <a.yupinov@gmail.com>
42  * \ingroup module_ewald
43  */
44 #include "gmxpre.h"
45
46 #include "pme-gpu-program-impl.h"
47
48 #include "pme-gpu-constants.h"
49 #include "pme-gpu-internal.h"                    // for GridOrdering enum
50 #include "pme-gpu-types-host.h"
51
52 //! PME CUDA kernels forward declarations. Kernels are documented in their respective files.
53 template <
54     const int order,
55     const bool computeSplines,
56     const bool spreadCharges,
57     const bool wrapX,
58     const bool wrapY
59     >
60 void pme_spline_and_spread_kernel(const PmeGpuCudaKernelParams kernelParams);
61
62 template<
63     GridOrdering gridOrdering,
64     bool computeEnergyAndVirial
65     >
66 void pme_solve_kernel(const PmeGpuCudaKernelParams kernelParams);
67
68 template <
69     const int order,
70     const bool overwriteForces,
71     const bool wrapX,
72     const bool wrapY
73     >
74 void pme_gather_kernel(const PmeGpuCudaKernelParams kernelParams);
75
76
77 PmeGpuProgramImpl::PmeGpuProgramImpl(const gmx_device_info_t *)
78 {
79     // kernel parameters
80     warpSize              = warp_size;
81     spreadWorkGroupSize   = c_spreadMaxThreadsPerBlock;
82     solveMaxWorkGroupSize = c_solveMaxThreadsPerBlock;
83     gatherWorkGroupSize   = c_gatherMaxThreadsPerBlock;
84
85     // PME interpolation order
86     constexpr int  pmeOrder = 4;
87     GMX_UNUSED_VALUE(pmeOrder);
88     // These hardcoded spread/gather parameters refer to not-implemented PME GPU 2D decomposition in X/Y
89     constexpr bool wrapX = true;
90     constexpr bool wrapY = true;
91     GMX_UNUSED_VALUE(wrapX);
92     GMX_UNUSED_VALUE(wrapY);
93     splineAndSpreadKernel       = pme_spline_and_spread_kernel<pmeOrder, true, true, wrapX, wrapY>;
94     splineKernel                = pme_spline_and_spread_kernel<pmeOrder, true, false, wrapX, wrapY>;
95     spreadKernel                = pme_spline_and_spread_kernel<pmeOrder, false, true, wrapX, wrapY>;
96     gatherKernel                = pme_gather_kernel<pmeOrder, true, wrapX, wrapY>;
97     gatherReduceWithInputKernel = pme_gather_kernel<pmeOrder, false, wrapX, wrapY>;
98     solveXYZKernel              = pme_solve_kernel<GridOrdering::XYZ, false>;
99     solveXYZEnergyKernel        = pme_solve_kernel<GridOrdering::XYZ, true>;
100     solveYZXKernel              = pme_solve_kernel<GridOrdering::YZX, false>;
101     solveYZXEnergyKernel        = pme_solve_kernel<GridOrdering::YZX, true>;
102 }
103
104 PmeGpuProgramImpl::~PmeGpuProgramImpl()
105 {
106 }