src/gromacs/mdlib/update_constrain_gpu.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 /*! \libinternal \file
  36  *
  37  * \brief Declaration of high-level functions of GPU implementation of update and constrain class.
  38  *
  39  * \author Artem Zhmurov <zhmurov@gmail.com>
  40  *
  41  * \ingroup module_mdlib
  42  * \inlibraryapi
  43  */
  44 #ifndef GMX_MDLIB_UPDATE_CONSTRAIN_GPU_H
  45 #define GMX_MDLIB_UPDATE_CONSTRAIN_GPU_H
  46
  47 #include <memory>
  48
  49 #include "gromacs/gpu_utils/devicebuffer_datatype.h"
  50 #include "gromacs/mdtypes/group.h"
  51 #include "gromacs/timing/wallcycle.h"
  52 #include "gromacs/utility/arrayref.h"
  53
  54 class DeviceContext;
  55 class DeviceStream;
  56 class GpuEventSynchronizer;
  57 struct gmx_mtop_t;
  58 enum class PbcType : int;
  59 class InteractionDefinitions;
  60 struct t_inputrec;
  61 struct t_mdatoms;
  62 struct t_pbc;
  63
  64 namespace gmx
  65 {
  66
  67 class UpdateConstrainGpu
  68 {
  69
  70 public:
  71     /*! \brief Create Update-Constrain object.
  72      *
  73      * The constructor is given a non-nullptr \p deviceStream, in which all the update and constrain
  74      * routines are executed. \p xUpdatedOnDevice should mark the completion of all kernels that
  75      * modify coordinates. The event is maintained outside this class and also passed to all (if
  76      * any) consumers of the updated coordinates. The \p xUpdatedOnDevice also can not be a nullptr
  77      * because the markEvent(...) method is called unconditionally.
  78      *
  79      * \param[in] ir                Input record data: LINCS takes number of iterations and order of
  80      *                              projection from it.
  81      * \param[in] mtop              Topology of the system: SETTLE gets the masses for O and H atoms
  82      *                              and target O-H and H-H distances from this object.
  83      * \param[in] deviceContext     GPU device context.
  84      * \param[in] deviceStream      GPU stream to use.
  85      * \param[in] xUpdatedOnDevice  The event synchronizer to use to mark that update is done
  86      *                              on the GPU.
  87      * \param[in] wcycle            The wallclock counter
  88      */
  89     UpdateConstrainGpu(const t_inputrec&     ir,
  90                        const gmx_mtop_t&     mtop,
  91                        const DeviceContext&  deviceContext,
  92                        const DeviceStream&   deviceStream,
  93                        GpuEventSynchronizer* xUpdatedOnDevice,
  94                        gmx_wallcycle*        wcycle);
  95
  96     ~UpdateConstrainGpu();
  97
  98     /*! \brief Integrate
  99      *
 100      * This will extract temperature scaling factors from tcstat, transform them into the plain
 101      * array and call the normal integrate method.
 102      *
 103      * \param[in]  fReadyOnDevice           Event synchronizer indicating that the forces are
 104      *                                      ready in 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      * \param[in]      numTempScaleValues  Number of temperature scaling groups. Zero for no temperature scaling.
 151      */
 152     void set(DeviceBuffer<RVec>            d_x,
 153              DeviceBuffer<RVec>            d_v,
 154              DeviceBuffer<RVec>            d_f,
 155              const InteractionDefinitions& idef,
 156              const t_mdatoms&              md,
 157              int                           numTempScaleValues);
 158
 159     /*! \brief
 160      * Update PBC data.
 161      *
 162      * Converts PBC data from t_pbc into the PbcAiuc format and stores the latter.
 163      *
 164      * \param[in] pbcType The type of the periodic boundary (Xyz, NO, XY or Screw).
 165      * \param[in] box     The periodic boundary box matrix.
 166      */
 167     void setPbc(PbcType pbcType, const matrix box);
 168
 169     /*! \brief Return the synchronizer associated with the event indicated that the coordinates are ready on the device.
 170      */
 171     GpuEventSynchronizer* getCoordinatesReadySync();
 172
 173     /*! \brief
 174      * Returns whether the maximum number of coupled constraints is supported
 175      * by the GPU LINCS code.
 176      *
 177      * \param[in] mtop The molecular topology
 178      */
 179     static bool isNumCoupledConstraintsSupported(const gmx_mtop_t& mtop);
 180
 181 private:
 182     class Impl;
 183     std::unique_ptr<Impl> impl_;
 184 };
 185
 186 } // namespace gmx
 187
 188 #endif // GMX_MDLIB_UPDATE_CONSTRAIN_GPU_H