src/gromacs/nbnxm/pairlistparams.h

   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
  36 /*! \internal \file
  37  *
  38  * \brief
  39  * Declares the PairlistType enum and PairlistParams class
  40  *
  41  * \author Berk Hess <hess@kth.se>
  42  * \ingroup module_nbnxm
  43  */
  44
  45 #ifndef GMX_NBNXM_PAIRLISTPARAMS_H
  46 #define GMX_NBNXM_PAIRLISTPARAMS_H
  47
  48 #include "config.h"
  49
  50 #include "gromacs/mdtypes/locality.h"
  51 #include "gromacs/utility/enumerationhelpers.h"
  52 #include "gromacs/utility/real.h"
  53
  54 namespace Nbnxm
  55 {
  56 enum class KernelType;
  57 }
  58
  59 //! The i-cluster size for CPU kernels, always 4 atoms
  60 static constexpr int c_nbnxnCpuIClusterSize = 4;
  61
  62 //! The i- and j-cluster size for GPU lists, 8 atoms for CUDA, set at compile time for OpenCL
  63 #if GMX_GPU == GMX_GPU_OPENCL
  64 static constexpr int c_nbnxnGpuClusterSize = GMX_OPENCL_NB_CLUSTER_SIZE;
  65 #else
  66 static constexpr int c_nbnxnGpuClusterSize = 8;
  67 #endif
  68
  69 //! The number of clusters along Z in a pair-search grid cell for GPU lists
  70 static constexpr int c_gpuNumClusterPerCellZ = 2;
  71 //! The number of clusters along Y in a pair-search grid cell for GPU lists
  72 static constexpr int c_gpuNumClusterPerCellY = 2;
  73 //! The number of clusters along X in a pair-search grid cell for GPU lists
  74 static constexpr int c_gpuNumClusterPerCellX = 2;
  75 //! The number of clusters in a pair-search grid cell for GPU lists
  76 static constexpr int c_gpuNumClusterPerCell  = c_gpuNumClusterPerCellZ*c_gpuNumClusterPerCellY*c_gpuNumClusterPerCellX;
  77
  78
  79 /*! \brief The number of sub-parts used for data storage for a GPU cluster pair
  80  *
  81  * In CUDA the number of threads in a warp is 32 and we have cluster pairs
  82  * of 8*8=64 atoms, so it's convenient to store data for cluster pair halves.
  83  */
  84 static constexpr int c_nbnxnGpuClusterpairSplit = 2;
  85
  86 //! The fixed size of the exclusion mask array for a half GPU cluster pair
  87 static constexpr int c_nbnxnGpuExclSize = c_nbnxnGpuClusterSize*c_nbnxnGpuClusterSize/c_nbnxnGpuClusterpairSplit;
  88
  89 //! The available pair list types
  90 enum class PairlistType : int
  91 {
  92     Simple4x2,
  93     Simple4x4,
  94     Simple4x8,
  95     HierarchicalNxN,
  96     Count
  97 };
  98
  99 //! Gives the i-cluster size for each pairlist type
 100 static constexpr gmx::EnumerationArray<PairlistType, int> IClusterSizePerListType =
 101 { {
 102       c_nbnxnCpuIClusterSize,
 103       c_nbnxnCpuIClusterSize,
 104       c_nbnxnCpuIClusterSize,
 105       c_nbnxnGpuClusterSize
 106   } };
 107 //! Gives the j-cluster size for each pairlist type
 108 static constexpr gmx::EnumerationArray<PairlistType, int> JClusterSizePerListType =
 109 { {
 110       2,
 111       4,
 112       8,
 113       c_nbnxnGpuClusterSize
 114   } };
 115
 116 /*! \internal
 117  * \brief The setup for generating and pruning the nbnxn pair list.
 118  *
 119  * Without dynamic pruning rlistOuter=rlistInner.
 120  */
 121 struct PairlistParams
 122 {
 123     /*! \brief Constructor producing a struct with dynamic pruning disabled
 124      */
 125     PairlistParams(Nbnxm::KernelType kernelType,
 126                    bool              haveFep,
 127                    real              rlist,
 128                    bool              haveMultipleDomains);
 129
 130     PairlistType pairlistType;           //!< The type of cluster-pair list
 131     bool         haveFep;                //!< Tells whether we have perturbed interactions
 132     real         rlistOuter;             //!< Cut-off of the larger, outer pair-list
 133     real         rlistInner;             //!< Cut-off of the smaller, inner pair-list
 134     bool         haveMultipleDomains;    //!< True when using DD with multiple domains
 135     bool         useDynamicPruning;      //!< Are we using dynamic pair-list pruning
 136     int          nstlistPrune;           //!< Pair-list dynamic pruning interval
 137     int          numRollingPruningParts; //!< The number parts to divide the pair-list into for rolling pruning, a value of 1 gives no rolling pruning
 138     int          lifetime;               //!< Lifetime in steps of the pair-list
 139 };
 140
 141 #endif