src/gromacs/ewald/pme.cuh

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2017,2018, 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 This file defines the PME CUDA-specific data structure,
  38  * various compile-time constants shared among the PME CUDA kernels,
  39  * and also names some PME CUDA memory management routines.
  40  * TODO: consider changing defines into variables where possible; have inline getters.
  41  *
  42  * \author Aleksei Iupinov <a.yupinov@gmail.com>
  43  */
  44
  45 #ifndef GMX_EWALD_PME_CUH
  46 #define GMX_EWALD_PME_CUH
  47
  48 #include <cassert>
  49
  50 #include "pme-gpu-constants.h"
  51 #include "pme-gpu-internal.h"
  52 #include "pme-gpu-types.h"
  53 #include "pme-gpu-types-host.h"
  54 #include "pme-gpu-types-host-impl.h"
  55
  56 /*! \brief \internal
  57  * An inline CUDA function for checking the global atom data indices against the atom data array sizes.
  58  *
  59  * \param[in] atomDataIndexGlobal  The atom data index.
  60  * \param[in] nAtomData            The atom data array element count.
  61  * \returns                        Non-0 if index is within bounds (or PME data padding is enabled), 0 otherwise.
  62  *
  63  * This is called from the spline_and_spread and gather PME kernels.
  64  * The goal is to isolate the global range checks, and allow avoiding them with c_usePadding enabled.
  65  */
  66 int __device__ __forceinline__ pme_gpu_check_atom_data_index(const int atomDataIndex, const int nAtomData)
  67 {
  68     return c_usePadding ? 1 : (atomDataIndex < nAtomData);
  69 }
  70
  71 /*! \brief \internal
  72  * An inline CUDA function for skipping the zero-charge atoms.
  73  *
  74  * \returns                        Non-0 if atom should be processed, 0 otherwise.
  75  * \param[in] coefficient          The atom charge.
  76  *
  77  * This is called from the spline_and_spread and gather PME kernels.
  78  */
  79 int __device__ __forceinline__ pme_gpu_check_atom_charge(const float coefficient)
  80 {
  81     assert(isfinite(coefficient));
  82     return c_skipNeutralAtoms ? (coefficient != 0.0f) : 1;
  83 }
  84
  85 /*! \brief \internal
  86  * Given possibly large \p blockCount, returns a compact 1D or 2D grid for kernel scheduling,
  87  * to minimize number of unused blocks.
  88  */
  89 template <typename PmeGpu>
  90 dim3 __host__ inline pmeGpuCreateGrid(const PmeGpu *pmeGpu, int blockCount)
  91 {
  92     // How many maximum widths in X do we need (hopefully just one)
  93     const int minRowCount = (blockCount + pmeGpu->maxGridWidthX - 1) / pmeGpu->maxGridWidthX;
  94     // Trying to make things even
  95     const int colCount = (blockCount + minRowCount - 1) / minRowCount;
  96     GMX_ASSERT((colCount * minRowCount - blockCount) >= 0, "pmeGpuCreateGrid: totally wrong");
  97     GMX_ASSERT((colCount * minRowCount - blockCount) < minRowCount, "pmeGpuCreateGrid: excessive blocks");
  98     return dim3(colCount, minRowCount);
  99 }
 100
 101 /*! \brief \internal
 102  * A single structure encompassing all the PME data used in CUDA kernels.
 103  * This inherits from PmeGpuKernelParamsBase and adds a couple cudaTextureObject_t handles,
 104  * which we would like to avoid in plain C++.
 105  */
 106 struct PmeGpuCudaKernelParams : PmeGpuKernelParamsBase
 107 {
 108     /* These are CUDA texture objects, related to the grid size. */
 109     /*! \brief CUDA texture object for accessing grid.d_fractShiftsTable */
 110     cudaTextureObject_t fractShiftsTableTexture;
 111     /*! \brief CUDA texture object for accessing grid.d_gridlineIndicesTable */
 112     cudaTextureObject_t gridlineIndicesTableTexture;
 113 };
 114
 115 #endif