src/gromacs/domdec/gpuhaloexchange.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 /*! \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
  53 namespace gmx
  54 {
  55
  56 /*! \libinternal
  57  * \brief Manages GPU Halo Exchange object */
  58 class GpuHaloExchange
  59 {
  60
  61     public:
  62         /*! \brief Creates GPU Halo Exchange object.
  63          *
  64          * Coordinate Halo exchange will be performed in \c
  65          * StreamNonLocal, and the \c communicateHaloCoordinates
  66          * method must be called before any subsequent operations that
  67          * access non-local parts of the coordinate buffer (such as
  68          * the non-local non-bonded kernels). It also must be called
  69          * after the local coordinates buffer operations (where the
  70          * coordinates are copied to the device and hence the \c
  71          * coordinatesOnDeviceEvent is recorded). Force Halo exchange
  72          * will be performed in \c streamNonLocal (also potentally
  73          * with buffer clearing in \c streamLocal)and the \c
  74          * communicateHaloForces method must be called after the
  75          * non-local buffer operations, after the local force buffer
  76          * has been copied to the GPU (if CPU forces are present), and
  77          * before the local buffer operations. The force halo exchange
  78          * does not yet support virial steps.
  79          *
  80          * \param [inout] dd                       domdec structure
  81          * \param [in]    mpi_comm_mysim           communicator used for simulation
  82          * \param [in]    streamLocal              local NB CUDA stream.
  83          * \param [in]    streamNonLocal           non-local NB CUDA stream.
  84          * \param [in]    coordinatesOnDeviceEvent event recorded when coordinates have been copied to device
  85          */
  86         GpuHaloExchange(gmx_domdec_t *dd,
  87                         MPI_Comm      mpi_comm_mysim,
  88                         void         *streamLocal,
  89                         void         *streamNonLocal,
  90                         void         *coordinatesOnDeviceEvent);
  91         ~GpuHaloExchange();
  92
  93         /*! \brief
  94          *
  95          * Initialization for GPU halo exchange of coordinates buffer
  96          * \param [in] d_coordinateBuffer   pointer to coordinates buffer in GPU memory
  97          * \param [in] d_forcesBuffer   pointer to coordinates buffer in GPU memory
  98          */
  99         void reinitHalo(DeviceBuffer<float>  d_coordinateBuffer,
 100                         DeviceBuffer<float>  d_forcesBuffer);
 101
 102
 103         /*! \brief GPU halo exchange of coordinates buffer.
 104          *
 105          * Must be called after local setCoordinates (which records an
 106          * event when the coordinate data has been copied to the
 107          * device).
 108          * \param [in] box  Coordinate box (from which shifts will be constructed)
 109          */
 110         void communicateHaloCoordinates(const matrix box);
 111
 112         /*! \brief GPU halo exchange of force buffer.
 113          * \param[in] accumulateForces  True if forces should accumulate, otherwise they are set
 114          */
 115         void communicateHaloForces(bool accumulateForces);
 116
 117
 118     private:
 119         class Impl;
 120         gmx::PrivateImplPointer<Impl> impl_;
 121
 122 };
 123
 124 } //namespace gmx
 125
 126 #endif