src/gromacs/nbnxm/atomdata.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 "atomdata.h"
  39
  40 #include <cassert>
  41 #include <cmath>
  42 #include <cstdlib>
  43 #include <cstring>
  44
  45 #include <algorithm>
  46
  47 #include "thread_mpi/atomic.h"
  48
  49 #include "gromacs/math/functions.h"
  50 #include "gromacs/math/utilities.h"
  51 #include "gromacs/math/vec.h"
  52 #include "gromacs/mdlib/gmx_omp_nthreads.h"
  53 #include "gromacs/mdtypes/forcerec.h" // only for GET_CGINFO_*
  54 #include "gromacs/mdtypes/mdatom.h"
  55 #include "gromacs/nbnxm/nbnxm.h"
  56 #include "gromacs/nbnxm/nbnxm_geometry.h"
  57 #include "gromacs/pbcutil/ishift.h"
  58 #include "gromacs/simd/simd.h"
  59 #include "gromacs/timing/wallcycle.h"
  60 #include "gromacs/utility/exceptions.h"
  61 #include "gromacs/utility/fatalerror.h"
  62 #include "gromacs/utility/gmxomp.h"
  63 #include "gromacs/utility/logger.h"
  64 #include "gromacs/utility/smalloc.h"
  65 #include "gromacs/utility/strconvert.h"
  66 #include "gromacs/utility/stringutil.h"
  67
  68 #include "internal.h"
  69
  70 using namespace gmx; // TODO: Remove when this file is moved into gmx namespace
  71
  72
  73 void nbnxn_atomdata_t::resizeCoordinateBuffer(int numAtoms)
  74 {
  75     numAtoms_ = numAtoms;
  76
  77     x_.resize(numAtoms*xstride);
  78 }
  79
  80 void nbnxn_atomdata_t::resizeForceBuffers()
  81 {
  82     /* Force buffers need padding up to a multiple of the buffer flag size */
  83     const int paddedSize = (numAtoms() + NBNXN_BUFFERFLAG_SIZE - 1)/NBNXN_BUFFERFLAG_SIZE*NBNXN_BUFFERFLAG_SIZE;
  84
  85     /* Should we let each thread allocate it's own data instead? */
  86     for (nbnxn_atomdata_output_t &outBuffer : out)
  87     {
  88         outBuffer.f.resize(paddedSize*fstride);
  89     }
  90 }
  91
  92 /* Initializes an nbnxn_atomdata_output_t data structure */
  93 nbnxn_atomdata_output_t::nbnxn_atomdata_output_t(int                nb_kernel_type,
  94                                                  int                numEnergyGroups,
  95                                                  int                simdEnergyBufferStride,
  96                                                  gmx::PinningPolicy pinningPolicy) :
  97     f({}, {pinningPolicy}),
  98     fshift({}, {pinningPolicy}),
  99     Vvdw({}, {pinningPolicy}),
 100     Vc({}, {pinningPolicy})
 101 {
 102     fshift.resize(SHIFTS*DIM);
 103     Vvdw.resize(numEnergyGroups*numEnergyGroups);
 104     Vc.resize(numEnergyGroups*numEnergyGroups);
 105
 106     if (nb_kernel_type == nbnxnk4xN_SIMD_4xN ||
 107         nb_kernel_type == nbnxnk4xN_SIMD_2xNN)
 108     {
 109         int cj_size     = nbnxn_kernel_to_cluster_j_size(nb_kernel_type);
 110         int numElements = numEnergyGroups*numEnergyGroups*simdEnergyBufferStride*(cj_size/2)*cj_size;
 111         VSvdw.resize(numElements);
 112         VSc.resize(numElements);
 113     }
 114 }
 115
 116 static void copy_int_to_nbat_int(const int *a, int na, int na_round,
 117                                  const int *in, int fill, int *innb)
 118 {
 119     int i, j;
 120
 121     j = 0;
 122     for (i = 0; i < na; i++)
 123     {
 124         innb[j++] = in[a[i]];
 125     }
 126     /* Complete the partially filled last cell with fill */
 127     for (; i < na_round; i++)
 128     {
 129         innb[j++] = fill;
 130     }
 131 }
 132
 133 void copy_rvec_to_nbat_real(const int *a, int na, int na_round,
 134                             const rvec *x, int nbatFormat,
 135                             real *xnb, int a0)
 136 {
 137     /* We complete partially filled cells, can only be the last one in each
 138      * column, with coordinates farAway. The actual coordinate value does
 139      * not influence the results, since these filler particles do not interact.
 140      * Clusters with normal atoms + fillers have a bounding box based only
 141      * on the coordinates of the atoms. Clusters with only fillers have as
 142      * the bounding box the coordinates of the first filler. Such clusters
 143      * are not considered as i-entries, but they are considered as j-entries.
 144      * So for performance it is better to have their bounding boxes far away,
 145      * such that filler only clusters don't end up in the pair list.
 146      */
 147     const real farAway = -1000000;
 148
 149     int        i, j, c;
 150
 151     switch (nbatFormat)
 152     {
 153         case nbatXYZ:
 154             j = a0*STRIDE_XYZ;
 155             for (i = 0; i < na; i++)
 156             {
 157                 xnb[j++] = x[a[i]][XX];
 158                 xnb[j++] = x[a[i]][YY];
 159                 xnb[j++] = x[a[i]][ZZ];
 160             }
 161             /* Complete the partially filled last cell with farAway elements */
 162             for (; i < na_round; i++)
 163             {
 164                 xnb[j++] = farAway;
 165                 xnb[j++] = farAway;
 166                 xnb[j++] = farAway;
 167             }
 168             break;
 169         case nbatXYZQ:
 170             j = a0*STRIDE_XYZQ;
 171             for (i = 0; i < na; i++)
 172             {
 173                 xnb[j++] = x[a[i]][XX];
 174                 xnb[j++] = x[a[i]][YY];
 175                 xnb[j++] = x[a[i]][ZZ];
 176                 j++;
 177             }
 178             /* Complete the partially filled last cell with zeros */
 179             for (; i < na_round; i++)
 180             {
 181                 xnb[j++] = farAway;
 182                 xnb[j++] = farAway;
 183                 xnb[j++] = farAway;
 184                 j++;
 185             }
 186             break;
 187         case nbatX4:
 188             j = atom_to_x_index<c_packX4>(a0);
 189             c = a0 & (c_packX4-1);
 190             for (i = 0; i < na; i++)
 191             {
 192                 xnb[j+XX*c_packX4] = x[a[i]][XX];
 193                 xnb[j+YY*c_packX4] = x[a[i]][YY];
 194                 xnb[j+ZZ*c_packX4] = x[a[i]][ZZ];
 195                 j++;
 196                 c++;
 197                 if (c == c_packX4)
 198                 {
 199                     j += (DIM-1)*c_packX4;
 200                     c  = 0;
 201                 }
 202             }
 203             /* Complete the partially filled last cell with zeros */
 204             for (; i < na_round; i++)
 205             {
 206                 xnb[j+XX*c_packX4] = farAway;
 207                 xnb[j+YY*c_packX4] = farAway;
 208                 xnb[j+ZZ*c_packX4] = farAway;
 209                 j++;
 210                 c++;
 211                 if (c == c_packX4)
 212                 {
 213                     j += (DIM-1)*c_packX4;
 214                     c  = 0;
 215                 }
 216             }
 217             break;
 218         case nbatX8:
 219             j = atom_to_x_index<c_packX8>(a0);
 220             c = a0 & (c_packX8 - 1);
 221             for (i = 0; i < na; i++)
 222             {
 223                 xnb[j+XX*c_packX8] = x[a[i]][XX];
 224                 xnb[j+YY*c_packX8] = x[a[i]][YY];
 225                 xnb[j+ZZ*c_packX8] = x[a[i]][ZZ];
 226                 j++;
 227                 c++;
 228                 if (c == c_packX8)
 229                 {
 230                     j += (DIM-1)*c_packX8;
 231                     c  = 0;
 232                 }
 233             }
 234             /* Complete the partially filled last cell with zeros */
 235             for (; i < na_round; i++)
 236             {
 237                 xnb[j+XX*c_packX8] = farAway;
 238                 xnb[j+YY*c_packX8] = farAway;
 239                 xnb[j+ZZ*c_packX8] = farAway;
 240                 j++;
 241                 c++;
 242                 if (c == c_packX8)
 243                 {
 244                     j += (DIM-1)*c_packX8;
 245                     c  = 0;
 246                 }
 247             }
 248             break;
 249         default:
 250             gmx_incons("Unsupported nbnxn_atomdata_t format");
 251     }
 252 }
 253
 254 /* Stores the LJ parameter data in a format convenient for different kernels */
 255 static void set_lj_parameter_data(nbnxn_atomdata_t::Params *params, gmx_bool bSIMD)
 256 {
 257     int  nt = params->numTypes;
 258
 259     if (bSIMD)
 260     {
 261 #if GMX_SIMD
 262         /* nbfp_aligned stores two parameters using the stride most suitable
 263          * for the present SIMD architecture, as specified by the constant
 264          * c_simdBestPairAlignment from the SIMD header.
 265          * There's a slight inefficiency in allocating and initializing nbfp_aligned
 266          * when it might not be used, but introducing the conditional code is not
 267          * really worth it.
 268          */
 269         params->nbfp_aligned.resize(nt*nt*c_simdBestPairAlignment);
 270
 271         for (int i = 0; i < nt; i++)
 272         {
 273             for (int j = 0; j < nt; j++)
 274             {
 275                 params->nbfp_aligned[(i*nt+j)*c_simdBestPairAlignment+0] = params->nbfp[(i*nt+j)*2+0];
 276                 params->nbfp_aligned[(i*nt+j)*c_simdBestPairAlignment+1] = params->nbfp[(i*nt+j)*2+1];
 277                 params->nbfp_aligned[(i*nt+j)*c_simdBestPairAlignment+2] = 0;
 278                 params->nbfp_aligned[(i*nt+j)*c_simdBestPairAlignment+3] = 0;
 279             }
 280         }
 281 #endif
 282     }
 283
 284     /* We use combination rule data for SIMD combination rule kernels
 285      * and with LJ-PME kernels. We then only need parameters per atom type,
 286      * not per pair of atom types.
 287      */
 288     params->nbfp_comb.resize(nt*2);
 289     switch (params->comb_rule)
 290     {
 291         case ljcrGEOM:
 292             params->comb_rule = ljcrGEOM;
 293
 294             for (int i = 0; i < nt; i++)
 295             {
 296                 /* Store the sqrt of the diagonal from the nbfp matrix */
 297                 params->nbfp_comb[i*2  ] = std::sqrt(params->nbfp[(i*nt+i)*2  ]);
 298                 params->nbfp_comb[i*2+1] = std::sqrt(params->nbfp[(i*nt+i)*2+1]);
 299             }
 300             break;
 301         case ljcrLB:
 302             for (int i = 0; i < nt; i++)
 303             {
 304                 /* Get 6*C6 and 12*C12 from the diagonal of the nbfp matrix */
 305                 const real c6  = params->nbfp[(i*nt+i)*2  ];
 306                 const real c12 = params->nbfp[(i*nt+i)*2+1];
 307                 if (c6 > 0 && c12 > 0)
 308                 {
 309                     /* We store 0.5*2^1/6*sigma and sqrt(4*3*eps),
 310                      * so we get 6*C6 and 12*C12 after combining.
 311                      */
 312                     params->nbfp_comb[i*2  ] = 0.5*gmx::sixthroot(c12/c6);
 313                     params->nbfp_comb[i*2+1] = std::sqrt(c6*c6/c12);
 314                 }
 315                 else
 316                 {
 317                     params->nbfp_comb[i*2  ] = 0;
 318                     params->nbfp_comb[i*2+1] = 0;
 319                 }
 320             }
 321             break;
 322         case ljcrNONE:
 323             /* We always store the full matrix (see code above) */
 324             break;
 325         default:
 326             gmx_incons("Unknown combination rule");
 327     }
 328 }
 329
 330 nbnxn_atomdata_t::SimdMasks::SimdMasks()
 331 {
 332 #if GMX_SIMD
 333     constexpr int simd_width = GMX_SIMD_REAL_WIDTH;
 334     /* Set the diagonal cluster pair exclusion mask setup data.
 335      * In the kernel we check 0 < j - i to generate the masks.
 336      * Here we store j - i for generating the mask for the first i,
 337      * we substract 0.5 to avoid rounding issues.
 338      * In the kernel we can subtract 1 to generate the subsequent mask.
 339      */
 340     const int simd_4xn_diag_size = std::max(c_nbnxnCpuIClusterSize, simd_width);
 341     diagonal_4xn_j_minus_i.resize(simd_4xn_diag_size);
 342     for (int j = 0; j < simd_4xn_diag_size; j++)
 343     {
 344         diagonal_4xn_j_minus_i[j] = j - 0.5;
 345     }
 346
 347     diagonal_2xnn_j_minus_i.resize(simd_width);
 348     for (int j = 0; j < simd_width/2; j++)
 349     {
 350         /* The j-cluster size is half the SIMD width */
 351         diagonal_2xnn_j_minus_i[j]                = j - 0.5;
 352         /* The next half of the SIMD width is for i + 1 */
 353         diagonal_2xnn_j_minus_i[simd_width/2 + j] = j - 1 - 0.5;
 354     }
 355
 356     /* We use up to 32 bits for exclusion masking.
 357      * The same masks are used for the 4xN and 2x(N+N) kernels.
 358      * The masks are read either into integer SIMD registers or into
 359      * real SIMD registers (together with a cast).
 360      * In single precision this means the real and integer SIMD registers
 361      * are of equal size.
 362      */
 363     const int simd_excl_size = c_nbnxnCpuIClusterSize*simd_width;
 364 #if GMX_DOUBLE && !GMX_SIMD_HAVE_INT32_LOGICAL
 365     exclusion_filter64.resize(simd_excl_size);
 366 #else
 367     exclusion_filter.resize(simd_excl_size);
 368 #endif
 369
 370     for (int j = 0; j < simd_excl_size; j++)
 371     {
 372         /* Set the consecutive bits for masking pair exclusions */
 373 #if GMX_DOUBLE && !GMX_SIMD_HAVE_INT32_LOGICAL
 374         exclusion_filter64[j] = (1U << j);
 375 #else
 376         exclusion_filter[j]   = (1U << j);
 377 #endif
 378     }
 379
 380     if (!GMX_SIMD_HAVE_LOGICAL && !GMX_SIMD_HAVE_INT32_LOGICAL) // NOLINT(misc-redundant-expression)
 381     {
 382         // If the SIMD implementation has no bitwise logical operation support
 383         // whatsoever we cannot use the normal masking. Instead,
 384         // we generate a vector of all 2^4 possible ways an i atom
 385         // interacts with its 4 j atoms. Each array entry contains
 386         // GMX_SIMD_REAL_WIDTH values that are read with a single aligned SIMD load.
 387         // Since there is no logical value representation in this case, we use
 388         // any nonzero value to indicate 'true', while zero mean 'false'.
 389         // This can then be converted to a SIMD boolean internally in the SIMD
 390         // module by comparing to zero.
 391         // Each array entry encodes how this i atom will interact with the 4 j atoms.
 392         // Matching code exists in set_ci_top_excls() to generate indices into this array.
 393         // Those indices are used in the kernels.
 394
 395         const int  simd_excl_size = c_nbnxnCpuIClusterSize*c_nbnxnCpuIClusterSize;
 396         const real simdFalse      = 0.0;
 397         const real simdTrue       = 1.0;
 398
 399         interaction_array.resize(simd_excl_size * GMX_SIMD_REAL_WIDTH);
 400         for (int j = 0; j < simd_excl_size; j++)
 401         {
 402             const int index = j * GMX_SIMD_REAL_WIDTH;
 403             for (int i = 0; i < GMX_SIMD_REAL_WIDTH; i++)
 404             {
 405                 interaction_array[index + i] = (j & (1 << i)) ? simdTrue : simdFalse;
 406             }
 407         }
 408     }
 409 #endif
 410 }
 411
 412 nbnxn_atomdata_t::Params::Params(gmx::PinningPolicy pinningPolicy) :
 413     numTypes(0),
 414     nbfp({}, {pinningPolicy}),
 415     nbfp_comb({}, {pinningPolicy}),
 416     type({}, {pinningPolicy}),
 417     lj_comb({}, {pinningPolicy}),
 418     q({}, {pinningPolicy}),
 419     nenergrp(0),
 420     neg_2log(0),
 421     energrp({}, {pinningPolicy})
 422 {
 423 }
 424
 425 nbnxn_atomdata_t::nbnxn_atomdata_t(gmx::PinningPolicy pinningPolicy) :
 426     params_(pinningPolicy),
 427     numAtoms_(0),
 428     natoms_local(0),
 429     shift_vec({}, {pinningPolicy}),
 430     x_({}, {pinningPolicy}),
 431     simdMasks(),
 432     bUseBufferFlags(FALSE),
 433     bUseTreeReduce(FALSE)
 434 {
 435 }
 436
 437 /* Initializes an nbnxn_atomdata_t::Params data structure */
 438 static void nbnxn_atomdata_params_init(const gmx::MDLogger &mdlog,
 439                                        nbnxn_atomdata_t::Params *params,
 440                                        int nb_kernel_type,
 441                                        int enbnxninitcombrule,
 442                                        int ntype, const real *nbfp,
 443                                        int n_energygroups)
 444 {
 445     real     c6, c12, tol;
 446     char    *ptr;
 447     gmx_bool simple, bCombGeom, bCombLB, bSIMD;
 448
 449     if (debug)
 450     {
 451         fprintf(debug, "There are %d atom types in the system, adding one for nbnxn_atomdata_t\n", ntype);
 452     }
 453     params->numTypes = ntype + 1;
 454     params->nbfp.resize(params->numTypes*params->numTypes*2);
 455     params->nbfp_comb.resize(params->numTypes*2);
 456
 457     /* A tolerance of 1e-5 seems reasonable for (possibly hand-typed)
 458      * force-field floating point parameters.
 459      */
 460     tol = 1e-5;
 461     ptr = getenv("GMX_LJCOMB_TOL");
 462     if (ptr != nullptr)
 463     {
 464         double dbl;
 465
 466         sscanf(ptr, "%lf", &dbl);
 467         tol = dbl;
 468     }
 469     bCombGeom = TRUE;
 470     bCombLB   = TRUE;
 471
 472     /* Temporarily fill params->nbfp_comb with sigma and epsilon
 473      * to check for the LB rule.
 474      */
 475     for (int i = 0; i < ntype; i++)
 476     {
 477         c6  = nbfp[(i*ntype+i)*2    ]/6.0;
 478         c12 = nbfp[(i*ntype+i)*2 + 1]/12.0;
 479         if (c6 > 0 && c12 > 0)
 480         {
 481             params->nbfp_comb[i*2    ] = gmx::sixthroot(c12/c6);
 482             params->nbfp_comb[i*2 + 1] = 0.25*c6*c6/c12;
 483         }
 484         else if (c6 == 0 && c12 == 0)
 485         {
 486             params->nbfp_comb[i*2    ] = 0;
 487             params->nbfp_comb[i*2 + 1] = 0;
 488         }
 489         else
 490         {
 491             /* Can not use LB rule with only dispersion or repulsion */
 492             bCombLB = FALSE;
 493         }
 494     }
 495
 496     for (int i = 0; i < params->numTypes; i++)
 497     {
 498         for (int j = 0; j < params->numTypes; j++)
 499         {
 500             if (i < ntype && j < ntype)
 501             {
 502                 /* fr->nbfp has been updated, so that array too now stores c6/c12 including
 503                  * the 6.0/12.0 prefactors to save 2 flops in the most common case (force-only).
 504                  */
 505                 c6  = nbfp[(i*ntype+j)*2    ];
 506                 c12 = nbfp[(i*ntype+j)*2 + 1];
 507                 params->nbfp[(i*params->numTypes+j)*2    ] = c6;
 508                 params->nbfp[(i*params->numTypes+j)*2 + 1] = c12;
 509
 510                 /* Compare 6*C6 and 12*C12 for geometric cobination rule */
 511                 bCombGeom = bCombGeom &&
 512                     gmx_within_tol(c6*c6, nbfp[(i*ntype+i)*2  ]*nbfp[(j*ntype+j)*2  ], tol) &&
 513                     gmx_within_tol(c12*c12, nbfp[(i*ntype+i)*2 + 1]*nbfp[(j*ntype+j)*2 + 1], tol);
 514
 515                 /* Compare C6 and C12 for Lorentz-Berthelot combination rule */
 516                 c6     /= 6.0;
 517                 c12    /= 12.0;
 518                 bCombLB = bCombLB &&
 519                     ((c6 == 0 && c12 == 0 &&
 520                       (params->nbfp_comb[i*2 + 1] == 0 || params->nbfp_comb[j*2 + 1] == 0)) ||
 521                      (c6 > 0 && c12 > 0 &&
 522                       gmx_within_tol(gmx::sixthroot(c12/c6),
 523                                      0.5*(params->nbfp_comb[i*2]+params->nbfp_comb[j*2]), tol) &&
 524                       gmx_within_tol(0.25*c6*c6/c12, std::sqrt(params->nbfp_comb[i*2 + 1]*params->nbfp_comb[j*2 + 1]), tol)));
 525             }
 526             else
 527             {
 528                 /* Add zero parameters for the additional dummy atom type */
 529                 params->nbfp[(i*params->numTypes + j)*2  ] = 0;
 530                 params->nbfp[(i*params->numTypes + j)*2+1] = 0;
 531             }
 532         }
 533     }
 534     if (debug)
 535     {
 536         fprintf(debug, "Combination rules: geometric %s Lorentz-Berthelot %s\n",
 537                 gmx::boolToString(bCombGeom), gmx::boolToString(bCombLB));
 538     }
 539
 540     simple = nbnxn_kernel_pairlist_simple(nb_kernel_type);
 541
 542     switch (enbnxninitcombrule)
 543     {
 544         case enbnxninitcombruleDETECT:
 545             /* We prefer the geometic combination rule,
 546              * as that gives a slightly faster kernel than the LB rule.
 547              */
 548             if (bCombGeom)
 549             {
 550                 params->comb_rule = ljcrGEOM;
 551             }
 552             else if (bCombLB)
 553             {
 554                 params->comb_rule = ljcrLB;
 555             }
 556             else
 557             {
 558                 params->comb_rule = ljcrNONE;
 559
 560                 params->nbfp_comb.clear();
 561             }
 562
 563             {
 564                 std::string mesg;
 565                 if (params->comb_rule == ljcrNONE)
 566                 {
 567                     mesg = "Using full Lennard-Jones parameter combination matrix";
 568                 }
 569                 else
 570                 {
 571                     mesg = gmx::formatString("Using %s Lennard-Jones combination rule",
 572                                              params->comb_rule == ljcrGEOM ? "geometric" : "Lorentz-Berthelot");
 573                 }
 574                 GMX_LOG(mdlog.info).asParagraph().appendText(mesg);
 575             }
 576             break;
 577         case enbnxninitcombruleGEOM:
 578             params->comb_rule = ljcrGEOM;
 579             break;
 580         case enbnxninitcombruleLB:
 581             params->comb_rule = ljcrLB;
 582             break;
 583         case enbnxninitcombruleNONE:
 584             params->comb_rule = ljcrNONE;
 585
 586             params->nbfp_comb.clear();
 587             break;
 588         default:
 589             gmx_incons("Unknown enbnxninitcombrule");
 590     }
 591
 592     bSIMD = (nb_kernel_type == nbnxnk4xN_SIMD_4xN ||
 593              nb_kernel_type == nbnxnk4xN_SIMD_2xNN);
 594
 595     set_lj_parameter_data(params, bSIMD);
 596
 597     params->nenergrp = n_energygroups;
 598     if (!simple)
 599     {
 600         // We now check for energy groups already when starting mdrun
 601         GMX_RELEASE_ASSERT(n_energygroups == 1, "GPU kernels do not support energy groups");
 602     }
 603     /* Temporary storage goes as #grp^3*simd_width^2/2, so limit to 64 */
 604     if (params->nenergrp > 64)
 605     {
 606         gmx_fatal(FARGS, "With NxN kernels not more than 64 energy groups are supported\n");
 607     }
 608     params->neg_2log = 1;
 609     while (params->nenergrp > (1<<params->neg_2log))
 610     {
 611         params->neg_2log++;
 612     }
 613 }
 614
 615 /* Initializes an nbnxn_atomdata_t data structure */
 616 void nbnxn_atomdata_init(const gmx::MDLogger &mdlog,
 617                          nbnxn_atomdata_t *nbat,
 618                          int nb_kernel_type,
 619                          int enbnxninitcombrule,
 620                          int ntype, const real *nbfp,
 621                          int n_energygroups,
 622                          int nout)
 623 {
 624     nbnxn_atomdata_params_init(mdlog, &nbat->paramsDeprecated(), nb_kernel_type,
 625                                enbnxninitcombrule, ntype, nbfp, n_energygroups);
 626
 627     const gmx_bool simple = nbnxn_kernel_pairlist_simple(nb_kernel_type);
 628     const gmx_bool bSIMD  = (nb_kernel_type == nbnxnk4xN_SIMD_4xN ||
 629                              nb_kernel_type == nbnxnk4xN_SIMD_2xNN);
 630
 631     if (simple)
 632     {
 633         int pack_x;
 634
 635         if (bSIMD)
 636         {
 637             pack_x = std::max(c_nbnxnCpuIClusterSize,
 638                               nbnxn_kernel_to_cluster_j_size(nb_kernel_type));
 639             switch (pack_x)
 640             {
 641                 case 4:
 642                     nbat->XFormat = nbatX4;
 643                     break;
 644                 case 8:
 645                     nbat->XFormat = nbatX8;
 646                     break;
 647                 default:
 648                     gmx_incons("Unsupported packing width");
 649             }
 650         }
 651         else
 652         {
 653             nbat->XFormat = nbatXYZ;
 654         }
 655
 656         nbat->FFormat = nbat->XFormat;
 657     }
 658     else
 659     {
 660         nbat->XFormat = nbatXYZQ;
 661         nbat->FFormat = nbatXYZ;
 662     }
 663
 664     nbat->shift_vec.resize(SHIFTS);
 665
 666     nbat->xstride = (nbat->XFormat == nbatXYZQ ? STRIDE_XYZQ : DIM);
 667     nbat->fstride = (nbat->FFormat == nbatXYZQ ? STRIDE_XYZQ : DIM);
 668
 669     /* Initialize the output data structures */
 670     for (int i = 0; i < nout; i++)
 671     {
 672         const auto &pinningPolicy = nbat->params().type.get_allocator().pinningPolicy();
 673         nbat->out.emplace_back(nb_kernel_type, nbat->params().nenergrp, 1 << nbat->params().neg_2log,
 674                                pinningPolicy);
 675     }
 676
 677     nbat->buffer_flags.flag        = nullptr;
 678     nbat->buffer_flags.flag_nalloc = 0;
 679
 680     const int   nth = gmx_omp_nthreads_get(emntNonbonded);
 681
 682     const char *ptr = getenv("GMX_USE_TREEREDUCE");
 683     if (ptr != nullptr)
 684     {
 685         nbat->bUseTreeReduce = (strtol(ptr, nullptr, 10) != 0);
 686     }
 687 #if defined __MIC__
 688     else if (nth > 8) /*on the CPU we currently don't benefit even at 32*/
 689     {
 690         nbat->bUseTreeReduce = 1;
 691     }
 692 #endif
 693     else
 694     {
 695         nbat->bUseTreeReduce = false;
 696     }
 697     if (nbat->bUseTreeReduce)
 698     {
 699         GMX_LOG(mdlog.info).asParagraph().appendText("Using tree force reduction");
 700
 701         nbat->syncStep = new tMPI_Atomic[nth];
 702     }
 703 }
 704
 705 template<int packSize>
 706 static void copy_lj_to_nbat_lj_comb(gmx::ArrayRef<const real> ljparam_type,
 707                                     const int *type, int na,
 708                                     real *ljparam_at)
 709 {
 710     /* The LJ params follow the combination rule:
 711      * copy the params for the type array to the atom array.
 712      */
 713     for (int is = 0; is < na; is += packSize)
 714     {
 715         for (int k = 0; k < packSize; k++)
 716         {
 717             int i = is + k;
 718             ljparam_at[is*2            + k] = ljparam_type[type[i]*2    ];
 719             ljparam_at[is*2 + packSize + k] = ljparam_type[type[i]*2 + 1];
 720         }
 721     }
 722 }
 723
 724 static int numAtomsFromGrids(const nbnxn_search &nbs)
 725 {
 726     const nbnxn_grid_t &lastGrid = nbs.grid.back();
 727
 728     return (lastGrid.cell0 + lastGrid.nc)*lastGrid.na_sc;
 729 }
 730
 731 /* Sets the atom type in nbnxn_atomdata_t */
 732 static void nbnxn_atomdata_set_atomtypes(nbnxn_atomdata_t::Params *params,
 733                                          const nbnxn_search       *nbs,
 734                                          const int                *type)
 735 {
 736     params->type.resize(numAtomsFromGrids(*nbs));
 737
 738     for (const nbnxn_grid_t &grid : nbs->grid)
 739     {
 740         /* Loop over all columns and copy and fill */
 741         for (int i = 0; i < grid.numCells[XX]*grid.numCells[YY]; i++)
 742         {
 743             int ncz = grid.cxy_ind[i+1] - grid.cxy_ind[i];
 744             int ash = (grid.cell0 + grid.cxy_ind[i])*grid.na_sc;
 745
 746             copy_int_to_nbat_int(nbs->a.data() + ash, grid.cxy_na[i], ncz*grid.na_sc,
 747                                  type, params->numTypes - 1, params->type.data() + ash);
 748         }
 749     }
 750 }
 751
 752 /* Sets the LJ combination rule parameters in nbnxn_atomdata_t */
 753 static void nbnxn_atomdata_set_ljcombparams(nbnxn_atomdata_t::Params *params,
 754                                             const int                 XFormat,
 755                                             const nbnxn_search       *nbs)
 756 {
 757     params->lj_comb.resize(numAtomsFromGrids(*nbs)*2);
 758
 759     if (params->comb_rule != ljcrNONE)
 760     {
 761         for (const nbnxn_grid_t &grid : nbs->grid)
 762         {
 763             /* Loop over all columns and copy and fill */
 764             for (int i = 0; i < grid.numCells[XX]*grid.numCells[YY]; i++)
 765             {
 766                 int ncz = grid.cxy_ind[i+1] - grid.cxy_ind[i];
 767                 int ash = (grid.cell0 + grid.cxy_ind[i])*grid.na_sc;
 768
 769                 if (XFormat == nbatX4)
 770                 {
 771                     copy_lj_to_nbat_lj_comb<c_packX4>(params->nbfp_comb,
 772                                                       params->type.data() + ash,
 773                                                       ncz*grid.na_sc,
 774                                                       params->lj_comb.data() + ash*2);
 775                 }
 776                 else if (XFormat == nbatX8)
 777                 {
 778                     copy_lj_to_nbat_lj_comb<c_packX8>(params->nbfp_comb,
 779                                                       params->type.data() + ash,
 780                                                       ncz*grid.na_sc,
 781                                                       params->lj_comb.data() + ash*2);
 782                 }
 783                 else if (XFormat == nbatXYZQ)
 784                 {
 785                     copy_lj_to_nbat_lj_comb<1>(params->nbfp_comb,
 786                                                params->type.data() + ash,
 787                                                ncz*grid.na_sc,
 788                                                params->lj_comb.data() + ash*2);
 789                 }
 790             }
 791         }
 792     }
 793 }
 794
 795 /* Sets the charges in nbnxn_atomdata_t *nbat */
 796 static void nbnxn_atomdata_set_charges(nbnxn_atomdata_t    *nbat,
 797                                        const nbnxn_search  *nbs,
 798                                        const real          *charge)
 799 {
 800     if (nbat->XFormat != nbatXYZQ)
 801     {
 802         nbat->paramsDeprecated().q.resize(nbat->numAtoms());
 803     }
 804
 805     for (const nbnxn_grid_t &grid : nbs->grid)
 806     {
 807         /* Loop over all columns and copy and fill */
 808         for (int cxy = 0; cxy < grid.numCells[XX]*grid.numCells[YY]; cxy++)
 809         {
 810             int ash      = (grid.cell0 + grid.cxy_ind[cxy])*grid.na_sc;
 811             int na       = grid.cxy_na[cxy];
 812             int na_round = (grid.cxy_ind[cxy+1] - grid.cxy_ind[cxy])*grid.na_sc;
 813
 814             if (nbat->XFormat == nbatXYZQ)
 815             {
 816                 real *q = nbat->x().data() + ash*STRIDE_XYZQ + ZZ + 1;
 817                 int   i;
 818                 for (i = 0; i < na; i++)
 819                 {
 820                     *q = charge[nbs->a[ash+i]];
 821                     q += STRIDE_XYZQ;
 822                 }
 823                 /* Complete the partially filled last cell with zeros */
 824                 for (; i < na_round; i++)
 825                 {
 826                     *q = 0;
 827                     q += STRIDE_XYZQ;
 828                 }
 829             }
 830             else
 831             {
 832                 real *q = nbat->paramsDeprecated().q.data() + ash;
 833                 int   i;
 834                 for (i = 0; i < na; i++)
 835                 {
 836                     *q = charge[nbs->a[ash+i]];
 837                     q++;
 838                 }
 839                 /* Complete the partially filled last cell with zeros */
 840                 for (; i < na_round; i++)
 841                 {
 842                     *q = 0;
 843                     q++;
 844                 }
 845             }
 846         }
 847     }
 848 }
 849
 850 /* Set the charges of perturbed atoms in nbnxn_atomdata_t to 0.
 851  * This is to automatically remove the RF/PME self term in the nbnxn kernels.
 852  * Part of the zero interactions are still calculated in the normal kernels.
 853  * All perturbed interactions are calculated in the free energy kernel,
 854  * using the original charge and LJ data, not nbnxn_atomdata_t.
 855  */
 856 static void nbnxn_atomdata_mask_fep(nbnxn_atomdata_t    *nbat,
 857                                     const nbnxn_search  *nbs)
 858 {
 859     nbnxn_atomdata_t::Params &params = nbat->paramsDeprecated();
 860     real                     *q;
 861     int                       stride_q;
 862
 863     if (nbat->XFormat == nbatXYZQ)
 864     {
 865         q        = nbat->x().data() + ZZ + 1;
 866         stride_q = STRIDE_XYZQ;
 867     }
 868     else
 869     {
 870         q        = params.q.data();
 871         stride_q = 1;
 872     }
 873
 874     for (const nbnxn_grid_t &grid : nbs->grid)
 875     {
 876         int nsubc;
 877         if (grid.bSimple)
 878         {
 879             nsubc = 1;
 880         }
 881         else
 882         {
 883             nsubc = c_gpuNumClusterPerCell;
 884         }
 885
 886         int c_offset = grid.cell0*grid.na_sc;
 887
 888         /* Loop over all columns and copy and fill */
 889         for (int c = 0; c < grid.nc*nsubc; c++)
 890         {
 891             /* Does this cluster contain perturbed particles? */
 892             if (grid.fep[c] != 0)
 893             {
 894                 for (int i = 0; i < grid.na_c; i++)
 895                 {
 896                     /* Is this a perturbed particle? */
 897                     if (grid.fep[c] & (1 << i))
 898                     {
 899                         int ind = c_offset + c*grid.na_c + i;
 900                         /* Set atom type and charge to non-interacting */
 901                         params.type[ind] = params.numTypes - 1;
 902                         q[ind*stride_q]  = 0;
 903                     }
 904                 }
 905             }
 906         }
 907     }
 908 }
 909
 910 /* Copies the energy group indices to a reordered and packed array */
 911 static void copy_egp_to_nbat_egps(const int *a, int na, int na_round,
 912                                   int na_c, int bit_shift,
 913                                   const int *in, int *innb)
 914 {
 915     int i;
 916     int comb;
 917
 918     int j = 0;
 919     for (i = 0; i < na; i += na_c)
 920     {
 921         /* Store na_c energy group numbers into one int */
 922         comb = 0;
 923         for (int sa = 0; sa < na_c; sa++)
 924         {
 925             int at = a[i+sa];
 926             if (at >= 0)
 927             {
 928                 comb |= (GET_CGINFO_GID(in[at]) << (sa*bit_shift));
 929             }
 930         }
 931         innb[j++] = comb;
 932     }
 933     /* Complete the partially filled last cell with fill */
 934     for (; i < na_round; i += na_c)
 935     {
 936         innb[j++] = 0;
 937     }
 938 }
 939
 940 /* Set the energy group indices for atoms in nbnxn_atomdata_t */
 941 static void nbnxn_atomdata_set_energygroups(nbnxn_atomdata_t::Params *params,
 942                                             const nbnxn_search       *nbs,
 943                                             const int                *atinfo)
 944 {
 945     if (params->nenergrp == 1)
 946     {
 947         return;
 948     }
 949
 950     params->energrp.resize(numAtomsFromGrids(*nbs));
 951
 952     for (const nbnxn_grid_t &grid : nbs->grid)
 953     {
 954         /* Loop over all columns and copy and fill */
 955         for (int i = 0; i < grid.numCells[XX]*grid.numCells[YY]; i++)
 956         {
 957             int ncz = grid.cxy_ind[i+1] - grid.cxy_ind[i];
 958             int ash = (grid.cell0 + grid.cxy_ind[i])*grid.na_sc;
 959
 960             copy_egp_to_nbat_egps(nbs->a.data() + ash, grid.cxy_na[i], ncz*grid.na_sc,
 961                                   c_nbnxnCpuIClusterSize, params->neg_2log,
 962                                   atinfo,
 963                                   params->energrp.data() + (ash >> grid.na_c_2log));
 964         }
 965     }
 966 }
 967
 968 /* Sets all required atom parameter data in nbnxn_atomdata_t */
 969 void nbnxn_atomdata_set(nbnxn_atomdata_t    *nbat,
 970                         const nbnxn_search  *nbs,
 971                         const t_mdatoms     *mdatoms,
 972                         const int           *atinfo)
 973 {
 974     nbnxn_atomdata_t::Params &params = nbat->paramsDeprecated();
 975
 976     nbnxn_atomdata_set_atomtypes(&params, nbs, mdatoms->typeA);
 977
 978     nbnxn_atomdata_set_charges(nbat, nbs, mdatoms->chargeA);
 979
 980     if (nbs->bFEP)
 981     {
 982         nbnxn_atomdata_mask_fep(nbat, nbs);
 983     }
 984
 985     /* This must be done after masking types for FEP */
 986     nbnxn_atomdata_set_ljcombparams(&params, nbat->XFormat, nbs);
 987
 988     nbnxn_atomdata_set_energygroups(&params, nbs, atinfo);
 989 }
 990
 991 /* Copies the shift vector array to nbnxn_atomdata_t */
 992 void nbnxn_atomdata_copy_shiftvec(gmx_bool          bDynamicBox,
 993                                   rvec             *shift_vec,
 994                                   nbnxn_atomdata_t *nbat)
 995 {
 996     int i;
 997
 998     nbat->bDynamicBox = bDynamicBox;
 999     for (i = 0; i < SHIFTS; i++)
1000     {
1001         copy_rvec(shift_vec[i], nbat->shift_vec[i]);
1002     }
1003 }
1004
1005 /* Copies (and reorders) the coordinates to nbnxn_atomdata_t */
1006 void nbnxn_atomdata_copy_x_to_nbat_x(const nbnxn_search  *nbs,
1007                                      int                  locality,
1008                                      gmx_bool             FillLocal,
1009                                      rvec                *x,
1010                                      nbnxn_atomdata_t    *nbat,
1011                                      gmx_wallcycle       *wcycle)
1012 {
1013     wallcycle_start(wcycle, ewcNB_XF_BUF_OPS);
1014     wallcycle_sub_start(wcycle, ewcsNB_X_BUF_OPS);
1015
1016     int g0 = 0, g1 = 0;
1017     int nth, th;
1018
1019     switch (locality)
1020     {
1021         case eatAll:
1022             g0 = 0;
1023             g1 = nbs->grid.size();
1024             break;
1025         case eatLocal:
1026             g0 = 0;
1027             g1 = 1;
1028             break;
1029         case eatNonlocal:
1030             g0 = 1;
1031             g1 = nbs->grid.size();
1032             break;
1033     }
1034
1035     if (FillLocal)
1036     {
1037         nbat->natoms_local = nbs->grid[0].nc*nbs->grid[0].na_sc;
1038     }
1039
1040     nth = gmx_omp_nthreads_get(emntPairsearch);
1041
1042 #pragma omp parallel for num_threads(nth) schedule(static)
1043     for (th = 0; th < nth; th++)
1044     {
1045         try
1046         {
1047             for (int g = g0; g < g1; g++)
1048             {
1049                 const nbnxn_grid_t &grid       = nbs->grid[g];
1050                 const int           numCellsXY = grid.numCells[XX]*grid.numCells[YY];
1051
1052                 const int           cxy0 = (numCellsXY* th      + nth - 1)/nth;
1053                 const int           cxy1 = (numCellsXY*(th + 1) + nth - 1)/nth;
1054
1055                 for (int cxy = cxy0; cxy < cxy1; cxy++)
1056                 {
1057                     int na, ash, na_fill;
1058
1059                     na  = grid.cxy_na[cxy];
1060                     ash = (grid.cell0 + grid.cxy_ind[cxy])*grid.na_sc;
1061
1062                     if (g == 0 && FillLocal)
1063                     {
1064                         na_fill =
1065                             (grid.cxy_ind[cxy+1] - grid.cxy_ind[cxy])*grid.na_sc;
1066                     }
1067                     else
1068                     {
1069                         /* We fill only the real particle locations.
1070                          * We assume the filling entries at the end have been
1071                          * properly set before during pair-list generation.
1072                          */
1073                         na_fill = na;
1074                     }
1075                     copy_rvec_to_nbat_real(nbs->a.data() + ash, na, na_fill, x,
1076                                            nbat->XFormat, nbat->x().data(), ash);
1077                 }
1078             }
1079         }
1080         GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
1081     }
1082
1083     wallcycle_sub_stop(wcycle, ewcsNB_X_BUF_OPS);
1084     wallcycle_stop(wcycle, ewcNB_XF_BUF_OPS);
1085 }
1086
1087 static void
1088 nbnxn_atomdata_clear_reals(gmx::ArrayRef<real> dest,
1089                            int i0, int i1)
1090 {
1091     for (int i = i0; i < i1; i++)
1092     {
1093         dest[i] = 0;
1094     }
1095 }
1096
1097 gmx_unused static void
1098 nbnxn_atomdata_reduce_reals(real * gmx_restrict dest,
1099                             gmx_bool bDestSet,
1100                             const real ** gmx_restrict src,
1101                             int nsrc,
1102                             int i0, int i1)
1103 {
1104     if (bDestSet)
1105     {
1106         /* The destination buffer contains data, add to it */
1107         for (int i = i0; i < i1; i++)
1108         {
1109             for (int s = 0; s < nsrc; s++)
1110             {
1111                 dest[i] += src[s][i];
1112             }
1113         }
1114     }
1115     else
1116     {
1117         /* The destination buffer is unitialized, set it first */
1118         for (int i = i0; i < i1; i++)
1119         {
1120             dest[i] = src[0][i];
1121             for (int s = 1; s < nsrc; s++)
1122             {
1123                 dest[i] += src[s][i];
1124             }
1125         }
1126     }
1127 }
1128
1129 gmx_unused static void
1130 nbnxn_atomdata_reduce_reals_simd(real gmx_unused * gmx_restrict dest,
1131                                  gmx_bool gmx_unused bDestSet,
1132                                  const gmx_unused real ** gmx_restrict src,
1133                                  int gmx_unused nsrc,
1134                                  int gmx_unused i0, int gmx_unused i1)
1135 {
1136 #if GMX_SIMD
1137 /* The SIMD width here is actually independent of that in the kernels,
1138  * but we use the same width for simplicity (usually optimal anyhow).
1139  */
1140     SimdReal dest_SSE, src_SSE;
1141
1142     if (bDestSet)
1143     {
1144         for (int i = i0; i < i1; i += GMX_SIMD_REAL_WIDTH)
1145         {
1146             dest_SSE = load<SimdReal>(dest+i);
1147             for (int s = 0; s < nsrc; s++)
1148             {
1149                 src_SSE  = load<SimdReal>(src[s]+i);
1150                 dest_SSE = dest_SSE + src_SSE;
1151             }
1152             store(dest+i, dest_SSE);
1153         }
1154     }
1155     else
1156     {
1157         for (int i = i0; i < i1; i += GMX_SIMD_REAL_WIDTH)
1158         {
1159             dest_SSE = load<SimdReal>(src[0]+i);
1160             for (int s = 1; s < nsrc; s++)
1161             {
1162                 src_SSE  = load<SimdReal>(src[s]+i);
1163                 dest_SSE = dest_SSE + src_SSE;
1164             }
1165             store(dest+i, dest_SSE);
1166         }
1167     }
1168 #endif
1169 }
1170
1171 /* Add part of the force array(s) from nbnxn_atomdata_t to f */
1172 static void
1173 nbnxn_atomdata_add_nbat_f_to_f_part(const nbnxn_search *nbs,
1174                                     const nbnxn_atomdata_t *nbat,
1175                                     gmx::ArrayRef<nbnxn_atomdata_output_t> out,
1176                                     int nfa,
1177                                     int a0, int a1,
1178                                     rvec *f)
1179 {
1180     gmx::ArrayRef<const int> cell = nbs->cell;
1181
1182     /* Loop over all columns and copy and fill */
1183     switch (nbat->FFormat)
1184     {
1185         case nbatXYZ:
1186         case nbatXYZQ:
1187             if (nfa == 1)
1188             {
1189                 const real *fnb = out[0].f.data();
1190
1191                 for (int a = a0; a < a1; a++)
1192                 {
1193                     int i = cell[a]*nbat->fstride;
1194
1195                     f[a][XX] += fnb[i];
1196                     f[a][YY] += fnb[i+1];
1197                     f[a][ZZ] += fnb[i+2];
1198                 }
1199             }
1200             else
1201             {
1202                 for (int a = a0; a < a1; a++)
1203                 {
1204                     int i = cell[a]*nbat->fstride;
1205
1206                     for (int fa = 0; fa < nfa; fa++)
1207                     {
1208                         f[a][XX] += out[fa].f[i];
1209                         f[a][YY] += out[fa].f[i+1];
1210                         f[a][ZZ] += out[fa].f[i+2];
1211                     }
1212                 }
1213             }
1214             break;
1215         case nbatX4:
1216             if (nfa == 1)
1217             {
1218                 const real *fnb = out[0].f.data();
1219
1220                 for (int a = a0; a < a1; a++)
1221                 {
1222                     int i = atom_to_x_index<c_packX4>(cell[a]);
1223
1224                     f[a][XX] += fnb[i+XX*c_packX4];
1225                     f[a][YY] += fnb[i+YY*c_packX4];
1226                     f[a][ZZ] += fnb[i+ZZ*c_packX4];
1227                 }
1228             }
1229             else
1230             {
1231                 for (int a = a0; a < a1; a++)
1232                 {
1233                     int i = atom_to_x_index<c_packX4>(cell[a]);
1234
1235                     for (int fa = 0; fa < nfa; fa++)
1236                     {
1237                         f[a][XX] += out[fa].f[i+XX*c_packX4];
1238                         f[a][YY] += out[fa].f[i+YY*c_packX4];
1239                         f[a][ZZ] += out[fa].f[i+ZZ*c_packX4];
1240                     }
1241                 }
1242             }
1243             break;
1244         case nbatX8:
1245             if (nfa == 1)
1246             {
1247                 const real *fnb = out[0].f.data();
1248
1249                 for (int a = a0; a < a1; a++)
1250                 {
1251                     int i = atom_to_x_index<c_packX8>(cell[a]);
1252
1253                     f[a][XX] += fnb[i+XX*c_packX8];
1254                     f[a][YY] += fnb[i+YY*c_packX8];
1255                     f[a][ZZ] += fnb[i+ZZ*c_packX8];
1256                 }
1257             }
1258             else
1259             {
1260                 for (int a = a0; a < a1; a++)
1261                 {
1262                     int i = atom_to_x_index<c_packX8>(cell[a]);
1263
1264                     for (int fa = 0; fa < nfa; fa++)
1265                     {
1266                         f[a][XX] += out[fa].f[i+XX*c_packX8];
1267                         f[a][YY] += out[fa].f[i+YY*c_packX8];
1268                         f[a][ZZ] += out[fa].f[i+ZZ*c_packX8];
1269                     }
1270                 }
1271             }
1272             break;
1273         default:
1274             gmx_incons("Unsupported nbnxn_atomdata_t format");
1275     }
1276 }
1277
1278 static inline unsigned char reverse_bits(unsigned char b)
1279 {
1280     /* http://graphics.stanford.edu/~seander/bithacks.html#ReverseByteWith64BitsDiv */
1281     return (b * 0x0202020202ULL & 0x010884422010ULL) % 1023;
1282 }
1283
1284 static void nbnxn_atomdata_add_nbat_f_to_f_treereduce(nbnxn_atomdata_t *nbat,
1285                                                       int               nth)
1286 {
1287     const nbnxn_buffer_flags_t *flags = &nbat->buffer_flags;
1288
1289     int                         next_pow2 = 1<<(gmx::log2I(nth-1)+1);
1290
1291     const int                   numOutputBuffers = nbat->out.size();
1292     GMX_ASSERT(numOutputBuffers == nth,
1293                "tree-reduce currently only works for numOutputBuffers==nth");
1294
1295     memset(nbat->syncStep, 0, sizeof(*(nbat->syncStep))*nth);
1296
1297 #pragma omp parallel num_threads(nth)
1298     {
1299         try
1300         {
1301             int   b0, b1, b;
1302             int   i0, i1;
1303             int   group_size, th;
1304
1305             th = gmx_omp_get_thread_num();
1306
1307             for (group_size = 2; group_size < 2*next_pow2; group_size *= 2)
1308             {
1309                 int index[2], group_pos, partner_pos, wu;
1310                 int partner_th = th ^ (group_size/2);
1311
1312                 if (group_size > 2)
1313                 {
1314 #ifdef TMPI_ATOMICS
1315                     /* wait on partner thread - replaces full barrier */
1316                     int sync_th, sync_group_size;
1317
1318                     tMPI_Atomic_memory_barrier();                         /* gurantee data is saved before marking work as done */
1319                     tMPI_Atomic_set(&(nbat->syncStep[th]), group_size/2); /* mark previous step as completed */
1320
1321                     /* find thread to sync with. Equal to partner_th unless nth is not a power of two. */
1322                     for (sync_th = partner_th, sync_group_size = group_size; sync_th >= nth && sync_group_size > 2; sync_group_size /= 2)
1323                     {
1324                         sync_th &= ~(sync_group_size/4);
1325                     }
1326                     if (sync_th < nth) /* otherwise nothing to sync index[1] will be >=nout */
1327                     {
1328                         /* wait on the thread which computed input data in previous step */
1329                         while (tMPI_Atomic_get(static_cast<volatile tMPI_Atomic_t*>(&(nbat->syncStep[sync_th]))) < group_size/2)
1330                         {
1331                             gmx_pause();
1332                         }
1333                         /* guarantee that no later load happens before wait loop is finisehd */
1334                         tMPI_Atomic_memory_barrier();
1335                     }
1336 #else               /* TMPI_ATOMICS */
1337 #pragma omp barrier
1338 #endif
1339                 }
1340
1341                 /* Calculate buffers to sum (result goes into first buffer) */
1342                 group_pos = th % group_size;
1343                 index[0]  = th - group_pos;
1344                 index[1]  = index[0] + group_size/2;
1345
1346                 /* If no second buffer, nothing to do */
1347                 if (index[1] >= numOutputBuffers && group_size > 2)
1348                 {
1349                     continue;
1350                 }
1351
1352 #if NBNXN_BUFFERFLAG_MAX_THREADS > 256
1353 #error reverse_bits assumes max 256 threads
1354 #endif
1355                 /* Position is permuted so that one of the 2 vectors being added was computed on the same thread in the previous step.
1356                    This improves locality and enables to sync with just a single thread between steps (=the levels in the btree).
1357                    The permutation which allows this corresponds to reversing the bits of the group position.
1358                  */
1359                 group_pos = reverse_bits(group_pos)/(256/group_size);
1360
1361                 partner_pos = group_pos ^ 1;
1362
1363                 /* loop over two work-units (own and partner) */
1364                 for (wu = 0; wu < 2; wu++)
1365                 {
1366                     if (wu == 1)
1367                     {
1368                         if (partner_th < nth)
1369                         {
1370                             break; /* partner exists we don't have to do his work */
1371                         }
1372                         else
1373                         {
1374                             group_pos = partner_pos;
1375                         }
1376                     }
1377
1378                     /* Calculate the cell-block range for our thread */
1379                     b0 = (flags->nflag* group_pos   )/group_size;
1380                     b1 = (flags->nflag*(group_pos+1))/group_size;
1381
1382                     for (b = b0; b < b1; b++)
1383                     {
1384                         i0 =  b   *NBNXN_BUFFERFLAG_SIZE*nbat->fstride;
1385                         i1 = (b+1)*NBNXN_BUFFERFLAG_SIZE*nbat->fstride;
1386
1387                         if (bitmask_is_set(flags->flag[b], index[1]) || group_size > 2)
1388                         {
1389                             const real *fIndex1 = nbat->out[index[1]].f.data();
1390 #if GMX_SIMD
1391                             nbnxn_atomdata_reduce_reals_simd
1392 #else
1393                             nbnxn_atomdata_reduce_reals
1394 #endif
1395                                 (nbat->out[index[0]].f.data(),
1396                                 bitmask_is_set(flags->flag[b], index[0]) || group_size > 2,
1397                                 &fIndex1, 1, i0, i1);
1398
1399                         }
1400                         else if (!bitmask_is_set(flags->flag[b], index[0]))
1401                         {
1402                             nbnxn_atomdata_clear_reals(nbat->out[index[0]].f,
1403                                                        i0, i1);
1404                         }
1405                     }
1406                 }
1407             }
1408         }
1409         GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
1410     }
1411 }
1412
1413
1414 static void nbnxn_atomdata_add_nbat_f_to_f_stdreduce(nbnxn_atomdata_t *nbat,
1415                                                      int               nth)
1416 {
1417 #pragma omp parallel for num_threads(nth) schedule(static)
1418     for (int th = 0; th < nth; th++)
1419     {
1420         try
1421         {
1422             const nbnxn_buffer_flags_t *flags;
1423             int                         nfptr;
1424             const real                 *fptr[NBNXN_BUFFERFLAG_MAX_THREADS];
1425
1426             flags = &nbat->buffer_flags;
1427
1428             /* Calculate the cell-block range for our thread */
1429             int b0 = (flags->nflag* th   )/nth;
1430             int b1 = (flags->nflag*(th+1))/nth;
1431
1432             for (int b = b0; b < b1; b++)
1433             {
1434                 int i0 =  b   *NBNXN_BUFFERFLAG_SIZE*nbat->fstride;
1435                 int i1 = (b+1)*NBNXN_BUFFERFLAG_SIZE*nbat->fstride;
1436
1437                 nfptr = 0;
1438                 for (int out = 1; out < gmx::ssize(nbat->out); out++)
1439                 {
1440                     if (bitmask_is_set(flags->flag[b], out))
1441                     {
1442                         fptr[nfptr++] = nbat->out[out].f.data();
1443                     }
1444                 }
1445                 if (nfptr > 0)
1446                 {
1447 #if GMX_SIMD
1448                     nbnxn_atomdata_reduce_reals_simd
1449 #else
1450                     nbnxn_atomdata_reduce_reals
1451 #endif
1452                         (nbat->out[0].f.data(),
1453                         bitmask_is_set(flags->flag[b], 0),
1454                         fptr, nfptr,
1455                         i0, i1);
1456                 }
1457                 else if (!bitmask_is_set(flags->flag[b], 0))
1458                 {
1459                     nbnxn_atomdata_clear_reals(nbat->out[0].f,
1460                                                i0, i1);
1461                 }
1462             }
1463         }
1464         GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
1465     }
1466 }
1467
1468 /* Add the force array(s) from nbnxn_atomdata_t to f */
1469 void nbnxn_atomdata_add_nbat_f_to_f(nbnxn_search           *nbs,
1470                                     int                     locality,
1471                                     nbnxn_atomdata_t       *nbat,
1472                                     rvec                   *f,
1473                                     gmx_wallcycle          *wcycle)
1474 {
1475     wallcycle_start(wcycle, ewcNB_XF_BUF_OPS);
1476     wallcycle_sub_start(wcycle, ewcsNB_F_BUF_OPS);
1477
1478     int a0 = 0, na = 0;
1479
1480     nbs_cycle_start(&nbs->cc[enbsCCreducef]);
1481
1482     switch (locality)
1483     {
1484         case eatAll:
1485             a0 = 0;
1486             na = nbs->natoms_nonlocal;
1487             break;
1488         case eatLocal:
1489             a0 = 0;
1490             na = nbs->natoms_local;
1491             break;
1492         case eatNonlocal:
1493             a0 = nbs->natoms_local;
1494             na = nbs->natoms_nonlocal - nbs->natoms_local;
1495             break;
1496     }
1497
1498     int nth = gmx_omp_nthreads_get(emntNonbonded);
1499
1500     if (nbat->out.size() > 1)
1501     {
1502         if (locality != eatAll)
1503         {
1504             gmx_incons("add_f_to_f called with nout>1 and locality!=eatAll");
1505         }
1506
1507         /* Reduce the force thread output buffers into buffer 0, before adding
1508          * them to the, differently ordered, "real" force buffer.
1509          */
1510         if (nbat->bUseTreeReduce)
1511         {
1512             nbnxn_atomdata_add_nbat_f_to_f_treereduce(nbat, nth);
1513         }
1514         else
1515         {
1516             nbnxn_atomdata_add_nbat_f_to_f_stdreduce(nbat, nth);
1517         }
1518     }
1519 #pragma omp parallel for num_threads(nth) schedule(static)
1520     for (int th = 0; th < nth; th++)
1521     {
1522         try
1523         {
1524             nbnxn_atomdata_add_nbat_f_to_f_part(nbs, nbat,
1525                                                 nbat->out,
1526                                                 1,
1527                                                 a0+((th+0)*na)/nth,
1528                                                 a0+((th+1)*na)/nth,
1529                                                 f);
1530         }
1531         GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
1532     }
1533
1534     nbs_cycle_stop(&nbs->cc[enbsCCreducef]);
1535
1536     wallcycle_sub_stop(wcycle, ewcsNB_F_BUF_OPS);
1537     wallcycle_stop(wcycle, ewcNB_XF_BUF_OPS);
1538 }
1539
1540 /* Adds the shift forces from nbnxn_atomdata_t to fshift */
1541 void nbnxn_atomdata_add_nbat_fshift_to_fshift(const nbnxn_atomdata_t *nbat,
1542                                               rvec                   *fshift)
1543 {
1544     gmx::ArrayRef<const nbnxn_atomdata_output_t> outputBuffers = nbat->out;
1545
1546     for (int s = 0; s < SHIFTS; s++)
1547     {
1548         rvec sum;
1549         clear_rvec(sum);
1550         for (const nbnxn_atomdata_output_t &out : outputBuffers)
1551         {
1552             sum[XX] += out.fshift[s*DIM+XX];
1553             sum[YY] += out.fshift[s*DIM+YY];
1554             sum[ZZ] += out.fshift[s*DIM+ZZ];
1555         }
1556         rvec_inc(fshift[s], sum);
1557     }
1558 }