src/gromacs/ewald/pme_solve_sycl.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   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.
   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 Implements PME GPU spline calculation and charge spreading in SYCL.
  38  *
  39  *  \author Mark Abraham <mark.j.abraham@gmail.com>
  40  *  \author Andrey Alekseenko <al42and@gmail.com>
  41  */
  42
  43 #include "gromacs/gpu_utils/gmxsycl.h"
  44 #include "gromacs/gpu_utils/syclutils.h"
  45 #include "gromacs/math/vectypes.h"
  46
  47 #include "pme_gpu_internal.h"
  48 #include "pme_gpu_types.h"
  49
  50 struct PmeGpuConstParams;
  51 struct PmeGpuGridParams;
  52
  53 //! Contains most of the parameters used by the solve kernel
  54 struct SolveKernelParams
  55 {
  56     /*! \brief Ewald solving factor = (M_PI / pme->ewaldcoeff_q)^2 */
  57     float ewaldFactor;
  58     /*! \brief Real-space grid data dimensions. */
  59     gmx::IVec realGridSize;
  60     /*! \brief Fourier grid dimensions. This counts the complex numbers! */
  61     gmx::IVec complexGridSize;
  62     /*! \brief Fourier grid dimensions (padded). This counts the complex numbers! */
  63     gmx::IVec complexGridSizePadded;
  64     /*! \brief Offsets for X/Y/Z components of d_splineModuli */
  65     gmx::IVec splineValuesOffset;
  66     /*! \brief Reciprocal (inverted unit cell) box. */
  67     gmx::RVec recipBox[DIM];
  68     /*! \brief The unit cell volume for solving. */
  69     float boxVolume;
  70     /*! \brief Electrostatics coefficient = c_one4PiEps0 / pme->epsilon_r */
  71     float elFactor;
  72 };
  73
  74 //! The kernel for PME solve
  75 template<GridOrdering gridOrdering, bool computeEnergyAndVirial, int gridIndex, int subGroupSize>
  76 class PmeSolveKernel : public ISyclKernelFunctor
  77 {
  78 public:
  79     PmeSolveKernel();
  80     //! Sets the kernel arguments
  81     void setArg(size_t argIndex, void* arg) override;
  82     //! Launches the kernel with given \c config and \c deviceStream
  83     cl::sycl::event launch(const KernelLaunchConfig& config, const DeviceStream& deviceStream) override;
  84
  85 private:
  86     //! Kernel argument set by \c setArg()
  87     PmeGpuConstParams* constParams_ = nullptr;
  88     //! Kernel argument set by \c setArg()
  89     PmeGpuGridParams* gridParams_ = nullptr;
  90     //! Kernel argument set by \c setArg()
  91     SolveKernelParams solveKernelParams_;
  92
  93     //! Called after each launch to ensure we set the arguments again properly
  94     void reset();
  95 };