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/math/vectypes.h"
  46 #include "gromacs/utility/basedefinitions.h"
  47 #include "gromacs/utility/classhelpers.h"
  48 #include "gromacs/utility/gmxmpi.h"
  49
  50 struct gmx_domdec_t;
  51
  52 namespace gmx
  53 {
  54
  55 /*! \libinternal
  56  * \brief Manages GPU Halo Exchange object */
  57 class GpuHaloExchange
  58 {
  59
  60     public:
  61         /*! \brief Creates GPU Halo Exchange object.
  62          *
  63          * Halo exchange will be performed in \c streamNonLocal, and
  64          * the main communicateHaloCoordinates method must be called
  65          * before any subsequent operations that access non-local
  66          * parts of the coordinate buffer (such as the non-local
  67          * non-bonded kernels). It also must be called after the local
  68          * coordinates buffer operations (where the coordinates are
  69          * copied to the device and hence the \c
  70          * coordinatesOnDeviceEvent is recorded).
  71          *
  72          * \param [inout] dd                       domdec structure
  73          * \param [in]    mpi_comm_mysim           communicator used for simulation
  74          * \param [in]    streamNonLocal           non-local NB CUDA stream.
  75          * \param [in]    coordinatesOnDeviceEvent event recorded when coordinates have been copied to device
  76          */
  77         GpuHaloExchange(gmx_domdec_t *dd,
  78                         MPI_Comm      mpi_comm_mysim,
  79                         void         *streamNonLocal,
  80                         void         *coordinatesOnDeviceEvent);
  81         ~GpuHaloExchange();
  82
  83         /*! \brief
  84          *
  85          * Initialization for GPU halo exchange of coordinates buffer
  86          * \param [in] d_coordinateBuffer   pointer to coordinates buffer in GPU memory
  87          */
  88         void reinitHalo(rvec *d_coordinateBuffer);
  89
  90
  91         /*! \brief GPU halo exchange of coordinates buffer.
  92          *
  93          * Must be called after local setCoordinates (which records an
  94          * event when the coordinate data has been copied to the
  95          * device).
  96          * \param [in] box  Coordinate box (from which shifts will be constructed)
  97          */
  98         void communicateHaloCoordinates(const matrix box);
  99
 100     private:
 101         class Impl;
 102         gmx::PrivateImplPointer<Impl> impl_;
 103
 104 };
 105
 106 } //namespace gmx
 107
 108 #endif