src/gromacs/mdlib/gpuforcereduction.h

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