src/gromacs/nbnxm/pairlist.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2016,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 #include "gmxpre.h"
  37
  38 #include "pairlist.h"
  39
  40 #include "config.h"
  41
  42 #include <cassert>
  43 #include <cmath>
  44 #include <cstring>
  45
  46 #include <algorithm>
  47
  48 #include "gromacs/domdec/domdec_struct.h"
  49 #include "gromacs/gmxlib/nrnb.h"
  50 #include "gromacs/math/functions.h"
  51 #include "gromacs/math/utilities.h"
  52 #include "gromacs/math/vec.h"
  53 #include "gromacs/mdlib/gmx_omp_nthreads.h"
  54 #include "gromacs/mdlib/ns.h"
  55 #include "gromacs/mdtypes/group.h"
  56 #include "gromacs/mdtypes/md_enums.h"
  57 #include "gromacs/nbnxm/atomdata.h"
  58 #include "gromacs/nbnxm/gpu_data_mgmt.h"
  59 #include "gromacs/nbnxm/nbnxm.h"
  60 #include "gromacs/nbnxm/nbnxm_geometry.h"
  61 #include "gromacs/nbnxm/nbnxm_simd.h"
  62 #include "gromacs/nbnxm/pairlistset.h"
  63 #include "gromacs/pbcutil/ishift.h"
  64 #include "gromacs/pbcutil/pbc.h"
  65 #include "gromacs/simd/simd.h"
  66 #include "gromacs/simd/vector_operations.h"
  67 #include "gromacs/topology/block.h"
  68 #include "gromacs/utility/exceptions.h"
  69 #include "gromacs/utility/fatalerror.h"
  70 #include "gromacs/utility/gmxomp.h"
  71 #include "gromacs/utility/smalloc.h"
  72
  73 #include "grid.h"
  74 #include "internal.h"
  75 #include "pairlistwork.h"
  76
  77 using namespace gmx;                        // TODO: Remove when this file is moved into gmx namespace
  78
  79 using BoundingBox   = Nbnxm::BoundingBox;   // TODO: Remove when refactoring this file
  80 using BoundingBox1D = Nbnxm::BoundingBox1D; // TODO: Remove when refactoring this file
  81
  82 using Grid          = Nbnxm::Grid;          // TODO: Remove when refactoring this file
  83
  84 // Convience alias for partial Nbnxn namespace usage
  85 using InteractionLocality = Nbnxm::InteractionLocality;
  86
  87 /* We shift the i-particles backward for PBC.
  88  * This leads to more conditionals than shifting forward.
  89  * We do this to get more balanced pair lists.
  90  */
  91 constexpr bool c_pbcShiftBackward = true;
  92
  93
  94 static void nbs_cycle_clear(nbnxn_cycle_t *cc)
  95 {
  96     for (int i = 0; i < enbsCCnr; i++)
  97     {
  98         cc[i].count = 0;
  99         cc[i].c     = 0;
 100     }
 101 }
 102
 103 static double Mcyc_av(const nbnxn_cycle_t *cc)
 104 {
 105     return static_cast<double>(cc->c)*1e-6/cc->count;
 106 }
 107
 108 static void nbs_cycle_print(FILE *fp, const nbnxn_search *nbs)
 109 {
 110     fprintf(fp, "\n");
 111     fprintf(fp, "ns %4d grid %4.1f search %4.1f red.f %5.3f",
 112             nbs->cc[enbsCCgrid].count,
 113             Mcyc_av(&nbs->cc[enbsCCgrid]),
 114             Mcyc_av(&nbs->cc[enbsCCsearch]),
 115             Mcyc_av(&nbs->cc[enbsCCreducef]));
 116
 117     if (nbs->work.size() > 1)
 118     {
 119         if (nbs->cc[enbsCCcombine].count > 0)
 120         {
 121             fprintf(fp, " comb %5.2f",
 122                     Mcyc_av(&nbs->cc[enbsCCcombine]));
 123         }
 124         fprintf(fp, " s. th");
 125         for (const nbnxn_search_work_t &work : nbs->work)
 126         {
 127             fprintf(fp, " %4.1f",
 128                     Mcyc_av(&work.cc[enbsCCsearch]));
 129         }
 130     }
 131     fprintf(fp, "\n");
 132 }
 133
 134 /* Layout for the nonbonded NxN pair lists */
 135 enum class NbnxnLayout
 136 {
 137     NoSimd4x4, // i-cluster size 4, j-cluster size 4
 138     Simd4xN,   // i-cluster size 4, j-cluster size SIMD width
 139     Simd2xNN,  // i-cluster size 4, j-cluster size half SIMD width
 140     Gpu8x8x8   // i-cluster size 8, j-cluster size 8 + super-clustering
 141 };
 142
 143 #if GMX_SIMD
 144 /* Returns the j-cluster size */
 145 template <NbnxnLayout layout>
 146 static constexpr int jClusterSize()
 147 {
 148     static_assert(layout == NbnxnLayout::NoSimd4x4 || layout == NbnxnLayout::Simd4xN || layout == NbnxnLayout::Simd2xNN, "Currently jClusterSize only supports CPU layouts");
 149
 150     return layout == NbnxnLayout::Simd4xN ? GMX_SIMD_REAL_WIDTH : (layout == NbnxnLayout::Simd2xNN ? GMX_SIMD_REAL_WIDTH/2 : c_nbnxnCpuIClusterSize);
 151 }
 152
 153 /*! \brief Returns the j-cluster index given the i-cluster index.
 154  *
 155  * \tparam    jClusterSize      The number of atoms in a j-cluster
 156  * \tparam    jSubClusterIndex  The j-sub-cluster index (0/1), used when size(j-cluster) < size(i-cluster)
 157  * \param[in] ci                The i-cluster index
 158  */
 159 template <int jClusterSize, int jSubClusterIndex>
 160 static inline int cjFromCi(int ci)
 161 {
 162     static_assert(jClusterSize == c_nbnxnCpuIClusterSize/2 || jClusterSize == c_nbnxnCpuIClusterSize || jClusterSize == c_nbnxnCpuIClusterSize*2, "Only j-cluster sizes 2, 4 and 8 are currently implemented");
 163
 164     static_assert(jSubClusterIndex == 0 || jSubClusterIndex == 1,
 165                   "Only sub-cluster indices 0 and 1 are supported");
 166
 167     if (jClusterSize == c_nbnxnCpuIClusterSize/2)
 168     {
 169         if (jSubClusterIndex == 0)
 170         {
 171             return ci << 1;
 172         }
 173         else
 174         {
 175             return ((ci + 1) << 1) - 1;
 176         }
 177     }
 178     else if (jClusterSize == c_nbnxnCpuIClusterSize)
 179     {
 180         return ci;
 181     }
 182     else
 183     {
 184         return ci >> 1;
 185     }
 186 }
 187
 188 /*! \brief Returns the j-cluster index given the i-cluster index.
 189  *
 190  * \tparam    layout            The pair-list layout
 191  * \tparam    jSubClusterIndex  The j-sub-cluster index (0/1), used when size(j-cluster) < size(i-cluster)
 192  * \param[in] ci                The i-cluster index
 193  */
 194 template <NbnxnLayout layout, int jSubClusterIndex>
 195 static inline int cjFromCi(int ci)
 196 {
 197     constexpr int clusterSize = jClusterSize<layout>();
 198
 199     return cjFromCi<clusterSize, jSubClusterIndex>(ci);
 200 }
 201
 202 /* Returns the nbnxn coordinate data index given the i-cluster index */
 203 template <NbnxnLayout layout>
 204 static inline int xIndexFromCi(int ci)
 205 {
 206     constexpr int clusterSize = jClusterSize<layout>();
 207
 208     static_assert(clusterSize == c_nbnxnCpuIClusterSize/2 || clusterSize == c_nbnxnCpuIClusterSize || clusterSize == c_nbnxnCpuIClusterSize*2, "Only j-cluster sizes 2, 4 and 8 are currently implemented");
 209
 210     if (clusterSize <= c_nbnxnCpuIClusterSize)
 211     {
 212         /* Coordinates are stored packed in groups of 4 */
 213         return ci*STRIDE_P4;
 214     }
 215     else
 216     {
 217         /* Coordinates packed in 8, i-cluster size is half the packing width */
 218         return (ci >> 1)*STRIDE_P8 + (ci & 1)*(c_packX8 >> 1);
 219     }
 220 }
 221
 222 /* Returns the nbnxn coordinate data index given the j-cluster index */
 223 template <NbnxnLayout layout>
 224 static inline int xIndexFromCj(int cj)
 225 {
 226     constexpr int clusterSize = jClusterSize<layout>();
 227
 228     static_assert(clusterSize == c_nbnxnCpuIClusterSize/2 || clusterSize == c_nbnxnCpuIClusterSize || clusterSize == c_nbnxnCpuIClusterSize*2, "Only j-cluster sizes 2, 4 and 8 are currently implemented");
 229
 230     if (clusterSize == c_nbnxnCpuIClusterSize/2)
 231     {
 232         /* Coordinates are stored packed in groups of 4 */
 233         return (cj >> 1)*STRIDE_P4 + (cj & 1)*(c_packX4 >> 1);
 234     }
 235     else if (clusterSize == c_nbnxnCpuIClusterSize)
 236     {
 237         /* Coordinates are stored packed in groups of 4 */
 238         return cj*STRIDE_P4;
 239     }
 240     else
 241     {
 242         /* Coordinates are stored packed in groups of 8 */
 243         return cj*STRIDE_P8;
 244     }
 245 }
 246 #endif //GMX_SIMD
 247
 248 /* Initializes a single nbnxn_pairlist_t data structure */
 249 static void nbnxn_init_pairlist_fep(t_nblist *nl)
 250 {
 251     nl->type        = GMX_NBLIST_INTERACTION_FREE_ENERGY;
 252     nl->igeometry   = GMX_NBLIST_GEOMETRY_PARTICLE_PARTICLE;
 253     /* The interaction functions are set in the free energy kernel fuction */
 254     nl->ivdw        = -1;
 255     nl->ivdwmod     = -1;
 256     nl->ielec       = -1;
 257     nl->ielecmod    = -1;
 258
 259     nl->maxnri      = 0;
 260     nl->maxnrj      = 0;
 261     nl->nri         = 0;
 262     nl->nrj         = 0;
 263     nl->iinr        = nullptr;
 264     nl->gid         = nullptr;
 265     nl->shift       = nullptr;
 266     nl->jindex      = nullptr;
 267     nl->jjnr        = nullptr;
 268     nl->excl_fep    = nullptr;
 269
 270 }
 271
 272 static void free_nblist(t_nblist *nl)
 273 {
 274     sfree(nl->iinr);
 275     sfree(nl->gid);
 276     sfree(nl->shift);
 277     sfree(nl->jindex);
 278     sfree(nl->jjnr);
 279     sfree(nl->excl_fep);
 280 }
 281
 282 nbnxn_search_work_t::nbnxn_search_work_t() :
 283     cp0({{0}}
 284         ),
 285     buffer_flags({0, nullptr, 0}),
 286     ndistc(0),
 287     nbl_fep(new t_nblist),
 288     cp1({{0}})
 289 {
 290     nbnxn_init_pairlist_fep(nbl_fep.get());
 291
 292     nbs_cycle_clear(cc);
 293 }
 294
 295 nbnxn_search_work_t::~nbnxn_search_work_t()
 296 {
 297     sfree(buffer_flags.flag);
 298
 299     free_nblist(nbl_fep.get());
 300 }
 301
 302 nbnxn_search::nbnxn_search(const int                 ePBC,
 303                            const ivec               *n_dd_cells,
 304                            const gmx_domdec_zones_t *zones,
 305                            const PairlistType        pairlistType,
 306                            const bool                haveFep,
 307                            const int                 maxNumThreads) :
 308     ePBC(ePBC),
 309     zones(zones),
 310     gridSet_(n_dd_cells, pairlistType, haveFep, maxNumThreads),
 311     search_count(0),
 312     work(maxNumThreads)
 313 {
 314     clear_ivec(dd_dim);
 315     DomDec = n_dd_cells != nullptr;
 316     if (DomDec)
 317     {
 318         for (int d = 0; d < DIM; d++)
 319         {
 320             if ((*n_dd_cells)[d] > 1)
 321             {
 322                 dd_dim[d] = 1;
 323             }
 324         }
 325     }
 326
 327     /* Initialize detailed nbsearch cycle counting */
 328     print_cycles = (getenv("GMX_NBNXN_CYCLE") != nullptr);
 329     nbs_cycle_clear(cc);
 330 }
 331
 332 static void init_buffer_flags(nbnxn_buffer_flags_t *flags,
 333                               int                   natoms)
 334 {
 335     flags->nflag = (natoms + NBNXN_BUFFERFLAG_SIZE - 1)/NBNXN_BUFFERFLAG_SIZE;
 336     if (flags->nflag > flags->flag_nalloc)
 337     {
 338         flags->flag_nalloc = over_alloc_large(flags->nflag);
 339         srenew(flags->flag, flags->flag_nalloc);
 340     }
 341     for (int b = 0; b < flags->nflag; b++)
 342     {
 343         bitmask_clear(&(flags->flag[b]));
 344     }
 345 }
 346
 347 /* Returns the pair-list cutoff between a bounding box and a grid cell given an atom-to-atom pair-list cutoff
 348  *
 349  * Given a cutoff distance between atoms, this functions returns the cutoff
 350  * distance2 between a bounding box of a group of atoms and a grid cell.
 351  * Since atoms can be geometrically outside of the cell they have been
 352  * assigned to (when atom groups instead of individual atoms are assigned
 353  * to cells), this distance returned can be larger than the input.
 354  */
 355 static real
 356 listRangeForBoundingBoxToGridCell(real                    rlist,
 357                                   const Grid::Dimensions &gridDims)
 358 {
 359     return rlist + gridDims.maxAtomGroupRadius;
 360
 361 }
 362 /* Returns the pair-list cutoff between a grid cells given an atom-to-atom pair-list cutoff
 363  *
 364  * Given a cutoff distance between atoms, this functions returns the cutoff
 365  * distance2 between two grid cells.
 366  * Since atoms can be geometrically outside of the cell they have been
 367  * assigned to (when atom groups instead of individual atoms are assigned
 368  * to cells), this distance returned can be larger than the input.
 369  */
 370 static real
 371 listRangeForGridCellToGridCell(real                    rlist,
 372                                const Grid::Dimensions &iGridDims,
 373                                const Grid::Dimensions &jGridDims)
 374 {
 375     return rlist + iGridDims.maxAtomGroupRadius + jGridDims.maxAtomGroupRadius;
 376 }
 377
 378 /* Determines the cell range along one dimension that
 379  * the bounding box b0 - b1 sees.
 380  */
 381 template<int dim>
 382 static void get_cell_range(real b0, real b1,
 383                            const Grid::Dimensions &jGridDims,
 384                            real d2, real rlist, int *cf, int *cl)
 385 {
 386     real listRangeBBToCell2 = gmx::square(listRangeForBoundingBoxToGridCell(rlist, jGridDims));
 387     real distanceInCells    = (b0 - jGridDims.lowerCorner[dim])*jGridDims.invCellSize[dim];
 388     *cf                     = std::max(static_cast<int>(distanceInCells), 0);
 389
 390     while (*cf > 0 &&
 391            d2 + gmx::square((b0 - jGridDims.lowerCorner[dim]) - (*cf - 1 + 1)*jGridDims.cellSize[dim]) < listRangeBBToCell2)
 392     {
 393         (*cf)--;
 394     }
 395
 396     *cl = std::min(static_cast<int>((b1 - jGridDims.lowerCorner[dim])*jGridDims.invCellSize[dim]), jGridDims.numCells[dim] - 1);
 397     while (*cl < jGridDims.numCells[dim] - 1 &&
 398            d2 + gmx::square((*cl + 1)*jGridDims.cellSize[dim] - (b1 - jGridDims.lowerCorner[dim])) < listRangeBBToCell2)
 399     {
 400         (*cl)++;
 401     }
 402 }
 403
 404 /* Reference code calculating the distance^2 between two bounding boxes */
 405 /*
 406    static float box_dist2(float bx0, float bx1, float by0,
 407                        float by1, float bz0, float bz1,
 408                        const BoundingBox *bb)
 409    {
 410     float d2;
 411     float dl, dh, dm, dm0;
 412
 413     d2 = 0;
 414
 415     dl  = bx0 - bb->upper.x;
 416     dh  = bb->lower.x - bx1;
 417     dm  = std::max(dl, dh);
 418     dm0 = std::max(dm, 0.0f);
 419     d2 += dm0*dm0;
 420
 421     dl  = by0 - bb->upper.y;
 422     dh  = bb->lower.y - by1;
 423     dm  = std::max(dl, dh);
 424     dm0 = std::max(dm, 0.0f);
 425     d2 += dm0*dm0;
 426
 427     dl  = bz0 - bb->upper.z;
 428     dh  = bb->lower.z - bz1;
 429     dm  = std::max(dl, dh);
 430     dm0 = std::max(dm, 0.0f);
 431     d2 += dm0*dm0;
 432
 433     return d2;
 434    }
 435  */
 436
 437 #if !NBNXN_SEARCH_BB_SIMD4
 438
 439 /*! \brief Plain C code calculating the distance^2 between two bounding boxes in xyz0 format
 440  *
 441  * \param[in] bb_i  First bounding box
 442  * \param[in] bb_j  Second bounding box
 443  */
 444 static float clusterBoundingBoxDistance2(const BoundingBox &bb_i,
 445                                          const BoundingBox &bb_j)
 446 {
 447     float dl   = bb_i.lower.x - bb_j.upper.x;
 448     float dh   = bb_j.lower.x - bb_i.upper.x;
 449     float dm   = std::max(dl, dh);
 450     float dm0  = std::max(dm, 0.0f);
 451     float d2   = dm0*dm0;
 452
 453     dl         = bb_i.lower.y - bb_j.upper.y;
 454     dh         = bb_j.lower.y - bb_i.upper.y;
 455     dm         = std::max(dl, dh);
 456     dm0        = std::max(dm, 0.0f);
 457     d2        += dm0*dm0;
 458
 459     dl         = bb_i.lower.z - bb_j.upper.z;
 460     dh         = bb_j.lower.z - bb_i.upper.z;
 461     dm         = std::max(dl, dh);
 462     dm0        = std::max(dm, 0.0f);
 463     d2        += dm0*dm0;
 464
 465     return d2;
 466 }
 467
 468 #else /* NBNXN_SEARCH_BB_SIMD4 */
 469
 470 /*! \brief 4-wide SIMD code calculating the distance^2 between two bounding boxes in xyz0 format
 471  *
 472  * \param[in] bb_i  First bounding box, should be aligned for 4-wide SIMD
 473  * \param[in] bb_j  Second bounding box, should be aligned for 4-wide SIMD
 474  */
 475 static float clusterBoundingBoxDistance2(const BoundingBox &bb_i,
 476                                          const BoundingBox &bb_j)
 477 {
 478     // TODO: During SIMDv2 transition only some archs use namespace (remove when done)
 479     using namespace gmx;
 480
 481     const Simd4Float bb_i_S0 = load4(bb_i.lower.ptr());
 482     const Simd4Float bb_i_S1 = load4(bb_i.upper.ptr());
 483     const Simd4Float bb_j_S0 = load4(bb_j.lower.ptr());
 484     const Simd4Float bb_j_S1 = load4(bb_j.upper.ptr());
 485
 486     const Simd4Float dl_S    = bb_i_S0 - bb_j_S1;
 487     const Simd4Float dh_S    = bb_j_S0 - bb_i_S1;
 488
 489     const Simd4Float dm_S    = max(dl_S, dh_S);
 490     const Simd4Float dm0_S   = max(dm_S, simd4SetZeroF());
 491
 492     return dotProduct(dm0_S, dm0_S);
 493 }
 494
 495 /* Calculate bb bounding distances of bb_i[si,...,si+3] and store them in d2 */
 496 template <int boundingBoxStart>
 497 static inline void gmx_simdcall
 498 clusterBoundingBoxDistance2_xxxx_simd4_inner(const float      *bb_i,
 499                                              float            *d2,
 500                                              const Simd4Float  xj_l,
 501                                              const Simd4Float  yj_l,
 502                                              const Simd4Float  zj_l,
 503                                              const Simd4Float  xj_h,
 504                                              const Simd4Float  yj_h,
 505                                              const Simd4Float  zj_h)
 506 {
 507     constexpr int    stride = c_packedBoundingBoxesDimSize;
 508
 509     const int        shi  = boundingBoxStart*Nbnxm::c_numBoundingBoxBounds1D*DIM;
 510
 511     const Simd4Float zero = setZero();
 512
 513     const Simd4Float xi_l = load4(bb_i + shi + 0*stride);
 514     const Simd4Float yi_l = load4(bb_i + shi + 1*stride);
 515     const Simd4Float zi_l = load4(bb_i + shi + 2*stride);
 516     const Simd4Float xi_h = load4(bb_i + shi + 3*stride);
 517     const Simd4Float yi_h = load4(bb_i + shi + 4*stride);
 518     const Simd4Float zi_h = load4(bb_i + shi + 5*stride);
 519
 520     const Simd4Float dx_0 = xi_l - xj_h;
 521     const Simd4Float dy_0 = yi_l - yj_h;
 522     const Simd4Float dz_0 = zi_l - zj_h;
 523
 524     const Simd4Float dx_1 = xj_l - xi_h;
 525     const Simd4Float dy_1 = yj_l - yi_h;
 526     const Simd4Float dz_1 = zj_l - zi_h;
 527
 528     const Simd4Float mx   = max(dx_0, dx_1);
 529     const Simd4Float my   = max(dy_0, dy_1);
 530     const Simd4Float mz   = max(dz_0, dz_1);
 531
 532     const Simd4Float m0x  = max(mx, zero);
 533     const Simd4Float m0y  = max(my, zero);
 534     const Simd4Float m0z  = max(mz, zero);
 535
 536     const Simd4Float d2x  = m0x * m0x;
 537     const Simd4Float d2y  = m0y * m0y;
 538     const Simd4Float d2z  = m0z * m0z;
 539
 540     const Simd4Float d2s  = d2x + d2y;
 541     const Simd4Float d2t  = d2s + d2z;
 542
 543     store4(d2 + boundingBoxStart, d2t);
 544 }
 545
 546 /* 4-wide SIMD code for nsi bb distances for bb format xxxxyyyyzzzz */
 547 static void
 548 clusterBoundingBoxDistance2_xxxx_simd4(const float *bb_j,
 549                                        const int    nsi,
 550                                        const float *bb_i,
 551                                        float       *d2)
 552 {
 553     constexpr int    stride = c_packedBoundingBoxesDimSize;
 554
 555     // TODO: During SIMDv2 transition only some archs use namespace (remove when done)
 556     using namespace gmx;
 557
 558     const Simd4Float xj_l = Simd4Float(bb_j[0*stride]);
 559     const Simd4Float yj_l = Simd4Float(bb_j[1*stride]);
 560     const Simd4Float zj_l = Simd4Float(bb_j[2*stride]);
 561     const Simd4Float xj_h = Simd4Float(bb_j[3*stride]);
 562     const Simd4Float yj_h = Simd4Float(bb_j[4*stride]);
 563     const Simd4Float zj_h = Simd4Float(bb_j[5*stride]);
 564
 565     /* Here we "loop" over si (0,stride) from 0 to nsi with step stride.
 566      * But as we know the number of iterations is 1 or 2, we unroll manually.
 567      */
 568     clusterBoundingBoxDistance2_xxxx_simd4_inner<0>(bb_i, d2,
 569                                                     xj_l, yj_l, zj_l,
 570                                                     xj_h, yj_h, zj_h);
 571     if (stride < nsi)
 572     {
 573         clusterBoundingBoxDistance2_xxxx_simd4_inner<stride>(bb_i, d2,
 574                                                              xj_l, yj_l, zj_l,
 575                                                              xj_h, yj_h, zj_h);
 576     }
 577 }
 578
 579 #endif /* NBNXN_SEARCH_BB_SIMD4 */
 580
 581
 582 /* Returns if any atom pair from two clusters is within distance sqrt(rlist2) */
 583 static inline gmx_bool
 584 clusterpair_in_range(const NbnxnPairlistGpuWork &work,
 585                      int si,
 586                      int csj, int stride, const real *x_j,
 587                      real rlist2)
 588 {
 589 #if !GMX_SIMD4_HAVE_REAL
 590
 591     /* Plain C version.
 592      * All coordinates are stored as xyzxyz...
 593      */
 594
 595     const real *x_i = work.iSuperClusterData.x.data();
 596
 597     for (int i = 0; i < c_nbnxnGpuClusterSize; i++)
 598     {
 599         int i0 = (si*c_nbnxnGpuClusterSize + i)*DIM;
 600         for (int j = 0; j < c_nbnxnGpuClusterSize; j++)
 601         {
 602             int  j0 = (csj*c_nbnxnGpuClusterSize + j)*stride;
 603
 604             real d2 = gmx::square(x_i[i0  ] - x_j[j0  ]) + gmx::square(x_i[i0+1] - x_j[j0+1]) + gmx::square(x_i[i0+2] - x_j[j0+2]);
 605
 606             if (d2 < rlist2)
 607             {
 608                 return TRUE;
 609             }
 610         }
 611     }
 612
 613     return FALSE;
 614
 615 #else /* !GMX_SIMD4_HAVE_REAL */
 616
 617     /* 4-wide SIMD version.
 618      * The coordinates x_i are stored as xxxxyyyy..., x_j is stored xyzxyz...
 619      * Using 8-wide AVX(2) is not faster on Intel Sandy Bridge and Haswell.
 620      */
 621     static_assert(c_nbnxnGpuClusterSize == 8 || c_nbnxnGpuClusterSize == 4,
 622                   "A cluster is hard-coded to 4/8 atoms.");
 623
 624     Simd4Real   rc2_S      = Simd4Real(rlist2);
 625
 626     const real *x_i        = work.iSuperClusterData.xSimd.data();
 627
 628     int         dim_stride = c_nbnxnGpuClusterSize*DIM;
 629     Simd4Real   ix_S0      = load4(x_i + si*dim_stride + 0*GMX_SIMD4_WIDTH);
 630     Simd4Real   iy_S0      = load4(x_i + si*dim_stride + 1*GMX_SIMD4_WIDTH);
 631     Simd4Real   iz_S0      = load4(x_i + si*dim_stride + 2*GMX_SIMD4_WIDTH);
 632
 633     Simd4Real   ix_S1, iy_S1, iz_S1;
 634     if (c_nbnxnGpuClusterSize == 8)
 635     {
 636         ix_S1      = load4(x_i + si*dim_stride + 3*GMX_SIMD4_WIDTH);
 637         iy_S1      = load4(x_i + si*dim_stride + 4*GMX_SIMD4_WIDTH);
 638         iz_S1      = load4(x_i + si*dim_stride + 5*GMX_SIMD4_WIDTH);
 639     }
 640     /* We loop from the outer to the inner particles to maximize
 641      * the chance that we find a pair in range quickly and return.
 642      */
 643     int j0 = csj*c_nbnxnGpuClusterSize;
 644     int j1 = j0 + c_nbnxnGpuClusterSize - 1;
 645     while (j0 < j1)
 646     {
 647         Simd4Real jx0_S, jy0_S, jz0_S;
 648         Simd4Real jx1_S, jy1_S, jz1_S;
 649
 650         Simd4Real dx_S0, dy_S0, dz_S0;
 651         Simd4Real dx_S1, dy_S1, dz_S1;
 652         Simd4Real dx_S2, dy_S2, dz_S2;
 653         Simd4Real dx_S3, dy_S3, dz_S3;
 654
 655         Simd4Real rsq_S0;
 656         Simd4Real rsq_S1;
 657         Simd4Real rsq_S2;
 658         Simd4Real rsq_S3;
 659
 660         Simd4Bool wco_S0;
 661         Simd4Bool wco_S1;
 662         Simd4Bool wco_S2;
 663         Simd4Bool wco_S3;
 664         Simd4Bool wco_any_S01, wco_any_S23, wco_any_S;
 665
 666         jx0_S = Simd4Real(x_j[j0*stride+0]);
 667         jy0_S = Simd4Real(x_j[j0*stride+1]);
 668         jz0_S = Simd4Real(x_j[j0*stride+2]);
 669
 670         jx1_S = Simd4Real(x_j[j1*stride+0]);
 671         jy1_S = Simd4Real(x_j[j1*stride+1]);
 672         jz1_S = Simd4Real(x_j[j1*stride+2]);
 673
 674         /* Calculate distance */
 675         dx_S0            = ix_S0 - jx0_S;
 676         dy_S0            = iy_S0 - jy0_S;
 677         dz_S0            = iz_S0 - jz0_S;
 678         dx_S2            = ix_S0 - jx1_S;
 679         dy_S2            = iy_S0 - jy1_S;
 680         dz_S2            = iz_S0 - jz1_S;
 681         if (c_nbnxnGpuClusterSize == 8)
 682         {
 683             dx_S1            = ix_S1 - jx0_S;
 684             dy_S1            = iy_S1 - jy0_S;
 685             dz_S1            = iz_S1 - jz0_S;
 686             dx_S3            = ix_S1 - jx1_S;
 687             dy_S3            = iy_S1 - jy1_S;
 688             dz_S3            = iz_S1 - jz1_S;
 689         }
 690
 691         /* rsq = dx*dx+dy*dy+dz*dz */
 692         rsq_S0           = norm2(dx_S0, dy_S0, dz_S0);
 693         rsq_S2           = norm2(dx_S2, dy_S2, dz_S2);
 694         if (c_nbnxnGpuClusterSize == 8)
 695         {
 696             rsq_S1           = norm2(dx_S1, dy_S1, dz_S1);
 697             rsq_S3           = norm2(dx_S3, dy_S3, dz_S3);
 698         }
 699
 700         wco_S0           = (rsq_S0 < rc2_S);
 701         wco_S2           = (rsq_S2 < rc2_S);
 702         if (c_nbnxnGpuClusterSize == 8)
 703         {
 704             wco_S1           = (rsq_S1 < rc2_S);
 705             wco_S3           = (rsq_S3 < rc2_S);
 706         }
 707         if (c_nbnxnGpuClusterSize == 8)
 708         {
 709             wco_any_S01      = wco_S0 || wco_S1;
 710             wco_any_S23      = wco_S2 || wco_S3;
 711             wco_any_S        = wco_any_S01 || wco_any_S23;
 712         }
 713         else
 714         {
 715             wco_any_S = wco_S0 || wco_S2;
 716         }
 717
 718         if (anyTrue(wco_any_S))
 719         {
 720             return TRUE;
 721         }
 722
 723         j0++;
 724         j1--;
 725     }
 726
 727     return FALSE;
 728
 729 #endif /* !GMX_SIMD4_HAVE_REAL */
 730 }
 731
 732 /* Returns the j-cluster index for index cjIndex in a cj list */
 733 static inline int nblCj(gmx::ArrayRef<const nbnxn_cj_t> cjList,
 734                         int                             cjIndex)
 735 {
 736     return cjList[cjIndex].cj;
 737 }
 738
 739 /* Returns the j-cluster index for index cjIndex in a cj4 list */
 740 static inline int nblCj(gmx::ArrayRef<const nbnxn_cj4_t> cj4List,
 741                         int                              cjIndex)
 742 {
 743     return cj4List[cjIndex/c_nbnxnGpuJgroupSize].cj[cjIndex & (c_nbnxnGpuJgroupSize - 1)];
 744 }
 745
 746 /* Returns the i-interaction mask of the j sub-cell for index cj_ind */
 747 static unsigned int nbl_imask0(const NbnxnPairlistGpu *nbl, int cj_ind)
 748 {
 749     return nbl->cj4[cj_ind/c_nbnxnGpuJgroupSize].imei[0].imask;
 750 }
 751
 752 /* Initializes a single NbnxnPairlistCpu data structure */
 753 static void nbnxn_init_pairlist(NbnxnPairlistCpu *nbl)
 754 {
 755     nbl->na_ci       = c_nbnxnCpuIClusterSize;
 756     nbl->na_cj       = 0;
 757     nbl->ci.clear();
 758     nbl->ciOuter.clear();
 759     nbl->ncjInUse    = 0;
 760     nbl->cj.clear();
 761     nbl->cjOuter.clear();
 762     nbl->nci_tot     = 0;
 763
 764     nbl->work        = new NbnxnPairlistCpuWork();
 765 }
 766
 767 NbnxnPairlistGpu::NbnxnPairlistGpu(gmx::PinningPolicy pinningPolicy) :
 768     na_ci(c_nbnxnGpuClusterSize),
 769     na_cj(c_nbnxnGpuClusterSize),
 770     na_sc(c_gpuNumClusterPerCell*c_nbnxnGpuClusterSize),
 771     rlist(0),
 772     sci({}, {pinningPolicy}),
 773     cj4({}, {pinningPolicy}),
 774     excl({}, {pinningPolicy}),
 775     nci_tot(0)
 776 {
 777     static_assert(c_nbnxnGpuNumClusterPerSupercluster == c_gpuNumClusterPerCell,
 778                   "The search code assumes that the a super-cluster matches a search grid cell");
 779
 780     static_assert(sizeof(cj4[0].imei[0].imask)*8 >= c_nbnxnGpuJgroupSize*c_gpuNumClusterPerCell,
 781                   "The i super-cluster cluster interaction mask does not contain a sufficient number of bits");
 782
 783     static_assert(sizeof(excl[0])*8 >= c_nbnxnGpuJgroupSize*c_gpuNumClusterPerCell, "The GPU exclusion mask does not contain a sufficient number of bits");
 784
 785     // We always want a first entry without any exclusions
 786     excl.resize(1);
 787
 788     work = new NbnxnPairlistGpuWork();
 789 }
 790
 791 void nbnxn_init_pairlist_set(nbnxn_pairlist_set_t *nbl_list)
 792 {
 793     nbl_list->bSimple   =
 794         (nbl_list->params.pairlistType == PairlistType::Simple4x2 ||
 795          nbl_list->params.pairlistType == PairlistType::Simple4x4 ||
 796          nbl_list->params.pairlistType == PairlistType::Simple4x8);
 797     // Currently GPU lists are always combined
 798     nbl_list->bCombined = !nbl_list->bSimple;
 799
 800     nbl_list->nnbl = gmx_omp_nthreads_get(emntNonbonded);
 801
 802     if (!nbl_list->bCombined &&
 803         nbl_list->nnbl > NBNXN_BUFFERFLAG_MAX_THREADS)
 804     {
 805         gmx_fatal(FARGS, "%d OpenMP threads were requested. Since the non-bonded force buffer reduction is prohibitively slow with more than %d threads, we do not allow this. Use %d or less OpenMP threads.",
 806                   nbl_list->nnbl, NBNXN_BUFFERFLAG_MAX_THREADS, NBNXN_BUFFERFLAG_MAX_THREADS);
 807     }
 808
 809     if (nbl_list->bSimple)
 810     {
 811         snew(nbl_list->nbl, nbl_list->nnbl);
 812         if (nbl_list->nnbl > 1)
 813         {
 814             snew(nbl_list->nbl_work, nbl_list->nnbl);
 815         }
 816     }
 817     else
 818     {
 819         snew(nbl_list->nblGpu, nbl_list->nnbl);
 820     }
 821     nbl_list->nbl_fep.resize(nbl_list->nnbl);
 822     /* Execute in order to avoid memory interleaving between threads */
 823 #pragma omp parallel for num_threads(nbl_list->nnbl) schedule(static)
 824     for (int i = 0; i < nbl_list->nnbl; i++)
 825     {
 826         try
 827         {
 828             /* Allocate the nblist data structure locally on each thread
 829              * to optimize memory access for NUMA architectures.
 830              */
 831             if (nbl_list->bSimple)
 832             {
 833                 nbl_list->nbl[i] = new NbnxnPairlistCpu();
 834
 835                 nbnxn_init_pairlist(nbl_list->nbl[i]);
 836                 if (nbl_list->nnbl > 1)
 837                 {
 838                     nbl_list->nbl_work[i] = new NbnxnPairlistCpu();
 839                     nbnxn_init_pairlist(nbl_list->nbl_work[i]);
 840                 }
 841             }
 842             else
 843             {
 844                 /* Only list 0 is used on the GPU, use normal allocation for i>0 */
 845                 auto pinningPolicy = (i == 0 ? gmx::PinningPolicy::PinnedIfSupported : gmx::PinningPolicy::CannotBePinned);
 846
 847                 nbl_list->nblGpu[i] = new NbnxnPairlistGpu(pinningPolicy);
 848             }
 849
 850             snew(nbl_list->nbl_fep[i], 1);
 851             nbnxn_init_pairlist_fep(nbl_list->nbl_fep[i]);
 852         }
 853         GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
 854     }
 855 }
 856
 857 /* Print statistics of a pair list, used for debug output */
 858 static void print_nblist_statistics(FILE *fp, const NbnxnPairlistCpu *nbl,
 859                                     const nbnxn_search *nbs, real rl)
 860 {
 861     const Grid             &grid = nbs->gridSet().grids()[0];
 862     const Grid::Dimensions &dims = grid.dimensions();
 863
 864     fprintf(fp, "nbl nci %zu ncj %d\n",
 865             nbl->ci.size(), nbl->ncjInUse);
 866     const int    numAtomsJCluster = grid.geometry().numAtomsJCluster;
 867     const double numAtomsPerCell  = nbl->ncjInUse/static_cast<double>(grid.numCells())*numAtomsJCluster;
 868     fprintf(fp, "nbl na_cj %d rl %g ncp %d per cell %.1f atoms %.1f ratio %.2f\n",
 869             nbl->na_cj, rl, nbl->ncjInUse, nbl->ncjInUse/static_cast<double>(grid.numCells()),
 870             numAtomsPerCell,
 871             numAtomsPerCell/(0.5*4.0/3.0*M_PI*rl*rl*rl*grid.numCells()*numAtomsJCluster/(dims.gridSize[XX]*dims.gridSize[YY]*dims.gridSize[ZZ])));
 872
 873     fprintf(fp, "nbl average j cell list length %.1f\n",
 874             0.25*nbl->ncjInUse/std::max(static_cast<double>(nbl->ci.size()), 1.0));
 875
 876     int cs[SHIFTS] = { 0 };
 877     int npexcl     = 0;
 878     for (const nbnxn_ci_t &ciEntry : nbl->ci)
 879     {
 880         cs[ciEntry.shift & NBNXN_CI_SHIFT] +=
 881             ciEntry.cj_ind_end - ciEntry.cj_ind_start;
 882
 883         int j = ciEntry.cj_ind_start;
 884         while (j < ciEntry.cj_ind_end &&
 885                nbl->cj[j].excl != NBNXN_INTERACTION_MASK_ALL)
 886         {
 887             npexcl++;
 888             j++;
 889         }
 890     }
 891     fprintf(fp, "nbl cell pairs, total: %zu excl: %d %.1f%%\n",
 892             nbl->cj.size(), npexcl, 100*npexcl/std::max(static_cast<double>(nbl->cj.size()), 1.0));
 893     for (int s = 0; s < SHIFTS; s++)
 894     {
 895         if (cs[s] > 0)
 896         {
 897             fprintf(fp, "nbl shift %2d ncj %3d\n", s, cs[s]);
 898         }
 899     }
 900 }
 901
 902 /* Print statistics of a pair lists, used for debug output */
 903 static void print_nblist_statistics(FILE *fp, const NbnxnPairlistGpu *nbl,
 904                                     const nbnxn_search *nbs, real rl)
 905 {
 906     const Grid             &grid = nbs->gridSet().grids()[0];
 907     const Grid::Dimensions &dims = grid.dimensions();
 908
 909     fprintf(fp, "nbl nsci %zu ncj4 %zu nsi %d excl4 %zu\n",
 910             nbl->sci.size(), nbl->cj4.size(), nbl->nci_tot, nbl->excl.size());
 911     const int    numAtomsCluster = grid.geometry().numAtomsICluster;
 912     const double numAtomsPerCell = nbl->nci_tot/static_cast<double>(grid.numClusters())*numAtomsCluster;
 913     fprintf(fp, "nbl na_c %d rl %g ncp %d per cell %.1f atoms %.1f ratio %.2f\n",
 914             nbl->na_ci, rl, nbl->nci_tot, nbl->nci_tot/static_cast<double>(grid.numClusters()),
 915             numAtomsPerCell,
 916             numAtomsPerCell/(0.5*4.0/3.0*M_PI*rl*rl*rl*grid.numClusters()*numAtomsCluster/(dims.gridSize[XX]*dims.gridSize[YY]*dims.gridSize[ZZ])));
 917
 918     double sum_nsp  = 0;
 919     double sum_nsp2 = 0;
 920     int    nsp_max  = 0;
 921     int    c[c_gpuNumClusterPerCell + 1] = { 0 };
 922     for (const nbnxn_sci_t &sci : nbl->sci)
 923     {
 924         int nsp = 0;
 925         for (int j4 = sci.cj4_ind_start; j4 < sci.cj4_ind_end; j4++)
 926         {
 927             for (int j = 0; j < c_nbnxnGpuJgroupSize; j++)
 928             {
 929                 int b = 0;
 930                 for (int si = 0; si < c_gpuNumClusterPerCell; si++)
 931                 {
 932                     if (nbl->cj4[j4].imei[0].imask & (1U << (j*c_gpuNumClusterPerCell + si)))
 933                     {
 934                         b++;
 935                     }
 936                 }
 937                 nsp += b;
 938                 c[b]++;
 939             }
 940         }
 941         sum_nsp  += nsp;
 942         sum_nsp2 += nsp*nsp;
 943         nsp_max   = std::max(nsp_max, nsp);
 944     }
 945     if (!nbl->sci.empty())
 946     {
 947         sum_nsp  /= nbl->sci.size();
 948         sum_nsp2 /= nbl->sci.size();
 949     }
 950     fprintf(fp, "nbl #cluster-pairs: av %.1f stddev %.1f max %d\n",
 951             sum_nsp, std::sqrt(sum_nsp2 - sum_nsp*sum_nsp), nsp_max);
 952
 953     if (!nbl->cj4.empty())
 954     {
 955         for (int b = 0; b <= c_gpuNumClusterPerCell; b++)
 956         {
 957             fprintf(fp, "nbl j-list #i-subcell %d %7d %4.1f\n",
 958                     b, c[b], 100.0*c[b]/size_t {nbl->cj4.size()*c_nbnxnGpuJgroupSize});
 959         }
 960     }
 961 }
 962
 963 /* Returns a pointer to the exclusion mask for j-cluster-group \p cj4 and warp \p warp
 964  * Generates a new exclusion entry when the j-cluster-group uses
 965  * the default all-interaction mask at call time, so the returned mask
 966  * can be modified when needed.
 967  */
 968 static nbnxn_excl_t *get_exclusion_mask(NbnxnPairlistGpu *nbl,
 969                                         int               cj4,
 970                                         int               warp)
 971 {
 972     if (nbl->cj4[cj4].imei[warp].excl_ind == 0)
 973     {
 974         /* No exclusions set, make a new list entry */
 975         const size_t oldSize = nbl->excl.size();
 976         GMX_ASSERT(oldSize >= 1, "We should always have entry [0]");
 977         /* Add entry with default values: no exclusions */
 978         nbl->excl.resize(oldSize + 1);
 979         nbl->cj4[cj4].imei[warp].excl_ind = oldSize;
 980     }
 981
 982     return &nbl->excl[nbl->cj4[cj4].imei[warp].excl_ind];
 983 }
 984
 985 static void set_self_and_newton_excls_supersub(NbnxnPairlistGpu *nbl,
 986                                                int cj4_ind, int sj_offset,
 987                                                int i_cluster_in_cell)
 988 {
 989     nbnxn_excl_t *excl[c_nbnxnGpuClusterpairSplit];
 990
 991     /* Here we only set the set self and double pair exclusions */
 992
 993     /* Reserve extra elements, so the resize() in get_exclusion_mask()
 994      * will not invalidate excl entries in the loop below
 995      */
 996     nbl->excl.reserve(nbl->excl.size() + c_nbnxnGpuClusterpairSplit);
 997     for (int w = 0; w < c_nbnxnGpuClusterpairSplit; w++)
 998     {
 999         excl[w] = get_exclusion_mask(nbl, cj4_ind, w);
1000     }
1001
1002     /* Only minor < major bits set */
1003     for (int ej = 0; ej < nbl->na_ci; ej++)
1004     {
1005         int w = (ej>>2);
1006         for (int ei = ej; ei < nbl->na_ci; ei++)
1007         {
1008             excl[w]->pair[(ej & (c_nbnxnGpuJgroupSize-1))*nbl->na_ci + ei] &=
1009                 ~(1U << (sj_offset*c_gpuNumClusterPerCell + i_cluster_in_cell));
1010         }
1011     }
1012 }
1013
1014 /* Returns a diagonal or off-diagonal interaction mask for plain C lists */
1015 static unsigned int get_imask(gmx_bool rdiag, int ci, int cj)
1016 {
1017     return (rdiag && ci == cj ? NBNXN_INTERACTION_MASK_DIAG : NBNXN_INTERACTION_MASK_ALL);
1018 }
1019
1020 /* Returns a diagonal or off-diagonal interaction mask for cj-size=2 */
1021 gmx_unused static unsigned int get_imask_simd_j2(gmx_bool rdiag, int ci, int cj)
1022 {
1023     return (rdiag && ci*2 == cj ? NBNXN_INTERACTION_MASK_DIAG_J2_0 :
1024             (rdiag && ci*2+1 == cj ? NBNXN_INTERACTION_MASK_DIAG_J2_1 :
1025              NBNXN_INTERACTION_MASK_ALL));
1026 }
1027
1028 /* Returns a diagonal or off-diagonal interaction mask for cj-size=4 */
1029 gmx_unused static unsigned int get_imask_simd_j4(gmx_bool rdiag, int ci, int cj)
1030 {
1031     return (rdiag && ci == cj ? NBNXN_INTERACTION_MASK_DIAG : NBNXN_INTERACTION_MASK_ALL);
1032 }
1033
1034 /* Returns a diagonal or off-diagonal interaction mask for cj-size=8 */
1035 gmx_unused static unsigned int get_imask_simd_j8(gmx_bool rdiag, int ci, int cj)
1036 {
1037     return (rdiag && ci == cj*2 ? NBNXN_INTERACTION_MASK_DIAG_J8_0 :
1038             (rdiag && ci == cj*2+1 ? NBNXN_INTERACTION_MASK_DIAG_J8_1 :
1039              NBNXN_INTERACTION_MASK_ALL));
1040 }
1041
1042 #if GMX_SIMD
1043 #if GMX_SIMD_REAL_WIDTH == 2
1044 #define get_imask_simd_4xn  get_imask_simd_j2
1045 #endif
1046 #if GMX_SIMD_REAL_WIDTH == 4
1047 #define get_imask_simd_4xn  get_imask_simd_j4
1048 #endif
1049 #if GMX_SIMD_REAL_WIDTH == 8
1050 #define get_imask_simd_4xn  get_imask_simd_j8
1051 #define get_imask_simd_2xnn get_imask_simd_j4
1052 #endif
1053 #if GMX_SIMD_REAL_WIDTH == 16
1054 #define get_imask_simd_2xnn get_imask_simd_j8
1055 #endif
1056 #endif
1057
1058 /* Plain C code for checking and adding cluster-pairs to the list.
1059  *
1060  * \param[in]     gridj               The j-grid
1061  * \param[in,out] nbl                 The pair-list to store the cluster pairs in
1062  * \param[in]     icluster            The index of the i-cluster
1063  * \param[in]     jclusterFirst       The first cluster in the j-range
1064  * \param[in]     jclusterLast        The last cluster in the j-range
1065  * \param[in]     excludeSubDiagonal  Exclude atom pairs with i-index > j-index
1066  * \param[in]     x_j                 Coordinates for the j-atom, in xyz format
1067  * \param[in]     rlist2              The squared list cut-off
1068  * \param[in]     rbb2                The squared cut-off for putting cluster-pairs in the list based on bounding box distance only
1069  * \param[in,out] numDistanceChecks   The number of distance checks performed
1070  */
1071 static void
1072 makeClusterListSimple(const Grid               &jGrid,
1073                       NbnxnPairlistCpu *        nbl,
1074                       int                       icluster,
1075                       int                       jclusterFirst,
1076                       int                       jclusterLast,
1077                       bool                      excludeSubDiagonal,
1078                       const real * gmx_restrict x_j,
1079                       real                      rlist2,
1080                       float                     rbb2,
1081                       int * gmx_restrict        numDistanceChecks)
1082 {
1083     const BoundingBox * gmx_restrict bb_ci = nbl->work->iClusterData.bb.data();
1084     const real * gmx_restrict        x_ci  = nbl->work->iClusterData.x.data();
1085
1086     gmx_bool                         InRange;
1087
1088     InRange = FALSE;
1089     while (!InRange && jclusterFirst <= jclusterLast)
1090     {
1091         real d2  = clusterBoundingBoxDistance2(bb_ci[0], jGrid.jBoundingBoxes()[jclusterFirst]);
1092         *numDistanceChecks += 2;
1093
1094         /* Check if the distance is within the distance where
1095          * we use only the bounding box distance rbb,
1096          * or within the cut-off and there is at least one atom pair
1097          * within the cut-off.
1098          */
1099         if (d2 < rbb2)
1100         {
1101             InRange = TRUE;
1102         }
1103         else if (d2 < rlist2)
1104         {
1105             int cjf_gl = jGrid.cellOffset() + jclusterFirst;
1106             for (int i = 0; i < c_nbnxnCpuIClusterSize && !InRange; i++)
1107             {
1108                 for (int j = 0; j < c_nbnxnCpuIClusterSize; j++)
1109                 {
1110                     InRange = InRange ||
1111                         (gmx::square(x_ci[i*STRIDE_XYZ+XX] - x_j[(cjf_gl*c_nbnxnCpuIClusterSize+j)*STRIDE_XYZ+XX]) +
1112                          gmx::square(x_ci[i*STRIDE_XYZ+YY] - x_j[(cjf_gl*c_nbnxnCpuIClusterSize+j)*STRIDE_XYZ+YY]) +
1113                          gmx::square(x_ci[i*STRIDE_XYZ+ZZ] - x_j[(cjf_gl*c_nbnxnCpuIClusterSize+j)*STRIDE_XYZ+ZZ]) < rlist2);
1114                 }
1115             }
1116             *numDistanceChecks += c_nbnxnCpuIClusterSize*c_nbnxnCpuIClusterSize;
1117         }
1118         if (!InRange)
1119         {
1120             jclusterFirst++;
1121         }
1122     }
1123     if (!InRange)
1124     {
1125         return;
1126     }
1127
1128     InRange = FALSE;
1129     while (!InRange && jclusterLast > jclusterFirst)
1130     {
1131         real d2  = clusterBoundingBoxDistance2(bb_ci[0], jGrid.jBoundingBoxes()[jclusterLast]);
1132         *numDistanceChecks += 2;
1133
1134         /* Check if the distance is within the distance where
1135          * we use only the bounding box distance rbb,
1136          * or within the cut-off and there is at least one atom pair
1137          * within the cut-off.
1138          */
1139         if (d2 < rbb2)
1140         {
1141             InRange = TRUE;
1142         }
1143         else if (d2 < rlist2)
1144         {
1145             int cjl_gl = jGrid.cellOffset() + jclusterLast;
1146             for (int i = 0; i < c_nbnxnCpuIClusterSize && !InRange; i++)
1147             {
1148                 for (int j = 0; j < c_nbnxnCpuIClusterSize; j++)
1149                 {
1150                     InRange = InRange ||
1151                         (gmx::square(x_ci[i*STRIDE_XYZ+XX] - x_j[(cjl_gl*c_nbnxnCpuIClusterSize+j)*STRIDE_XYZ+XX]) +
1152                          gmx::square(x_ci[i*STRIDE_XYZ+YY] - x_j[(cjl_gl*c_nbnxnCpuIClusterSize+j)*STRIDE_XYZ+YY]) +
1153                          gmx::square(x_ci[i*STRIDE_XYZ+ZZ] - x_j[(cjl_gl*c_nbnxnCpuIClusterSize+j)*STRIDE_XYZ+ZZ]) < rlist2);
1154                 }
1155             }
1156             *numDistanceChecks += c_nbnxnCpuIClusterSize*c_nbnxnCpuIClusterSize;
1157         }
1158         if (!InRange)
1159         {
1160             jclusterLast--;
1161         }
1162     }
1163
1164     if (jclusterFirst <= jclusterLast)
1165     {
1166         for (int jcluster = jclusterFirst; jcluster <= jclusterLast; jcluster++)
1167         {
1168             /* Store cj and the interaction mask */
1169             nbnxn_cj_t cjEntry;
1170             cjEntry.cj   = jGrid.cellOffset() + jcluster;
1171             cjEntry.excl = get_imask(excludeSubDiagonal, icluster, jcluster);
1172             nbl->cj.push_back(cjEntry);
1173         }
1174         /* Increase the closing index in the i list */
1175         nbl->ci.back().cj_ind_end = nbl->cj.size();
1176     }
1177 }
1178
1179 #ifdef GMX_NBNXN_SIMD_4XN
1180 #include "gromacs/nbnxm/pairlist_simd_4xm.h"
1181 #endif
1182 #ifdef GMX_NBNXN_SIMD_2XNN
1183 #include "gromacs/nbnxm/pairlist_simd_2xmm.h"
1184 #endif
1185
1186 /* Plain C or SIMD4 code for making a pair list of super-cell sci vs scj.
1187  * Checks bounding box distances and possibly atom pair distances.
1188  */
1189 static void make_cluster_list_supersub(const Grid         &iGrid,
1190                                        const Grid         &jGrid,
1191                                        NbnxnPairlistGpu   *nbl,
1192                                        const int           sci,
1193                                        const int           scj,
1194                                        const bool          excludeSubDiagonal,
1195                                        const int           stride,
1196                                        const real         *x,
1197                                        const real          rlist2,
1198                                        const float         rbb2,
1199                                        int                *numDistanceChecks)
1200 {
1201     NbnxnPairlistGpuWork &work   = *nbl->work;
1202
1203 #if NBNXN_BBXXXX
1204     const float          *pbb_ci = work.iSuperClusterData.bbPacked.data();
1205 #else
1206     const BoundingBox    *bb_ci  = work.iSuperClusterData.bb.data();
1207 #endif
1208
1209     assert(c_nbnxnGpuClusterSize == iGrid.geometry().numAtomsICluster);
1210     assert(c_nbnxnGpuClusterSize == jGrid.geometry().numAtomsICluster);
1211
1212     /* We generate the pairlist mainly based on bounding-box distances
1213      * and do atom pair distance based pruning on the GPU.
1214      * Only if a j-group contains a single cluster-pair, we try to prune
1215      * that pair based on atom distances on the CPU to avoid empty j-groups.
1216      */
1217 #define PRUNE_LIST_CPU_ONE 1
1218 #define PRUNE_LIST_CPU_ALL 0
1219
1220 #if PRUNE_LIST_CPU_ONE
1221     int  ci_last = -1;
1222 #endif
1223
1224     float *d2l = work.distanceBuffer.data();
1225
1226     for (int subc = 0; subc < jGrid.numClustersPerCell()[scj]; subc++)
1227     {
1228         const int    cj4_ind   = work.cj_ind/c_nbnxnGpuJgroupSize;
1229         const int    cj_offset = work.cj_ind - cj4_ind*c_nbnxnGpuJgroupSize;
1230         const int    cj        = scj*c_gpuNumClusterPerCell + subc;
1231
1232         const int    cj_gl     = jGrid.cellOffset()*c_gpuNumClusterPerCell + cj;
1233
1234         int          ci1;
1235         if (excludeSubDiagonal && sci == scj)
1236         {
1237             ci1 = subc + 1;
1238         }
1239         else
1240         {
1241             ci1 = iGrid.numClustersPerCell()[sci];
1242         }
1243
1244 #if NBNXN_BBXXXX
1245         /* Determine all ci1 bb distances in one call with SIMD4 */
1246         const int offset = packedBoundingBoxesIndex(cj) + (cj & (c_packedBoundingBoxesDimSize - 1));
1247         clusterBoundingBoxDistance2_xxxx_simd4(jGrid.packedBoundingBoxes().data() + offset,
1248                                                ci1, pbb_ci, d2l);
1249         *numDistanceChecks += c_nbnxnGpuClusterSize*2;
1250 #endif
1251
1252         int          npair = 0;
1253         unsigned int imask = 0;
1254         /* We use a fixed upper-bound instead of ci1 to help optimization */
1255         for (int ci = 0; ci < c_gpuNumClusterPerCell; ci++)
1256         {
1257             if (ci == ci1)
1258             {
1259                 break;
1260             }
1261
1262 #if !NBNXN_BBXXXX
1263             /* Determine the bb distance between ci and cj */
1264             d2l[ci]             = clusterBoundingBoxDistance2(bb_ci[ci], jGrid.jBoundingBoxes()[cj]);
1265             *numDistanceChecks += 2;
1266 #endif
1267             float d2 = d2l[ci];
1268
1269 #if PRUNE_LIST_CPU_ALL
1270             /* Check if the distance is within the distance where
1271              * we use only the bounding box distance rbb,
1272              * or within the cut-off and there is at least one atom pair
1273              * within the cut-off. This check is very costly.
1274              */
1275             *numDistanceChecks += c_nbnxnGpuClusterSize*c_nbnxnGpuClusterSize;
1276             if (d2 < rbb2 ||
1277                 (d2 < rlist2 &&
1278                  clusterpair_in_range(work, ci, cj_gl, stride, x, rlist2)))
1279 #else
1280             /* Check if the distance between the two bounding boxes
1281              * in within the pair-list cut-off.
1282              */
1283             if (d2 < rlist2)
1284 #endif
1285             {
1286                 /* Flag this i-subcell to be taken into account */
1287                 imask |= (1U << (cj_offset*c_gpuNumClusterPerCell + ci));
1288
1289 #if PRUNE_LIST_CPU_ONE
1290                 ci_last = ci;
1291 #endif
1292
1293                 npair++;
1294             }
1295         }
1296
1297 #if PRUNE_LIST_CPU_ONE
1298         /* If we only found 1 pair, check if any atoms are actually
1299          * within the cut-off, so we could get rid of it.
1300          */
1301         if (npair == 1 && d2l[ci_last] >= rbb2 &&
1302             !clusterpair_in_range(work, ci_last, cj_gl, stride, x, rlist2))
1303         {
1304             imask &= ~(1U << (cj_offset*c_gpuNumClusterPerCell + ci_last));
1305             npair--;
1306         }
1307 #endif
1308
1309         if (npair > 0)
1310         {
1311             /* We have at least one cluster pair: add a j-entry */
1312             if (static_cast<size_t>(cj4_ind) == nbl->cj4.size())
1313             {
1314                 nbl->cj4.resize(nbl->cj4.size() + 1);
1315             }
1316             nbnxn_cj4_t *cj4   = &nbl->cj4[cj4_ind];
1317
1318             cj4->cj[cj_offset] = cj_gl;
1319
1320             /* Set the exclusions for the ci==sj entry.
1321              * Here we don't bother to check if this entry is actually flagged,
1322              * as it will nearly always be in the list.
1323              */
1324             if (excludeSubDiagonal && sci == scj)
1325             {
1326                 set_self_and_newton_excls_supersub(nbl, cj4_ind, cj_offset, subc);
1327             }
1328
1329             /* Copy the cluster interaction mask to the list */
1330             for (int w = 0; w < c_nbnxnGpuClusterpairSplit; w++)
1331             {
1332                 cj4->imei[w].imask |= imask;
1333             }
1334
1335             nbl->work->cj_ind++;
1336
1337             /* Keep the count */
1338             nbl->nci_tot += npair;
1339
1340             /* Increase the closing index in i super-cell list */
1341             nbl->sci.back().cj4_ind_end =
1342                 (nbl->work->cj_ind + c_nbnxnGpuJgroupSize - 1)/c_nbnxnGpuJgroupSize;
1343         }
1344     }
1345 }
1346
1347 /* Returns how many contiguous j-clusters we have starting in the i-list */
1348 template <typename CjListType>
1349 static int numContiguousJClusters(const int                       cjIndexStart,
1350                                   const int                       cjIndexEnd,
1351                                   gmx::ArrayRef<const CjListType> cjList)
1352 {
1353     const int firstJCluster = nblCj(cjList, cjIndexStart);
1354
1355     int       numContiguous = 0;
1356
1357     while (cjIndexStart + numContiguous < cjIndexEnd &&
1358            nblCj(cjList, cjIndexStart + numContiguous) == firstJCluster + numContiguous)
1359     {
1360         numContiguous++;
1361     }
1362
1363     return numContiguous;
1364 }
1365
1366 /*! \internal
1367  * \brief Helper struct for efficient searching for excluded atoms in a j-list
1368  */
1369 struct JListRanges
1370 {
1371     /*! \brief Constructs a j-list range from \p cjList with the given index range */
1372     template <typename CjListType>
1373     JListRanges(int                             cjIndexStart,
1374                 int                             cjIndexEnd,
1375                 gmx::ArrayRef<const CjListType> cjList);
1376
1377     int cjIndexStart; //!< The start index in the j-list
1378     int cjIndexEnd;   //!< The end index in the j-list
1379     int cjFirst;      //!< The j-cluster with index cjIndexStart
1380     int cjLast;       //!< The j-cluster with index cjIndexEnd-1
1381     int numDirect;    //!< Up to cjIndexStart+numDirect the j-clusters are cjFirst + the index offset
1382 };
1383
1384 #ifndef DOXYGEN
1385 template <typename CjListType>
1386 JListRanges::JListRanges(int                             cjIndexStart,
1387                          int                             cjIndexEnd,
1388                          gmx::ArrayRef<const CjListType> cjList) :
1389     cjIndexStart(cjIndexStart),
1390     cjIndexEnd(cjIndexEnd)
1391 {
1392     GMX_ASSERT(cjIndexEnd > cjIndexStart, "JListRanges should only be called with non-empty lists");
1393
1394     cjFirst   = nblCj(cjList, cjIndexStart);
1395     cjLast    = nblCj(cjList, cjIndexEnd - 1);
1396
1397     /* Determine how many contiguous j-cells we have starting
1398      * from the first i-cell. This number can be used to directly
1399      * calculate j-cell indices for excluded atoms.
1400      */
1401     numDirect = numContiguousJClusters(cjIndexStart, cjIndexEnd, cjList);
1402 }
1403 #endif // !DOXYGEN
1404
1405 /* Return the index of \p jCluster in the given range or -1 when not present
1406  *
1407  * Note: This code is executed very often and therefore performance is
1408  *       important. It should be inlined and fully optimized.
1409  */
1410 template <typename CjListType>
1411 static inline int
1412 findJClusterInJList(int                              jCluster,
1413                     const JListRanges               &ranges,
1414                     gmx::ArrayRef<const CjListType>  cjList)
1415 {
1416     int index;
1417
1418     if (jCluster < ranges.cjFirst + ranges.numDirect)
1419     {
1420         /* We can calculate the index directly using the offset */
1421         index = ranges.cjIndexStart + jCluster - ranges.cjFirst;
1422     }
1423     else
1424     {
1425         /* Search for jCluster using bisection */
1426         index           = -1;
1427         int rangeStart  = ranges.cjIndexStart + ranges.numDirect;
1428         int rangeEnd    = ranges.cjIndexEnd;
1429         int rangeMiddle;
1430         while (index == -1 && rangeStart < rangeEnd)
1431         {
1432             rangeMiddle = (rangeStart + rangeEnd) >> 1;
1433
1434             const int clusterMiddle = nblCj(cjList, rangeMiddle);
1435
1436             if (jCluster == clusterMiddle)
1437             {
1438                 index      = rangeMiddle;
1439             }
1440             else if (jCluster < clusterMiddle)
1441             {
1442                 rangeEnd   = rangeMiddle;
1443             }
1444             else
1445             {
1446                 rangeStart = rangeMiddle + 1;
1447             }
1448         }
1449     }
1450
1451     return index;
1452 }
1453
1454 // TODO: Get rid of the two functions below by renaming sci to ci (or something better)
1455
1456 /* Return the i-entry in the list we are currently operating on */
1457 static nbnxn_ci_t *getOpenIEntry(NbnxnPairlistCpu *nbl)
1458 {
1459     return &nbl->ci.back();
1460 }
1461
1462 /* Return the i-entry in the list we are currently operating on */
1463 static nbnxn_sci_t *getOpenIEntry(NbnxnPairlistGpu *nbl)
1464 {
1465     return &nbl->sci.back();
1466 }
1467
1468 /* Set all atom-pair exclusions for a simple type list i-entry
1469  *
1470  * Set all atom-pair exclusions from the topology stored in exclusions
1471  * as masks in the pair-list for simple list entry iEntry.
1472  */
1473 static void
1474 setExclusionsForIEntry(const Nbnxm::GridSet &gridSet,
1475                        NbnxnPairlistCpu     *nbl,
1476                        gmx_bool              diagRemoved,
1477                        int                   na_cj_2log,
1478                        const nbnxn_ci_t     &iEntry,
1479                        const t_blocka       &exclusions)
1480 {
1481     if (iEntry.cj_ind_end == iEntry.cj_ind_start)
1482     {
1483         /* Empty list: no exclusions */
1484         return;
1485     }
1486
1487     const JListRanges        ranges(iEntry.cj_ind_start, iEntry.cj_ind_end, gmx::makeConstArrayRef(nbl->cj));
1488
1489     const int                iCluster = iEntry.ci;
1490
1491     gmx::ArrayRef<const int> cell        = gridSet.cells();
1492     gmx::ArrayRef<const int> atomIndices = gridSet.atomIndices();
1493
1494     /* Loop over the atoms in the i-cluster */
1495     for (int i = 0; i < nbl->na_ci; i++)
1496     {
1497         const int iIndex = iCluster*nbl->na_ci + i;
1498         const int iAtom  = atomIndices[iIndex];
1499         if (iAtom >= 0)
1500         {
1501             /* Loop over the topology-based exclusions for this i-atom */
1502             for (int exclIndex = exclusions.index[iAtom]; exclIndex < exclusions.index[iAtom + 1]; exclIndex++)
1503             {
1504                 const int jAtom = exclusions.a[exclIndex];
1505
1506                 if (jAtom == iAtom)
1507                 {
1508                     /* The self exclusion are already set, save some time */
1509                     continue;
1510                 }
1511
1512                 /* Get the index of the j-atom in the nbnxn atom data */
1513                 const int jIndex = cell[jAtom];
1514
1515                 /* Without shifts we only calculate interactions j>i
1516                  * for one-way pair-lists.
1517                  */
1518                 if (diagRemoved && jIndex <= iIndex)
1519                 {
1520                     continue;
1521                 }
1522
1523                 const int jCluster = (jIndex >> na_cj_2log);
1524
1525                 /* Could the cluster se be in our list? */
1526                 if (jCluster >= ranges.cjFirst && jCluster <= ranges.cjLast)
1527                 {
1528                     const int index =
1529                         findJClusterInJList(jCluster, ranges,
1530                                             gmx::makeConstArrayRef(nbl->cj));
1531
1532                     if (index >= 0)
1533                     {
1534                         /* We found an exclusion, clear the corresponding
1535                          * interaction bit.
1536                          */
1537                         const int innerJ     = jIndex - (jCluster << na_cj_2log);
1538
1539                         nbl->cj[index].excl &= ~(1U << ((i << na_cj_2log) + innerJ));
1540                     }
1541                 }
1542             }
1543         }
1544     }
1545 }
1546
1547 /* Add a new i-entry to the FEP list and copy the i-properties */
1548 static inline void fep_list_new_nri_copy(t_nblist *nlist)
1549 {
1550     /* Add a new i-entry */
1551     nlist->nri++;
1552
1553     assert(nlist->nri < nlist->maxnri);
1554
1555     /* Duplicate the last i-entry, except for jindex, which continues */
1556     nlist->iinr[nlist->nri]   = nlist->iinr[nlist->nri-1];
1557     nlist->shift[nlist->nri]  = nlist->shift[nlist->nri-1];
1558     nlist->gid[nlist->nri]    = nlist->gid[nlist->nri-1];
1559     nlist->jindex[nlist->nri] = nlist->nrj;
1560 }
1561
1562 /* For load balancing of the free-energy lists over threads, we set
1563  * the maximum nrj size of an i-entry to 40. This leads to good
1564  * load balancing in the worst case scenario of a single perturbed
1565  * particle on 16 threads, while not introducing significant overhead.
1566  * Note that half of the perturbed pairs will anyhow end up in very small lists,
1567  * since non perturbed i-particles will see few perturbed j-particles).
1568  */
1569 const int max_nrj_fep = 40;
1570
1571 /* Exclude the perturbed pairs from the Verlet list. This is only done to avoid
1572  * singularities for overlapping particles (0/0), since the charges and
1573  * LJ parameters have been zeroed in the nbnxn data structure.
1574  * Simultaneously make a group pair list for the perturbed pairs.
1575  */
1576 static void make_fep_list(gmx::ArrayRef<const int>  atomIndices,
1577                           const nbnxn_atomdata_t   *nbat,
1578                           NbnxnPairlistCpu         *nbl,
1579                           gmx_bool                  bDiagRemoved,
1580                           nbnxn_ci_t               *nbl_ci,
1581                           real gmx_unused           shx,
1582                           real gmx_unused           shy,
1583                           real gmx_unused           shz,
1584                           real gmx_unused           rlist_fep2,
1585                           const Grid               &iGrid,
1586                           const Grid               &jGrid,
1587                           t_nblist                 *nlist)
1588 {
1589     int      ci, cj_ind_start, cj_ind_end, cja, cjr;
1590     int      nri_max;
1591     int      gid_i = 0, gid_j, gid;
1592     int      egp_shift, egp_mask;
1593     int      gid_cj = 0;
1594     int      ind_i, ind_j, ai, aj;
1595     int      nri;
1596     gmx_bool bFEP_i, bFEP_i_all;
1597
1598     if (nbl_ci->cj_ind_end == nbl_ci->cj_ind_start)
1599     {
1600         /* Empty list */
1601         return;
1602     }
1603
1604     ci = nbl_ci->ci;
1605
1606     cj_ind_start = nbl_ci->cj_ind_start;
1607     cj_ind_end   = nbl_ci->cj_ind_end;
1608
1609     /* In worst case we have alternating energy groups
1610      * and create #atom-pair lists, which means we need the size
1611      * of a cluster pair (na_ci*na_cj) times the number of cj's.
1612      */
1613     nri_max = nbl->na_ci*nbl->na_cj*(cj_ind_end - cj_ind_start);
1614     if (nlist->nri + nri_max > nlist->maxnri)
1615     {
1616         nlist->maxnri = over_alloc_large(nlist->nri + nri_max);
1617         reallocate_nblist(nlist);
1618     }
1619
1620     const int numAtomsJCluster = jGrid.geometry().numAtomsJCluster;
1621
1622     const nbnxn_atomdata_t::Params &nbatParams = nbat->params();
1623
1624     const int ngid = nbatParams.nenergrp;
1625
1626     /* TODO: Consider adding a check in grompp and changing this to an assert */
1627     const int numBitsInEnergyGroupIdsForAtomsInJCluster = sizeof(gid_cj)*8;
1628     if (ngid*numAtomsJCluster > numBitsInEnergyGroupIdsForAtomsInJCluster)
1629     {
1630         gmx_fatal(FARGS, "The Verlet scheme with %dx%d kernels and free-energy only supports up to %zu energy groups",
1631                   iGrid.geometry().numAtomsICluster, numAtomsJCluster,
1632                   (sizeof(gid_cj)*8)/numAtomsJCluster);
1633     }
1634
1635     egp_shift = nbatParams.neg_2log;
1636     egp_mask  = (1 << egp_shift) - 1;
1637
1638     /* Loop over the atoms in the i sub-cell */
1639     bFEP_i_all = TRUE;
1640     for (int i = 0; i < nbl->na_ci; i++)
1641     {
1642         ind_i = ci*nbl->na_ci + i;
1643         ai    = atomIndices[ind_i];
1644         if (ai >= 0)
1645         {
1646             nri                  = nlist->nri;
1647             nlist->jindex[nri+1] = nlist->jindex[nri];
1648             nlist->iinr[nri]     = ai;
1649             /* The actual energy group pair index is set later */
1650             nlist->gid[nri]      = 0;
1651             nlist->shift[nri]    = nbl_ci->shift & NBNXN_CI_SHIFT;
1652
1653             bFEP_i = iGrid.atomIsPerturbed(ci - iGrid.cellOffset(), i);
1654
1655             bFEP_i_all = bFEP_i_all && bFEP_i;
1656
1657             if (nlist->nrj + (cj_ind_end - cj_ind_start)*nbl->na_cj > nlist->maxnrj)
1658             {
1659                 nlist->maxnrj = over_alloc_small(nlist->nrj + (cj_ind_end - cj_ind_start)*nbl->na_cj);
1660                 srenew(nlist->jjnr,     nlist->maxnrj);
1661                 srenew(nlist->excl_fep, nlist->maxnrj);
1662             }
1663
1664             if (ngid > 1)
1665             {
1666                 gid_i = (nbatParams.energrp[ci] >> (egp_shift*i)) & egp_mask;
1667             }
1668
1669             for (int cj_ind = cj_ind_start; cj_ind < cj_ind_end; cj_ind++)
1670             {
1671                 unsigned int fep_cj;
1672
1673                 cja = nbl->cj[cj_ind].cj;
1674
1675                 if (numAtomsJCluster == jGrid.geometry().numAtomsICluster)
1676                 {
1677                     cjr    = cja - jGrid.cellOffset();
1678                     fep_cj = jGrid.fepBits(cjr);
1679                     if (ngid > 1)
1680                     {
1681                         gid_cj = nbatParams.energrp[cja];
1682                     }
1683                 }
1684                 else if (2*numAtomsJCluster == jGrid.geometry().numAtomsICluster)
1685                 {
1686                     cjr    = cja - jGrid.cellOffset()*2;
1687                     /* Extract half of the ci fep/energrp mask */
1688                     fep_cj = (jGrid.fepBits(cjr >> 1) >> ((cjr & 1)*numAtomsJCluster)) & ((1 << numAtomsJCluster) - 1);
1689                     if (ngid > 1)
1690                     {
1691                         gid_cj = nbatParams.energrp[cja >> 1] >> ((cja & 1)*numAtomsJCluster*egp_shift) & ((1 << (numAtomsJCluster*egp_shift)) - 1);
1692                     }
1693                 }
1694                 else
1695                 {
1696                     cjr    = cja - (jGrid.cellOffset() >> 1);
1697                     /* Combine two ci fep masks/energrp */
1698                     fep_cj = jGrid.fepBits(cjr*2) + (jGrid.fepBits(cjr*2 + 1) << jGrid.geometry().numAtomsICluster);
1699                     if (ngid > 1)
1700                     {
1701                         gid_cj = nbatParams.energrp[cja*2] + (nbatParams.energrp[cja*2+1] << (jGrid.geometry().numAtomsICluster*egp_shift));
1702                     }
1703                 }
1704
1705                 if (bFEP_i || fep_cj != 0)
1706                 {
1707                     for (int j = 0; j < nbl->na_cj; j++)
1708                     {
1709                         /* Is this interaction perturbed and not excluded? */
1710                         ind_j = cja*nbl->na_cj + j;
1711                         aj    = atomIndices[ind_j];
1712                         if (aj >= 0 &&
1713                             (bFEP_i || (fep_cj & (1 << j))) &&
1714                             (!bDiagRemoved || ind_j >= ind_i))
1715                         {
1716                             if (ngid > 1)
1717                             {
1718                                 gid_j = (gid_cj >> (j*egp_shift)) & egp_mask;
1719                                 gid   = GID(gid_i, gid_j, ngid);
1720
1721                                 if (nlist->nrj > nlist->jindex[nri] &&
1722                                     nlist->gid[nri] != gid)
1723                                 {
1724                                     /* Energy group pair changed: new list */
1725                                     fep_list_new_nri_copy(nlist);
1726                                     nri = nlist->nri;
1727                                 }
1728                                 nlist->gid[nri] = gid;
1729                             }
1730
1731                             if (nlist->nrj - nlist->jindex[nri] >= max_nrj_fep)
1732                             {
1733                                 fep_list_new_nri_copy(nlist);
1734                                 nri = nlist->nri;
1735                             }
1736
1737                             /* Add it to the FEP list */
1738                             nlist->jjnr[nlist->nrj]     = aj;
1739                             nlist->excl_fep[nlist->nrj] = (nbl->cj[cj_ind].excl >> (i*nbl->na_cj + j)) & 1;
1740                             nlist->nrj++;
1741
1742                             /* Exclude it from the normal list.
1743                              * Note that the charge has been set to zero,
1744                              * but we need to avoid 0/0, as perturbed atoms
1745                              * can be on top of each other.
1746                              */
1747                             nbl->cj[cj_ind].excl &= ~(1U << (i*nbl->na_cj + j));
1748                         }
1749                     }
1750                 }
1751             }
1752
1753             if (nlist->nrj > nlist->jindex[nri])
1754             {
1755                 /* Actually add this new, non-empty, list */
1756                 nlist->nri++;
1757                 nlist->jindex[nlist->nri] = nlist->nrj;
1758             }
1759         }
1760     }
1761
1762     if (bFEP_i_all)
1763     {
1764         /* All interactions are perturbed, we can skip this entry */
1765         nbl_ci->cj_ind_end = cj_ind_start;
1766         nbl->ncjInUse     -= cj_ind_end - cj_ind_start;
1767     }
1768 }
1769
1770 /* Return the index of atom a within a cluster */
1771 static inline int cj_mod_cj4(int cj)
1772 {
1773     return cj & (c_nbnxnGpuJgroupSize - 1);
1774 }
1775
1776 /* Convert a j-cluster to a cj4 group */
1777 static inline int cj_to_cj4(int cj)
1778 {
1779     return cj/c_nbnxnGpuJgroupSize;
1780 }
1781
1782 /* Return the index of an j-atom within a warp */
1783 static inline int a_mod_wj(int a)
1784 {
1785     return a & (c_nbnxnGpuClusterSize/c_nbnxnGpuClusterpairSplit - 1);
1786 }
1787
1788 /* As make_fep_list above, but for super/sub lists. */
1789 static void make_fep_list(gmx::ArrayRef<const int>  atomIndices,
1790                           const nbnxn_atomdata_t   *nbat,
1791                           NbnxnPairlistGpu         *nbl,
1792                           gmx_bool                  bDiagRemoved,
1793                           const nbnxn_sci_t        *nbl_sci,
1794                           real                      shx,
1795                           real                      shy,
1796                           real                      shz,
1797                           real                      rlist_fep2,
1798                           const Grid               &iGrid,
1799                           const Grid               &jGrid,
1800                           t_nblist                 *nlist)
1801 {
1802     int                nri_max;
1803     int                c_abs;
1804     int                ind_i, ind_j, ai, aj;
1805     int                nri;
1806     gmx_bool           bFEP_i;
1807     real               xi, yi, zi;
1808     const nbnxn_cj4_t *cj4;
1809
1810     const int          numJClusterGroups = nbl_sci->numJClusterGroups();
1811     if (numJClusterGroups == 0)
1812     {
1813         /* Empty list */
1814         return;
1815     }
1816
1817     const int sci           = nbl_sci->sci;
1818
1819     const int cj4_ind_start = nbl_sci->cj4_ind_start;
1820     const int cj4_ind_end   = nbl_sci->cj4_ind_end;
1821
1822     /* Here we process one super-cell, max #atoms na_sc, versus a list
1823      * cj4 entries, each with max c_nbnxnGpuJgroupSize cj's, each
1824      * of size na_cj atoms.
1825      * On the GPU we don't support energy groups (yet).
1826      * So for each of the na_sc i-atoms, we need max one FEP list
1827      * for each max_nrj_fep j-atoms.
1828      */
1829     nri_max = nbl->na_sc*nbl->na_cj*(1 + (numJClusterGroups*c_nbnxnGpuJgroupSize)/max_nrj_fep);
1830     if (nlist->nri + nri_max > nlist->maxnri)
1831     {
1832         nlist->maxnri = over_alloc_large(nlist->nri + nri_max);
1833         reallocate_nblist(nlist);
1834     }
1835
1836     /* Loop over the atoms in the i super-cluster */
1837     for (int c = 0; c < c_gpuNumClusterPerCell; c++)
1838     {
1839         c_abs = sci*c_gpuNumClusterPerCell + c;
1840
1841         for (int i = 0; i < nbl->na_ci; i++)
1842         {
1843             ind_i = c_abs*nbl->na_ci + i;
1844             ai    = atomIndices[ind_i];
1845             if (ai >= 0)
1846             {
1847                 nri                  = nlist->nri;
1848                 nlist->jindex[nri+1] = nlist->jindex[nri];
1849                 nlist->iinr[nri]     = ai;
1850                 /* With GPUs, energy groups are not supported */
1851                 nlist->gid[nri]      = 0;
1852                 nlist->shift[nri]    = nbl_sci->shift & NBNXN_CI_SHIFT;
1853
1854                 bFEP_i = iGrid.atomIsPerturbed(c_abs - iGrid.cellOffset()*c_gpuNumClusterPerCell, i);
1855
1856                 xi = nbat->x()[ind_i*nbat->xstride+XX] + shx;
1857                 yi = nbat->x()[ind_i*nbat->xstride+YY] + shy;
1858                 zi = nbat->x()[ind_i*nbat->xstride+ZZ] + shz;
1859
1860                 const int nrjMax = nlist->nrj + numJClusterGroups*c_nbnxnGpuJgroupSize*nbl->na_cj;
1861                 if (nrjMax > nlist->maxnrj)
1862                 {
1863                     nlist->maxnrj = over_alloc_small(nrjMax);
1864                     srenew(nlist->jjnr,     nlist->maxnrj);
1865                     srenew(nlist->excl_fep, nlist->maxnrj);
1866                 }
1867
1868                 for (int cj4_ind = cj4_ind_start; cj4_ind < cj4_ind_end; cj4_ind++)
1869                 {
1870                     cj4 = &nbl->cj4[cj4_ind];
1871
1872                     for (int gcj = 0; gcj < c_nbnxnGpuJgroupSize; gcj++)
1873                     {
1874                         if ((cj4->imei[0].imask & (1U << (gcj*c_gpuNumClusterPerCell + c))) == 0)
1875                         {
1876                             /* Skip this ci for this cj */
1877                             continue;
1878                         }
1879
1880                         const int cjr =
1881                             cj4->cj[gcj] - jGrid.cellOffset()*c_gpuNumClusterPerCell;
1882
1883                         if (bFEP_i || jGrid.clusterIsPerturbed(cjr))
1884                         {
1885                             for (int j = 0; j < nbl->na_cj; j++)
1886                             {
1887                                 /* Is this interaction perturbed and not excluded? */
1888                                 ind_j = (jGrid.cellOffset()*c_gpuNumClusterPerCell + cjr)*nbl->na_cj + j;
1889                                 aj    = atomIndices[ind_j];
1890                                 if (aj >= 0 &&
1891                                     (bFEP_i || jGrid.atomIsPerturbed(cjr, j)) &&
1892                                     (!bDiagRemoved || ind_j >= ind_i))
1893                                 {
1894                                     int           excl_pair;
1895                                     unsigned int  excl_bit;
1896                                     real          dx, dy, dz;
1897
1898                                     const int     jHalf = j/(c_nbnxnGpuClusterSize/c_nbnxnGpuClusterpairSplit);
1899                                     nbnxn_excl_t *excl  =
1900                                         get_exclusion_mask(nbl, cj4_ind, jHalf);
1901
1902                                     excl_pair = a_mod_wj(j)*nbl->na_ci + i;
1903                                     excl_bit  = (1U << (gcj*c_gpuNumClusterPerCell + c));
1904
1905                                     dx = nbat->x()[ind_j*nbat->xstride+XX] - xi;
1906                                     dy = nbat->x()[ind_j*nbat->xstride+YY] - yi;
1907                                     dz = nbat->x()[ind_j*nbat->xstride+ZZ] - zi;
1908
1909                                     /* The unpruned GPU list has more than 2/3
1910                                      * of the atom pairs beyond rlist. Using
1911                                      * this list will cause a lot of overhead
1912                                      * in the CPU FEP kernels, especially
1913                                      * relative to the fast GPU kernels.
1914                                      * So we prune the FEP list here.
1915                                      */
1916                                     if (dx*dx + dy*dy + dz*dz < rlist_fep2)
1917                                     {
1918                                         if (nlist->nrj - nlist->jindex[nri] >= max_nrj_fep)
1919                                         {
1920                                             fep_list_new_nri_copy(nlist);
1921                                             nri = nlist->nri;
1922                                         }
1923
1924                                         /* Add it to the FEP list */
1925                                         nlist->jjnr[nlist->nrj]     = aj;
1926                                         nlist->excl_fep[nlist->nrj] = (excl->pair[excl_pair] & excl_bit) ? 1 : 0;
1927                                         nlist->nrj++;
1928                                     }
1929
1930                                     /* Exclude it from the normal list.
1931                                      * Note that the charge and LJ parameters have
1932                                      * been set to zero, but we need to avoid 0/0,
1933                                      * as perturbed atoms can be on top of each other.
1934                                      */
1935                                     excl->pair[excl_pair] &= ~excl_bit;
1936                                 }
1937                             }
1938
1939                             /* Note that we could mask out this pair in imask
1940                              * if all i- and/or all j-particles are perturbed.
1941                              * But since the perturbed pairs on the CPU will
1942                              * take an order of magnitude more time, the GPU
1943                              * will finish before the CPU and there is no gain.
1944                              */
1945                         }
1946                     }
1947                 }
1948
1949                 if (nlist->nrj > nlist->jindex[nri])
1950                 {
1951                     /* Actually add this new, non-empty, list */
1952                     nlist->nri++;
1953                     nlist->jindex[nlist->nri] = nlist->nrj;
1954                 }
1955             }
1956         }
1957     }
1958 }
1959
1960 /* Set all atom-pair exclusions for a GPU type list i-entry
1961  *
1962  * Sets all atom-pair exclusions from the topology stored in exclusions
1963  * as masks in the pair-list for i-super-cluster list entry iEntry.
1964  */
1965 static void
1966 setExclusionsForIEntry(const Nbnxm::GridSet &gridSet,
1967                        NbnxnPairlistGpu     *nbl,
1968                        gmx_bool              diagRemoved,
1969                        int gmx_unused        na_cj_2log,
1970                        const nbnxn_sci_t    &iEntry,
1971                        const t_blocka       &exclusions)
1972 {
1973     if (iEntry.numJClusterGroups() == 0)
1974     {
1975         /* Empty list */
1976         return;
1977     }
1978
1979     /* Set the search ranges using start and end j-cluster indices.
1980      * Note that here we can not use cj4_ind_end, since the last cj4
1981      * can be only partially filled, so we use cj_ind.
1982      */
1983     const JListRanges ranges(iEntry.cj4_ind_start*c_nbnxnGpuJgroupSize,
1984                              nbl->work->cj_ind,
1985                              gmx::makeConstArrayRef(nbl->cj4));
1986
1987     GMX_ASSERT(nbl->na_ci == c_nbnxnGpuClusterSize, "na_ci should match the GPU cluster size");
1988     constexpr int            c_clusterSize      = c_nbnxnGpuClusterSize;
1989     constexpr int            c_superClusterSize = c_nbnxnGpuNumClusterPerSupercluster*c_nbnxnGpuClusterSize;
1990
1991     const int                iSuperCluster = iEntry.sci;
1992
1993     gmx::ArrayRef<const int> atomIndices   = gridSet.atomIndices();
1994     gmx::ArrayRef<const int> cell          = gridSet.cells();
1995
1996     /* Loop over the atoms in the i super-cluster */
1997     for (int i = 0; i < c_superClusterSize; i++)
1998     {
1999         const int iIndex = iSuperCluster*c_superClusterSize + i;
2000         const int iAtom  = atomIndices[iIndex];
2001         if (iAtom >= 0)
2002         {
2003             const int iCluster = i/c_clusterSize;
2004
2005             /* Loop over the topology-based exclusions for this i-atom */
2006             for (int exclIndex = exclusions.index[iAtom]; exclIndex < exclusions.index[iAtom + 1]; exclIndex++)
2007             {
2008                 const int jAtom = exclusions.a[exclIndex];
2009
2010                 if (jAtom == iAtom)
2011                 {
2012                     /* The self exclusions are already set, save some time */
2013                     continue;
2014                 }
2015
2016                 /* Get the index of the j-atom in the nbnxn atom data */
2017                 const int jIndex = cell[jAtom];
2018
2019                 /* Without shifts we only calculate interactions j>i
2020                  * for one-way pair-lists.
2021                  */
2022                 /* NOTE: We would like to use iIndex on the right hand side,
2023                  * but that makes this routine 25% slower with gcc6/7.
2024                  * Even using c_superClusterSize makes it slower.
2025                  * Either of these changes triggers peeling of the exclIndex
2026                  * loop, which apparently leads to far less efficient code.
2027                  */
2028                 if (diagRemoved && jIndex <= iSuperCluster*nbl->na_sc + i)
2029                 {
2030                     continue;
2031                 }
2032
2033                 const int jCluster = jIndex/c_clusterSize;
2034
2035                 /* Check whether the cluster is in our list? */
2036                 if (jCluster >= ranges.cjFirst && jCluster <= ranges.cjLast)
2037                 {
2038                     const int index =
2039                         findJClusterInJList(jCluster, ranges,
2040                                             gmx::makeConstArrayRef(nbl->cj4));
2041
2042                     if (index >= 0)
2043                     {
2044                         /* We found an exclusion, clear the corresponding
2045                          * interaction bit.
2046                          */
2047                         const unsigned int pairMask = (1U << (cj_mod_cj4(index)*c_gpuNumClusterPerCell + iCluster));
2048                         /* Check if the i-cluster interacts with the j-cluster */
2049                         if (nbl_imask0(nbl, index) & pairMask)
2050                         {
2051                             const int innerI = (i      & (c_clusterSize - 1));
2052                             const int innerJ = (jIndex & (c_clusterSize - 1));
2053
2054                             /* Determine which j-half (CUDA warp) we are in */
2055                             const int     jHalf = innerJ/(c_clusterSize/c_nbnxnGpuClusterpairSplit);
2056
2057                             nbnxn_excl_t *interactionMask =
2058                                 get_exclusion_mask(nbl, cj_to_cj4(index), jHalf);
2059
2060                             interactionMask->pair[a_mod_wj(innerJ)*c_clusterSize + innerI] &= ~pairMask;
2061                         }
2062                     }
2063                 }
2064             }
2065         }
2066     }
2067 }
2068
2069 /* Make a new ci entry at the back of nbl->ci */
2070 static void addNewIEntry(NbnxnPairlistCpu *nbl, int ci, int shift, int flags)
2071 {
2072     nbnxn_ci_t ciEntry;
2073     ciEntry.ci            = ci;
2074     ciEntry.shift         = shift;
2075     /* Store the interaction flags along with the shift */
2076     ciEntry.shift        |= flags;
2077     ciEntry.cj_ind_start  = nbl->cj.size();
2078     ciEntry.cj_ind_end    = nbl->cj.size();
2079     nbl->ci.push_back(ciEntry);
2080 }
2081
2082 /* Make a new sci entry at index nbl->nsci */
2083 static void addNewIEntry(NbnxnPairlistGpu *nbl, int sci, int shift, int gmx_unused flags)
2084 {
2085     nbnxn_sci_t sciEntry;
2086     sciEntry.sci           = sci;
2087     sciEntry.shift         = shift;
2088     sciEntry.cj4_ind_start = nbl->cj4.size();
2089     sciEntry.cj4_ind_end   = nbl->cj4.size();
2090
2091     nbl->sci.push_back(sciEntry);
2092 }
2093
2094 /* Sort the simple j-list cj on exclusions.
2095  * Entries with exclusions will all be sorted to the beginning of the list.
2096  */
2097 static void sort_cj_excl(nbnxn_cj_t *cj, int ncj,
2098                          NbnxnPairlistCpuWork *work)
2099 {
2100     work->cj.resize(ncj);
2101
2102     /* Make a list of the j-cells involving exclusions */
2103     int jnew = 0;
2104     for (int j = 0; j < ncj; j++)
2105     {
2106         if (cj[j].excl != NBNXN_INTERACTION_MASK_ALL)
2107         {
2108             work->cj[jnew++] = cj[j];
2109         }
2110     }
2111     /* Check if there are exclusions at all or not just the first entry */
2112     if (!((jnew == 0) ||
2113           (jnew == 1 && cj[0].excl != NBNXN_INTERACTION_MASK_ALL)))
2114     {
2115         for (int j = 0; j < ncj; j++)
2116         {
2117             if (cj[j].excl == NBNXN_INTERACTION_MASK_ALL)
2118             {
2119                 work->cj[jnew++] = cj[j];
2120             }
2121         }
2122         for (int j = 0; j < ncj; j++)
2123         {
2124             cj[j] = work->cj[j];
2125         }
2126     }
2127 }
2128
2129 /* Close this simple list i entry */
2130 static void closeIEntry(NbnxnPairlistCpu    *nbl,
2131                         int gmx_unused       sp_max_av,
2132                         gmx_bool gmx_unused  progBal,
2133                         float gmx_unused     nsp_tot_est,
2134                         int gmx_unused       thread,
2135                         int gmx_unused       nthread)
2136 {
2137     nbnxn_ci_t &ciEntry = nbl->ci.back();
2138
2139     /* All content of the new ci entry have already been filled correctly,
2140      * we only need to sort and increase counts or remove the entry when empty.
2141      */
2142     const int jlen = ciEntry.cj_ind_end - ciEntry.cj_ind_start;
2143     if (jlen > 0)
2144     {
2145         sort_cj_excl(nbl->cj.data() + ciEntry.cj_ind_start, jlen, nbl->work);
2146
2147         /* The counts below are used for non-bonded pair/flop counts
2148          * and should therefore match the available kernel setups.
2149          */
2150         if (!(ciEntry.shift & NBNXN_CI_DO_COUL(0)))
2151         {
2152             nbl->work->ncj_noq += jlen;
2153         }
2154         else if ((ciEntry.shift & NBNXN_CI_HALF_LJ(0)) ||
2155                  !(ciEntry.shift & NBNXN_CI_DO_LJ(0)))
2156         {
2157             nbl->work->ncj_hlj += jlen;
2158         }
2159     }
2160     else
2161     {
2162         /* Entry is empty: remove it  */
2163         nbl->ci.pop_back();
2164     }
2165 }
2166
2167 /* Split sci entry for load balancing on the GPU.
2168  * Splitting ensures we have enough lists to fully utilize the whole GPU.
2169  * With progBal we generate progressively smaller lists, which improves
2170  * load balancing. As we only know the current count on our own thread,
2171  * we will need to estimate the current total amount of i-entries.
2172  * As the lists get concatenated later, this estimate depends
2173  * both on nthread and our own thread index.
2174  */
2175 static void split_sci_entry(NbnxnPairlistGpu *nbl,
2176                             int nsp_target_av,
2177                             gmx_bool progBal, float nsp_tot_est,
2178                             int thread, int nthread)
2179 {
2180     int nsp_max;
2181
2182     if (progBal)
2183     {
2184         float nsp_est;
2185
2186         /* Estimate the total numbers of ci's of the nblist combined
2187          * over all threads using the target number of ci's.
2188          */
2189         nsp_est = (nsp_tot_est*thread)/nthread + nbl->nci_tot;
2190
2191         /* The first ci blocks should be larger, to avoid overhead.
2192          * The last ci blocks should be smaller, to improve load balancing.
2193          * The factor 3/2 makes the first block 3/2 times the target average
2194          * and ensures that the total number of blocks end up equal to
2195          * that of equally sized blocks of size nsp_target_av.
2196          */
2197         nsp_max = static_cast<int>(nsp_target_av*(nsp_tot_est*1.5/(nsp_est + nsp_tot_est)));
2198     }
2199     else
2200     {
2201         nsp_max = nsp_target_av;
2202     }
2203
2204     const int cj4_start = nbl->sci.back().cj4_ind_start;
2205     const int cj4_end   = nbl->sci.back().cj4_ind_end;
2206     const int j4len     = cj4_end - cj4_start;
2207
2208     if (j4len > 1 && j4len*c_gpuNumClusterPerCell*c_nbnxnGpuJgroupSize > nsp_max)
2209     {
2210         /* Modify the last ci entry and process the cj4's again */
2211
2212         int nsp        = 0;
2213         int nsp_sci    = 0;
2214         int nsp_cj4_e  = 0;
2215         int nsp_cj4    = 0;
2216         for (int cj4 = cj4_start; cj4 < cj4_end; cj4++)
2217         {
2218             int nsp_cj4_p = nsp_cj4;
2219             /* Count the number of cluster pairs in this cj4 group */
2220             nsp_cj4   = 0;
2221             for (int p = 0; p < c_gpuNumClusterPerCell*c_nbnxnGpuJgroupSize; p++)
2222             {
2223                 nsp_cj4 += (nbl->cj4[cj4].imei[0].imask >> p) & 1;
2224             }
2225
2226             /* If adding the current cj4 with nsp_cj4 pairs get us further
2227              * away from our target nsp_max, split the list before this cj4.
2228              */
2229             if (nsp > 0 && nsp_max - nsp < nsp + nsp_cj4 - nsp_max)
2230             {
2231                 /* Split the list at cj4 */
2232                 nbl->sci.back().cj4_ind_end = cj4;
2233                 /* Create a new sci entry */
2234                 nbnxn_sci_t sciNew;
2235                 sciNew.sci           = nbl->sci.back().sci;
2236                 sciNew.shift         = nbl->sci.back().shift;
2237                 sciNew.cj4_ind_start = cj4;
2238                 nbl->sci.push_back(sciNew);
2239
2240                 nsp_sci              = nsp;
2241                 nsp_cj4_e            = nsp_cj4_p;
2242                 nsp                  = 0;
2243             }
2244             nsp += nsp_cj4;
2245         }
2246
2247         /* Put the remaining cj4's in the last sci entry */
2248         nbl->sci.back().cj4_ind_end = cj4_end;
2249
2250         /* Possibly balance out the last two sci's
2251          * by moving the last cj4 of the second last sci.
2252          */
2253         if (nsp_sci - nsp_cj4_e >= nsp + nsp_cj4_e)
2254         {
2255             GMX_ASSERT(nbl->sci.size() >= 2, "We expect at least two elements");
2256             nbl->sci[nbl->sci.size() - 2].cj4_ind_end--;
2257             nbl->sci[nbl->sci.size() - 1].cj4_ind_start--;
2258         }
2259     }
2260 }
2261
2262 /* Clost this super/sub list i entry */
2263 static void closeIEntry(NbnxnPairlistGpu *nbl,
2264                         int nsp_max_av,
2265                         gmx_bool progBal, float nsp_tot_est,
2266                         int thread, int nthread)
2267 {
2268     nbnxn_sci_t &sciEntry = *getOpenIEntry(nbl);
2269
2270     /* All content of the new ci entry have already been filled correctly,
2271      * we only need to, potentially, split or remove the entry when empty.
2272      */
2273     int j4len = sciEntry.numJClusterGroups();
2274     if (j4len > 0)
2275     {
2276         /* We can only have complete blocks of 4 j-entries in a list,
2277          * so round the count up before closing.
2278          */
2279         int ncj4          = (nbl->work->cj_ind + c_nbnxnGpuJgroupSize - 1)/c_nbnxnGpuJgroupSize;
2280         nbl->work->cj_ind = ncj4*c_nbnxnGpuJgroupSize;
2281
2282         if (nsp_max_av > 0)
2283         {
2284             /* Measure the size of the new entry and potentially split it */
2285             split_sci_entry(nbl, nsp_max_av, progBal, nsp_tot_est,
2286                             thread, nthread);
2287         }
2288     }
2289     else
2290     {
2291         /* Entry is empty: remove it  */
2292         nbl->sci.pop_back();
2293     }
2294 }
2295
2296 /* Syncs the working array before adding another grid pair to the GPU list */
2297 static void sync_work(NbnxnPairlistCpu gmx_unused *nbl)
2298 {
2299 }
2300
2301 /* Syncs the working array before adding another grid pair to the GPU list */
2302 static void sync_work(NbnxnPairlistGpu *nbl)
2303 {
2304     nbl->work->cj_ind   = nbl->cj4.size()*c_nbnxnGpuJgroupSize;
2305 }
2306
2307 /* Clears an NbnxnPairlistCpu data structure */
2308 static void clear_pairlist(NbnxnPairlistCpu *nbl)
2309 {
2310     nbl->ci.clear();
2311     nbl->cj.clear();
2312     nbl->ncjInUse      = 0;
2313     nbl->nci_tot       = 0;
2314     nbl->ciOuter.clear();
2315     nbl->cjOuter.clear();
2316
2317     nbl->work->ncj_noq = 0;
2318     nbl->work->ncj_hlj = 0;
2319 }
2320
2321 /* Clears an NbnxnPairlistGpu data structure */
2322 static void clear_pairlist(NbnxnPairlistGpu *nbl)
2323 {
2324     nbl->sci.clear();
2325     nbl->cj4.clear();
2326     nbl->excl.resize(1);
2327     nbl->nci_tot = 0;
2328 }
2329
2330 /* Clears a group scheme pair list */
2331 static void clear_pairlist_fep(t_nblist *nl)
2332 {
2333     nl->nri = 0;
2334     nl->nrj = 0;
2335     if (nl->jindex == nullptr)
2336     {
2337         snew(nl->jindex, 1);
2338     }
2339     nl->jindex[0] = 0;
2340 }
2341
2342 /* Sets a simple list i-cell bounding box, including PBC shift */
2343 static inline void set_icell_bb_simple(gmx::ArrayRef<const BoundingBox> bb,
2344                                        int ci,
2345                                        real shx, real shy, real shz,
2346                                        BoundingBox *bb_ci)
2347 {
2348     bb_ci->lower.x = bb[ci].lower.x + shx;
2349     bb_ci->lower.y = bb[ci].lower.y + shy;
2350     bb_ci->lower.z = bb[ci].lower.z + shz;
2351     bb_ci->upper.x = bb[ci].upper.x + shx;
2352     bb_ci->upper.y = bb[ci].upper.y + shy;
2353     bb_ci->upper.z = bb[ci].upper.z + shz;
2354 }
2355
2356 /* Sets a simple list i-cell bounding box, including PBC shift */
2357 static inline void set_icell_bb(const Grid &iGrid,
2358                                 int ci,
2359                                 real shx, real shy, real shz,
2360                                 NbnxnPairlistCpuWork *work)
2361 {
2362     set_icell_bb_simple(iGrid.iBoundingBoxes(), ci, shx, shy, shz,
2363                         &work->iClusterData.bb[0]);
2364 }
2365
2366 #if NBNXN_BBXXXX
2367 /* Sets a super-cell and sub cell bounding boxes, including PBC shift */
2368 static void set_icell_bbxxxx_supersub(gmx::ArrayRef<const float> bb,
2369                                       int ci,
2370                                       real shx, real shy, real shz,
2371                                       float *bb_ci)
2372 {
2373     constexpr int cellBBStride = packedBoundingBoxesIndex(c_gpuNumClusterPerCell);
2374     constexpr int pbbStride    = c_packedBoundingBoxesDimSize;
2375     const int     ia           = ci*cellBBStride;
2376     for (int m = 0; m < cellBBStride; m += c_packedBoundingBoxesSize)
2377     {
2378         for (int i = 0; i < pbbStride; i++)
2379         {
2380             bb_ci[m + 0*pbbStride + i] = bb[ia + m + 0*pbbStride + i] + shx;
2381             bb_ci[m + 1*pbbStride + i] = bb[ia + m + 1*pbbStride + i] + shy;
2382             bb_ci[m + 2*pbbStride + i] = bb[ia + m + 2*pbbStride + i] + shz;
2383             bb_ci[m + 3*pbbStride + i] = bb[ia + m + 3*pbbStride + i] + shx;
2384             bb_ci[m + 4*pbbStride + i] = bb[ia + m + 4*pbbStride + i] + shy;
2385             bb_ci[m + 5*pbbStride + i] = bb[ia + m + 5*pbbStride + i] + shz;
2386         }
2387     }
2388 }
2389 #endif
2390
2391 /* Sets a super-cell and sub cell bounding boxes, including PBC shift */
2392 gmx_unused static void set_icell_bb_supersub(gmx::ArrayRef<const BoundingBox> bb,
2393                                              int ci,
2394                                              real shx, real shy, real shz,
2395                                              BoundingBox *bb_ci)
2396 {
2397     for (int i = 0; i < c_gpuNumClusterPerCell; i++)
2398     {
2399         set_icell_bb_simple(bb, ci*c_gpuNumClusterPerCell+i,
2400                             shx, shy, shz,
2401                             &bb_ci[i]);
2402     }
2403 }
2404
2405 /* Sets a super-cell and sub cell bounding boxes, including PBC shift */
2406 gmx_unused static void set_icell_bb(const Grid &iGrid,
2407                                     int ci,
2408                                     real shx, real shy, real shz,
2409                                     NbnxnPairlistGpuWork *work)
2410 {
2411 #if NBNXN_BBXXXX
2412     set_icell_bbxxxx_supersub(iGrid.packedBoundingBoxes(), ci, shx, shy, shz,
2413                               work->iSuperClusterData.bbPacked.data());
2414 #else
2415     set_icell_bb_supersub(iGrid.iBoundingBoxes(), ci, shx, shy, shz,
2416                           work->iSuperClusterData.bb.data());
2417 #endif
2418 }
2419
2420 /* Copies PBC shifted i-cell atom coordinates x,y,z to working array */
2421 static void icell_set_x_simple(int ci,
2422                                real shx, real shy, real shz,
2423                                int stride, const real *x,
2424                                NbnxnPairlistCpuWork::IClusterData *iClusterData)
2425 {
2426     const int ia = ci*c_nbnxnCpuIClusterSize;
2427
2428     for (int i = 0; i < c_nbnxnCpuIClusterSize; i++)
2429     {
2430         iClusterData->x[i*STRIDE_XYZ+XX] = x[(ia+i)*stride+XX] + shx;
2431         iClusterData->x[i*STRIDE_XYZ+YY] = x[(ia+i)*stride+YY] + shy;
2432         iClusterData->x[i*STRIDE_XYZ+ZZ] = x[(ia+i)*stride+ZZ] + shz;
2433     }
2434 }
2435
2436 static void icell_set_x(int ci,
2437                         real shx, real shy, real shz,
2438                         int stride, const real *x,
2439                         const Nbnxm::KernelType kernelType,
2440                         NbnxnPairlistCpuWork *work)
2441 {
2442     switch (kernelType)
2443     {
2444 #if GMX_SIMD
2445 #ifdef GMX_NBNXN_SIMD_4XN
2446         case Nbnxm::KernelType::Cpu4xN_Simd_4xN:
2447             icell_set_x_simd_4xn(ci, shx, shy, shz, stride, x, work);
2448             break;
2449 #endif
2450 #ifdef GMX_NBNXN_SIMD_2XNN
2451         case Nbnxm::KernelType::Cpu4xN_Simd_2xNN:
2452             icell_set_x_simd_2xnn(ci, shx, shy, shz, stride, x, work);
2453             break;
2454 #endif
2455 #endif
2456         case Nbnxm::KernelType::Cpu4x4_PlainC:
2457             icell_set_x_simple(ci, shx, shy, shz, stride, x, &work->iClusterData);
2458             break;
2459         default:
2460             GMX_ASSERT(false, "Unhandled case");
2461             break;
2462     }
2463 }
2464
2465 /* Copies PBC shifted super-cell atom coordinates x,y,z to working array */
2466 static void icell_set_x(int ci,
2467                         real shx, real shy, real shz,
2468                         int stride, const real *x,
2469                         Nbnxm::KernelType gmx_unused kernelType,
2470                         NbnxnPairlistGpuWork *work)
2471 {
2472 #if !GMX_SIMD4_HAVE_REAL
2473
2474     real * x_ci = work->iSuperClusterData.x.data();
2475
2476     int    ia = ci*c_gpuNumClusterPerCell*c_nbnxnGpuClusterSize;
2477     for (int i = 0; i < c_gpuNumClusterPerCell*c_nbnxnGpuClusterSize; i++)
2478     {
2479         x_ci[i*DIM + XX] = x[(ia+i)*stride + XX] + shx;
2480         x_ci[i*DIM + YY] = x[(ia+i)*stride + YY] + shy;
2481         x_ci[i*DIM + ZZ] = x[(ia+i)*stride + ZZ] + shz;
2482     }
2483
2484 #else /* !GMX_SIMD4_HAVE_REAL */
2485
2486     real * x_ci = work->iSuperClusterData.xSimd.data();
2487
2488     for (int si = 0; si < c_gpuNumClusterPerCell; si++)
2489     {
2490         for (int i = 0; i < c_nbnxnGpuClusterSize; i += GMX_SIMD4_WIDTH)
2491         {
2492             int io = si*c_nbnxnGpuClusterSize + i;
2493             int ia = ci*c_gpuNumClusterPerCell*c_nbnxnGpuClusterSize + io;
2494             for (int j = 0; j < GMX_SIMD4_WIDTH; j++)
2495             {
2496                 x_ci[io*DIM + j + XX*GMX_SIMD4_WIDTH] = x[(ia + j)*stride + XX] + shx;
2497                 x_ci[io*DIM + j + YY*GMX_SIMD4_WIDTH] = x[(ia + j)*stride + YY] + shy;
2498                 x_ci[io*DIM + j + ZZ*GMX_SIMD4_WIDTH] = x[(ia + j)*stride + ZZ] + shz;
2499             }
2500         }
2501     }
2502
2503 #endif /* !GMX_SIMD4_HAVE_REAL */
2504 }
2505
2506 static real minimum_subgrid_size_xy(const Grid &grid)
2507 {
2508     const Grid::Dimensions &dims = grid.dimensions();
2509
2510     if (grid.geometry().isSimple)
2511     {
2512         return std::min(dims.cellSize[XX], dims.cellSize[YY]);
2513     }
2514     else
2515     {
2516         return std::min(dims.cellSize[XX]/c_gpuNumClusterPerCellX,
2517                         dims.cellSize[YY]/c_gpuNumClusterPerCellY);
2518     }
2519 }
2520
2521 static real effective_buffer_1x1_vs_MxN(const Grid &iGrid,
2522                                         const Grid &jGrid)
2523 {
2524     const real eff_1x1_buffer_fac_overest = 0.1;
2525
2526     /* Determine an atom-pair list cut-off buffer size for atom pairs,
2527      * to be added to rlist (including buffer) used for MxN.
2528      * This is for converting an MxN list to a 1x1 list. This means we can't
2529      * use the normal buffer estimate, as we have an MxN list in which
2530      * some atom pairs beyond rlist are missing. We want to capture
2531      * the beneficial effect of buffering by extra pairs just outside rlist,
2532      * while removing the useless pairs that are further away from rlist.
2533      * (Also the buffer could have been set manually not using the estimate.)
2534      * This buffer size is an overestimate.
2535      * We add 10% of the smallest grid sub-cell dimensions.
2536      * Note that the z-size differs per cell and we don't use this,
2537      * so we overestimate.
2538      * With PME, the 10% value gives a buffer that is somewhat larger
2539      * than the effective buffer with a tolerance of 0.005 kJ/mol/ps.
2540      * Smaller tolerances or using RF lead to a smaller effective buffer,
2541      * so 10% gives a safe overestimate.
2542      */
2543     return eff_1x1_buffer_fac_overest*(minimum_subgrid_size_xy(iGrid) +
2544                                        minimum_subgrid_size_xy(jGrid));
2545 }
2546
2547 /* Estimates the interaction volume^2 for non-local interactions */
2548 static real nonlocal_vol2(const struct gmx_domdec_zones_t *zones, const rvec ls, real r)
2549 {
2550     real cl, ca, za;
2551     real vold_est;
2552     real vol2_est_tot;
2553
2554     vol2_est_tot = 0;
2555
2556     /* Here we simply add up the volumes of 1, 2 or 3 1D decomposition
2557      * not home interaction volume^2. As these volumes are not additive,
2558      * this is an overestimate, but it would only be significant in the limit
2559      * of small cells, where we anyhow need to split the lists into
2560      * as small parts as possible.
2561      */
2562
2563     for (int z = 0; z < zones->n; z++)
2564     {
2565         if (zones->shift[z][XX] + zones->shift[z][YY] + zones->shift[z][ZZ] == 1)
2566         {
2567             cl = 0;
2568             ca = 1;
2569             za = 1;
2570             for (int d = 0; d < DIM; d++)
2571             {
2572                 if (zones->shift[z][d] == 0)
2573                 {
2574                     cl += 0.5*ls[d];
2575                     ca *= ls[d];
2576                     za *= zones->size[z].x1[d] - zones->size[z].x0[d];
2577                 }
2578             }
2579
2580             /* 4 octants of a sphere */
2581             vold_est  = 0.25*M_PI*r*r*r*r;
2582             /* 4 quarter pie slices on the edges */
2583             vold_est += 4*cl*M_PI/6.0*r*r*r;
2584             /* One rectangular volume on a face */
2585             vold_est += ca*0.5*r*r;
2586
2587             vol2_est_tot += vold_est*za;
2588         }
2589     }
2590
2591     return vol2_est_tot;
2592 }
2593
2594 /* Estimates the average size of a full j-list for super/sub setup */
2595 static void get_nsubpair_target(const nbnxn_search        *nbs,
2596                                 const InteractionLocality  iloc,
2597                                 const real                 rlist,
2598                                 const int                  min_ci_balanced,
2599                                 int                       *nsubpair_target,
2600                                 float                     *nsubpair_tot_est)
2601 {
2602     /* The target value of 36 seems to be the optimum for Kepler.
2603      * Maxwell is less sensitive to the exact value.
2604      */
2605     const int           nsubpair_target_min = 36;
2606     real                r_eff_sup, vol_est, nsp_est, nsp_est_nl;
2607
2608     const Grid         &grid = nbs->gridSet().grids()[0];
2609
2610     /* We don't need to balance list sizes if:
2611      * - We didn't request balancing.
2612      * - The number of grid cells >= the number of lists requested,
2613      *   since we will always generate at least #cells lists.
2614      * - We don't have any cells, since then there won't be any lists.
2615      */
2616     if (min_ci_balanced <= 0 || grid.numCells() >= min_ci_balanced || grid.numCells() == 0)
2617     {
2618         /* nsubpair_target==0 signals no balancing */
2619         *nsubpair_target  = 0;
2620         *nsubpair_tot_est = 0;
2621
2622         return;
2623     }
2624
2625     gmx::RVec               ls;
2626     const int               numAtomsCluster = grid.geometry().numAtomsICluster;
2627     const Grid::Dimensions &dims            = grid.dimensions();
2628
2629     ls[XX] = dims.cellSize[XX]/c_gpuNumClusterPerCellX;
2630     ls[YY] = dims.cellSize[YY]/c_gpuNumClusterPerCellY;
2631     ls[ZZ] = numAtomsCluster/(dims.atomDensity*ls[XX]*ls[YY]);
2632
2633     /* The formulas below are a heuristic estimate of the average nsj per si*/
2634     r_eff_sup = rlist + nbnxn_get_rlist_effective_inc(numAtomsCluster, ls);
2635
2636     if (!nbs->DomDec || nbs->zones->n == 1)
2637     {
2638         nsp_est_nl = 0;
2639     }
2640     else
2641     {
2642         nsp_est_nl =
2643             gmx::square(dims.atomDensity/numAtomsCluster)*
2644             nonlocal_vol2(nbs->zones, ls, r_eff_sup);
2645     }
2646
2647     if (iloc == InteractionLocality::Local)
2648     {
2649         /* Sub-cell interacts with itself */
2650         vol_est  = ls[XX]*ls[YY]*ls[ZZ];
2651         /* 6/2 rectangular volume on the faces */
2652         vol_est += (ls[XX]*ls[YY] + ls[XX]*ls[ZZ] + ls[YY]*ls[ZZ])*r_eff_sup;
2653         /* 12/2 quarter pie slices on the edges */
2654         vol_est += 2*(ls[XX] + ls[YY] + ls[ZZ])*0.25*M_PI*gmx::square(r_eff_sup);
2655         /* 4 octants of a sphere */
2656         vol_est += 0.5*4.0/3.0*M_PI*gmx::power3(r_eff_sup);
2657
2658         /* Estimate the number of cluster pairs as the local number of
2659          * clusters times the volume they interact with times the density.
2660          */
2661         nsp_est = grid.numClusters()*vol_est*dims.atomDensity/numAtomsCluster;
2662
2663         /* Subtract the non-local pair count */
2664         nsp_est -= nsp_est_nl;
2665
2666         /* For small cut-offs nsp_est will be an underesimate.
2667          * With DD nsp_est_nl is an overestimate so nsp_est can get negative.
2668          * So to avoid too small or negative nsp_est we set a minimum of
2669          * all cells interacting with all 3^3 direct neighbors (3^3-1)/2+1=14.
2670          * This might be a slight overestimate for small non-periodic groups of
2671          * atoms as will occur for a local domain with DD, but for small
2672          * groups of atoms we'll anyhow be limited by nsubpair_target_min,
2673          * so this overestimation will not matter.
2674          */
2675         nsp_est = std::max(nsp_est, grid.numClusters()*14._real);
2676
2677         if (debug)
2678         {
2679             fprintf(debug, "nsp_est local %5.1f non-local %5.1f\n",
2680                     nsp_est, nsp_est_nl);
2681         }
2682     }
2683     else
2684     {
2685         nsp_est = nsp_est_nl;
2686     }
2687
2688     /* Thus the (average) maximum j-list size should be as follows.
2689      * Since there is overhead, we shouldn't make the lists too small
2690      * (and we can't chop up j-groups) so we use a minimum target size of 36.
2691      */
2692     *nsubpair_target  = std::max(nsubpair_target_min,
2693                                  roundToInt(nsp_est/min_ci_balanced));
2694     *nsubpair_tot_est = static_cast<int>(nsp_est);
2695
2696     if (debug)
2697     {
2698         fprintf(debug, "nbl nsp estimate %.1f, nsubpair_target %d\n",
2699                 nsp_est, *nsubpair_target);
2700     }
2701 }
2702
2703 /* Debug list print function */
2704 static void print_nblist_ci_cj(FILE *fp, const NbnxnPairlistCpu *nbl)
2705 {
2706     for (const nbnxn_ci_t &ciEntry : nbl->ci)
2707     {
2708         fprintf(fp, "ci %4d  shift %2d  ncj %3d\n",
2709                 ciEntry.ci, ciEntry.shift,
2710                 ciEntry.cj_ind_end - ciEntry.cj_ind_start);
2711
2712         for (int j = ciEntry.cj_ind_start; j < ciEntry.cj_ind_end; j++)
2713         {
2714             fprintf(fp, "  cj %5d  imask %x\n",
2715                     nbl->cj[j].cj,
2716                     nbl->cj[j].excl);
2717         }
2718     }
2719 }
2720
2721 /* Debug list print function */
2722 static void print_nblist_sci_cj(FILE *fp, const NbnxnPairlistGpu *nbl)
2723 {
2724     for (const nbnxn_sci_t &sci : nbl->sci)
2725     {
2726         fprintf(fp, "ci %4d  shift %2d  ncj4 %2d\n",
2727                 sci.sci, sci.shift,
2728                 sci.numJClusterGroups());
2729
2730         int ncp = 0;
2731         for (int j4 = sci.cj4_ind_start; j4 < sci.cj4_ind_end; j4++)
2732         {
2733             for (int j = 0; j < c_nbnxnGpuJgroupSize; j++)
2734             {
2735                 fprintf(fp, "  sj %5d  imask %x\n",
2736                         nbl->cj4[j4].cj[j],
2737                         nbl->cj4[j4].imei[0].imask);
2738                 for (int si = 0; si < c_gpuNumClusterPerCell; si++)
2739                 {
2740                     if (nbl->cj4[j4].imei[0].imask & (1U << (j*c_gpuNumClusterPerCell + si)))
2741                     {
2742                         ncp++;
2743                     }
2744                 }
2745             }
2746         }
2747         fprintf(fp, "ci %4d  shift %2d  ncj4 %2d ncp %3d\n",
2748                 sci.sci, sci.shift,
2749                 sci.numJClusterGroups(),
2750                 ncp);
2751     }
2752 }
2753
2754 /* Combine pair lists *nbl generated on multiple threads nblc */
2755 static void combine_nblists(int nnbl, NbnxnPairlistGpu **nbl,
2756                             NbnxnPairlistGpu *nblc)
2757 {
2758     int nsci  = nblc->sci.size();
2759     int ncj4  = nblc->cj4.size();
2760     int nexcl = nblc->excl.size();
2761     for (int i = 0; i < nnbl; i++)
2762     {
2763         nsci  += nbl[i]->sci.size();
2764         ncj4  += nbl[i]->cj4.size();
2765         nexcl += nbl[i]->excl.size();
2766     }
2767
2768     /* Resize with the final, combined size, so we can fill in parallel */
2769     /* NOTE: For better performance we should use default initialization */
2770     nblc->sci.resize(nsci);
2771     nblc->cj4.resize(ncj4);
2772     nblc->excl.resize(nexcl);
2773
2774     /* Each thread should copy its own data to the combined arrays,
2775      * as otherwise data will go back and forth between different caches.
2776      */
2777 #if GMX_OPENMP && !(defined __clang_analyzer__)
2778     int nthreads = gmx_omp_nthreads_get(emntPairsearch);
2779 #endif
2780
2781 #pragma omp parallel for num_threads(nthreads) schedule(static)
2782     for (int n = 0; n < nnbl; n++)
2783     {
2784         try
2785         {
2786             /* Determine the offset in the combined data for our thread.
2787              * Note that the original sizes in nblc are lost.
2788              */
2789             int sci_offset  = nsci;
2790             int cj4_offset  = ncj4;
2791             int excl_offset = nexcl;
2792
2793             for (int i = n; i < nnbl; i++)
2794             {
2795                 sci_offset  -= nbl[i]->sci.size();
2796                 cj4_offset  -= nbl[i]->cj4.size();
2797                 excl_offset -= nbl[i]->excl.size();
2798             }
2799
2800             const NbnxnPairlistGpu &nbli = *nbl[n];
2801
2802             for (size_t i = 0; i < nbli.sci.size(); i++)
2803             {
2804                 nblc->sci[sci_offset + i]                = nbli.sci[i];
2805                 nblc->sci[sci_offset + i].cj4_ind_start += cj4_offset;
2806                 nblc->sci[sci_offset + i].cj4_ind_end   += cj4_offset;
2807             }
2808
2809             for (size_t j4 = 0; j4 < nbli.cj4.size(); j4++)
2810             {
2811                 nblc->cj4[cj4_offset + j4]                   = nbli.cj4[j4];
2812                 nblc->cj4[cj4_offset + j4].imei[0].excl_ind += excl_offset;
2813                 nblc->cj4[cj4_offset + j4].imei[1].excl_ind += excl_offset;
2814             }
2815
2816             for (size_t j4 = 0; j4 < nbli.excl.size(); j4++)
2817             {
2818                 nblc->excl[excl_offset + j4] = nbli.excl[j4];
2819             }
2820         }
2821         GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
2822     }
2823
2824     for (int n = 0; n < nnbl; n++)
2825     {
2826         nblc->nci_tot += nbl[n]->nci_tot;
2827     }
2828 }
2829
2830 static void balance_fep_lists(const nbnxn_search   *nbs,
2831                               nbnxn_pairlist_set_t *nbl_lists)
2832 {
2833     int       nnbl;
2834     int       nri_tot, nrj_tot, nrj_target;
2835     int       th_dest;
2836     t_nblist *nbld;
2837
2838     nnbl = nbl_lists->nnbl;
2839
2840     if (nnbl == 1)
2841     {
2842         /* Nothing to balance */
2843         return;
2844     }
2845
2846     /* Count the total i-lists and pairs */
2847     nri_tot = 0;
2848     nrj_tot = 0;
2849     for (int th = 0; th < nnbl; th++)
2850     {
2851         nri_tot += nbl_lists->nbl_fep[th]->nri;
2852         nrj_tot += nbl_lists->nbl_fep[th]->nrj;
2853     }
2854
2855     nrj_target = (nrj_tot + nnbl - 1)/nnbl;
2856
2857     assert(gmx_omp_nthreads_get(emntNonbonded) == nnbl);
2858
2859 #pragma omp parallel for schedule(static) num_threads(nnbl)
2860     for (int th = 0; th < nnbl; th++)
2861     {
2862         try
2863         {
2864             t_nblist *nbl = nbs->work[th].nbl_fep.get();
2865
2866             /* Note that here we allocate for the total size, instead of
2867              * a per-thread esimate (which is hard to obtain).
2868              */
2869             if (nri_tot > nbl->maxnri)
2870             {
2871                 nbl->maxnri = over_alloc_large(nri_tot);
2872                 reallocate_nblist(nbl);
2873             }
2874             if (nri_tot > nbl->maxnri || nrj_tot > nbl->maxnrj)
2875             {
2876                 nbl->maxnrj = over_alloc_small(nrj_tot);
2877                 srenew(nbl->jjnr, nbl->maxnrj);
2878                 srenew(nbl->excl_fep, nbl->maxnrj);
2879             }
2880
2881             clear_pairlist_fep(nbl);
2882         }
2883         GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
2884     }
2885
2886     /* Loop over the source lists and assign and copy i-entries */
2887     th_dest = 0;
2888     nbld    = nbs->work[th_dest].nbl_fep.get();
2889     for (int th = 0; th < nnbl; th++)
2890     {
2891         t_nblist *nbls;
2892
2893         nbls = nbl_lists->nbl_fep[th];
2894
2895         for (int i = 0; i < nbls->nri; i++)
2896         {
2897             int nrj;
2898
2899             /* The number of pairs in this i-entry */
2900             nrj = nbls->jindex[i+1] - nbls->jindex[i];
2901
2902             /* Decide if list th_dest is too large and we should procede
2903              * to the next destination list.
2904              */
2905             if (th_dest+1 < nnbl && nbld->nrj > 0 &&
2906                 nbld->nrj + nrj - nrj_target > nrj_target - nbld->nrj)
2907             {
2908                 th_dest++;
2909                 nbld = nbs->work[th_dest].nbl_fep.get();
2910             }
2911
2912             nbld->iinr[nbld->nri]  = nbls->iinr[i];
2913             nbld->gid[nbld->nri]   = nbls->gid[i];
2914             nbld->shift[nbld->nri] = nbls->shift[i];
2915
2916             for (int j = nbls->jindex[i]; j < nbls->jindex[i+1]; j++)
2917             {
2918                 nbld->jjnr[nbld->nrj]     = nbls->jjnr[j];
2919                 nbld->excl_fep[nbld->nrj] = nbls->excl_fep[j];
2920                 nbld->nrj++;
2921             }
2922             nbld->nri++;
2923             nbld->jindex[nbld->nri] = nbld->nrj;
2924         }
2925     }
2926
2927     /* Swap the list pointers */
2928     for (int th = 0; th < nnbl; th++)
2929     {
2930         t_nblist *nbl_tmp      = nbs->work[th].nbl_fep.release();
2931         nbs->work[th].nbl_fep.reset(nbl_lists->nbl_fep[th]);
2932         nbl_lists->nbl_fep[th] = nbl_tmp;
2933
2934         if (debug)
2935         {
2936             fprintf(debug, "nbl_fep[%d] nri %4d nrj %4d\n",
2937                     th,
2938                     nbl_lists->nbl_fep[th]->nri,
2939                     nbl_lists->nbl_fep[th]->nrj);
2940         }
2941     }
2942 }
2943
2944 /* Returns the next ci to be processes by our thread */
2945 static gmx_bool next_ci(const Grid &grid,
2946                         int nth, int ci_block,
2947                         int *ci_x, int *ci_y,
2948                         int *ci_b, int *ci)
2949 {
2950     (*ci_b)++;
2951     (*ci)++;
2952
2953     if (*ci_b == ci_block)
2954     {
2955         /* Jump to the next block assigned to this task */
2956         *ci   += (nth - 1)*ci_block;
2957         *ci_b  = 0;
2958     }
2959
2960     if (*ci >= grid.numCells())
2961     {
2962         return FALSE;
2963     }
2964
2965     while (*ci >= grid.firstCellInColumn(*ci_x*grid.dimensions().numCells[YY] + *ci_y + 1))
2966     {
2967         *ci_y += 1;
2968         if (*ci_y == grid.dimensions().numCells[YY])
2969         {
2970             *ci_x += 1;
2971             *ci_y  = 0;
2972         }
2973     }
2974
2975     return TRUE;
2976 }
2977
2978 /* Returns the distance^2 for which we put cell pairs in the list
2979  * without checking atom pair distances. This is usually < rlist^2.
2980  */
2981 static float boundingbox_only_distance2(const Grid::Dimensions &iGridDims,
2982                                         const Grid::Dimensions &jGridDims,
2983                                         real                    rlist,
2984                                         gmx_bool                simple)
2985 {
2986     /* If the distance between two sub-cell bounding boxes is less
2987      * than this distance, do not check the distance between
2988      * all particle pairs in the sub-cell, since then it is likely
2989      * that the box pair has atom pairs within the cut-off.
2990      * We use the nblist cut-off minus 0.5 times the average x/y diagonal
2991      * spacing of the sub-cells. Around 40% of the checked pairs are pruned.
2992      * Using more than 0.5 gains at most 0.5%.
2993      * If forces are calculated more than twice, the performance gain
2994      * in the force calculation outweighs the cost of checking.
2995      * Note that with subcell lists, the atom-pair distance check
2996      * is only performed when only 1 out of 8 sub-cells in within range,
2997      * this is because the GPU is much faster than the cpu.
2998      */
2999     real bbx, bby;
3000     real rbb2;
3001
3002     bbx = 0.5*(iGridDims.cellSize[XX] + jGridDims.cellSize[XX]);
3003     bby = 0.5*(iGridDims.cellSize[YY] + jGridDims.cellSize[YY]);
3004     if (!simple)
3005     {
3006         bbx /= c_gpuNumClusterPerCellX;
3007         bby /= c_gpuNumClusterPerCellY;
3008     }
3009
3010     rbb2 = std::max(0.0, rlist - 0.5*std::sqrt(bbx*bbx + bby*bby));
3011     rbb2 = rbb2 * rbb2;
3012
3013 #if !GMX_DOUBLE
3014     return rbb2;
3015 #else
3016     return (float)((1+GMX_FLOAT_EPS)*rbb2);
3017 #endif
3018 }
3019
3020 static int get_ci_block_size(const Grid &iGrid,
3021                              gmx_bool bDomDec, int nth)
3022 {
3023     const int ci_block_enum      = 5;
3024     const int ci_block_denom     = 11;
3025     const int ci_block_min_atoms = 16;
3026     int       ci_block;
3027
3028     /* Here we decide how to distribute the blocks over the threads.
3029      * We use prime numbers to try to avoid that the grid size becomes
3030      * a multiple of the number of threads, which would lead to some
3031      * threads getting "inner" pairs and others getting boundary pairs,
3032      * which in turns will lead to load imbalance between threads.
3033      * Set the block size as 5/11/ntask times the average number of cells
3034      * in a y,z slab. This should ensure a quite uniform distribution
3035      * of the grid parts of the different thread along all three grid
3036      * zone boundaries with 3D domain decomposition. At the same time
3037      * the blocks will not become too small.
3038      */
3039     ci_block = (iGrid.numCells()*ci_block_enum)/(ci_block_denom*iGrid.dimensions().numCells[XX]*nth);
3040
3041     const int numAtomsPerCell = iGrid.geometry().numAtomsPerCell;
3042
3043     /* Ensure the blocks are not too small: avoids cache invalidation */
3044     if (ci_block*numAtomsPerCell < ci_block_min_atoms)
3045     {
3046         ci_block = (ci_block_min_atoms + numAtomsPerCell - 1)/numAtomsPerCell;
3047     }
3048
3049     /* Without domain decomposition
3050      * or with less than 3 blocks per task, divide in nth blocks.
3051      */
3052     if (!bDomDec || nth*3*ci_block > iGrid.numCells())
3053     {
3054         ci_block = (iGrid.numCells() + nth - 1)/nth;
3055     }
3056
3057     if (ci_block > 1 && (nth - 1)*ci_block >= iGrid.numCells())
3058     {
3059         /* Some threads have no work. Although reducing the block size
3060          * does not decrease the block count on the first few threads,
3061          * with GPUs better mixing of "upper" cells that have more empty
3062          * clusters results in a somewhat lower max load over all threads.
3063          * Without GPUs the regime of so few atoms per thread is less
3064          * performance relevant, but with 8-wide SIMD the same reasoning
3065          * applies, since the pair list uses 4 i-atom "sub-clusters".
3066          */
3067         ci_block--;
3068     }
3069
3070     return ci_block;
3071 }
3072
3073 /* Returns the number of bits to right-shift a cluster index to obtain
3074  * the corresponding force buffer flag index.
3075  */
3076 static int getBufferFlagShift(int numAtomsPerCluster)
3077 {
3078     int bufferFlagShift = 0;
3079     while ((numAtomsPerCluster << bufferFlagShift) < NBNXN_BUFFERFLAG_SIZE)
3080     {
3081         bufferFlagShift++;
3082     }
3083
3084     return bufferFlagShift;
3085 }
3086
3087 static bool pairlistIsSimple(const NbnxnPairlistCpu gmx_unused &pairlist)
3088 {
3089     return true;
3090 }
3091
3092 static bool pairlistIsSimple(const NbnxnPairlistGpu gmx_unused &pairlist)
3093 {
3094     return false;
3095 }
3096
3097 static void makeClusterListWrapper(NbnxnPairlistCpu       *nbl,
3098                                    const Grid gmx_unused  &iGrid,
3099                                    const int               ci,
3100                                    const Grid             &jGrid,
3101                                    const int               firstCell,
3102                                    const int               lastCell,
3103                                    const bool              excludeSubDiagonal,
3104                                    const nbnxn_atomdata_t *nbat,
3105                                    const real              rlist2,
3106                                    const real              rbb2,
3107                                    const Nbnxm::KernelType kernelType,
3108                                    int                    *numDistanceChecks)
3109 {
3110     switch (kernelType)
3111     {
3112         case Nbnxm::KernelType::Cpu4x4_PlainC:
3113             makeClusterListSimple(jGrid,
3114                                   nbl, ci, firstCell, lastCell,
3115                                   excludeSubDiagonal,
3116                                   nbat->x().data(),
3117                                   rlist2, rbb2,
3118                                   numDistanceChecks);
3119             break;
3120 #ifdef GMX_NBNXN_SIMD_4XN
3121         case Nbnxm::KernelType::Cpu4xN_Simd_4xN:
3122             makeClusterListSimd4xn(jGrid,
3123                                    nbl, ci, firstCell, lastCell,
3124                                    excludeSubDiagonal,
3125                                    nbat->x().data(),
3126                                    rlist2, rbb2,
3127                                    numDistanceChecks);
3128             break;
3129 #endif
3130 #ifdef GMX_NBNXN_SIMD_2XNN
3131         case Nbnxm::KernelType::Cpu4xN_Simd_2xNN:
3132             makeClusterListSimd2xnn(jGrid,
3133                                     nbl, ci, firstCell, lastCell,
3134                                     excludeSubDiagonal,
3135                                     nbat->x().data(),
3136                                     rlist2, rbb2,
3137                                     numDistanceChecks);
3138             break;
3139 #endif
3140         default:
3141             GMX_ASSERT(false, "Unhandled kernel type");
3142     }
3143 }
3144
3145 static void makeClusterListWrapper(NbnxnPairlistGpu             *nbl,
3146                                    const Grid &gmx_unused        iGrid,
3147                                    const int                     ci,
3148                                    const Grid                   &jGrid,
3149                                    const int                     firstCell,
3150                                    const int                     lastCell,
3151                                    const bool                    excludeSubDiagonal,
3152                                    const nbnxn_atomdata_t       *nbat,
3153                                    const real                    rlist2,
3154                                    const real                    rbb2,
3155                                    Nbnxm::KernelType gmx_unused  kernelType,
3156                                    int                          *numDistanceChecks)
3157 {
3158     for (int cj = firstCell; cj <= lastCell; cj++)
3159     {
3160         make_cluster_list_supersub(iGrid, jGrid,
3161                                    nbl, ci, cj,
3162                                    excludeSubDiagonal,
3163                                    nbat->xstride, nbat->x().data(),
3164                                    rlist2, rbb2,
3165                                    numDistanceChecks);
3166     }
3167 }
3168
3169 static int getNumSimpleJClustersInList(const NbnxnPairlistCpu &nbl)
3170 {
3171     return nbl.cj.size();
3172 }
3173
3174 static int getNumSimpleJClustersInList(const gmx_unused NbnxnPairlistGpu &nbl)
3175 {
3176     return 0;
3177 }
3178
3179 static void incrementNumSimpleJClustersInList(NbnxnPairlistCpu *nbl,
3180                                               int               ncj_old_j)
3181 {
3182     nbl->ncjInUse += nbl->cj.size() - ncj_old_j;
3183 }
3184
3185 static void incrementNumSimpleJClustersInList(NbnxnPairlistGpu gmx_unused *nbl,
3186                                               int              gmx_unused  ncj_old_j)
3187 {
3188 }
3189
3190 static void checkListSizeConsistency(const NbnxnPairlistCpu &nbl,
3191                                      const bool              haveFreeEnergy)
3192 {
3193     GMX_RELEASE_ASSERT(static_cast<size_t>(nbl.ncjInUse) == nbl.cj.size() || haveFreeEnergy,
3194                        "Without free-energy all cj pair-list entries should be in use. "
3195                        "Note that subsequent code does not make use of the equality, "
3196                        "this check is only here to catch bugs");
3197 }
3198
3199 static void checkListSizeConsistency(const NbnxnPairlistGpu gmx_unused &nbl,
3200                                      bool gmx_unused                    haveFreeEnergy)
3201 {
3202     /* We currently can not check consistency here */
3203 }
3204
3205 /* Set the buffer flags for newly added entries in the list */
3206 static void setBufferFlags(const NbnxnPairlistCpu &nbl,
3207                            const int               ncj_old_j,
3208                            const int               gridj_flag_shift,
3209                            gmx_bitmask_t          *gridj_flag,
3210                            const int               th)
3211 {
3212     if (gmx::ssize(nbl.cj) > ncj_old_j)
3213     {
3214         int cbFirst = nbl.cj[ncj_old_j].cj >> gridj_flag_shift;
3215         int cbLast  = nbl.cj.back().cj >> gridj_flag_shift;
3216         for (int cb = cbFirst; cb <= cbLast; cb++)
3217         {
3218             bitmask_init_bit(&gridj_flag[cb], th);
3219         }
3220     }
3221 }
3222
3223 static void setBufferFlags(const NbnxnPairlistGpu gmx_unused &nbl,
3224                            int gmx_unused                     ncj_old_j,
3225                            int gmx_unused                     gridj_flag_shift,
3226                            gmx_bitmask_t gmx_unused          *gridj_flag,
3227                            int gmx_unused                     th)
3228 {
3229     GMX_ASSERT(false, "This function should never be called");
3230 }
3231
3232 /* Generates the part of pair-list nbl assigned to our thread */
3233 template <typename T>
3234 static void nbnxn_make_pairlist_part(const nbnxn_search *nbs,
3235                                      const Grid &iGrid,
3236                                      const Grid &jGrid,
3237                                      nbnxn_search_work_t *work,
3238                                      const nbnxn_atomdata_t *nbat,
3239                                      const t_blocka &exclusions,
3240                                      real rlist,
3241                                      const Nbnxm::KernelType kernelType,
3242                                      int ci_block,
3243                                      gmx_bool bFBufferFlag,
3244                                      int nsubpair_max,
3245                                      gmx_bool progBal,
3246                                      float nsubpair_tot_est,
3247                                      int th, int nth,
3248                                      T *nbl,
3249                                      t_nblist *nbl_fep)
3250 {
3251     int               na_cj_2log;
3252     matrix            box;
3253     real              rl_fep2 = 0;
3254     float             rbb2;
3255     int               ci_b, ci, ci_x, ci_y, ci_xy;
3256     ivec              shp;
3257     real              bx0, bx1, by0, by1, bz0, bz1;
3258     real              bz1_frac;
3259     real              d2cx, d2z, d2z_cx, d2z_cy, d2zx, d2zxy, d2xy;
3260     int               cxf, cxl, cyf, cyf_x, cyl;
3261     int               numDistanceChecks;
3262     int               gridi_flag_shift = 0, gridj_flag_shift = 0;
3263     gmx_bitmask_t    *gridj_flag       = nullptr;
3264     int               ncj_old_i, ncj_old_j;
3265
3266     nbs_cycle_start(&work->cc[enbsCCsearch]);
3267
3268     if (jGrid.geometry().isSimple != pairlistIsSimple(*nbl) ||
3269         iGrid.geometry().isSimple != pairlistIsSimple(*nbl))
3270     {
3271         gmx_incons("Grid incompatible with pair-list");
3272     }
3273
3274     sync_work(nbl);
3275     GMX_ASSERT(nbl->na_ci == jGrid.geometry().numAtomsICluster,
3276                "The cluster sizes in the list and grid should match");
3277     nbl->na_cj = Nbnxm::JClusterSizePerKernelType[kernelType];
3278     na_cj_2log = get_2log(nbl->na_cj);
3279
3280     nbl->rlist  = rlist;
3281
3282     if (bFBufferFlag)
3283     {
3284         /* Determine conversion of clusters to flag blocks */
3285         gridi_flag_shift = getBufferFlagShift(nbl->na_ci);
3286         gridj_flag_shift = getBufferFlagShift(nbl->na_cj);
3287
3288         gridj_flag       = work->buffer_flags.flag;
3289     }
3290
3291     const Nbnxm::GridSet &gridSet = nbs->gridSet();
3292
3293     gridSet.getBox(box);
3294
3295     const bool            haveFep = gridSet.haveFep();
3296
3297     const real            rlist2  = nbl->rlist*nbl->rlist;
3298
3299     if (haveFep && !pairlistIsSimple(*nbl))
3300     {
3301         /* Determine an atom-pair list cut-off distance for FEP atom pairs.
3302          * We should not simply use rlist, since then we would not have
3303          * the small, effective buffering of the NxN lists.
3304          * The buffer is on overestimate, but the resulting cost for pairs
3305          * beyond rlist is neglible compared to the FEP pairs within rlist.
3306          */
3307         rl_fep2 = nbl->rlist + effective_buffer_1x1_vs_MxN(iGrid, jGrid);
3308
3309         if (debug)
3310         {
3311             fprintf(debug, "nbl_fep atom-pair rlist %f\n", rl_fep2);
3312         }
3313         rl_fep2 = rl_fep2*rl_fep2;
3314     }
3315
3316     const Grid::Dimensions &iGridDims = iGrid.dimensions();
3317     const Grid::Dimensions &jGridDims = jGrid.dimensions();
3318
3319     rbb2 = boundingbox_only_distance2(iGridDims, jGridDims, nbl->rlist, pairlistIsSimple(*nbl));
3320
3321     if (debug)
3322     {
3323         fprintf(debug, "nbl bounding box only distance %f\n", std::sqrt(rbb2));
3324     }
3325
3326     const bool isIntraGridList = (&iGrid == &jGrid);
3327
3328     /* Set the shift range */
3329     for (int d = 0; d < DIM; d++)
3330     {
3331         /* Check if we need periodicity shifts.
3332          * Without PBC or with domain decomposition we don't need them.
3333          */
3334         if (d >= ePBC2npbcdim(nbs->ePBC) || nbs->dd_dim[d])
3335         {
3336             shp[d] = 0;
3337         }
3338         else
3339         {
3340             const real listRangeCellToCell =
3341                 listRangeForGridCellToGridCell(rlist, iGrid.dimensions(), jGrid.dimensions());
3342             if (d == XX &&
3343                 box[XX][XX] - fabs(box[YY][XX]) - fabs(box[ZZ][XX]) < listRangeCellToCell)
3344             {
3345                 shp[d] = 2;
3346             }
3347             else
3348             {
3349                 shp[d] = 1;
3350             }
3351         }
3352     }
3353     const bool bSimple = pairlistIsSimple(*nbl);
3354     gmx::ArrayRef<const BoundingBox> bb_i;
3355 #if NBNXN_BBXXXX
3356     gmx::ArrayRef<const float>       pbb_i;
3357     if (bSimple)
3358     {
3359         bb_i  = iGrid.iBoundingBoxes();
3360     }
3361     else
3362     {
3363         pbb_i = iGrid.packedBoundingBoxes();
3364     }
3365 #else
3366     /* We use the normal bounding box format for both grid types */
3367     bb_i  = iGrid.iBoundingBoxes();
3368 #endif
3369     gmx::ArrayRef<const BoundingBox1D> bbcz_i  = iGrid.zBoundingBoxes();
3370     gmx::ArrayRef<const int>           flags_i = iGrid.clusterFlags();
3371     gmx::ArrayRef<const BoundingBox1D> bbcz_j  = jGrid.zBoundingBoxes();
3372     int                                cell0_i = iGrid.cellOffset();
3373
3374     if (debug)
3375     {
3376         fprintf(debug, "nbl nc_i %d col.av. %.1f ci_block %d\n",
3377                 iGrid.numCells(), iGrid.numCells()/static_cast<double>(iGrid.numColumns()), ci_block);
3378     }
3379
3380     numDistanceChecks = 0;
3381
3382     const real listRangeBBToJCell2 = gmx::square(listRangeForBoundingBoxToGridCell(rlist, jGrid.dimensions()));
3383
3384     /* Initially ci_b and ci to 1 before where we want them to start,
3385      * as they will both be incremented in next_ci.
3386      */
3387     ci_b = -1;
3388     ci   = th*ci_block - 1;
3389     ci_x = 0;
3390     ci_y = 0;
3391     while (next_ci(iGrid, nth, ci_block, &ci_x, &ci_y, &ci_b, &ci))
3392     {
3393         if (bSimple && flags_i[ci] == 0)
3394         {
3395             continue;
3396         }
3397
3398         ncj_old_i = getNumSimpleJClustersInList(*nbl);
3399
3400         d2cx = 0;
3401         if (!isIntraGridList && shp[XX] == 0)
3402         {
3403             if (bSimple)
3404             {
3405                 bx1 = bb_i[ci].upper.x;
3406             }
3407             else
3408             {
3409                 bx1 = iGridDims.lowerCorner[XX] + (ci_x+1)*iGridDims.cellSize[XX];
3410             }
3411             if (bx1 < jGridDims.lowerCorner[XX])
3412             {
3413                 d2cx = gmx::square(jGridDims.lowerCorner[XX] - bx1);
3414
3415                 if (d2cx >= listRangeBBToJCell2)
3416                 {
3417                     continue;
3418                 }
3419             }
3420         }
3421
3422         ci_xy = ci_x*iGridDims.numCells[YY] + ci_y;
3423
3424         /* Loop over shift vectors in three dimensions */
3425         for (int tz = -shp[ZZ]; tz <= shp[ZZ]; tz++)
3426         {
3427             const real shz = tz*box[ZZ][ZZ];
3428
3429             bz0 = bbcz_i[ci].lower + shz;
3430             bz1 = bbcz_i[ci].upper + shz;
3431
3432             if (tz == 0)
3433             {
3434                 d2z = 0;
3435             }
3436             else if (tz < 0)
3437             {
3438                 d2z = gmx::square(bz1);
3439             }
3440             else
3441             {
3442                 d2z = gmx::square(bz0 - box[ZZ][ZZ]);
3443             }
3444
3445             d2z_cx = d2z + d2cx;
3446
3447             if (d2z_cx >= rlist2)
3448             {
3449                 continue;
3450             }
3451
3452             bz1_frac = bz1/iGrid.numCellsInColumn(ci_xy);
3453             if (bz1_frac < 0)
3454             {
3455                 bz1_frac = 0;
3456             }
3457             /* The check with bz1_frac close to or larger than 1 comes later */
3458
3459             for (int ty = -shp[YY]; ty <= shp[YY]; ty++)
3460             {
3461                 const real shy = ty*box[YY][YY] + tz*box[ZZ][YY];
3462
3463                 if (bSimple)
3464                 {
3465                     by0 = bb_i[ci].lower.y + shy;
3466                     by1 = bb_i[ci].upper.y + shy;
3467                 }
3468                 else
3469                 {
3470                     by0 = iGridDims.lowerCorner[YY] + (ci_y    )*iGridDims.cellSize[YY] + shy;
3471                     by1 = iGridDims.lowerCorner[YY] + (ci_y + 1)*iGridDims.cellSize[YY] + shy;
3472                 }
3473
3474                 get_cell_range<YY>(by0, by1,
3475                                    jGridDims,
3476                                    d2z_cx, rlist,
3477                                    &cyf, &cyl);
3478
3479                 if (cyf > cyl)
3480                 {
3481                     continue;
3482                 }
3483
3484                 d2z_cy = d2z;
3485                 if (by1 < jGridDims.lowerCorner[YY])
3486                 {
3487                     d2z_cy += gmx::square(jGridDims.lowerCorner[YY] - by1);
3488                 }
3489                 else if (by0 > jGridDims.upperCorner[YY])
3490                 {
3491                     d2z_cy += gmx::square(by0 - jGridDims.upperCorner[YY]);
3492                 }
3493
3494                 for (int tx = -shp[XX]; tx <= shp[XX]; tx++)
3495                 {
3496                     const int  shift              = XYZ2IS(tx, ty, tz);
3497
3498                     const bool excludeSubDiagonal = (isIntraGridList && shift == CENTRAL);
3499
3500                     if (c_pbcShiftBackward && isIntraGridList && shift > CENTRAL)
3501                     {
3502                         continue;
3503                     }
3504
3505                     const real shx = tx*box[XX][XX] + ty*box[YY][XX] + tz*box[ZZ][XX];
3506
3507                     if (bSimple)
3508                     {
3509                         bx0 = bb_i[ci].lower.x + shx;
3510                         bx1 = bb_i[ci].upper.x + shx;
3511                     }
3512                     else
3513                     {
3514                         bx0 = iGridDims.lowerCorner[XX] + (ci_x  )*iGridDims.cellSize[XX] + shx;
3515                         bx1 = iGridDims.lowerCorner[XX] + (ci_x+1)*iGridDims.cellSize[XX] + shx;
3516                     }
3517
3518                     get_cell_range<XX>(bx0, bx1,
3519                                        jGridDims,
3520                                        d2z_cy, rlist,
3521                                        &cxf, &cxl);
3522
3523                     if (cxf > cxl)
3524                     {
3525                         continue;
3526                     }
3527
3528                     addNewIEntry(nbl, cell0_i+ci, shift, flags_i[ci]);
3529
3530                     if ((!c_pbcShiftBackward || excludeSubDiagonal) &&
3531                         cxf < ci_x)
3532                     {
3533                         /* Leave the pairs with i > j.
3534                          * x is the major index, so skip half of it.
3535                          */
3536                         cxf = ci_x;
3537                     }
3538
3539                     set_icell_bb(iGrid, ci, shx, shy, shz,
3540                                  nbl->work);
3541
3542                     icell_set_x(cell0_i+ci, shx, shy, shz,
3543                                 nbat->xstride, nbat->x().data(),
3544                                 kernelType,
3545                                 nbl->work);
3546
3547                     for (int cx = cxf; cx <= cxl; cx++)
3548                     {
3549                         d2zx = d2z;
3550                         if (jGridDims.lowerCorner[XX] + cx*jGridDims.cellSize[XX] > bx1)
3551                         {
3552                             d2zx += gmx::square(jGridDims.lowerCorner[XX] + cx*jGridDims.cellSize[XX] - bx1);
3553                         }
3554                         else if (jGridDims.lowerCorner[XX] + (cx+1)*jGridDims.cellSize[XX] < bx0)
3555                         {
3556                             d2zx += gmx::square(jGridDims.lowerCorner[XX] + (cx+1)*jGridDims.cellSize[XX] - bx0);
3557                         }
3558
3559                         if (isIntraGridList &&
3560                             cx == 0 &&
3561                             (!c_pbcShiftBackward || shift == CENTRAL) &&
3562                             cyf < ci_y)
3563                         {
3564                             /* Leave the pairs with i > j.
3565                              * Skip half of y when i and j have the same x.
3566                              */
3567                             cyf_x = ci_y;
3568                         }
3569                         else
3570                         {
3571                             cyf_x = cyf;
3572                         }
3573
3574                         for (int cy = cyf_x; cy <= cyl; cy++)
3575                         {
3576                             const int columnStart = jGrid.firstCellInColumn(cx*jGridDims.numCells[YY] + cy);
3577                             const int columnEnd   = jGrid.firstCellInColumn(cx*jGridDims.numCells[YY] + cy + 1);
3578
3579                             d2zxy = d2zx;
3580                             if (jGridDims.lowerCorner[YY] + cy*jGridDims.cellSize[YY] > by1)
3581                             {
3582                                 d2zxy += gmx::square(jGridDims.lowerCorner[YY] + cy*jGridDims.cellSize[YY] - by1);
3583                             }
3584                             else if (jGridDims.lowerCorner[YY] + (cy + 1)*jGridDims.cellSize[YY] < by0)
3585                             {
3586                                 d2zxy += gmx::square(jGridDims.lowerCorner[YY] + (cy + 1)*jGridDims.cellSize[YY] - by0);
3587                             }
3588                             if (columnStart < columnEnd && d2zxy < listRangeBBToJCell2)
3589                             {
3590                                 /* To improve efficiency in the common case
3591                                  * of a homogeneous particle distribution,
3592                                  * we estimate the index of the middle cell
3593                                  * in range (midCell). We search down and up
3594                                  * starting from this index.
3595                                  *
3596                                  * Note that the bbcz_j array contains bounds
3597                                  * for i-clusters, thus for clusters of 4 atoms.
3598                                  * For the common case where the j-cluster size
3599                                  * is 8, we could step with a stride of 2,
3600                                  * but we do not do this because it would
3601                                  * complicate this code even more.
3602                                  */
3603                                 int midCell = columnStart + static_cast<int>(bz1_frac*(columnEnd - columnStart));
3604                                 if (midCell >= columnEnd)
3605                                 {
3606                                     midCell = columnEnd - 1;
3607                                 }
3608
3609                                 d2xy = d2zxy - d2z;
3610
3611                                 /* Find the lowest cell that can possibly
3612                                  * be within range.
3613                                  * Check if we hit the bottom of the grid,
3614                                  * if the j-cell is below the i-cell and if so,
3615                                  * if it is within range.
3616                                  */
3617                                 int downTestCell = midCell;
3618                                 while (downTestCell >= columnStart &&
3619                                        (bbcz_j[downTestCell].upper >= bz0 ||
3620                                         d2xy + gmx::square(bbcz_j[downTestCell].upper - bz0) < rlist2))
3621                                 {
3622                                     downTestCell--;
3623                                 }
3624                                 int firstCell = downTestCell + 1;
3625
3626                                 /* Find the highest cell that can possibly
3627                                  * be within range.
3628                                  * Check if we hit the top of the grid,
3629                                  * if the j-cell is above the i-cell and if so,
3630                                  * if it is within range.
3631                                  */
3632                                 int upTestCell = midCell + 1;
3633                                 while (upTestCell < columnEnd &&
3634                                        (bbcz_j[upTestCell].lower <= bz1 ||
3635                                         d2xy + gmx::square(bbcz_j[upTestCell].lower - bz1) < rlist2))
3636                                 {
3637                                     upTestCell++;
3638                                 }
3639                                 int lastCell = upTestCell - 1;
3640
3641 #define NBNXN_REFCODE 0
3642 #if NBNXN_REFCODE
3643                                 {
3644                                     /* Simple reference code, for debugging,
3645                                      * overrides the more complex code above.
3646                                      */
3647                                     firstCell = columnEnd;
3648                                     lastCell  = -1;
3649                                     for (int k = columnStart; k < columnEnd; k++)
3650                                     {
3651                                         if (d2xy + gmx::square(bbcz_j[k*NNBSBB_D + 1] - bz0) < rlist2 &&
3652                                             k < firstCell)
3653                                         {
3654                                             firstCell = k;
3655                                         }
3656                                         if (d2xy + gmx::square(bbcz_j[k*NNBSBB_D] - bz1) < rlist2 &&
3657                                             k > lastCell)
3658                                         {
3659                                             lastCell = k;
3660                                         }
3661                                     }
3662                                 }
3663 #endif
3664
3665                                 if (isIntraGridList)
3666                                 {
3667                                     /* We want each atom/cell pair only once,
3668                                      * only use cj >= ci.
3669                                      */
3670                                     if (!c_pbcShiftBackward || shift == CENTRAL)
3671                                     {
3672                                         firstCell = std::max(firstCell, ci);
3673                                     }
3674                                 }
3675
3676                                 if (firstCell <= lastCell)
3677                                 {
3678                                     GMX_ASSERT(firstCell >= columnStart && lastCell < columnEnd, "The range should reside within the current grid column");
3679
3680                                     /* For f buffer flags with simple lists */
3681                                     ncj_old_j = getNumSimpleJClustersInList(*nbl);
3682
3683                                     makeClusterListWrapper(nbl,
3684                                                            iGrid, ci,
3685                                                            jGrid, firstCell, lastCell,
3686                                                            excludeSubDiagonal,
3687                                                            nbat,
3688                                                            rlist2, rbb2,
3689                                                            kernelType,
3690                                                            &numDistanceChecks);
3691
3692                                     if (bFBufferFlag)
3693                                     {
3694                                         setBufferFlags(*nbl, ncj_old_j, gridj_flag_shift,
3695                                                        gridj_flag, th);
3696                                     }
3697
3698                                     incrementNumSimpleJClustersInList(nbl, ncj_old_j);
3699                                 }
3700                             }
3701                         }
3702                     }
3703
3704                     /* Set the exclusions for this ci list */
3705                     setExclusionsForIEntry(gridSet,
3706                                            nbl,
3707                                            excludeSubDiagonal,
3708                                            na_cj_2log,
3709                                            *getOpenIEntry(nbl),
3710                                            exclusions);
3711
3712                     if (haveFep)
3713                     {
3714                         make_fep_list(gridSet.atomIndices(), nbat, nbl,
3715                                       excludeSubDiagonal,
3716                                       getOpenIEntry(nbl),
3717                                       shx, shy, shz,
3718                                       rl_fep2,
3719                                       iGrid, jGrid, nbl_fep);
3720                     }
3721
3722                     /* Close this ci list */
3723                     closeIEntry(nbl,
3724                                 nsubpair_max,
3725                                 progBal, nsubpair_tot_est,
3726                                 th, nth);
3727                 }
3728             }
3729         }
3730
3731         if (bFBufferFlag && getNumSimpleJClustersInList(*nbl) > ncj_old_i)
3732         {
3733             bitmask_init_bit(&(work->buffer_flags.flag[(iGrid.cellOffset() + ci) >> gridi_flag_shift]), th);
3734         }
3735     }
3736
3737     work->ndistc = numDistanceChecks;
3738
3739     nbs_cycle_stop(&work->cc[enbsCCsearch]);
3740
3741     checkListSizeConsistency(*nbl, haveFep);
3742
3743     if (debug)
3744     {
3745         fprintf(debug, "number of distance checks %d\n", numDistanceChecks);
3746
3747         print_nblist_statistics(debug, nbl, nbs, rlist);
3748
3749         if (haveFep)
3750         {
3751             fprintf(debug, "nbl FEP list pairs: %d\n", nbl_fep->nrj);
3752         }
3753     }
3754 }
3755
3756 static void reduce_buffer_flags(const nbnxn_search         *nbs,
3757                                 int                         nsrc,
3758                                 const nbnxn_buffer_flags_t *dest)
3759 {
3760     for (int s = 0; s < nsrc; s++)
3761     {
3762         gmx_bitmask_t * flag = nbs->work[s].buffer_flags.flag;
3763
3764         for (int b = 0; b < dest->nflag; b++)
3765         {
3766             bitmask_union(&(dest->flag[b]), flag[b]);
3767         }
3768     }
3769 }
3770
3771 static void print_reduction_cost(const nbnxn_buffer_flags_t *flags, int nout)
3772 {
3773     int           nelem, nkeep, ncopy, nred, out;
3774     gmx_bitmask_t mask_0;
3775
3776     nelem = 0;
3777     nkeep = 0;
3778     ncopy = 0;
3779     nred  = 0;
3780     bitmask_init_bit(&mask_0, 0);
3781     for (int b = 0; b < flags->nflag; b++)
3782     {
3783         if (bitmask_is_equal(flags->flag[b], mask_0))
3784         {
3785             /* Only flag 0 is set, no copy of reduction required */
3786             nelem++;
3787             nkeep++;
3788         }
3789         else if (!bitmask_is_zero(flags->flag[b]))
3790         {
3791             int c = 0;
3792             for (out = 0; out < nout; out++)
3793             {
3794                 if (bitmask_is_set(flags->flag[b], out))
3795                 {
3796                     c++;
3797                 }
3798             }
3799             nelem += c;
3800             if (c == 1)
3801             {
3802                 ncopy++;
3803             }
3804             else
3805             {
3806                 nred += c;
3807             }
3808         }
3809     }
3810
3811     fprintf(debug, "nbnxn reduction: #flag %d #list %d elem %4.2f, keep %4.2f copy %4.2f red %4.2f\n",
3812             flags->nflag, nout,
3813             nelem/static_cast<double>(flags->nflag),
3814             nkeep/static_cast<double>(flags->nflag),
3815             ncopy/static_cast<double>(flags->nflag),
3816             nred/static_cast<double>(flags->nflag));
3817 }
3818
3819 /* Copies the list entries from src to dest when cjStart <= *cjGlobal < cjEnd.
3820  * *cjGlobal is updated with the cj count in src.
3821  * When setFlags==true, flag bit t is set in flag for all i and j clusters.
3822  */
3823 template<bool setFlags>
3824 static void copySelectedListRange(const nbnxn_ci_t * gmx_restrict srcCi,
3825                                   const NbnxnPairlistCpu * gmx_restrict src,
3826                                   NbnxnPairlistCpu * gmx_restrict dest,
3827                                   gmx_bitmask_t *flag,
3828                                   int iFlagShift, int jFlagShift, int t)
3829 {
3830     const int ncj = srcCi->cj_ind_end - srcCi->cj_ind_start;
3831
3832     dest->ci.push_back(*srcCi);
3833     dest->ci.back().cj_ind_start = dest->cj.size();
3834     dest->ci.back().cj_ind_end   = dest->cj.size() + ncj;
3835
3836     if (setFlags)
3837     {
3838         bitmask_init_bit(&flag[srcCi->ci >> iFlagShift], t);
3839     }
3840
3841     for (int j = srcCi->cj_ind_start; j < srcCi->cj_ind_end; j++)
3842     {
3843         dest->cj.push_back(src->cj[j]);
3844
3845         if (setFlags)
3846         {
3847             /* NOTE: This is relatively expensive, since this
3848              * operation is done for all elements in the list,
3849              * whereas at list generation this is done only
3850              * once for each flag entry.
3851              */
3852             bitmask_init_bit(&flag[src->cj[j].cj >> jFlagShift], t);
3853         }
3854     }
3855 }
3856
3857 /* This routine re-balances the pairlists such that all are nearly equally
3858  * sized. Only whole i-entries are moved between lists. These are moved
3859  * between the ends of the lists, such that the buffer reduction cost should
3860  * not change significantly.
3861  * Note that all original reduction flags are currently kept. This can lead
3862  * to reduction of parts of the force buffer that could be avoided. But since
3863  * the original lists are quite balanced, this will only give minor overhead.
3864  */
3865 static void rebalanceSimpleLists(int                                  numLists,
3866                                  NbnxnPairlistCpu * const * const     srcSet,
3867                                  NbnxnPairlistCpu                   **destSet,
3868                                  gmx::ArrayRef<nbnxn_search_work_t>   searchWork)
3869 {
3870     int ncjTotal = 0;
3871     for (int s = 0; s < numLists; s++)
3872     {
3873         ncjTotal += srcSet[s]->ncjInUse;
3874     }
3875     int ncjTarget = (ncjTotal + numLists - 1)/numLists;
3876
3877 #pragma omp parallel num_threads(numLists)
3878     {
3879         int t       = gmx_omp_get_thread_num();
3880
3881         int cjStart = ncjTarget* t;
3882         int cjEnd   = ncjTarget*(t + 1);
3883
3884         /* The destination pair-list for task/thread t */
3885         NbnxnPairlistCpu *dest = destSet[t];
3886
3887         clear_pairlist(dest);
3888         dest->na_cj   = srcSet[0]->na_cj;
3889
3890         /* Note that the flags in the work struct (still) contain flags
3891          * for all entries that are present in srcSet->nbl[t].
3892          */
3893         gmx_bitmask_t *flag       = searchWork[t].buffer_flags.flag;
3894
3895         int            iFlagShift = getBufferFlagShift(dest->na_ci);
3896         int            jFlagShift = getBufferFlagShift(dest->na_cj);
3897
3898         int            cjGlobal   = 0;
3899         for (int s = 0; s < numLists && cjGlobal < cjEnd; s++)
3900         {
3901             const NbnxnPairlistCpu *src = srcSet[s];
3902
3903             if (cjGlobal + src->ncjInUse > cjStart)
3904             {
3905                 for (gmx::index i = 0; i < gmx::ssize(src->ci) && cjGlobal < cjEnd; i++)
3906                 {
3907                     const nbnxn_ci_t *srcCi = &src->ci[i];
3908                     int               ncj   = srcCi->cj_ind_end - srcCi->cj_ind_start;
3909                     if (cjGlobal >= cjStart)
3910                     {
3911                         /* If the source list is not our own, we need to set
3912                          * extra flags (the template bool parameter).
3913                          */
3914                         if (s != t)
3915                         {
3916                             copySelectedListRange
3917                             <true>
3918                                 (srcCi, src, dest,
3919                                 flag, iFlagShift, jFlagShift, t);
3920                         }
3921                         else
3922                         {
3923                             copySelectedListRange
3924                             <false>
3925                                 (srcCi, src,
3926                                 dest, flag, iFlagShift, jFlagShift, t);
3927                         }
3928                     }
3929                     cjGlobal += ncj;
3930                 }
3931             }
3932             else
3933             {
3934                 cjGlobal += src->ncjInUse;
3935             }
3936         }
3937
3938         dest->ncjInUse = dest->cj.size();
3939     }
3940
3941 #ifndef NDEBUG
3942     int ncjTotalNew = 0;
3943     for (int s = 0; s < numLists; s++)
3944     {
3945         ncjTotalNew += destSet[s]->ncjInUse;
3946     }
3947     GMX_RELEASE_ASSERT(ncjTotalNew == ncjTotal, "The total size of the lists before and after rebalancing should match");
3948 #endif
3949 }
3950
3951 /* Returns if the pairlists are so imbalanced that it is worth rebalancing. */
3952 static bool checkRebalanceSimpleLists(const nbnxn_pairlist_set_t *listSet)
3953 {
3954     int numLists = listSet->nnbl;
3955     int ncjMax   = 0;
3956     int ncjTotal = 0;
3957     for (int s = 0; s < numLists; s++)
3958     {
3959         ncjMax    = std::max(ncjMax, listSet->nbl[s]->ncjInUse);
3960         ncjTotal += listSet->nbl[s]->ncjInUse;
3961     }
3962     if (debug)
3963     {
3964         fprintf(debug, "Pair-list ncjMax %d ncjTotal %d\n", ncjMax, ncjTotal);
3965     }
3966     /* The rebalancing adds 3% extra time to the search. Heuristically we
3967      * determined that under common conditions the non-bonded kernel balance
3968      * improvement will outweigh this when the imbalance is more than 3%.
3969      * But this will, obviously, depend on search vs kernel time and nstlist.
3970      */
3971     const real rebalanceTolerance = 1.03;
3972
3973     return numLists*ncjMax > ncjTotal*rebalanceTolerance;
3974 }
3975
3976 /* Perform a count (linear) sort to sort the smaller lists to the end.
3977  * This avoids load imbalance on the GPU, as large lists will be
3978  * scheduled and executed first and the smaller lists later.
3979  * Load balancing between multi-processors only happens at the end
3980  * and there smaller lists lead to more effective load balancing.
3981  * The sorting is done on the cj4 count, not on the actual pair counts.
3982  * Not only does this make the sort faster, but it also results in
3983  * better load balancing than using a list sorted on exact load.
3984  * This function swaps the pointer in the pair list to avoid a copy operation.
3985  */
3986 static void sort_sci(NbnxnPairlistGpu *nbl)
3987 {
3988     if (nbl->cj4.size() <= nbl->sci.size())
3989     {
3990         /* nsci = 0 or all sci have size 1, sorting won't change the order */
3991         return;
3992     }
3993
3994     NbnxnPairlistGpuWork &work = *nbl->work;
3995
3996     /* We will distinguish differences up to double the average */
3997     const int m = (2*nbl->cj4.size())/nbl->sci.size();
3998
3999     /* Resize work.sci_sort so we can sort into it */
4000     work.sci_sort.resize(nbl->sci.size());
4001
4002     std::vector<int> &sort = work.sortBuffer;
4003     /* Set up m + 1 entries in sort, initialized at 0 */
4004     sort.clear();
4005     sort.resize(m + 1, 0);
4006     /* Count the entries of each size */
4007     for (const nbnxn_sci_t &sci : nbl->sci)
4008     {
4009         int i = std::min(m, sci.numJClusterGroups());
4010         sort[i]++;
4011     }
4012     /* Calculate the offset for each count */
4013     int s0  = sort[m];
4014     sort[m] = 0;
4015     for (int i = m - 1; i >= 0; i--)
4016     {
4017         int s1  = sort[i];
4018         sort[i] = sort[i + 1] + s0;
4019         s0      = s1;
4020     }
4021
4022     /* Sort entries directly into place */
4023     gmx::ArrayRef<nbnxn_sci_t> sci_sort = work.sci_sort;
4024     for (const nbnxn_sci_t &sci : nbl->sci)
4025     {
4026         int i = std::min(m, sci.numJClusterGroups());
4027         sci_sort[sort[i]++] = sci;
4028     }
4029
4030     /* Swap the sci pointers so we use the new, sorted list */
4031     std::swap(nbl->sci, work.sci_sort);
4032 }
4033
4034 void
4035 nonbonded_verlet_t::PairlistSets::construct(const InteractionLocality  iLocality,
4036                                             nbnxn_search              *nbs,
4037                                             nbnxn_atomdata_t          *nbat,
4038                                             const t_blocka            *excl,
4039                                             const Nbnxm::KernelType    kernelType,
4040                                             const int64_t              step,
4041                                             t_nrnb                    *nrnb)
4042 {
4043     nbnxn_pairlist_set_t *nbl_list = &pairlistSet(iLocality);
4044
4045     const real            rlist    = nbl_list->params.rlistOuter;
4046
4047     int                nsubpair_target;
4048     float              nsubpair_tot_est;
4049     int                nnbl;
4050     int                ci_block;
4051     gmx_bool           CombineNBLists;
4052     gmx_bool           progBal;
4053     int                np_tot, np_noq, np_hlj, nap;
4054
4055     nnbl            = nbl_list->nnbl;
4056     CombineNBLists  = nbl_list->bCombined;
4057
4058     if (debug)
4059     {
4060         fprintf(debug, "ns making %d nblists\n", nnbl);
4061     }
4062
4063     nbat->bUseBufferFlags = (nbat->out.size() > 1);
4064     /* We should re-init the flags before making the first list */
4065     if (nbat->bUseBufferFlags && iLocality == InteractionLocality::Local)
4066     {
4067         init_buffer_flags(&nbat->buffer_flags, nbat->numAtoms());
4068     }
4069
4070     int nzi;
4071     if (iLocality == InteractionLocality::Local)
4072     {
4073         /* Only zone (grid) 0 vs 0 */
4074         nzi = 1;
4075     }
4076     else
4077     {
4078         nzi = nbs->zones->nizone;
4079     }
4080
4081     if (!nbl_list->bSimple && minimumIlistCountForGpuBalancing_ > 0)
4082     {
4083         get_nsubpair_target(nbs, iLocality, rlist, minimumIlistCountForGpuBalancing_,
4084                             &nsubpair_target, &nsubpair_tot_est);
4085     }
4086     else
4087     {
4088         nsubpair_target  = 0;
4089         nsubpair_tot_est = 0;
4090     }
4091
4092     /* Clear all pair-lists */
4093     for (int th = 0; th < nnbl; th++)
4094     {
4095         if (nbl_list->bSimple)
4096         {
4097             clear_pairlist(nbl_list->nbl[th]);
4098         }
4099         else
4100         {
4101             clear_pairlist(nbl_list->nblGpu[th]);
4102         }
4103
4104         if (nbs->gridSet().haveFep())
4105         {
4106             clear_pairlist_fep(nbl_list->nbl_fep[th]);
4107         }
4108     }
4109
4110     for (int zi = 0; zi < nzi; zi++)
4111     {
4112         const Grid &iGrid = nbs->gridSet().grids()[zi];
4113
4114         int                 zj0;
4115         int                 zj1;
4116         if (iLocality == InteractionLocality::Local)
4117         {
4118             zj0 = 0;
4119             zj1 = 1;
4120         }
4121         else
4122         {
4123             zj0 = nbs->zones->izone[zi].j0;
4124             zj1 = nbs->zones->izone[zi].j1;
4125             if (zi == 0)
4126             {
4127                 zj0++;
4128             }
4129         }
4130         for (int zj = zj0; zj < zj1; zj++)
4131         {
4132             const Grid &jGrid = nbs->gridSet().grids()[zj];
4133
4134             if (debug)
4135             {
4136                 fprintf(debug, "ns search grid %d vs %d\n", zi, zj);
4137             }
4138
4139             nbs_cycle_start(&nbs->cc[enbsCCsearch]);
4140
4141             ci_block = get_ci_block_size(iGrid, nbs->DomDec, nnbl);
4142
4143             /* With GPU: generate progressively smaller lists for
4144              * load balancing for local only or non-local with 2 zones.
4145              */
4146             progBal = (iLocality == InteractionLocality::Local || nbs->zones->n <= 2);
4147
4148 #pragma omp parallel for num_threads(nnbl) schedule(static)
4149             for (int th = 0; th < nnbl; th++)
4150             {
4151                 try
4152                 {
4153                     /* Re-init the thread-local work flag data before making
4154                      * the first list (not an elegant conditional).
4155                      */
4156                     if (nbat->bUseBufferFlags && ((zi == 0 && zj == 0)))
4157                     {
4158                         init_buffer_flags(&nbs->work[th].buffer_flags, nbat->numAtoms());
4159                     }
4160
4161                     if (CombineNBLists && th > 0)
4162                     {
4163                         GMX_ASSERT(!nbl_list->bSimple, "Can only combine GPU lists");
4164
4165                         clear_pairlist(nbl_list->nblGpu[th]);
4166                     }
4167
4168                     /* Divide the i super cell equally over the nblists */
4169                     if (nbl_list->bSimple)
4170                     {
4171                         nbnxn_make_pairlist_part(nbs, iGrid, jGrid,
4172                                                  &nbs->work[th], nbat, *excl,
4173                                                  rlist,
4174                                                  kernelType,
4175                                                  ci_block,
4176                                                  nbat->bUseBufferFlags,
4177                                                  nsubpair_target,
4178                                                  progBal, nsubpair_tot_est,
4179                                                  th, nnbl,
4180                                                  nbl_list->nbl[th],
4181                                                  nbl_list->nbl_fep[th]);
4182                     }
4183                     else
4184                     {
4185                         nbnxn_make_pairlist_part(nbs, iGrid, jGrid,
4186                                                  &nbs->work[th], nbat, *excl,
4187                                                  rlist,
4188                                                  kernelType,
4189                                                  ci_block,
4190                                                  nbat->bUseBufferFlags,
4191                                                  nsubpair_target,
4192                                                  progBal, nsubpair_tot_est,
4193                                                  th, nnbl,
4194                                                  nbl_list->nblGpu[th],
4195                                                  nbl_list->nbl_fep[th]);
4196                     }
4197                 }
4198                 GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
4199             }
4200             nbs_cycle_stop(&nbs->cc[enbsCCsearch]);
4201
4202             np_tot = 0;
4203             np_noq = 0;
4204             np_hlj = 0;
4205             for (int th = 0; th < nnbl; th++)
4206             {
4207                 inc_nrnb(nrnb, eNR_NBNXN_DIST2, nbs->work[th].ndistc);
4208
4209                 if (nbl_list->bSimple)
4210                 {
4211                     NbnxnPairlistCpu *nbl = nbl_list->nbl[th];
4212                     np_tot += nbl->cj.size();
4213                     np_noq += nbl->work->ncj_noq;
4214                     np_hlj += nbl->work->ncj_hlj;
4215                 }
4216                 else
4217                 {
4218                     NbnxnPairlistGpu *nbl = nbl_list->nblGpu[th];
4219                     /* This count ignores potential subsequent pair pruning */
4220                     np_tot += nbl->nci_tot;
4221                 }
4222             }
4223             if (nbl_list->bSimple)
4224             {
4225                 nap               = nbl_list->nbl[0]->na_ci*nbl_list->nbl[0]->na_cj;
4226             }
4227             else
4228             {
4229                 nap               = gmx::square(nbl_list->nblGpu[0]->na_ci);
4230             }
4231             nbl_list->natpair_ljq = (np_tot - np_noq)*nap - np_hlj*nap/2;
4232             nbl_list->natpair_lj  = np_noq*nap;
4233             nbl_list->natpair_q   = np_hlj*nap/2;
4234
4235             if (CombineNBLists && nnbl > 1)
4236             {
4237                 GMX_ASSERT(!nbl_list->bSimple, "Can only combine GPU lists");
4238                 NbnxnPairlistGpu **nbl = nbl_list->nblGpu;
4239
4240                 nbs_cycle_start(&nbs->cc[enbsCCcombine]);
4241
4242                 combine_nblists(nnbl-1, nbl+1, nbl[0]);
4243
4244                 nbs_cycle_stop(&nbs->cc[enbsCCcombine]);
4245             }
4246         }
4247     }
4248
4249     if (nbl_list->bSimple)
4250     {
4251         if (nnbl > 1 && checkRebalanceSimpleLists(nbl_list))
4252         {
4253             rebalanceSimpleLists(nbl_list->nnbl, nbl_list->nbl, nbl_list->nbl_work, nbs->work);
4254
4255             /* Swap the pointer of the sets of pair lists */
4256             NbnxnPairlistCpu **tmp = nbl_list->nbl;
4257             nbl_list->nbl          = nbl_list->nbl_work;
4258             nbl_list->nbl_work     = tmp;
4259         }
4260     }
4261     else
4262     {
4263         /* Sort the entries on size, large ones first */
4264         if (CombineNBLists || nnbl == 1)
4265         {
4266             sort_sci(nbl_list->nblGpu[0]);
4267         }
4268         else
4269         {
4270 #pragma omp parallel for num_threads(nnbl) schedule(static)
4271             for (int th = 0; th < nnbl; th++)
4272             {
4273                 try
4274                 {
4275                     sort_sci(nbl_list->nblGpu[th]);
4276                 }
4277                 GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
4278             }
4279         }
4280     }
4281
4282     if (nbat->bUseBufferFlags)
4283     {
4284         reduce_buffer_flags(nbs, nbl_list->nnbl, &nbat->buffer_flags);
4285     }
4286
4287     if (nbs->gridSet().haveFep())
4288     {
4289         /* Balance the free-energy lists over all the threads */
4290         balance_fep_lists(nbs, nbl_list);
4291     }
4292
4293     if (nbl_list->bSimple)
4294     {
4295         /* This is a fresh list, so not pruned, stored using ci.
4296          * ciOuter is invalid at this point.
4297          */
4298         GMX_ASSERT(nbl_list->nbl[0]->ciOuter.empty(), "ciOuter is invalid so it should be empty");
4299     }
4300
4301     if (iLocality == Nbnxm::InteractionLocality::Local)
4302     {
4303         outerListCreationStep_ = step;
4304     }
4305     else
4306     {
4307         GMX_RELEASE_ASSERT(outerListCreationStep_ == step,
4308                            "Outer list should be created at the same step as the inner list");
4309     }
4310
4311     /* Special performance logging stuff (env.var. GMX_NBNXN_CYCLE) */
4312     if (iLocality == InteractionLocality::Local)
4313     {
4314         nbs->search_count++;
4315     }
4316     if (nbs->print_cycles &&
4317         (!nbs->DomDec || iLocality == InteractionLocality::NonLocal) &&
4318         nbs->search_count % 100 == 0)
4319     {
4320         nbs_cycle_print(stderr, nbs);
4321     }
4322
4323     /* If we have more than one list, they either got rebalancing (CPU)
4324      * or combined (GPU), so we should dump the final result to debug.
4325      */
4326     if (debug && nbl_list->nnbl > 1)
4327     {
4328         if (nbl_list->bSimple)
4329         {
4330             for (int t = 0; t < nbl_list->nnbl; t++)
4331             {
4332                 print_nblist_statistics(debug, nbl_list->nbl[t], nbs, rlist);
4333             }
4334         }
4335         else
4336         {
4337             print_nblist_statistics(debug, nbl_list->nblGpu[0], nbs, rlist);
4338         }
4339     }
4340
4341     if (debug)
4342     {
4343         if (gmx_debug_at)
4344         {
4345             if (nbl_list->bSimple)
4346             {
4347                 for (int t = 0; t < nbl_list->nnbl; t++)
4348                 {
4349                     print_nblist_ci_cj(debug, nbl_list->nbl[t]);
4350                 }
4351             }
4352             else
4353             {
4354                 print_nblist_sci_cj(debug, nbl_list->nblGpu[0]);
4355             }
4356         }
4357
4358         if (nbat->bUseBufferFlags)
4359         {
4360             print_reduction_cost(&nbat->buffer_flags, nbl_list->nnbl);
4361         }
4362     }
4363
4364     if (params_.useDynamicPruning && nbl_list->bSimple)
4365     {
4366         nbnxnPrepareListForDynamicPruning(nbl_list);
4367     }
4368 }
4369
4370 void
4371 nonbonded_verlet_t::constructPairlist(const Nbnxm::InteractionLocality  iLocality,
4372                                       const t_blocka                   *excl,
4373                                       int64_t                           step,
4374                                       t_nrnb                           *nrnb)
4375 {
4376     pairlistSets_->construct(iLocality, nbs.get(), nbat.get(), excl,
4377                              kernelSetup_.kernelType,
4378                              step, nrnb);
4379
4380     if (useGpu())
4381     {
4382         /* Launch the transfer of the pairlist to the GPU.
4383          *
4384          * NOTE: The launch overhead is currently not timed separately
4385          */
4386         Nbnxm::gpu_init_pairlist(gpu_nbv,
4387                                  pairlistSets().pairlistSet(iLocality).nblGpu[0],
4388                                  iLocality);
4389     }
4390 }
4391
4392 void nbnxnPrepareListForDynamicPruning(nbnxn_pairlist_set_t *listSet)
4393 {
4394     GMX_RELEASE_ASSERT(listSet->bSimple, "Should only be called for simple lists");
4395
4396     /* TODO: Restructure the lists so we have actual outer and inner
4397      *       list objects so we can set a single pointer instead of
4398      *       swapping several pointers.
4399      */
4400
4401     for (int i = 0; i < listSet->nnbl; i++)
4402     {
4403         NbnxnPairlistCpu &list = *listSet->nbl[i];
4404
4405         /* The search produced a list in ci/cj.
4406          * Swap the list pointers so we get the outer list is ciOuter,cjOuter
4407          * and we can prune that to get an inner list in ci/cj.
4408          */
4409         GMX_RELEASE_ASSERT(list.ciOuter.empty() && list.cjOuter.empty(),
4410                            "The outer lists should be empty before preparation");
4411
4412         std::swap(list.ci, list.ciOuter);
4413         std::swap(list.cj, list.cjOuter);
4414     }
4415 }