src/gromacs/nbnxm/nbnxm.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2017,2018,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 // FIXME: remove the "__" prefix in front of the group def when we move the
  37 //        nonbonded code into separate dir.
  38
  39 /*! \libinternal \defgroup __module_nbnxm Short-range non-bonded interaction module
  40  * \ingroup group_mdrun
  41  *
  42  * \brief Computes forces and energies for short-range pair-interactions
  43  * based on the Verlet algorithm. The algorithm uses pair-lists generated
  44  * at fixed intervals as well as various flavors of pair interaction kernels
  45  * implemented for a wide range of CPU and GPU architectures.
  46  *
  47  * The module includes support for flavors of Coulomb and Lennard-Jones interaction
  48  * treatment implemented for a large range of SIMD instruction sets for CPU
  49  * architectures as well as in CUDA and OpenCL for GPU architectures.
  50  * Additionally there is a reference CPU non-SIMD and a reference CPU
  51  * for GPU pair-list setup interaction kernel.
  52  *
  53  * The implementation of the kernels is based on the cluster non-bonded algorithm
  54  * which in the code is referred to as the NxM algorithms ("nbnxm_" prefix);
  55  * for details of the algorithm see DOI:10.1016/j.cpc.2013.06.003.
  56  *
  57  * Algorithmically, the non-bonded computation has two different modes:
  58  * A "classical" mode: generate a list every nstlist steps containing at least
  59  * all atom pairs up to a distance of rlistOuter and compute pair interactions
  60  * for all pairs that are within the interaction cut-off.
  61  * A "dynamic pruning" mode: generate an "outer-list" up to cut-off rlistOuter
  62  * every nstlist steps and prune the outer-list using a cut-off of rlistInner
  63  * every nstlistPrune steps to obtain a, smaller, "inner-list". This
  64  * results in fewer interaction computations and allows for a larger nstlist.
  65  * On a GPU, this dynamic pruning is performed in a rolling fashion, pruning
  66  * only a sub-part of the list each (second) step. This way it can often
  67  * overlap with integration and constraints on the CPU.
  68  * Currently a simple heuristic determines which mode will be used.
  69  *
  70  * TODO: add a summary list and brief descriptions of the different submodules:
  71  * search, CPU kernels, GPU glue code + kernels.
  72  *
  73  * \author Berk Hess <hess@kth.se>
  74  * \author Szilárd Páll <pall.szilard@gmail.com>
  75  * \author Mark Abraham <mark.j.abraham@gmail.com>
  76  * \author Anca Hamuraru <anca@streamcomputing.eu>
  77  * \author Teemu Virolainen <teemu@streamcomputing.eu>
  78  * \author Dimitrios Karkoulis <dimitris.karkoulis@gmail.com>
  79  *
  80  * TODO: add more authors!
  81  */
  82
  83 /*! \libinternal \file
  84  *
  85  * \brief This file contains the public interface of the nbnxm module
  86  * that implements the NxM atom cluster non-bonded algorithm to efficiently
  87  * compute pair forces.
  88  *
  89  *
  90  * \author Berk Hess <hess@kth.se>
  91  * \author Szilárd Páll <pall.szilard@gmail.com>
  92  *
  93  * \inlibraryapi
  94  * \ingroup __module_nbnxm
  95  */
  96
  97
  98 #ifndef GMX_NBNXM_NBNXM_H
  99 #define GMX_NBNXM_NBNXM_H
 100
 101 #include <memory>
 102
 103 #include "gromacs/math/vectypes.h"
 104 #include "gromacs/nbnxm/pairlist.h"
 105 #include "gromacs/nbnxm/pairlistset.h"
 106 #include "gromacs/utility/arrayref.h"
 107 #include "gromacs/utility/enumerationhelpers.h"
 108 #include "gromacs/utility/real.h"
 109
 110 #include "locality.h"
 111
 112 // TODO: Remove this include and the two nbnxm includes above
 113 #include "nbnxm_gpu.h"
 114
 115 struct gmx_device_info_t;
 116 struct gmx_domdec_zones_t;
 117 struct gmx_enerdata_t;
 118 struct gmx_hw_info_t;
 119 struct gmx_mtop_t;
 120 struct interaction_const_t;
 121 struct t_commrec;
 122 struct t_nrnb;
 123 struct t_forcerec;
 124 struct t_inputrec;
 125
 126 namespace gmx
 127 {
 128 class MDLogger;
 129 class UpdateGroupsCog;
 130 }
 131
 132 //! Help pass GPU-emulation parameters with type safety.
 133 enum class EmulateGpuNonbonded : bool
 134 {
 135     //! Do not emulate GPUs.
 136     No,
 137     //! Do emulate GPUs.
 138     Yes
 139 };
 140
 141
 142 /*! \brief Nonbonded NxN kernel types: plain C, CPU SIMD, GPU, GPU emulation */
 143 typedef enum
 144 {
 145     nbnxnkNotSet = 0,
 146     nbnxnk4x4_PlainC,
 147     nbnxnk4xN_SIMD_4xN,
 148     nbnxnk4xN_SIMD_2xNN,
 149     nbnxnk8x8x8_GPU,
 150     nbnxnk8x8x8_PlainC,
 151     nbnxnkNR
 152 } nbnxn_kernel_type;
 153
 154 namespace Nbnxm
 155 {
 156
 157 /*! \brief Return a string identifying the kernel type.
 158  *
 159  * \param [in] kernel_type   nonbonded kernel types, takes values from the nbnxn_kernel_type enum
 160  * \returns                  a string identifying the kernel corresponding to the type passed as argument
 161  */
 162 const char *lookup_kernel_name(int kernel_type);
 163
 164 } // namespace Nbnxm
 165
 166 /*! \brief Ewald exclusion types */
 167 enum {
 168     ewaldexclTable, ewaldexclAnalytical
 169 };
 170
 171 /*! \brief Flag to tell the nonbonded kernels whether to clear the force output buffers */
 172 enum {
 173     enbvClearFNo, enbvClearFYes
 174 };
 175
 176 /*! \libinternal
 177  *  \brief Non-bonded interaction group data structure. */
 178 typedef struct nonbonded_verlet_group_t {
 179     nbnxn_pairlist_set_t  nbl_lists;   /**< pair list(s)                       */
 180     int                   kernel_type; /**< non-bonded kernel - see enum above */
 181     int                   ewald_excl;  /**< Ewald exclusion - see enum above   */
 182 } nonbonded_verlet_group_t;
 183
 184 /*! \libinternal
 185  *  \brief Top-level non-bonded data structure for the Verlet-type cut-off scheme. */
 186 struct nonbonded_verlet_t
 187 {
 188     std::unique_ptr<NbnxnListParameters>                                        listParams; /**< Parameters for the search and list pruning setup */
 189     std::unique_ptr<nbnxn_search>                                               nbs;        /**< n vs n atom pair searching data       */
 190     int                                                                         ngrp;       /**< number of interaction groups          */
 191     //! Local and non-local interaction group
 192     gmx::EnumerationArray<Nbnxm::InteractionLocality, nonbonded_verlet_group_t> grp;
 193     //! Atom data
 194     nbnxn_atomdata_t                                                           *nbat;
 195
 196     gmx_bool                                                                    bUseGPU;         /**< TRUE when non-bonded interactions are computed on a physical GPU */
 197     EmulateGpuNonbonded                                                         emulateGpu;      /**< true when non-bonded interactions are computed on the CPU using GPU-style pair lists */
 198     gmx_nbnxn_gpu_t                                                            *gpu_nbv;         /**< pointer to GPU nb verlet data     */
 199     int                                                                         min_ci_balanced; /**< pair list balancing parameter
 200                                                                                                       used for the 8x8x8 GPU kernels    */
 201 };
 202
 203 namespace Nbnxm
 204 {
 205
 206 /*! \brief Initializes the nbnxn module */
 207 void init_nb_verlet(const gmx::MDLogger     &mdlog,
 208                     nonbonded_verlet_t     **nb_verlet,
 209                     gmx_bool                 bFEP_NonBonded,
 210                     const t_inputrec        *ir,
 211                     const t_forcerec        *fr,
 212                     const t_commrec         *cr,
 213                     const gmx_hw_info_t     &hardwareInfo,
 214                     const gmx_device_info_t *deviceInfo,
 215                     const gmx_mtop_t        *mtop,
 216                     matrix                   box);
 217
 218 } // namespace Nbnxm
 219
 220 /*! \brief Put the atoms on the pair search grid.
 221  *
 222  * Only atoms atomStart to atomEnd in x are put on the grid.
 223  * The atom_density is used to determine the grid size.
 224  * When atomDensity<=0, the density is determined from atomEnd-atomStart and the corners.
 225  * With domain decomposition part of the n particles might have migrated,
 226  * but have not been removed yet. This count is given by nmoved.
 227  * When move[i] < 0 particle i has migrated and will not be put on the grid.
 228  * Without domain decomposition move will be NULL.
 229  */
 230 void nbnxn_put_on_grid(nbnxn_search_t                  nbs,
 231                        int                             ePBC,
 232                        const matrix                    box,
 233                        int                             ddZone,
 234                        const rvec                      lowerCorner,
 235                        const rvec                      upperCorner,
 236                        const gmx::UpdateGroupsCog     *updateGroupsCog,
 237                        int                             atomStart,
 238                        int                             atomEnd,
 239                        real                            atomDensity,
 240                        const int                      *atinfo,
 241                        gmx::ArrayRef<const gmx::RVec>  x,
 242                        int                             numAtomsMoved,
 243                        const int                      *move,
 244                        int                             nb_kernel_type,
 245                        nbnxn_atomdata_t               *nbat);
 246
 247 /*! \brief As nbnxn_put_on_grid, but for the non-local atoms
 248  *
 249  * with domain decomposition. Should be called after calling
 250  * nbnxn_search_put_on_grid for the local atoms / home zone.
 251  */
 252 void nbnxn_put_on_grid_nonlocal(nbnxn_search_t                   nbs,
 253                                 const struct gmx_domdec_zones_t *zones,
 254                                 const int                       *atinfo,
 255                                 gmx::ArrayRef<const gmx::RVec>   x,
 256                                 int                              nb_kernel_type,
 257                                 nbnxn_atomdata_t                *nbat);
 258
 259 /*! \brief Returns the number of x and y cells in the local grid */
 260 void nbnxn_get_ncells(nbnxn_search_t nbs, int *ncx, int *ncy);
 261
 262 /*! \brief Returns the order indices of the atoms on the pairlist search grid */
 263 gmx::ArrayRef<const int> nbnxn_get_atomorder(const nbnxn_search* nbs);
 264
 265 /*! \brief Renumbers the atom indices on the grid to consecutive order */
 266 void nbnxn_set_atomorder(nbnxn_search_t nbs);
 267
 268 /*! \brief Returns the index position of the atoms on the pairlist search grid */
 269 gmx::ArrayRef<const int> nbnxn_get_gridindices(const nbnxn_search* nbs);
 270
 271 /*! \brief Prune all pair-lists with given locality (currently CPU only)
 272  *
 273  * For all pair-lists with given locality, takes the outer list and prunes out
 274  * pairs beyond the pairlist inner radius and writes the result to a list that is
 275  * to be consumed by the non-bonded kernel.
 276  */
 277 void NbnxnDispatchPruneKernel(nonbonded_verlet_t         *nbv,
 278                               Nbnxm::InteractionLocality  iLocality,
 279                               const rvec                 *shift_vec);
 280
 281 /*! \brief Executes the non-bonded kernel of the GPU or launches it on the GPU */
 282 void NbnxnDispatchKernel(nonbonded_verlet_t         *nbv,
 283                          Nbnxm::InteractionLocality  iLocality,
 284                          const interaction_const_t  &ic,
 285                          int                         forceFlags,
 286                          int                         clearF,
 287                          t_forcerec                 *fr,
 288                          gmx_enerdata_t             *enerd,
 289                          t_nrnb                     *nrnb);
 290
 291 #endif // GMX_NBNXN_NBNXN_H