src/gromacs/domdec/gpuhaloexchange.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 GPU halo exchange.
  37  *
  38  * \author Alan Gray <alang@nvidia.com>
  39  * \inlibraryapi
  40  * \ingroup module_domdec
  41  */
  42 #ifndef GMX_DOMDEC_GPUHALOEXCHANGE_H
  43 #define GMX_DOMDEC_GPUHALOEXCHANGE_H
  44
  45 #include "gromacs/gpu_utils/devicebuffer_datatype.h"
  46 #include "gromacs/math/vectypes.h"
  47 #include "gromacs/utility/basedefinitions.h"
  48 #include "gromacs/utility/classhelpers.h"
  49 #include "gromacs/utility/gmxmpi.h"
  50
  51 struct gmx_domdec_t;
  52 class GpuEventSynchronizer;
  53
  54 namespace gmx
  55 {
  56
  57 /*! \libinternal
  58  * \brief Manages GPU Halo Exchange object */
  59 class GpuHaloExchange
  60 {
  61
  62 public:
  63     /*! \brief Creates GPU Halo Exchange object.
  64      *
  65      * Coordinate Halo exchange will be performed in \c
  66      * StreamNonLocal, and the \c communicateHaloCoordinates
  67      * method must be called before any subsequent operations that
  68      * access non-local parts of the coordinate buffer (such as
  69      * the non-local non-bonded kernels). It also must be called
  70      * after the local coordinates buffer operations (where the
  71      * coordinates are copied to the device and hence the \c
  72      * coordinatesReadyOnDeviceEvent is recorded). Force Halo exchange
  73      * will be performed in \c streamNonLocal (also potentally
  74      * with buffer clearing in \c streamLocal)and the \c
  75      * communicateHaloForces method must be called after the
  76      * non-local buffer operations, after the local force buffer
  77      * has been copied to the GPU (if CPU forces are present), and
  78      * before the local buffer operations. The force halo exchange
  79      * does not yet support virial steps.
  80      *
  81      * \param [inout] dd                       domdec structure
  82      * \param [in]    mpi_comm_mysim           communicator used for simulation
  83      * \param [in]    streamLocal              local NB CUDA stream.
  84      * \param [in]    streamNonLocal           non-local NB CUDA stream.
  85      * \param [in]    pulse                    the communication pulse for this instance
  86      */
  87     GpuHaloExchange(gmx_domdec_t* dd, MPI_Comm mpi_comm_mysim, void* streamLocal, void* streamNonLocal, int pulse);
  88     ~GpuHaloExchange();
  89
  90     /*! \brief
  91      *
  92      * Initialization for GPU halo exchange of coordinates buffer
  93      * \param [in] d_coordinateBuffer   pointer to coordinates buffer in GPU memory
  94      * \param [in] d_forcesBuffer   pointer to coordinates buffer in GPU memory
  95      */
  96     void reinitHalo(DeviceBuffer<RVec> d_coordinateBuffer, DeviceBuffer<RVec> d_forcesBuffer);
  97
  98
  99     /*! \brief GPU halo exchange of coordinates buffer.
 100      *
 101      * Must be called after local setCoordinates (which records an
 102      * event when the coordinate data has been copied to the
 103      * device).
 104      * \param [in] box  Coordinate box (from which shifts will be constructed)
 105      * \param [in] coordinatesReadyOnDeviceEvent event recorded when coordinates have been copied to device
 106      */
 107     void communicateHaloCoordinates(const matrix box, GpuEventSynchronizer* coordinatesReadyOnDeviceEvent);
 108
 109     /*! \brief GPU halo exchange of force buffer.
 110      * \param[in] accumulateForces  True if forces should accumulate, otherwise they are set
 111      */
 112     void communicateHaloForces(bool accumulateForces);
 113
 114     /*! \brief Get the event synchronizer for the forces ready on device.
 115      *  \returns  The event to synchronize the stream that consumes forces on device.
 116      */
 117     GpuEventSynchronizer* getForcesReadyOnDeviceEvent();
 118
 119 private:
 120     class Impl;
 121     gmx::PrivateImplPointer<Impl> impl_;
 122 };
 123
 124 } // namespace gmx
 125
 126 #endif