src/gromacs/nbnxm/nbnxm_gpu_buffer_ops_internal.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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
  36 /*! \internal \file
  37  *  \brief
  38  *  Wrapper for the backend-specific coordinate layout conversion functionality
  39  *
  40  *  \ingroup module_nbnxm
  41  */
  42 #include "gromacs/gpu_utils/devicebuffer_datatype.h"
  43 #include "gromacs/gpu_utils/gputraits.h"
  44
  45 class DeviceStream;
  46 struct NbnxmGpu;
  47
  48 namespace Nbnxm
  49 {
  50
  51 class Grid;
  52
  53 /*! \brief Launch coordinate layout conversion kernel
  54  *
  55  * \param[in]     grid          Pair-search grid.
  56  * \param[in,out] nb            Nbnxm main structure.
  57  * \param[in]     d_x           Source atom coordinates.
  58  * \param[in]     deviceStream  Device stream for kernel submission.
  59  * \param[in]     numColumnsMax Max. number of columns per grid for offset calculation in \p nb.
  60  * \param[in]     gridId        Grid index for offset calculation in \p nb.
  61  */
  62 void launchNbnxmKernelTransformXToXq(const Grid&          grid,
  63                                      NbnxmGpu*            nb,
  64                                      DeviceBuffer<Float3> d_x,
  65                                      const DeviceStream&  deviceStream,
  66                                      unsigned int         numColumnsMax,
  67                                      int                  gridId);
  68
  69 } // namespace Nbnxm