src/gromacs/ewald/pme_coordinate_receiver_gpu_impl.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019, 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 /*! \internal \file
  36  *
  37  * \brief Declaration of class which receives coordinates to GPU memory on PME task
  38  *
  39  * \author Alan Gray <alang@nvidia.com>
  40  *
  41  * \ingroup module_ewald
  42  */
  43 #ifndef GMX_PMECOORDINATERECEIVERGPU_IMPL_H
  44 #define GMX_PMECOORDINATERECEIVERGPU_IMPL_H
  45
  46 #include "gromacs/ewald/pme_coordinate_receiver_gpu.h"
  47 #include "gromacs/gpu_utils/gpueventsynchronizer.cuh"
  48
  49 namespace gmx
  50 {
  51
  52 /*! \internal \brief Class with interfaces and data for CUDA version of PME coordinate receiving functionality */
  53
  54 class PmeCoordinateReceiverGpu::Impl
  55 {
  56
  57     public:
  58         /*! \brief Creates PME GPU coordinate receiver object
  59          * \param[in] pmeStream       CUDA stream used for PME computations
  60          * \param[in] comm            Communicator used for simulation
  61          * \param[in] ppRanks         List of PP ranks
  62          */
  63         Impl(void *pmeStream, MPI_Comm comm, gmx::ArrayRef<PpRanks> ppRanks);
  64         ~Impl();
  65
  66         /*! \brief
  67          * send coordinates buffer address to PP rank
  68          * \param[in] d_x   coordinates buffer in GPU memory
  69          */
  70         void sendCoordinateBufferAddressToPpRanks(rvec *d_x);
  71
  72         /*! \brief
  73          * receive coordinate data from PP rank
  74          * \param[in] ppRank  PP rank to send data
  75          */
  76         void receiveCoordinatesFromPpCudaDirect(int ppRank);
  77
  78     private:
  79         //! CUDA stream for PME operations
  80         cudaStream_t            pmeStream_ = nullptr;
  81         //! communicator for simulation
  82         MPI_Comm                comm_;
  83         //! list of PP ranks
  84         gmx::ArrayRef<PpRanks>  ppRanks_;
  85 };
  86
  87 } // namespace gmx
  88
  89 #endif