src/gromacs/ewald/pme_coordinate_receiver_gpu.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019,2020, 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 /*! \libinternal \file
  36  * \brief Declaration of class which receives coordinates to GPU memory on PME task
  37  *
  38  * \author Alan Gray <alang@nvidia.com>
  39  * \inlibraryapi
  40  * \ingroup module_ewald
  41  */
  42 #ifndef GMX_PMECOORDINATERECEIVERGPU_H
  43 #define GMX_PMECOORDINATERECEIVERGPU_H
  44
  45 #include "gromacs/gpu_utils/devicebuffer_datatype.h"
  46 #include "gromacs/math/vectypes.h"
  47 #include "gromacs/utility/classhelpers.h"
  48 #include "gromacs/utility/gmxmpi.h"
  49
  50 struct PpRanks;
  51
  52 namespace gmx
  53 {
  54
  55 template<typename>
  56 class ArrayRef;
  57
  58 class PmeCoordinateReceiverGpu
  59 {
  60
  61 public:
  62     /*! \brief Creates PME GPU coordinate receiver object
  63      * \param[in] pmeStream       CUDA stream used for PME computations
  64      * \param[in] comm            Communicator used for simulation
  65      * \param[in] ppRanks         List of PP ranks
  66      */
  67     PmeCoordinateReceiverGpu(const void* pmeStream, MPI_Comm comm, gmx::ArrayRef<PpRanks> ppRanks);
  68     ~PmeCoordinateReceiverGpu();
  69
  70     /*! \brief
  71      * send coordinates buffer address to PP rank
  72      * \param[in] d_x   coordinates buffer in GPU memory
  73      */
  74     void sendCoordinateBufferAddressToPpRanks(DeviceBuffer<RVec> d_x);
  75
  76
  77     /*! \brief
  78      * launch receive of coordinate data from PP rank
  79      * \param[in] ppRank  PP rank to send data
  80      */
  81     void launchReceiveCoordinatesFromPpCudaDirect(int ppRank);
  82
  83     /*! \brief
  84      * enqueue wait for coordinate data from PP ranks
  85      */
  86     void enqueueWaitReceiveCoordinatesFromPpCudaDirect();
  87
  88 private:
  89     class Impl;
  90     gmx::PrivateImplPointer<Impl> impl_;
  91 };
  92
  93 } // namespace gmx
  94
  95 #endif