src/gromacs/mdlib/leapfrog_cuda.cuh

   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 /*! \libinternal \file
  36  *
  37  * \brief Declarations for CUDA implementation of Leap-Frog.
  38  *
  39  * \todo Reconsider naming towards using "gpu" suffix instead of "cuda".
  40  *
  41  * \author Artem Zhmurov <zhmurov@gmail.com>
  42  *
  43  * \ingroup module_mdlib
  44  * \inlibraryapi
  45  */
  46 #ifndef GMX_MDLIB_LEAPFROG_CUDA_CUH
  47 #define GMX_MDLIB_LEAPFROG_CUDA_CUH
  48
  49 #include "gromacs/gpu_utils/gputraits.cuh"
  50 #include "gromacs/gpu_utils/hostallocator.h"
  51 #include "gromacs/mdtypes/group.h"
  52 #include "gromacs/mdtypes/mdatom.h"
  53 #include "gromacs/pbcutil/pbc.h"
  54 #include "gromacs/pbcutil/pbc_aiuc.h"
  55 #include "gromacs/utility/arrayref.h"
  56 #include "gromacs/utility/classhelpers.h"
  57
  58 namespace gmx
  59 {
  60
  61 class LeapFrogCuda
  62 {
  63
  64     public:
  65
  66         LeapFrogCuda();
  67         ~LeapFrogCuda();
  68
  69         /*! \brief
  70          * Update PBC data.
  71          *
  72          * Converts PBC data from t_pbc into the PbcAiuc format and stores the latter.
  73          *
  74          * \param[in] pbc The PBC data in t_pbc format.
  75          */
  76         void setPbc(const t_pbc *pbc);
  77
  78         /*! \brief Integrate
  79          *
  80          * Integrates the equation of motion using Leap-Frog algorithm.
  81          * Updates coordinates and velocities on the GPU.
  82          *
  83          * \param[in]     d_x                    Initial coordinates.
  84          * \param[out]    d_xp                   Place to save the resulting coordinates to.
  85          * \param[in,out] d_v                    Velocities (will be updated).
  86          * \param[in]     d_f                    Forces.
  87          * \param[in]     dt                     Timestep.
  88          * \param[in]     doTempCouple           If the temperature coupling should be applied.
  89          * \param[in]     tcstat                 Temperature coupling data.
  90          * \param[in]     doPressureCouple       If the temperature coupling should be applied.
  91          * \param[in]     dtPressureCouple       Period between pressure coupling steps
  92          * \param[in]     velocityScalingMatrix  Parrinello-Rahman velocity scaling matrix
  93          */
  94         void integrate(const float3                     *d_x,
  95                        float3                           *d_xp,
  96                        float3                           *d_v,
  97                        const float3                     *d_f,
  98                        const real                        dt,
  99                        const bool                        doTempCouple,
 100                        gmx::ArrayRef<const t_grp_tcstat> tcstat,
 101                        const bool                        doPressureCouple,
 102                        const float                       dtPressureCouple,
 103                        const matrix                      velocityScalingMatrix);
 104
 105         /*! \brief Set the integrator
 106          *
 107          * Allocates memory for inverse masses, and, if needed for temperature scaling factor(s)
 108          * and temperature coupling groups. Copies inverse masses and temperature coupling groups
 109          * to the GPU.
 110          *
 111          * \param[in] md                  MD atoms, from which inverse masses are taken.
 112          * \param[in] numTempScaleValues  Number of temperature scale groups.
 113          * \param[in] tempScaleGroups     Maps the atom index to temperature scale value.
 114          */
 115         void set(const t_mdatoms      &md,
 116                  int                   numTempScaleValues,
 117                  const unsigned short *tempScaleGroups);
 118
 119         /*! \brief Class with hardware-specific interfaces and implementations.*/
 120         class Impl;
 121
 122     private:
 123
 124         //! CUDA stream
 125         cudaStream_t           stream_;
 126         //! CUDA kernel launch config
 127         KernelLaunchConfig     kernelLaunchConfig_;
 128         //! Periodic boundary data
 129         PbcAiuc                pbcAiuc_;
 130         //! Number of atoms
 131         int                    numAtoms_;
 132
 133         //! 1/mass for all atoms (GPU)
 134         real                  *d_inverseMasses_;
 135         //! Current size of the reciprocal masses array
 136         int                    numInverseMasses_ = -1;
 137         //! Maximum size of the reciprocal masses array
 138         int                    numInverseMassesAlloc_ = -1;
 139
 140         //! Number of temperature coupling groups (zero = no coupling)
 141         int                    numTempScaleValues_ = 0;
 142         /*! \brief Array with temperature scaling factors.
 143          * This is temporary solution to remap data from t_grp_tcstat into plain array
 144          * \todo Replace with better solution.
 145          */
 146         gmx::HostVector<float> h_lambdas_;
 147         //! Device-side temperature scaling factors
 148         float                 *d_lambdas_;
 149         //! Current size of the array with temperature scaling factors (lambdas)
 150         int                    numLambdas_ = -1;
 151         //! Maximum size of the array with temperature scaling factors (lambdas)
 152         int                    numLambdasAlloc_ = -1;
 153
 154
 155         //! Array that maps atom index onto the temperature scaling group to get scaling parameter
 156         unsigned short        *d_tempScaleGroups_;
 157         //! Current size of the temperature coupling groups array
 158         int                    numTempScaleGroups_ = -1;
 159         //! Maximum size of the temperature coupling groups array
 160         int                    numTempScaleGroupsAlloc_ = -1;
 161
 162         //! Vector with diagonal elements of the pressure coupling velocity rescale factors
 163         float3                 velocityScalingMatrixDiagonal_;
 164
 165 };
 166
 167 } //namespace gmx
 168
 169 #endif