src/gromacs/listed_forces/gpubonded.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014,2015,2016,2017,2018,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  *
  37  * \brief This file contains declarations of high-level functions used
  38  * by mdrun to compute energies and forces for listed interactions.
  39  *
  40  * Clients of libgromacs that want to evaluate listed interactions
  41  * should call functions declared here.
  42  *
  43  * \author Mark Abraham <mark.j.abraham@gmail.com>
  44  *
  45  * \inlibraryapi
  46  * \ingroup module_listed_forces
  47  */
  48 #ifndef GMX_LISTED_FORCES_GPUBONDED_H
  49 #define GMX_LISTED_FORCES_GPUBONDED_H
  50
  51 #include "gromacs/math/vectypes.h"
  52 #include "gromacs/topology/idef.h"
  53 #include "gromacs/utility/arrayref.h"
  54 #include "gromacs/utility/classhelpers.h"
  55
  56 struct gmx_enerdata_t;
  57 struct gmx_ffparams_t;
  58 struct gmx_mtop_t;
  59 struct t_forcerec;
  60 struct t_idef;
  61 struct t_inputrec;
  62
  63 /*! \brief The number on bonded function types supported on GPUs */
  64 static constexpr int nFtypesOnGpu = 8;
  65
  66 namespace gmx
  67 {
  68
  69 /*! \brief List of all bonded function types supported on GPUs
  70  *
  71  * \note This list should be in sync with the actual GPU code.
  72  * \note Perturbed interactions are not supported on GPUs.
  73  * \note The function types in the list are ordered on increasing value.
  74  * \note Currently bonded are only supported with CUDA, not with OpenCL.
  75  */
  76 constexpr std::array<int, nFtypesOnGpu> ftypesOnGpu =
  77 {
  78     F_BONDS,
  79     F_ANGLES,
  80     F_UREY_BRADLEY,
  81     F_PDIHS,
  82     F_RBDIHS,
  83     F_IDIHS,
  84     F_PIDIHS,
  85     F_LJ14
  86 };
  87
  88 /*! \brief Checks whether the GROMACS build allows to compute bonded interactions on a GPU.
  89  *
  90  * \param[out] error  If non-null, the diagnostic message when bondeds cannot run on a GPU.
  91  *
  92  * \returns true when this build can run bonded interactions on a GPU, false otherwise.
  93  *
  94  * \throws std::bad_alloc when out of memory.
  95  */
  96 bool buildSupportsGpuBondeds(std::string *error);
  97
  98 /*! \brief Checks whether the input system allows to compute bonded interactions on a GPU.
  99  *
 100  * \param[in]  ir     Input system.
 101  * \param[in]  mtop   Complete system topology to search for supported interactions.
 102  * \param[out] error  If non-null, the error message if the input is not supported on GPU.
 103  *
 104  * \returns true if PME can run on GPU with this input, false otherwise.
 105  */
 106 bool inputSupportsGpuBondeds(const t_inputrec &ir,
 107                              const gmx_mtop_t &mtop,
 108                              std::string      *error);
 109
 110 class GpuBonded
 111 {
 112     public:
 113         //! Construct the manager with constant data and the stream to use.
 114         GpuBonded(const gmx_ffparams_t &ffparams,
 115                   void                 *streamPtr);
 116         //! Destructor
 117         ~GpuBonded();
 118
 119         /*! \brief Update lists of interactions from idef suitable for the GPU,
 120          * using the data structures prepared for PP work.
 121          *
 122          * Intended to be called after each neighbour search
 123          * stage. Copies the bonded interactions assigned to the GPU
 124          * to device data structures, and updates device buffers that
 125          * may have been updated after search. */
 126         void updateInteractionListsAndDeviceBuffers(ArrayRef<const int>  nbnxnAtomOrder,
 127                                                     const t_idef        &idef,
 128                                                     void                *xqDevice,
 129                                                     void                *forceDevice,
 130                                                     void                *fshiftDevice);
 131         /*! \brief Returns whether there are bonded interactions
 132          * assigned to the GPU */
 133         bool haveInteractions() const;
 134         /*! \brief Launches bonded kernel on a GPU */
 135         void launchKernel(const t_forcerec *fr,
 136                           int               forceFlags,
 137                           const matrix      box);
 138         /*! \brief Launches the transfer of computed bonded energies. */
 139         void launchEnergyTransfer();
 140         /*! \brief Waits on the energy transfer, and accumulates bonded energies to \c enerd. */
 141         void accumulateEnergyTerms(gmx_enerdata_t *enerd);
 142         /*! \brief Clears the device side energy buffer */
 143         void clearEnergies();
 144
 145     private:
 146         class Impl;
 147         PrivateImplPointer<Impl> impl_;
 148 };
 149
 150 } // namespace gmx
 151
 152 #endif