src/gromacs/mdlib/settle_gpu_internal.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 backend-specific functions for GPU implementation of SETTLE.
  38  *
  39  * \author Artem Zhmurov <zhmurov@gmail.com>
  40  *
  41  * \ingroup module_mdlib
  42  */
  43 #ifndef GMX_MDLIB_SETTLE_GPU_INTERNAL_H
  44 #define GMX_MDLIB_SETTLE_GPU_INTERNAL_H
  45
  46 #include "gromacs/gpu_utils/devicebuffer_datatype.h"
  47 #include "gromacs/gpu_utils/gputraits.h"
  48 #include "gromacs/mdlib/settle_gpu.h"
  49
  50 namespace gmx
  51 {
  52
  53 /*! \brief Apply SETTLE.
  54  *
  55  * Applies SETTLE to coordinates and velocities, stored on GPU. Data at pointers d_xp and
  56  * d_v change in the GPU memory. The results are not automatically copied back to the CPU
  57  * memory. Method uses this class data structures which should be updated when needed using
  58  * update method.
  59  *
  60  * \param[in]     numSettles        Number of SETTLE constraints.
  61  * \param[in]     d_atomIds         Device buffer with indices of atoms to be SETTLEd.
  62  * \param[in]     settleParameters  Parameters for SETTLE constraints.
  63  * \param[in]     d_x               Coordinates before timestep (in GPU memory)
  64  * \param[in,out] d_xp              Coordinates after timestep (in GPU memory). The
  65  *                                  resulting constrained coordinates will be saved here.
  66  * \param[in]     updateVelocities  If the velocities should be updated.
  67  * \param[in,out] d_v               Velocities to update (in GPU memory, can be nullptr
  68  *                                  if not updated)
  69  * \param[in]     invdt             Reciprocal timestep (to scale Lagrange
  70  *                                  multipliers when velocities are updated)
  71  * \param[in]     computeVirial     If virial should be updated.
  72  * \param[in,out] virialScaled      Scaled virial tensor to be updated.
  73  * \param[in]     pbcAiuc           PBC data.
  74  * \param[in]     deviceStream      Device stream to launch kernel in.
  75  */
  76 void launchSettleGpuKernel(int                                numSettles,
  77                            const DeviceBuffer<WaterMolecule>& d_atomIds,
  78                            const SettleParameters&            settleParameters,
  79                            const DeviceBuffer<Float3>&        d_x,
  80                            DeviceBuffer<Float3>               d_xp,
  81                            bool                               updateVelocities,
  82                            DeviceBuffer<Float3>               d_v,
  83                            real                               invdt,
  84                            bool                               computeVirial,
  85                            DeviceBuffer<float>                virialScaled,
  86                            const PbcAiuc&                     pbcAiuc,
  87                            const DeviceStream&                deviceStream);
  88
  89 } // namespace gmx
  90
  91 #endif // GMX_MDLIB_SETTLE_GPU_INTERNAL_H