src/gromacs/mdlib/lincs_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 Declare backend-specific LINCS GPU functions
  38  *
  39  * \author Artem Zhmurov <zhmurov@gmail.com>
  40  * \author Alan Gray <alang@nvidia.com>
  41  *
  42  * \ingroup module_mdlib
  43  */
  44 #ifndef GMX_MDLIB_LINCS_GPU_INTERNAL_H
  45 #define GMX_MDLIB_LINCS_GPU_INTERNAL_H
  46
  47 #include "gromacs/gpu_utils/devicebuffer_datatype.h"
  48 #include "gromacs/gpu_utils/gputraits.h"
  49
  50 class DeviceStream;
  51
  52 namespace gmx
  53 {
  54
  55 struct LincsGpuKernelParameters;
  56
  57 //! Number of threads in a GPU block
  58 constexpr static int c_threadsPerBlock = 256;
  59
  60 void launchLincsGpuKernel(const LincsGpuKernelParameters& kernelParams,
  61                           const DeviceBuffer<Float3>&     d_x,
  62                           DeviceBuffer<Float3>            d_xp,
  63                           bool                            updateVelocities,
  64                           DeviceBuffer<Float3>            d_v,
  65                           real                            invdt,
  66                           bool                            computeVirial,
  67                           const DeviceStream&             deviceStream);
  68
  69 } // namespace gmx
  70
  71 #endif // GMX_MDLIB_LINCS_GPU_INTERNAL_H