src/gromacs/mdlib/update_constrain_gpu_impl.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019,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 GPU implementation class for update and constraints.
  38  *
  39  * This header file is needed to include from both the device-side
  40  * kernels file, and the host-side management code.
  41  *
  42  * \author Artem Zhmurov <zhmurov@gmail.com>
  43  *
  44  * \ingroup module_mdlib
  45  */
  46 #ifndef GMX_MDLIB_UPDATE_CONSTRAIN_GPU_IMPL_H
  47 #define GMX_MDLIB_UPDATE_CONSTRAIN_GPU_IMPL_H
  48
  49 #include "gmxpre.h"
  50
  51 #include "config.h"
  52
  53 #include "gromacs/gpu_utils/gpueventsynchronizer.h"
  54 #include "gromacs/mdlib/leapfrog_gpu.h"
  55 #include "gromacs/mdlib/lincs_gpu.h"
  56 #include "gromacs/mdlib/settle_gpu.h"
  57 #include "gromacs/mdlib/update_constrain_gpu.h"
  58 #include "gromacs/mdtypes/inputrec.h"
  59
  60 class GpuEventSynchronizer;
  61
  62 namespace gmx
  63 {
  64
  65 /*! \internal \brief Class with interfaces and data for GPU version of Update-Constraint. */
  66 class UpdateConstrainGpu::Impl
  67 {
  68
  69 public:
  70     /*! \brief Create Update-Constrain object.
  71      *
  72      * The constructor is given a non-nullptr \p deviceStream, in which all the update and constrain
  73      * routines are executed.
  74      *
  75      * \param[in] ir                  Input record data: LINCS takes number of iterations and order of
  76      *                                projection from it.
  77      * \param[in] mtop                Topology of the system: SETTLE gets the masses for O and H atoms
  78      *                                and target O-H and H-H distances from this object.
  79      * \param[in] numTempScaleValues  Number of temperature scaling groups. Set zero for no temperature coupling.
  80      * \param[in] deviceContext       GPU device context.
  81      * \param[in] deviceStream        GPU stream to use.
  82      * \param[in] wcycle              The wallclock counter
  83      */
  84     Impl(const t_inputrec&    ir,
  85          const gmx_mtop_t&    mtop,
  86          int                  numTempScaleValues,
  87          const DeviceContext& deviceContext,
  88          const DeviceStream&  deviceStream,
  89          gmx_wallcycle*       wcycle);
  90
  91     ~Impl();
  92
  93     /*! \brief Integrate
  94      *
  95      * Integrates the equation of motion using Leap-Frog algorithm and applies
  96      * LINCS and SETTLE constraints.
  97      * If computeVirial is true, constraints virial is written at the provided pointer.
  98      * doTempCouple should be true if:
  99      *   1. The temperature coupling is enabled.
 100      *   2. This is the temperature coupling step.
 101      * Parameters virial/lambdas can be nullptr if computeVirial/doTempCouple are false.
 102      *
 103      * \param[in]  fReadyOnDevice           Event synchronizer indicating that the forces are ready in
 104      *                                      the device memory.
 105      * \param[in]  dt                       Timestep.
 106      * \param[in]  updateVelocities         If the velocities should be constrained.
 107      * \param[in]  computeVirial            If virial should be updated.
 108      * \param[out] virial                   Place to save virial tensor.
 109      * \param[in]  doTemperatureScaling     If velocities should be scaled for temperature coupling.
 110      * \param[in]  tcstat                   Temperature coupling data.
 111      * \param[in]  doParrinelloRahman       If current step is a Parrinello-Rahman pressure coupling step.
 112      * \param[in]  dtPressureCouple         Period between pressure coupling steps.
 113      * \param[in]  prVelocityScalingMatrix  Parrinello-Rahman velocity scaling matrix.
 114      */
 115     void integrate(GpuEventSynchronizer*             fReadyOnDevice,
 116                    real                              dt,
 117                    bool                              updateVelocities,
 118                    bool                              computeVirial,
 119                    tensor                            virial,
 120                    bool                              doTemperatureScaling,
 121                    gmx::ArrayRef<const t_grp_tcstat> tcstat,
 122                    bool                              doParrinelloRahman,
 123                    float                             dtPressureCouple,
 124                    const matrix                      prVelocityScalingMatrix);
 125
 126     /*! \brief Scale coordinates on the GPU for the pressure coupling.
 127      *
 128      * After pressure coupling step, the box size may change. Hence, the coordinates should be
 129      * scaled so that all the particles fit in the new box.
 130      *
 131      * \param[in] scalingMatrix Coordinates scaling matrix.
 132      */
 133     void scaleCoordinates(const matrix scalingMatrix);
 134
 135     /*! \brief Scale velocities on the GPU for the pressure coupling.
 136      *
 137      * After pressure coupling step, the box size may change. In the C-Rescale algorithm, velocities should be scaled.
 138      *
 139      * \param[in] scalingMatrix Velocities scaling matrix.
 140      */
 141     void scaleVelocities(const matrix scalingMatrix);
 142
 143     /*! \brief Set the pointers and update data-structures (e.g. after NB search step).
 144      *
 145      * \param[in,out]  d_x            Device buffer with coordinates.
 146      * \param[in,out]  d_v            Device buffer with velocities.
 147      * \param[in]      d_f            Device buffer with forces.
 148      * \param[in] idef                System topology
 149      * \param[in] md                  Atoms data.
 150      */
 151     void set(DeviceBuffer<Float3>          d_x,
 152              DeviceBuffer<Float3>          d_v,
 153              DeviceBuffer<Float3>          d_f,
 154              const InteractionDefinitions& idef,
 155              const t_mdatoms&              md);
 156
 157     /*! \brief
 158      * Update PBC data.
 159      *
 160      * Converts PBC data from t_pbc into the PbcAiuc format and stores the latter.
 161      *
 162      * \param[in] pbcType The type of the periodic boundary.
 163      * \param[in] box     The periodic boundary box matrix.
 164      */
 165     void setPbc(PbcType pbcType, const matrix box);
 166
 167     /*! \brief Return the synchronizer associated with the event indicated that the coordinates are ready on the device.
 168      */
 169     GpuEventSynchronizer* xUpdatedOnDeviceEvent();
 170
 171     /*! \brief
 172      * Returns whether the maximum number of coupled constraints is supported
 173      * by the GPU LINCS code.
 174      *
 175      * \param[in] mtop The molecular topology
 176      */
 177     static bool isNumCoupledConstraintsSupported(const gmx_mtop_t& mtop);
 178
 179 private:
 180     //! GPU context object
 181     const DeviceContext& deviceContext_;
 182     //! GPU stream
 183     const DeviceStream& deviceStream_;
 184     //! GPU kernel launch config
 185     KernelLaunchConfig coordinateScalingKernelLaunchConfig_;
 186
 187     //! Periodic boundary data
 188     PbcAiuc pbcAiuc_;
 189
 190     //! Number of atoms
 191     int numAtoms_;
 192
 193     //! Local copy of the pointer to the device positions buffer
 194     DeviceBuffer<Float3> d_x_;
 195     //! Local copy of the pointer to the device velocities buffer
 196     DeviceBuffer<Float3> d_v_;
 197     //! Local copy of the pointer to the device forces buffer
 198     DeviceBuffer<Float3> d_f_;
 199
 200     //! Device buffer for intermediate positions (maintained internally)
 201     DeviceBuffer<Float3> d_xp_;
 202     //! Number of elements in shifted coordinates buffer
 203     int numXp_ = -1;
 204     //! Allocation size for the shifted coordinates buffer
 205     int numXpAlloc_ = -1;
 206
 207
 208     //! 1/mass for all atoms (GPU)
 209     DeviceBuffer<real> d_inverseMasses_;
 210     //! Number of elements in reciprocal masses buffer
 211     int numInverseMasses_ = -1;
 212     //! Allocation size for the reciprocal masses buffer
 213     int numInverseMassesAlloc_ = -1;
 214
 215     //! Leap-Frog integrator
 216     std::unique_ptr<LeapFrogGpu> integrator_;
 217     //! LINCS GPU object to use for non-water constraints
 218     std::unique_ptr<LincsGpu> lincsGpu_;
 219     //! SETTLE GPU object for water constrains
 220     std::unique_ptr<SettleGpu> settleGpu_;
 221
 222     //! The event to indicate when the update of coordinates is complete
 223     GpuEventSynchronizer xUpdatedOnDeviceEvent_;
 224     //! The wallclock counter
 225     gmx_wallcycle* wcycle_ = nullptr;
 226 };
 227
 228 } // namespace gmx
 229
 230 #endif // GMX_MDLIB_UPDATE_CONSTRAIN_GPU_IMPL_H