src/gromacs/mdlib/gpuforcereduction_impl.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_IMPL_H
  44 #define GMX_MDLIB_GPUFORCEREDUCTION_IMPL_H
  45
  46 #include "gromacs/gpu_utils/device_stream.h"
  47 #include "gromacs/gpu_utils/devicebuffer_datatype.h"
  48 #include "gromacs/gpu_utils/gputraits.h"
  49 #include "gromacs/math/vectypes.h"
  50
  51 #include "gpuforcereduction.h"
  52
  53 namespace gmx
  54 {
  55
  56 //! \internal
  57 //! \brief structure to hold cell information for any nbat-format forces
  58 struct cellInfo
  59 {
  60     //! cell index mapping for any nbat-format forces
  61     const int* cell = nullptr;
  62     //! device copy of cell index mapping for any nbat-format forces
  63     DeviceBuffer<int> d_cell;
  64     //! number of atoms in cell array
  65     int cellSize = -1;
  66     //! number of atoms allocated in cell array
  67     int cellSizeAlloc = -1;
  68 };
  69
  70 class GpuForceReduction::Impl
  71 {
  72
  73 public:
  74     /*! \brief Creates GPU force reduction object
  75      *
  76      * \param [in] deviceStream  Stream to use for reduction
  77      * \param [in] deviceContext GPU device context
  78      * \param [in] wcycle        The wallclock counter
  79      */
  80     Impl(const DeviceContext& deviceContext, const DeviceStream& deviceStream, gmx_wallcycle* wcycle);
  81
  82     ~Impl() = default;
  83     /*! \brief Register a nbnxm-format force to be reduced
  84      *
  85      * \param [in] forcePtr  Pointer to force to be reduced
  86      */
  87     void registerNbnxmForce(DeviceBuffer<Float3> forcePtr);
  88
  89     /*! \brief Register a rvec-format force to be reduced
  90      *
  91      * \param [in] forcePtr  Pointer to force to be reduced
  92      */
  93     void registerRvecForce(DeviceBuffer<Float3> forcePtr);
  94
  95     /*! \brief Add a dependency for this force reduction
  96      *
  97      * \param [in] dependency   Dependency for this reduction
  98      */
  99     void addDependency(GpuEventSynchronizer* dependency);
 100
 101     /*! \brief Reinitialize the GPU force reduction
 102      *
 103      * \param [in] baseForcePtr     Pointer to force to be used as a base
 104      * \param [in] numAtoms         The number of atoms
 105      * \param [in] cell             Pointer to the cell array
 106      * \param [in] atomStart        The start atom for the reduction
 107      * \param [in] accumulate       Whether reduction should be accumulated
 108      * \param [in] completionMarker Event to be marked when launch of reduction is complete
 109      */
 110     void reinit(DeviceBuffer<Float3>  baseForcePtr,
 111                 int                   numAtoms,
 112                 ArrayRef<const int>   cell,
 113                 int                   atomStart,
 114                 bool                  accumulate,
 115                 GpuEventSynchronizer* completionMarker = nullptr);
 116
 117     /*! \brief Execute the force reduction */
 118     void execute();
 119
 120 private:
 121     //! force to be used as a base for this reduction
 122     DeviceBuffer<Float3> baseForce_;
 123     //! starting atom
 124     int atomStart_ = 0;
 125     //! number of atoms
 126     int numAtoms_ = 0;
 127     //! whether reduction is accumulated into base force buffer
 128     bool accumulate_ = true;
 129     //! cell information for any nbat-format forces
 130     struct cellInfo cellInfo_;
 131     //! GPU context object
 132     const DeviceContext& deviceContext_;
 133     //! list of dependencies
 134     gmx::FixedCapacityVector<GpuEventSynchronizer*, 3> dependencyList_;
 135     //! stream to be used for this reduction
 136     const DeviceStream& deviceStream_;
 137     //! Nbnxm force to be added in this reduction
 138     DeviceBuffer<RVec> nbnxmForceToAdd_;
 139     //! Rvec-format force to be added in this reduction
 140     DeviceBuffer<RVec> rvecForceToAdd_;
 141     //! event to be marked when reduction launch has been completed
 142     GpuEventSynchronizer* completionMarker_ = nullptr;
 143     //! The wallclock counter
 144     gmx_wallcycle* wcycle_ = nullptr;
 145 };
 146
 147 } // namespace gmx
 148
 149 #endif