src/gromacs/mdlib/update_constrain_cuda_impl.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 /*! \internal \file
  36  *
  37  * \brief Declares CUDA 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_CUDA_IMPL_H
  47 #define GMX_MDLIB_UPDATE_CONSTRAIN_CUDA_IMPL_H
  48
  49 #include "gmxpre.h"
  50
  51 #include "gromacs/gpu_utils/gpueventsynchronizer.cuh"
  52 #include "gromacs/mdlib/leapfrog_cuda.cuh"
  53 #include "gromacs/mdlib/lincs_cuda.cuh"
  54 #include "gromacs/mdlib/settle_cuda.cuh"
  55 #include "gromacs/mdlib/update_constrain_cuda.h"
  56 #include "gromacs/mdtypes/inputrec.h"
  57
  58 namespace gmx
  59 {
  60
  61 /*! \internal \brief Class with interfaces and data for CUDA version of Update-Constraint. */
  62 class UpdateConstrainCuda::Impl
  63 {
  64
  65 public:
  66     /*! \brief Create Update-Constrain object.
  67      *
  68      * The constructor is given a non-nullptr \p commandStream, in which all the update and constrain
  69      * routines are executed. \p xUpdatedOnDevice should mark the completion of all kernels that modify
  70      * coordinates. The event is maintained outside this class and also passed to all (if any) consumers
  71      * of the updated coordinates. The \p xUpdatedOnDevice also can not be a nullptr because the
  72      * markEvent(...) method is called unconditionally.
  73      *
  74      * \param[in] ir                Input record data: LINCS takes number of iterations and order of
  75      *                              projection from it.
  76      * \param[in] mtop              Topology of the system: SETTLE gets the masses for O and H atoms
  77      *                              and target O-H and H-H distances from this object.
  78      * \param[in] commandStream     GPU stream to use. Can be nullptr.
  79      * \param[in] xUpdatedOnDevice  The event synchronizer to use to mark that update is done on the GPU.
  80      */
  81     Impl(const t_inputrec& ir, const gmx_mtop_t& mtop, const void* commandStream, GpuEventSynchronizer* xUpdatedOnDevice);
  82
  83     ~Impl();
  84
  85     /*! \brief Integrate
  86      *
  87      * Integrates the equation of motion using Leap-Frog algorithm and applies
  88      * LINCS and SETTLE constraints.
  89      * If computeVirial is true, constraints virial is written at the provided pointer.
  90      * doTempCouple should be true if:
  91      *   1. The temperature coupling is enabled.
  92      *   2. This is the temperature coupling step.
  93      * Parameters virial/lambdas can be nullptr if computeVirial/doTempCouple are false.
  94      *
  95      * \param[in]  fReadyOnDevice           Event synchronizer indicating that the forces are ready in
  96      *                                      the device memory.
  97      * \param[in]  dt                       Timestep.
  98      * \param[in]  updateVelocities         If the velocities should be constrained.
  99      * \param[in]  computeVirial            If virial should be updated.
 100      * \param[out] virial                   Place to save virial tensor.
 101      * \param[in]  doTemperatureScaling     If velocities should be scaled for temperature coupling.
 102      * \param[in]  tcstat                   Temperature coupling data.
 103      * \param[in]  doParrinelloRahman       If current step is a Parrinello-Rahman pressure coupling step.
 104      * \param[in]  dtPressureCouple         Period between pressure coupling steps.
 105      * \param[in]  prVelocityScalingMatrix  Parrinello-Rahman velocity scaling matrix.
 106      */
 107     void integrate(GpuEventSynchronizer*             fReadyOnDevice,
 108                    real                              dt,
 109                    bool                              updateVelocities,
 110                    bool                              computeVirial,
 111                    tensor                            virial,
 112                    bool                              doTemperatureScaling,
 113                    gmx::ArrayRef<const t_grp_tcstat> tcstat,
 114                    bool                              doParrinelloRahman,
 115                    float                             dtPressureCouple,
 116                    const matrix                      prVelocityScalingMatrix);
 117
 118     /*! \brief Scale coordinates on the GPU for the pressure coupling.
 119      *
 120      * After pressure coupling step, the box size may change. Hence, the coordinates should be
 121      * scaled so that all the particles fit in the new box.
 122      *
 123      * \param[in] scalingMatrix Coordinates scaling matrix.
 124      */
 125     void scaleCoordinates(const matrix scalingMatrix);
 126
 127     /*! \brief Set the pointers and update data-structures (e.g. after NB search step).
 128      *
 129      * \param[in,out]  d_x            Device buffer with coordinates.
 130      * \param[in,out]  d_v            Device buffer with velocities.
 131      * \param[in]      d_f            Device buffer with forces.
 132      * \param[in] idef                System topology
 133      * \param[in] md                  Atoms data.
 134      * \param[in] numTempScaleValues  Number of temperature scaling groups. Set zero for no temperature coupling.
 135      */
 136     void set(DeviceBuffer<float>       d_x,
 137              DeviceBuffer<float>       d_v,
 138              const DeviceBuffer<float> d_f,
 139              const t_idef&             idef,
 140              const t_mdatoms&          md,
 141              const int                 numTempScaleValues);
 142
 143     /*! \brief
 144      * Update PBC data.
 145      *
 146      * Converts PBC data from t_pbc into the PbcAiuc format and stores the latter.
 147      *
 148      * \param[in] pbc The PBC data in t_pbc format.
 149      */
 150     void setPbc(const t_pbc* pbc);
 151
 152     /*! \brief Return the synchronizer associated with the event indicated that the coordinates are ready on the device.
 153      */
 154     GpuEventSynchronizer* getCoordinatesReadySync();
 155
 156 private:
 157     //! CUDA stream
 158     CommandStream commandStream_ = nullptr;
 159     //! CUDA kernel launch config
 160     KernelLaunchConfig coordinateScalingKernelLaunchConfig_;
 161
 162     //! Periodic boundary data
 163     PbcAiuc pbcAiuc_;
 164
 165     //! Number of atoms
 166     int numAtoms_;
 167
 168     //! Local copy of the pointer to the device positions buffer
 169     float3* d_x_;
 170     //! Local copy of the pointer to the device velocities buffer
 171     float3* d_v_;
 172     //! Local copy of the pointer to the device forces buffer
 173     float3* d_f_;
 174
 175     //! Device buffer for intermediate positions (maintained internally)
 176     float3* d_xp_;
 177     //! Number of elements in shifted coordinates buffer
 178     int numXp_ = -1;
 179     //! Allocation size for the shifted coordinates buffer
 180     int numXpAlloc_ = -1;
 181
 182
 183     //! 1/mass for all atoms (GPU)
 184     real* d_inverseMasses_;
 185     //! Number of elements in reciprocal masses buffer
 186     int numInverseMasses_ = -1;
 187     //! Allocation size for the reciprocal masses buffer
 188     int numInverseMassesAlloc_ = -1;
 189
 190     //! Leap-Frog integrator
 191     std::unique_ptr<LeapFrogCuda> integrator_;
 192     //! LINCS CUDA object to use for non-water constraints
 193     std::unique_ptr<LincsCuda> lincsCuda_;
 194     //! SETTLE CUDA object for water constrains
 195     std::unique_ptr<SettleCuda> settleCuda_;
 196
 197     //! An pointer to the event to indicate when the update of coordinates is complete
 198     GpuEventSynchronizer* coordinatesReady_;
 199 };
 200
 201 } // namespace gmx
 202
 203 #endif