src/gromacs/mdlib/gpuforcereduction.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 Declares the GPU Force Reduction
  38  *
  39  * \author Alan Gray <alang@nvidia.com>
  40  *
  41  * \ingroup module_mdlib
  42  */
  43 #ifndef GMX_MDLIB_GPUFORCEREDUCTION_H
  44 #define GMX_MDLIB_GPUFORCEREDUCTION_H
  45
  46 #include <memory>
  47
  48 #include "gromacs/gpu_utils/devicebuffer_datatype.h"
  49 #include "gromacs/math/vectypes.h"
  50 #include "gromacs/timing/wallcycle.h"
  51 #include "gromacs/utility/arrayref.h"
  52 #include "gromacs/utility/fixedcapacityvector.h"
  53
  54 class GpuEventSynchronizer;
  55 class DeviceStream;
  56 class DeviceContext;
  57
  58 namespace gmx
  59 {
  60
  61 /*! \internal
  62  * \brief Manages the force reduction directly in GPU memory
  63  *
  64  * Manages the reduction of multiple GPU force buffers into a single
  65  * GPU force buffer. The reduction involves at least one (input/output)
  66  * Rvec-format buffer and one (input) Nbat-format buffer, where the
  67  * Nbat->Rvec conversion is handled internally. One additional (input)
  68  * Rvec-format buffer is supported as optional.
  69  */
  70 class GpuForceReduction
  71 {
  72
  73 public:
  74     /*! \brief Creates GPU force reduction object
  75      *
  76      * \param [in] deviceContext GPU device context
  77      * \param [in] deviceStream  Stream to use for reduction
  78      * \param [in] wcycle        Wall-clock cycle counter
  79      */
  80     GpuForceReduction(const DeviceContext& deviceContext,
  81                       const DeviceStream&  deviceStream,
  82                       gmx_wallcycle*       wcycle);
  83     ~GpuForceReduction();
  84
  85     /*! \brief Register a nbnxm-format force to be reduced
  86      *
  87      * \param [in] forcePtr  Pointer to force to be reduced
  88      */
  89     void registerNbnxmForce(DeviceBuffer<RVec> forcePtr);
  90
  91     /*! \brief Register a rvec-format force to be reduced
  92      *
  93      * \param [in] forcePtr  Pointer to force to be reduced
  94      */
  95     void registerRvecForce(DeviceBuffer<RVec> forcePtr);
  96
  97     /*! \brief Add a dependency for this force reduction
  98      *
  99      * \param [in] dependency   Dependency for this reduction
 100      */
 101     void addDependency(GpuEventSynchronizer* dependency);
 102
 103     /*! \brief Reinitialize the GPU force reduction
 104      *
 105      * \param [in] baseForce        Pointer to force to be used as a base
 106      * \param [in] numAtoms         The number of atoms
 107      * \param [in] cell             Pointer to the cell array
 108      * \param [in] atomStart        The start atom for the reduction
 109      * \param [in] accumulate       Whether reduction should be accumulated
 110      * \param [in] completionMarker Event to be marked when launch of reduction is complete
 111      */
 112     void reinit(DeviceBuffer<RVec>    baseForce,
 113                 int                   numAtoms,
 114                 ArrayRef<const int>   cell,
 115                 int                   atomStart,
 116                 bool                  accumulate,
 117                 GpuEventSynchronizer* completionMarker = nullptr);
 118
 119     /*! \brief Execute the force reduction */
 120     void execute();
 121
 122 private:
 123     class Impl;
 124     std::unique_ptr<Impl> impl_;
 125 };
 126
 127 } // namespace gmx
 128
 129 #endif