2 * This file is part of the GROMACS molecular simulation package.
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.
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.
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.
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.
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.
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.
35 /*! \libinternal \file
36 * \brief Declaration of class which sends PME Force from GPU memory to PP task
38 * \author Alan Gray <alang@nvidia.com>
40 * \ingroup module_ewald
42 #ifndef GMX_PMEFORCESENDERGPU_H
43 #define GMX_PMEFORCESENDERGPU_H
47 #include "gromacs/math/vectypes.h"
48 #include "gromacs/gpu_utils/devicebuffer_datatype.h"
49 #include "gromacs/utility/gmxmpi.h"
51 class GpuEventSynchronizer;
56 * \brief Contains information about the PP ranks that partner this PME rank. */
59 //! The MPI rank ID of this partner PP rank.
61 //! The number of atoms to communicate with this partner PP rank.
72 * \brief Manages sending forces from PME-only ranks to their PP ranks. */
73 class PmeForceSenderGpu
77 /*! \brief Creates PME GPU Force sender object
78 * \param[in] pmeForcesReady Event synchronizer marked when PME forces are ready on the GPU
79 * \param[in] comm Communicator used for simulation
80 * \param[in] deviceContext GPU context
81 * \param[in] ppRanks List of PP ranks
83 PmeForceSenderGpu(GpuEventSynchronizer* pmeForcesReady,
85 const DeviceContext& deviceContext,
86 gmx::ArrayRef<PpRanks> ppRanks);
90 * Sets location of force to be sent to each PP rank
91 * \param[in] d_f force buffer in GPU memory
93 void setForceSendBuffer(DeviceBuffer<RVec> d_f);
96 * Send force to PP rank (used with Thread-MPI)
97 * \param[in] ppRank PP rank to receive data
98 * \param[in] numAtoms number of atoms to send
99 * \param[in] sendForcesDirectToPpGpu whether forces are transferred direct to remote GPU memory
101 void sendFToPpCudaDirect(int ppRank, int numAtoms, bool sendForcesDirectToPpGpu);
104 * Send force to PP rank (used with Lib-MPI)
105 * \param[in] sendbuf force buffer in GPU memory
106 * \param[in] offset starting element in buffer
107 * \param[in] numBytes number of bytes to transfer
108 * \param[in] ppRank PP rank to receive data
109 * \param[in] request MPI request to track asynchronous MPI call status
111 void sendFToPpCudaMpi(DeviceBuffer<RVec> sendbuf, int offset, int numBytes, int ppRank, MPI_Request* request);
115 std::unique_ptr<Impl> impl_;