src/gromacs/ewald/pme_force_sender_gpu_impl.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019,2020,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 /*! \internal \file
  36  *
  37  * \brief Declaration of class which sends PME Force from GPU memory to PP task
  38  *
  39  * \author Alan Gray <alang@nvidia.com>
  40  *
  41  * \ingroup module_ewald
  42  */
  43 #ifndef GMX_PMEFORCESENDERGPU_IMPL_H
  44 #define GMX_PMEFORCESENDERGPU_IMPL_H
  45
  46 #include "gromacs/ewald/pme_force_sender_gpu.h"
  47 #include "gromacs/gpu_utils/devicebuffer_datatype.h"
  48 #include "gromacs/gpu_utils/gputraits.h"
  49 #include "gromacs/utility/arrayref.h"
  50
  51 class GpuEventSynchronizer;
  52
  53 namespace gmx
  54 {
  55
  56 /*! \internal \brief Class with interfaces and data for CUDA version of PME Force sending functionality*/
  57
  58 class PmeForceSenderGpu::Impl
  59 {
  60
  61 public:
  62     /*! \brief Creates PME GPU Force sender object
  63      * \param[in] pmeForcesReady  Event synchronizer marked when PME forces are ready on the GPU
  64      * \param[in] comm            Communicator used for simulation
  65      * \param[in] ppRanks         List of PP ranks
  66      */
  67     Impl(GpuEventSynchronizer* pmeForcesReady, MPI_Comm comm, gmx::ArrayRef<PpRanks> ppRanks);
  68     // NOLINTNEXTLINE(performance-trivially-destructible)
  69     ~Impl();
  70
  71     /*! \brief
  72      * sends force buffer address to PP rank
  73      * \param[in] d_f   force buffer in GPU memory
  74      */
  75     void sendForceBufferAddressToPpRanks(DeviceBuffer<Float3> d_f);
  76
  77     /*! \brief
  78      * Send force synchronizer to PP rank (used with Thread-MPI)
  79      * \param[in] ppRank           PP rank to receive data
  80      */
  81     void sendFSynchronizerToPpCudaDirect(int ppRank);
  82
  83     /*! \brief
  84      * Send force to PP rank (used with Lib-MPI)
  85      * \param[in] sendbuf  force buffer in GPU memory
  86      * \param[in] offset   starting element in buffer
  87      * \param[in] numBytes number of bytes to transfer
  88      * \param[in] ppRank   PP rank to receive data
  89      * \param[in] request  MPI request to track asynchronous MPI call status
  90      */
  91     void sendFToPpCudaMpi(DeviceBuffer<RVec> sendbuf, int offset, int numBytes, int ppRank, MPI_Request* request);
  92
  93 private:
  94     //! Event indicating when PME forces are ready on the GPU in order for PP stream to sync with the PME stream
  95     GpuEventSynchronizer* pmeForcesReady_;
  96     //! communicator for simulation
  97     MPI_Comm comm_;
  98     //! list of PP ranks
  99     gmx::ArrayRef<PpRanks> ppRanks_;
 100 };
 101
 102 } // namespace gmx
 103
 104 #endif