src/gromacs/mdlib/vsite.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015,2016,2017 by the GROMACS development team.
   7  * Copyright (c) 2018,2019,2020, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 #include "gmxpre.h"
  39
  40 #include "vsite.h"
  41
  42 #include <cstdio>
  43
  44 #include <algorithm>
  45 #include <memory>
  46 #include <vector>
  47
  48 #include "gromacs/domdec/domdec.h"
  49 #include "gromacs/domdec/domdec_struct.h"
  50 #include "gromacs/gmxlib/network.h"
  51 #include "gromacs/gmxlib/nrnb.h"
  52 #include "gromacs/math/functions.h"
  53 #include "gromacs/math/vec.h"
  54 #include "gromacs/mdlib/gmx_omp_nthreads.h"
  55 #include "gromacs/mdtypes/commrec.h"
  56 #include "gromacs/mdtypes/mdatom.h"
  57 #include "gromacs/pbcutil/ishift.h"
  58 #include "gromacs/pbcutil/mshift.h"
  59 #include "gromacs/pbcutil/pbc.h"
  60 #include "gromacs/timing/wallcycle.h"
  61 #include "gromacs/topology/ifunc.h"
  62 #include "gromacs/topology/mtop_util.h"
  63 #include "gromacs/topology/topology.h"
  64 #include "gromacs/utility/exceptions.h"
  65 #include "gromacs/utility/fatalerror.h"
  66 #include "gromacs/utility/gmxassert.h"
  67 #include "gromacs/utility/gmxomp.h"
  68
  69 /* The strategy used here for assigning virtual sites to (thread-)tasks
  70  * is as follows:
  71  *
  72  * We divide the atom range that vsites operate on (natoms_local with DD,
  73  * 0 - last atom involved in vsites without DD) equally over all threads.
  74  *
  75  * Vsites in the local range constructed from atoms in the local range
  76  * and/or other vsites that are fully local are assigned to a simple,
  77  * independent task.
  78  *
  79  * Vsites that are not assigned after using the above criterion get assigned
  80  * to a so called "interdependent" thread task when none of the constructing
  81  * atoms is a vsite. These tasks are called interdependent, because one task
  82  * accesses atoms assigned to a different task/thread.
  83  * Note that this option is turned off with large (local) atom counts
  84  * to avoid high memory usage.
  85  *
  86  * Any remaining vsites are assigned to a separate master thread task.
  87  */
  88
  89 using gmx::RVec;
  90
  91 static void init_ilist(t_ilist* ilist)
  92 {
  93     for (int i = 0; i < F_NRE; i++)
  94     {
  95         ilist[i].nr     = 0;
  96         ilist[i].nalloc = 0;
  97         ilist[i].iatoms = nullptr;
  98     }
  99 }
 100
 101 /*! \brief List of atom indices belonging to a task */
 102 struct AtomIndex
 103 {
 104     //! List of atom indices
 105     std::vector<int> atom;
 106 };
 107
 108 /*! \brief Data structure for thread tasks that use constructing atoms outside their own atom range */
 109 struct InterdependentTask
 110 {
 111     //! The interaction lists, only vsite entries are used
 112     t_ilist ilist[F_NRE];
 113     //! Thread/task-local force buffer
 114     std::vector<RVec> force;
 115     //! The atom indices of the vsites of our task
 116     std::vector<int> vsite;
 117     //! Flags if elements in force are spread to or not
 118     std::vector<bool> use;
 119     //! The number of entries set to true in use
 120     int nuse;
 121     //! Array of atoms indices, size nthreads, covering all nuse set elements in use
 122     std::vector<AtomIndex> atomIndex;
 123     //! List of tasks (force blocks) this task spread forces to
 124     std::vector<int> spreadTask;
 125     //! List of tasks that write to this tasks force block range
 126     std::vector<int> reduceTask;
 127
 128     InterdependentTask()
 129     {
 130         init_ilist(ilist);
 131         nuse = 0;
 132     }
 133 };
 134
 135 /*! \brief Vsite thread task data structure */
 136 struct VsiteThread
 137 {
 138     //! Start of atom range of this task
 139     int rangeStart;
 140     //! End of atom range of this task
 141     int rangeEnd;
 142     //! The interaction lists, only vsite entries are used
 143     t_ilist ilist[F_NRE];
 144     //! Local fshift accumulation buffer
 145     rvec fshift[SHIFTS];
 146     //! Local virial dx*df accumulation buffer
 147     matrix dxdf;
 148     //! Tells if interdependent task idTask should be used (in addition to the rest of this task), this bool has the same value on all threads
 149     bool useInterdependentTask;
 150     //! Data for vsites that involve constructing atoms in the atom range of other threads/tasks
 151     InterdependentTask idTask;
 152
 153     /*! \brief Constructor */
 154     VsiteThread()
 155     {
 156         rangeStart = -1;
 157         rangeEnd   = -1;
 158         init_ilist(ilist);
 159         clear_rvecs(SHIFTS, fshift);
 160         clear_mat(dxdf);
 161         useInterdependentTask = false;
 162     }
 163 };
 164
 165 /*! \brief Returns the sum of the vsite ilist sizes over all vsite types
 166  *
 167  * \param[in] ilist  The interaction list
 168  */
 169 template<typename T>
 170 static int vsiteIlistNrCount(const T* ilist)
 171 {
 172     int nr = 0;
 173     for (int ftype = c_ftypeVsiteStart; ftype < c_ftypeVsiteEnd; ftype++)
 174     {
 175         nr += ilist[ftype].size();
 176     }
 177
 178     return nr;
 179 }
 180
 181 static int pbc_rvec_sub(const t_pbc* pbc, const rvec xi, const rvec xj, rvec dx)
 182 {
 183     if (pbc)
 184     {
 185         return pbc_dx_aiuc(pbc, xi, xj, dx);
 186     }
 187     else
 188     {
 189         rvec_sub(xi, xj, dx);
 190         return CENTRAL;
 191     }
 192 }
 193
 194 static inline real inverseNorm(const rvec x)
 195 {
 196     return gmx::invsqrt(iprod(x, x));
 197 }
 198
 199 /* Vsite construction routines */
 200
 201 static void constr_vsite2(const rvec xi, const rvec xj, rvec x, real a, const t_pbc* pbc)
 202 {
 203     real b = 1 - a;
 204     /* 1 flop */
 205
 206     if (pbc)
 207     {
 208         rvec dx;
 209         pbc_dx_aiuc(pbc, xj, xi, dx);
 210         x[XX] = xi[XX] + a * dx[XX];
 211         x[YY] = xi[YY] + a * dx[YY];
 212         x[ZZ] = xi[ZZ] + a * dx[ZZ];
 213     }
 214     else
 215     {
 216         x[XX] = b * xi[XX] + a * xj[XX];
 217         x[YY] = b * xi[YY] + a * xj[YY];
 218         x[ZZ] = b * xi[ZZ] + a * xj[ZZ];
 219         /* 9 Flops */
 220     }
 221
 222     /* TOTAL: 10 flops */
 223 }
 224
 225 static void constr_vsite2FD(const rvec xi, const rvec xj, rvec x, real a, const t_pbc* pbc)
 226 {
 227     rvec xij;
 228     pbc_rvec_sub(pbc, xj, xi, xij);
 229     /* 3 flops */
 230
 231     const real b = a * inverseNorm(xij);
 232     /* 6 + 10 flops */
 233
 234     x[XX] = xi[XX] + b * xij[XX];
 235     x[YY] = xi[YY] + b * xij[YY];
 236     x[ZZ] = xi[ZZ] + b * xij[ZZ];
 237     /* 6 Flops */
 238
 239     /* TOTAL: 25 flops */
 240 }
 241
 242 static void constr_vsite3(const rvec xi, const rvec xj, const rvec xk, rvec x, real a, real b, const t_pbc* pbc)
 243 {
 244     real c = 1 - a - b;
 245     /* 2 flops */
 246
 247     if (pbc)
 248     {
 249         rvec dxj, dxk;
 250
 251         pbc_dx_aiuc(pbc, xj, xi, dxj);
 252         pbc_dx_aiuc(pbc, xk, xi, dxk);
 253         x[XX] = xi[XX] + a * dxj[XX] + b * dxk[XX];
 254         x[YY] = xi[YY] + a * dxj[YY] + b * dxk[YY];
 255         x[ZZ] = xi[ZZ] + a * dxj[ZZ] + b * dxk[ZZ];
 256     }
 257     else
 258     {
 259         x[XX] = c * xi[XX] + a * xj[XX] + b * xk[XX];
 260         x[YY] = c * xi[YY] + a * xj[YY] + b * xk[YY];
 261         x[ZZ] = c * xi[ZZ] + a * xj[ZZ] + b * xk[ZZ];
 262         /* 15 Flops */
 263     }
 264
 265     /* TOTAL: 17 flops */
 266 }
 267
 268 static void constr_vsite3FD(const rvec xi, const rvec xj, const rvec xk, rvec x, real a, real b, const t_pbc* pbc)
 269 {
 270     rvec xij, xjk, temp;
 271     real c;
 272
 273     pbc_rvec_sub(pbc, xj, xi, xij);
 274     pbc_rvec_sub(pbc, xk, xj, xjk);
 275     /* 6 flops */
 276
 277     /* temp goes from i to a point on the line jk */
 278     temp[XX] = xij[XX] + a * xjk[XX];
 279     temp[YY] = xij[YY] + a * xjk[YY];
 280     temp[ZZ] = xij[ZZ] + a * xjk[ZZ];
 281     /* 6 flops */
 282
 283     c = b * inverseNorm(temp);
 284     /* 6 + 10 flops */
 285
 286     x[XX] = xi[XX] + c * temp[XX];
 287     x[YY] = xi[YY] + c * temp[YY];
 288     x[ZZ] = xi[ZZ] + c * temp[ZZ];
 289     /* 6 Flops */
 290
 291     /* TOTAL: 34 flops */
 292 }
 293
 294 static void constr_vsite3FAD(const rvec xi, const rvec xj, const rvec xk, rvec x, real a, real b, const t_pbc* pbc)
 295 {
 296     rvec xij, xjk, xp;
 297     real a1, b1, c1, invdij;
 298
 299     pbc_rvec_sub(pbc, xj, xi, xij);
 300     pbc_rvec_sub(pbc, xk, xj, xjk);
 301     /* 6 flops */
 302
 303     invdij = inverseNorm(xij);
 304     c1     = invdij * invdij * iprod(xij, xjk);
 305     xp[XX] = xjk[XX] - c1 * xij[XX];
 306     xp[YY] = xjk[YY] - c1 * xij[YY];
 307     xp[ZZ] = xjk[ZZ] - c1 * xij[ZZ];
 308     a1     = a * invdij;
 309     b1     = b * inverseNorm(xp);
 310     /* 45 */
 311
 312     x[XX] = xi[XX] + a1 * xij[XX] + b1 * xp[XX];
 313     x[YY] = xi[YY] + a1 * xij[YY] + b1 * xp[YY];
 314     x[ZZ] = xi[ZZ] + a1 * xij[ZZ] + b1 * xp[ZZ];
 315     /* 12 Flops */
 316
 317     /* TOTAL: 63 flops */
 318 }
 319
 320 static void
 321 constr_vsite3OUT(const rvec xi, const rvec xj, const rvec xk, rvec x, real a, real b, real c, const t_pbc* pbc)
 322 {
 323     rvec xij, xik, temp;
 324
 325     pbc_rvec_sub(pbc, xj, xi, xij);
 326     pbc_rvec_sub(pbc, xk, xi, xik);
 327     cprod(xij, xik, temp);
 328     /* 15 Flops */
 329
 330     x[XX] = xi[XX] + a * xij[XX] + b * xik[XX] + c * temp[XX];
 331     x[YY] = xi[YY] + a * xij[YY] + b * xik[YY] + c * temp[YY];
 332     x[ZZ] = xi[ZZ] + a * xij[ZZ] + b * xik[ZZ] + c * temp[ZZ];
 333     /* 18 Flops */
 334
 335     /* TOTAL: 33 flops */
 336 }
 337
 338 static void constr_vsite4FD(const rvec   xi,
 339                             const rvec   xj,
 340                             const rvec   xk,
 341                             const rvec   xl,
 342                             rvec         x,
 343                             real         a,
 344                             real         b,
 345                             real         c,
 346                             const t_pbc* pbc)
 347 {
 348     rvec xij, xjk, xjl, temp;
 349     real d;
 350
 351     pbc_rvec_sub(pbc, xj, xi, xij);
 352     pbc_rvec_sub(pbc, xk, xj, xjk);
 353     pbc_rvec_sub(pbc, xl, xj, xjl);
 354     /* 9 flops */
 355
 356     /* temp goes from i to a point on the plane jkl */
 357     temp[XX] = xij[XX] + a * xjk[XX] + b * xjl[XX];
 358     temp[YY] = xij[YY] + a * xjk[YY] + b * xjl[YY];
 359     temp[ZZ] = xij[ZZ] + a * xjk[ZZ] + b * xjl[ZZ];
 360     /* 12 flops */
 361
 362     d = c * inverseNorm(temp);
 363     /* 6 + 10 flops */
 364
 365     x[XX] = xi[XX] + d * temp[XX];
 366     x[YY] = xi[YY] + d * temp[YY];
 367     x[ZZ] = xi[ZZ] + d * temp[ZZ];
 368     /* 6 Flops */
 369
 370     /* TOTAL: 43 flops */
 371 }
 372
 373 static void constr_vsite4FDN(const rvec   xi,
 374                              const rvec   xj,
 375                              const rvec   xk,
 376                              const rvec   xl,
 377                              rvec         x,
 378                              real         a,
 379                              real         b,
 380                              real         c,
 381                              const t_pbc* pbc)
 382 {
 383     rvec xij, xik, xil, ra, rb, rja, rjb, rm;
 384     real d;
 385
 386     pbc_rvec_sub(pbc, xj, xi, xij);
 387     pbc_rvec_sub(pbc, xk, xi, xik);
 388     pbc_rvec_sub(pbc, xl, xi, xil);
 389     /* 9 flops */
 390
 391     ra[XX] = a * xik[XX];
 392     ra[YY] = a * xik[YY];
 393     ra[ZZ] = a * xik[ZZ];
 394
 395     rb[XX] = b * xil[XX];
 396     rb[YY] = b * xil[YY];
 397     rb[ZZ] = b * xil[ZZ];
 398
 399     /* 6 flops */
 400
 401     rvec_sub(ra, xij, rja);
 402     rvec_sub(rb, xij, rjb);
 403     /* 6 flops */
 404
 405     cprod(rja, rjb, rm);
 406     /* 9 flops */
 407
 408     d = c * inverseNorm(rm);
 409     /* 5+5+1 flops */
 410
 411     x[XX] = xi[XX] + d * rm[XX];
 412     x[YY] = xi[YY] + d * rm[YY];
 413     x[ZZ] = xi[ZZ] + d * rm[ZZ];
 414     /* 6 Flops */
 415
 416     /* TOTAL: 47 flops */
 417 }
 418
 419
 420 static int constr_vsiten(const t_iatom* ia, const t_iparams ip[], rvec* x, const t_pbc* pbc)
 421 {
 422     rvec x1, dx;
 423     dvec dsum;
 424     int  n3, av, ai;
 425     real a;
 426
 427     n3 = 3 * ip[ia[0]].vsiten.n;
 428     av = ia[1];
 429     ai = ia[2];
 430     copy_rvec(x[ai], x1);
 431     clear_dvec(dsum);
 432     for (int i = 3; i < n3; i += 3)
 433     {
 434         ai = ia[i + 2];
 435         a  = ip[ia[i]].vsiten.a;
 436         if (pbc)
 437         {
 438             pbc_dx_aiuc(pbc, x[ai], x1, dx);
 439         }
 440         else
 441         {
 442             rvec_sub(x[ai], x1, dx);
 443         }
 444         dsum[XX] += a * dx[XX];
 445         dsum[YY] += a * dx[YY];
 446         dsum[ZZ] += a * dx[ZZ];
 447         /* 9 Flops */
 448     }
 449
 450     x[av][XX] = x1[XX] + dsum[XX];
 451     x[av][YY] = x1[YY] + dsum[YY];
 452     x[av][ZZ] = x1[ZZ] + dsum[ZZ];
 453
 454     return n3;
 455 }
 456
 457 /*! \brief PBC modes for vsite construction and spreading */
 458 enum class PbcMode
 459 {
 460     all, // Apply normal, simple PBC for all vsites
 461     none // No PBC treatment needed
 462 };
 463
 464 /*! \brief Returns the PBC mode based on the system PBC and vsite properties
 465  *
 466  * \param[in] pbcPtr  A pointer to a PBC struct or nullptr when no PBC treatment is required
 467  */
 468 static PbcMode getPbcMode(const t_pbc* pbcPtr)
 469 {
 470     if (pbcPtr == nullptr)
 471     {
 472         return PbcMode::none;
 473     }
 474     else
 475     {
 476         return PbcMode::all;
 477     }
 478 }
 479
 480 static void construct_vsites_thread(rvec            x[],
 481                                     real            dt,
 482                                     rvec*           v,
 483                                     const t_iparams ip[],
 484                                     const t_ilist   ilist[],
 485                                     const t_pbc*    pbc_null)
 486 {
 487     real inv_dt;
 488     if (v != nullptr)
 489     {
 490         inv_dt = 1.0 / dt;
 491     }
 492     else
 493     {
 494         inv_dt = 1.0;
 495     }
 496
 497     const PbcMode pbcMode = getPbcMode(pbc_null);
 498     /* We need another pbc pointer, as with charge groups we switch per vsite */
 499     const t_pbc* pbc_null2 = pbc_null;
 500
 501     for (int ftype = c_ftypeVsiteStart; ftype < c_ftypeVsiteEnd; ftype++)
 502     {
 503         if (ilist[ftype].nr == 0)
 504         {
 505             continue;
 506         }
 507
 508         { // TODO remove me
 509             int nra = interaction_function[ftype].nratoms;
 510             int inc = 1 + nra;
 511             int nr  = ilist[ftype].nr;
 512
 513             const t_iatom* ia = ilist[ftype].iatoms;
 514
 515             for (int i = 0; i < nr;)
 516             {
 517                 int tp = ia[0];
 518                 /* The vsite and constructing atoms */
 519                 int avsite = ia[1];
 520                 int ai     = ia[2];
 521                 /* Constants for constructing vsites */
 522                 real a1 = ip[tp].vsite.a;
 523                 /* Copy the old position */
 524                 rvec xv;
 525                 copy_rvec(x[avsite], xv);
 526
 527                 /* Construct the vsite depending on type */
 528                 int  aj, ak, al;
 529                 real b1, c1;
 530                 switch (ftype)
 531                 {
 532                     case F_VSITE2:
 533                         aj = ia[3];
 534                         constr_vsite2(x[ai], x[aj], x[avsite], a1, pbc_null2);
 535                         break;
 536                     case F_VSITE2FD:
 537                         aj = ia[3];
 538                         constr_vsite2FD(x[ai], x[aj], x[avsite], a1, pbc_null2);
 539                         break;
 540                     case F_VSITE3:
 541                         aj = ia[3];
 542                         ak = ia[4];
 543                         b1 = ip[tp].vsite.b;
 544                         constr_vsite3(x[ai], x[aj], x[ak], x[avsite], a1, b1, pbc_null2);
 545                         break;
 546                     case F_VSITE3FD:
 547                         aj = ia[3];
 548                         ak = ia[4];
 549                         b1 = ip[tp].vsite.b;
 550                         constr_vsite3FD(x[ai], x[aj], x[ak], x[avsite], a1, b1, pbc_null2);
 551                         break;
 552                     case F_VSITE3FAD:
 553                         aj = ia[3];
 554                         ak = ia[4];
 555                         b1 = ip[tp].vsite.b;
 556                         constr_vsite3FAD(x[ai], x[aj], x[ak], x[avsite], a1, b1, pbc_null2);
 557                         break;
 558                     case F_VSITE3OUT:
 559                         aj = ia[3];
 560                         ak = ia[4];
 561                         b1 = ip[tp].vsite.b;
 562                         c1 = ip[tp].vsite.c;
 563                         constr_vsite3OUT(x[ai], x[aj], x[ak], x[avsite], a1, b1, c1, pbc_null2);
 564                         break;
 565                     case F_VSITE4FD:
 566                         aj = ia[3];
 567                         ak = ia[4];
 568                         al = ia[5];
 569                         b1 = ip[tp].vsite.b;
 570                         c1 = ip[tp].vsite.c;
 571                         constr_vsite4FD(x[ai], x[aj], x[ak], x[al], x[avsite], a1, b1, c1, pbc_null2);
 572                         break;
 573                     case F_VSITE4FDN:
 574                         aj = ia[3];
 575                         ak = ia[4];
 576                         al = ia[5];
 577                         b1 = ip[tp].vsite.b;
 578                         c1 = ip[tp].vsite.c;
 579                         constr_vsite4FDN(x[ai], x[aj], x[ak], x[al], x[avsite], a1, b1, c1, pbc_null2);
 580                         break;
 581                     case F_VSITEN: inc = constr_vsiten(ia, ip, x, pbc_null2); break;
 582                     default:
 583                         gmx_fatal(FARGS, "No such vsite type %d in %s, line %d", ftype, __FILE__, __LINE__);
 584                 }
 585
 586                 if (pbcMode == PbcMode::all)
 587                 {
 588                     /* Keep the vsite in the same periodic image as before */
 589                     rvec dx;
 590                     int  ishift = pbc_dx_aiuc(pbc_null, x[avsite], xv, dx);
 591                     if (ishift != CENTRAL)
 592                     {
 593                         rvec_add(xv, dx, x[avsite]);
 594                     }
 595                 }
 596                 if (v != nullptr)
 597                 {
 598                     /* Calculate velocity of vsite... */
 599                     rvec vv;
 600                     rvec_sub(x[avsite], xv, vv);
 601                     svmul(inv_dt, vv, v[avsite]);
 602                 }
 603
 604                 /* Increment loop variables */
 605                 i += inc;
 606                 ia += inc;
 607             }
 608         }
 609     }
 610 }
 611
 612 void construct_vsites(const gmx_vsite_t* vsite,
 613                       rvec               x[],
 614                       real               dt,
 615                       rvec*              v,
 616                       const t_iparams    ip[],
 617                       const t_ilist      ilist[],
 618                       int                ePBC,
 619                       gmx_bool           bMolPBC,
 620                       const t_commrec*   cr,
 621                       const matrix       box)
 622 {
 623     const bool useDomdec = (vsite != nullptr && vsite->useDomdec);
 624     GMX_ASSERT(!useDomdec || (cr != nullptr && DOMAINDECOMP(cr)),
 625                "When vsites are set up with domain decomposition, we need a valid commrec");
 626     // TODO: Remove this assertion when we remove charge groups
 627     GMX_ASSERT(vsite != nullptr || ePBC == epbcNONE,
 628                "Without a vsite struct we can not do PBC (in case we have charge groups)");
 629
 630     t_pbc pbc, *pbc_null;
 631
 632     /* We only need to do pbc when we have inter-cg vsites.
 633      * Note that with domain decomposition we do not need to apply PBC here
 634      * when we have at least 3 domains along each dimension. Currently we
 635      * do not optimize this case.
 636      */
 637     if (ePBC != epbcNONE && (useDomdec || bMolPBC)
 638         && !(vsite != nullptr && vsite->numInterUpdategroupVsites == 0))
 639     {
 640         /* This is wasting some CPU time as we now do this multiple times
 641          * per MD step.
 642          */
 643         ivec null_ivec;
 644         clear_ivec(null_ivec);
 645         pbc_null = set_pbc_dd(&pbc, ePBC, useDomdec ? cr->dd->numCells : null_ivec, FALSE, box);
 646     }
 647     else
 648     {
 649         pbc_null = nullptr;
 650     }
 651
 652     if (useDomdec)
 653     {
 654         dd_move_x_vsites(cr->dd, box, x);
 655     }
 656
 657     if (vsite == nullptr || vsite->nthreads == 1)
 658     {
 659         construct_vsites_thread(x, dt, v, ip, ilist, pbc_null);
 660     }
 661     else
 662     {
 663 #pragma omp parallel num_threads(vsite->nthreads)
 664         {
 665             try
 666             {
 667                 const int          th    = gmx_omp_get_thread_num();
 668                 const VsiteThread& tData = *vsite->tData[th];
 669                 GMX_ASSERT(tData.rangeStart >= 0,
 670                            "The thread data should be initialized before calling construct_vsites");
 671
 672                 construct_vsites_thread(x, dt, v, ip, tData.ilist, pbc_null);
 673                 if (tData.useInterdependentTask)
 674                 {
 675                     /* Here we don't need a barrier (unlike the spreading),
 676                      * since both tasks only construct vsites from particles,
 677                      * or local vsites, not from non-local vsites.
 678                      */
 679                     construct_vsites_thread(x, dt, v, ip, tData.idTask.ilist, pbc_null);
 680                 }
 681             }
 682             GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR
 683         }
 684         /* Now we can construct the vsites that might depend on other vsites */
 685         construct_vsites_thread(x, dt, v, ip, vsite->tData[vsite->nthreads]->ilist, pbc_null);
 686     }
 687 }
 688
 689 static void spread_vsite2(const t_iatom  ia[],
 690                           real           a,
 691                           const rvec     x[],
 692                           rvec           f[],
 693                           rvec           fshift[],
 694                           const t_pbc*   pbc,
 695                           const t_graph* g)
 696 {
 697     rvec    fi, fj, dx;
 698     t_iatom av, ai, aj;
 699     ivec    di;
 700     int     siv, sij;
 701
 702     av = ia[1];
 703     ai = ia[2];
 704     aj = ia[3];
 705
 706     svmul(1 - a, f[av], fi);
 707     svmul(a, f[av], fj);
 708     /* 7 flop */
 709
 710     rvec_inc(f[ai], fi);
 711     rvec_inc(f[aj], fj);
 712     /* 6 Flops */
 713
 714     if (g)
 715     {
 716         ivec_sub(SHIFT_IVEC(g, ai), SHIFT_IVEC(g, av), di);
 717         siv = IVEC2IS(di);
 718         ivec_sub(SHIFT_IVEC(g, ai), SHIFT_IVEC(g, aj), di);
 719         sij = IVEC2IS(di);
 720     }
 721     else if (pbc)
 722     {
 723         siv = pbc_dx_aiuc(pbc, x[ai], x[av], dx);
 724         sij = pbc_dx_aiuc(pbc, x[ai], x[aj], dx);
 725     }
 726     else
 727     {
 728         siv = CENTRAL;
 729         sij = CENTRAL;
 730     }
 731
 732     if (fshift && (siv != CENTRAL || sij != CENTRAL))
 733     {
 734         rvec_inc(fshift[siv], f[av]);
 735         rvec_dec(fshift[CENTRAL], fi);
 736         rvec_dec(fshift[sij], fj);
 737     }
 738
 739     /* TOTAL: 13 flops */
 740 }
 741
 742 void constructVsitesGlobal(const gmx_mtop_t& mtop, gmx::ArrayRef<gmx::RVec> x)
 743 {
 744     GMX_ASSERT(x.ssize() >= mtop.natoms, "x should contain the whole system");
 745     GMX_ASSERT(!mtop.moleculeBlockIndices.empty(),
 746                "molblock indices are needed in constructVsitesGlobal");
 747
 748     for (size_t mb = 0; mb < mtop.molblock.size(); mb++)
 749     {
 750         const gmx_molblock_t& molb = mtop.molblock[mb];
 751         const gmx_moltype_t&  molt = mtop.moltype[molb.type];
 752         if (vsiteIlistNrCount(molt.ilist.data()) > 0)
 753         {
 754             int atomOffset = mtop.moleculeBlockIndices[mb].globalAtomStart;
 755             for (int mol = 0; mol < molb.nmol; mol++)
 756             {
 757                 t_ilist ilist[F_NRE];
 758                 for (int ftype = c_ftypeVsiteStart; ftype < c_ftypeVsiteEnd; ftype++)
 759                 {
 760                     ilist[ftype].nr     = molt.ilist[ftype].size();
 761                     ilist[ftype].iatoms = const_cast<t_iatom*>(molt.ilist[ftype].iatoms.data());
 762                 }
 763
 764                 construct_vsites(nullptr, as_rvec_array(x.data()) + atomOffset, 0.0, nullptr,
 765                                  mtop.ffparams.iparams.data(), ilist, epbcNONE, TRUE, nullptr, nullptr);
 766                 atomOffset += molt.atoms.nr;
 767             }
 768         }
 769     }
 770 }
 771
 772 static void spread_vsite2FD(const t_iatom  ia[],
 773                             real           a,
 774                             const rvec     x[],
 775                             rvec           f[],
 776                             rvec           fshift[],
 777                             gmx_bool       VirCorr,
 778                             matrix         dxdf,
 779                             const t_pbc*   pbc,
 780                             const t_graph* g)
 781 {
 782     const int av = ia[1];
 783     const int ai = ia[2];
 784     const int aj = ia[3];
 785     rvec      fv;
 786     copy_rvec(f[av], fv);
 787
 788     rvec xij;
 789     int  sji = pbc_rvec_sub(pbc, x[aj], x[ai], xij);
 790     /* 6 flops */
 791
 792     const real invDistance = inverseNorm(xij);
 793     const real b           = a * invDistance;
 794     /* 4 + ?10? flops */
 795
 796     const real fproj = iprod(xij, fv) * invDistance * invDistance;
 797
 798     rvec fj;
 799     fj[XX] = b * (fv[XX] - fproj * xij[XX]);
 800     fj[YY] = b * (fv[YY] - fproj * xij[YY]);
 801     fj[ZZ] = b * (fv[ZZ] - fproj * xij[ZZ]);
 802     /* 9 */
 803
 804     /* b is already calculated in constr_vsite2FD
 805        storing b somewhere will save flops.     */
 806
 807     f[ai][XX] += fv[XX] - fj[XX];
 808     f[ai][YY] += fv[YY] - fj[YY];
 809     f[ai][ZZ] += fv[ZZ] - fj[ZZ];
 810     f[aj][XX] += fj[XX];
 811     f[aj][YY] += fj[YY];
 812     f[aj][ZZ] += fj[ZZ];
 813     /* 9 Flops */
 814
 815     if (fshift)
 816     {
 817         int svi;
 818         if (g)
 819         {
 820             ivec di;
 821             ivec_sub(SHIFT_IVEC(g, ia[1]), SHIFT_IVEC(g, ai), di);
 822             svi = IVEC2IS(di);
 823             ivec_sub(SHIFT_IVEC(g, aj), SHIFT_IVEC(g, ai), di);
 824             sji = IVEC2IS(di);
 825         }
 826         else if (pbc)
 827         {
 828             rvec xvi;
 829             svi = pbc_rvec_sub(pbc, x[av], x[ai], xvi);
 830         }
 831         else
 832         {
 833             svi = CENTRAL;
 834         }
 835
 836         if (svi != CENTRAL || sji != CENTRAL)
 837         {
 838             rvec_dec(fshift[svi], fv);
 839             fshift[CENTRAL][XX] += fv[XX] - fj[XX];
 840             fshift[CENTRAL][YY] += fv[YY] - fj[YY];
 841             fshift[CENTRAL][ZZ] += fv[ZZ] - fj[ZZ];
 842             fshift[sji][XX] += fj[XX];
 843             fshift[sji][YY] += fj[YY];
 844             fshift[sji][ZZ] += fj[ZZ];
 845         }
 846     }
 847
 848     if (VirCorr)
 849     {
 850         /* When VirCorr=TRUE, the virial for the current forces is not
 851          * calculated from the redistributed forces. This means that
 852          * the effect of non-linear virtual site constructions on the virial
 853          * needs to be added separately. This contribution can be calculated
 854          * in many ways, but the simplest and cheapest way is to use
 855          * the first constructing atom ai as a reference position in space:
 856          * subtract (xv-xi)*fv and add (xj-xi)*fj.
 857          */
 858         rvec xiv;
 859
 860         pbc_rvec_sub(pbc, x[av], x[ai], xiv);
 861
 862         for (int i = 0; i < DIM; i++)
 863         {
 864             for (int j = 0; j < DIM; j++)
 865             {
 866                 /* As xix is a linear combination of j and k, use that here */
 867                 dxdf[i][j] += -xiv[i] * fv[j] + xij[i] * fj[j];
 868             }
 869         }
 870     }
 871
 872     /* TOTAL: 38 flops */
 873 }
 874
 875 static void spread_vsite3(const t_iatom  ia[],
 876                           real           a,
 877                           real           b,
 878                           const rvec     x[],
 879                           rvec           f[],
 880                           rvec           fshift[],
 881                           const t_pbc*   pbc,
 882                           const t_graph* g)
 883 {
 884     rvec fi, fj, fk, dx;
 885     int  av, ai, aj, ak;
 886     ivec di;
 887     int  siv, sij, sik;
 888
 889     av = ia[1];
 890     ai = ia[2];
 891     aj = ia[3];
 892     ak = ia[4];
 893
 894     svmul(1 - a - b, f[av], fi);
 895     svmul(a, f[av], fj);
 896     svmul(b, f[av], fk);
 897     /* 11 flops */
 898
 899     rvec_inc(f[ai], fi);
 900     rvec_inc(f[aj], fj);
 901     rvec_inc(f[ak], fk);
 902     /* 9 Flops */
 903
 904     if (g)
 905     {
 906         ivec_sub(SHIFT_IVEC(g, ai), SHIFT_IVEC(g, ia[1]), di);
 907         siv = IVEC2IS(di);
 908         ivec_sub(SHIFT_IVEC(g, ai), SHIFT_IVEC(g, aj), di);
 909         sij = IVEC2IS(di);
 910         ivec_sub(SHIFT_IVEC(g, ai), SHIFT_IVEC(g, ak), di);
 911         sik = IVEC2IS(di);
 912     }
 913     else if (pbc)
 914     {
 915         siv = pbc_dx_aiuc(pbc, x[ai], x[av], dx);
 916         sij = pbc_dx_aiuc(pbc, x[ai], x[aj], dx);
 917         sik = pbc_dx_aiuc(pbc, x[ai], x[ak], dx);
 918     }
 919     else
 920     {
 921         siv = CENTRAL;
 922         sij = CENTRAL;
 923         sik = CENTRAL;
 924     }
 925
 926     if (fshift && (siv != CENTRAL || sij != CENTRAL || sik != CENTRAL))
 927     {
 928         rvec_inc(fshift[siv], f[av]);
 929         rvec_dec(fshift[CENTRAL], fi);
 930         rvec_dec(fshift[sij], fj);
 931         rvec_dec(fshift[sik], fk);
 932     }
 933
 934     /* TOTAL: 20 flops */
 935 }
 936
 937 static void spread_vsite3FD(const t_iatom  ia[],
 938                             real           a,
 939                             real           b,
 940                             const rvec     x[],
 941                             rvec           f[],
 942                             rvec           fshift[],
 943                             gmx_bool       VirCorr,
 944                             matrix         dxdf,
 945                             const t_pbc*   pbc,
 946                             const t_graph* g)
 947 {
 948     real    fproj, a1;
 949     rvec    xvi, xij, xjk, xix, fv, temp;
 950     t_iatom av, ai, aj, ak;
 951     int     svi, sji, skj;
 952     ivec    di;
 953
 954     av = ia[1];
 955     ai = ia[2];
 956     aj = ia[3];
 957     ak = ia[4];
 958     copy_rvec(f[av], fv);
 959
 960     sji = pbc_rvec_sub(pbc, x[aj], x[ai], xij);
 961     skj = pbc_rvec_sub(pbc, x[ak], x[aj], xjk);
 962     /* 6 flops */
 963
 964     /* xix goes from i to point x on the line jk */
 965     xix[XX] = xij[XX] + a * xjk[XX];
 966     xix[YY] = xij[YY] + a * xjk[YY];
 967     xix[ZZ] = xij[ZZ] + a * xjk[ZZ];
 968     /* 6 flops */
 969
 970     const real invDistance = inverseNorm(xix);
 971     const real c           = b * invDistance;
 972     /* 4 + ?10? flops */
 973
 974     fproj = iprod(xix, fv) * invDistance * invDistance; /* = (xix . f)/(xix . xix) */
 975
 976     temp[XX] = c * (fv[XX] - fproj * xix[XX]);
 977     temp[YY] = c * (fv[YY] - fproj * xix[YY]);
 978     temp[ZZ] = c * (fv[ZZ] - fproj * xix[ZZ]);
 979     /* 16 */
 980
 981     /* c is already calculated in constr_vsite3FD
 982        storing c somewhere will save 26 flops!     */
 983
 984     a1 = 1 - a;
 985     f[ai][XX] += fv[XX] - temp[XX];
 986     f[ai][YY] += fv[YY] - temp[YY];
 987     f[ai][ZZ] += fv[ZZ] - temp[ZZ];
 988     f[aj][XX] += a1 * temp[XX];
 989     f[aj][YY] += a1 * temp[YY];
 990     f[aj][ZZ] += a1 * temp[ZZ];
 991     f[ak][XX] += a * temp[XX];
 992     f[ak][YY] += a * temp[YY];
 993     f[ak][ZZ] += a * temp[ZZ];
 994     /* 19 Flops */
 995
 996     if (g)
 997     {
 998         ivec_sub(SHIFT_IVEC(g, ia[1]), SHIFT_IVEC(g, ai), di);
 999         svi = IVEC2IS(di);
1000         ivec_sub(SHIFT_IVEC(g, aj), SHIFT_IVEC(g, ai), di);
1001         sji = IVEC2IS(di);
1002         ivec_sub(SHIFT_IVEC(g, ak), SHIFT_IVEC(g, aj), di);
1003         skj = IVEC2IS(di);
1004     }
1005     else if (pbc)
1006     {
1007         svi = pbc_rvec_sub(pbc, x[av], x[ai], xvi);
1008     }
1009     else
1010     {
1011         svi = CENTRAL;
1012     }
1013
1014     if (fshift && (svi != CENTRAL || sji != CENTRAL || skj != CENTRAL))
1015     {
1016         rvec_dec(fshift[svi], fv);
1017         fshift[CENTRAL][XX] += fv[XX] - (1 + a) * temp[XX];
1018         fshift[CENTRAL][YY] += fv[YY] - (1 + a) * temp[YY];
1019         fshift[CENTRAL][ZZ] += fv[ZZ] - (1 + a) * temp[ZZ];
1020         fshift[sji][XX] += temp[XX];
1021         fshift[sji][YY] += temp[YY];
1022         fshift[sji][ZZ] += temp[ZZ];
1023         fshift[skj][XX] += a * temp[XX];
1024         fshift[skj][YY] += a * temp[YY];
1025         fshift[skj][ZZ] += a * temp[ZZ];
1026     }
1027
1028     if (VirCorr)
1029     {
1030         /* When VirCorr=TRUE, the virial for the current forces is not
1031          * calculated from the redistributed forces. This means that
1032          * the effect of non-linear virtual site constructions on the virial
1033          * needs to be added separately. This contribution can be calculated
1034          * in many ways, but the simplest and cheapest way is to use
1035          * the first constructing atom ai as a reference position in space:
1036          * subtract (xv-xi)*fv and add (xj-xi)*fj + (xk-xi)*fk.
1037          */
1038         rvec xiv;
1039
1040         pbc_rvec_sub(pbc, x[av], x[ai], xiv);
1041
1042         for (int i = 0; i < DIM; i++)
1043         {
1044             for (int j = 0; j < DIM; j++)
1045             {
1046                 /* As xix is a linear combination of j and k, use that here */
1047                 dxdf[i][j] += -xiv[i] * fv[j] + xix[i] * temp[j];
1048             }
1049         }
1050     }
1051
1052     /* TOTAL: 61 flops */
1053 }
1054
1055 static void spread_vsite3FAD(const t_iatom  ia[],
1056                              real           a,
1057                              real           b,
1058                              const rvec     x[],
1059                              rvec           f[],
1060                              rvec           fshift[],
1061                              gmx_bool       VirCorr,
1062                              matrix         dxdf,
1063                              const t_pbc*   pbc,
1064                              const t_graph* g)
1065 {
1066     rvec    xvi, xij, xjk, xperp, Fpij, Fppp, fv, f1, f2, f3;
1067     real    a1, b1, c1, c2, invdij, invdij2, invdp, fproj;
1068     t_iatom av, ai, aj, ak;
1069     int     svi, sji, skj, d;
1070     ivec    di;
1071
1072     av = ia[1];
1073     ai = ia[2];
1074     aj = ia[3];
1075     ak = ia[4];
1076     copy_rvec(f[ia[1]], fv);
1077
1078     sji = pbc_rvec_sub(pbc, x[aj], x[ai], xij);
1079     skj = pbc_rvec_sub(pbc, x[ak], x[aj], xjk);
1080     /* 6 flops */
1081
1082     invdij    = inverseNorm(xij);
1083     invdij2   = invdij * invdij;
1084     c1        = iprod(xij, xjk) * invdij2;
1085     xperp[XX] = xjk[XX] - c1 * xij[XX];
1086     xperp[YY] = xjk[YY] - c1 * xij[YY];
1087     xperp[ZZ] = xjk[ZZ] - c1 * xij[ZZ];
1088     /* xperp in plane ijk, perp. to ij */
1089     invdp = inverseNorm(xperp);
1090     a1    = a * invdij;
1091     b1    = b * invdp;
1092     /* 45 flops */
1093
1094     /* a1, b1 and c1 are already calculated in constr_vsite3FAD
1095        storing them somewhere will save 45 flops!     */
1096
1097     fproj = iprod(xij, fv) * invdij2;
1098     svmul(fproj, xij, Fpij);                              /* proj. f on xij */
1099     svmul(iprod(xperp, fv) * invdp * invdp, xperp, Fppp); /* proj. f on xperp */
1100     svmul(b1 * fproj, xperp, f3);
1101     /* 23 flops */
1102
1103     rvec_sub(fv, Fpij, f1); /* f1 = f - Fpij */
1104     rvec_sub(f1, Fppp, f2); /* f2 = f - Fpij - Fppp */
1105     for (d = 0; (d < DIM); d++)
1106     {
1107         f1[d] *= a1;
1108         f2[d] *= b1;
1109     }
1110     /* 12 flops */
1111
1112     c2 = 1 + c1;
1113     f[ai][XX] += fv[XX] - f1[XX] + c1 * f2[XX] + f3[XX];
1114     f[ai][YY] += fv[YY] - f1[YY] + c1 * f2[YY] + f3[YY];
1115     f[ai][ZZ] += fv[ZZ] - f1[ZZ] + c1 * f2[ZZ] + f3[ZZ];
1116     f[aj][XX] += f1[XX] - c2 * f2[XX] - f3[XX];
1117     f[aj][YY] += f1[YY] - c2 * f2[YY] - f3[YY];
1118     f[aj][ZZ] += f1[ZZ] - c2 * f2[ZZ] - f3[ZZ];
1119     f[ak][XX] += f2[XX];
1120     f[ak][YY] += f2[YY];
1121     f[ak][ZZ] += f2[ZZ];
1122     /* 30 Flops */
1123
1124     if (g)
1125     {
1126         ivec_sub(SHIFT_IVEC(g, ia[1]), SHIFT_IVEC(g, ai), di);
1127         svi = IVEC2IS(di);
1128         ivec_sub(SHIFT_IVEC(g, aj), SHIFT_IVEC(g, ai), di);
1129         sji = IVEC2IS(di);
1130         ivec_sub(SHIFT_IVEC(g, ak), SHIFT_IVEC(g, aj), di);
1131         skj = IVEC2IS(di);
1132     }
1133     else if (pbc)
1134     {
1135         svi = pbc_rvec_sub(pbc, x[av], x[ai], xvi);
1136     }
1137     else
1138     {
1139         svi = CENTRAL;
1140     }
1141
1142     if (fshift && (svi != CENTRAL || sji != CENTRAL || skj != CENTRAL))
1143     {
1144         rvec_dec(fshift[svi], fv);
1145         fshift[CENTRAL][XX] += fv[XX] - f1[XX] - (1 - c1) * f2[XX] + f3[XX];
1146         fshift[CENTRAL][YY] += fv[YY] - f1[YY] - (1 - c1) * f2[YY] + f3[YY];
1147         fshift[CENTRAL][ZZ] += fv[ZZ] - f1[ZZ] - (1 - c1) * f2[ZZ] + f3[ZZ];
1148         fshift[sji][XX] += f1[XX] - c1 * f2[XX] - f3[XX];
1149         fshift[sji][YY] += f1[YY] - c1 * f2[YY] - f3[YY];
1150         fshift[sji][ZZ] += f1[ZZ] - c1 * f2[ZZ] - f3[ZZ];
1151         fshift[skj][XX] += f2[XX];
1152         fshift[skj][YY] += f2[YY];
1153         fshift[skj][ZZ] += f2[ZZ];
1154     }
1155
1156     if (VirCorr)
1157     {
1158         rvec xiv;
1159         int  i, j;
1160
1161         pbc_rvec_sub(pbc, x[av], x[ai], xiv);
1162
1163         for (i = 0; i < DIM; i++)
1164         {
1165             for (j = 0; j < DIM; j++)
1166             {
1167                 /* Note that xik=xij+xjk, so we have to add xij*f2 */
1168                 dxdf[i][j] += -xiv[i] * fv[j] + xij[i] * (f1[j] + (1 - c2) * f2[j] - f3[j])
1169                               + xjk[i] * f2[j];
1170             }
1171         }
1172     }
1173
1174     /* TOTAL: 113 flops */
1175 }
1176
1177 static void spread_vsite3OUT(const t_iatom  ia[],
1178                              real           a,
1179                              real           b,
1180                              real           c,
1181                              const rvec     x[],
1182                              rvec           f[],
1183                              rvec           fshift[],
1184                              gmx_bool       VirCorr,
1185                              matrix         dxdf,
1186                              const t_pbc*   pbc,
1187                              const t_graph* g)
1188 {
1189     rvec xvi, xij, xik, fv, fj, fk;
1190     real cfx, cfy, cfz;
1191     int  av, ai, aj, ak;
1192     ivec di;
1193     int  svi, sji, ski;
1194
1195     av = ia[1];
1196     ai = ia[2];
1197     aj = ia[3];
1198     ak = ia[4];
1199
1200     sji = pbc_rvec_sub(pbc, x[aj], x[ai], xij);
1201     ski = pbc_rvec_sub(pbc, x[ak], x[ai], xik);
1202     /* 6 Flops */
1203
1204     copy_rvec(f[av], fv);
1205
1206     cfx = c * fv[XX];
1207     cfy = c * fv[YY];
1208     cfz = c * fv[ZZ];
1209     /* 3 Flops */
1210
1211     fj[XX] = a * fv[XX] - xik[ZZ] * cfy + xik[YY] * cfz;
1212     fj[YY] = xik[ZZ] * cfx + a * fv[YY] - xik[XX] * cfz;
1213     fj[ZZ] = -xik[YY] * cfx + xik[XX] * cfy + a * fv[ZZ];
1214
1215     fk[XX] = b * fv[XX] + xij[ZZ] * cfy - xij[YY] * cfz;
1216     fk[YY] = -xij[ZZ] * cfx + b * fv[YY] + xij[XX] * cfz;
1217     fk[ZZ] = xij[YY] * cfx - xij[XX] * cfy + b * fv[ZZ];
1218     /* 30 Flops */
1219
1220     f[ai][XX] += fv[XX] - fj[XX] - fk[XX];
1221     f[ai][YY] += fv[YY] - fj[YY] - fk[YY];
1222     f[ai][ZZ] += fv[ZZ] - fj[ZZ] - fk[ZZ];
1223     rvec_inc(f[aj], fj);
1224     rvec_inc(f[ak], fk);
1225     /* 15 Flops */
1226
1227     if (g)
1228     {
1229         ivec_sub(SHIFT_IVEC(g, ia[1]), SHIFT_IVEC(g, ai), di);
1230         svi = IVEC2IS(di);
1231         ivec_sub(SHIFT_IVEC(g, aj), SHIFT_IVEC(g, ai), di);
1232         sji = IVEC2IS(di);
1233         ivec_sub(SHIFT_IVEC(g, ak), SHIFT_IVEC(g, ai), di);
1234         ski = IVEC2IS(di);
1235     }
1236     else if (pbc)
1237     {
1238         svi = pbc_rvec_sub(pbc, x[av], x[ai], xvi);
1239     }
1240     else
1241     {
1242         svi = CENTRAL;
1243     }
1244
1245     if (fshift && (svi != CENTRAL || sji != CENTRAL || ski != CENTRAL))
1246     {
1247         rvec_dec(fshift[svi], fv);
1248         fshift[CENTRAL][XX] += fv[XX] - fj[XX] - fk[XX];
1249         fshift[CENTRAL][YY] += fv[YY] - fj[YY] - fk[YY];
1250         fshift[CENTRAL][ZZ] += fv[ZZ] - fj[ZZ] - fk[ZZ];
1251         rvec_inc(fshift[sji], fj);
1252         rvec_inc(fshift[ski], fk);
1253     }
1254
1255     if (VirCorr)
1256     {
1257         rvec xiv;
1258
1259         pbc_rvec_sub(pbc, x[av], x[ai], xiv);
1260
1261         for (int i = 0; i < DIM; i++)
1262         {
1263             for (int j = 0; j < DIM; j++)
1264             {
1265                 dxdf[i][j] += -xiv[i] * fv[j] + xij[i] * fj[j] + xik[i] * fk[j];
1266             }
1267         }
1268     }
1269
1270     /* TOTAL: 54 flops */
1271 }
1272
1273 static void spread_vsite4FD(const t_iatom  ia[],
1274                             real           a,
1275                             real           b,
1276                             real           c,
1277                             const rvec     x[],
1278                             rvec           f[],
1279                             rvec           fshift[],
1280                             gmx_bool       VirCorr,
1281                             matrix         dxdf,
1282                             const t_pbc*   pbc,
1283                             const t_graph* g)
1284 {
1285     real fproj, a1;
1286     rvec xvi, xij, xjk, xjl, xix, fv, temp;
1287     int  av, ai, aj, ak, al;
1288     ivec di;
1289     int  svi, sji, skj, slj, m;
1290
1291     av = ia[1];
1292     ai = ia[2];
1293     aj = ia[3];
1294     ak = ia[4];
1295     al = ia[5];
1296
1297     sji = pbc_rvec_sub(pbc, x[aj], x[ai], xij);
1298     skj = pbc_rvec_sub(pbc, x[ak], x[aj], xjk);
1299     slj = pbc_rvec_sub(pbc, x[al], x[aj], xjl);
1300     /* 9 flops */
1301
1302     /* xix goes from i to point x on the plane jkl */
1303     for (m = 0; m < DIM; m++)
1304     {
1305         xix[m] = xij[m] + a * xjk[m] + b * xjl[m];
1306     }
1307     /* 12 flops */
1308
1309     const real invDistance = inverseNorm(xix);
1310     const real d           = c * invDistance;
1311     /* 4 + ?10? flops */
1312
1313     copy_rvec(f[av], fv);
1314
1315     fproj = iprod(xix, fv) * invDistance * invDistance; /* = (xix . f)/(xix . xix) */
1316
1317     for (m = 0; m < DIM; m++)
1318     {
1319         temp[m] = d * (fv[m] - fproj * xix[m]);
1320     }
1321     /* 16 */
1322
1323     /* c is already calculated in constr_vsite3FD
1324        storing c somewhere will save 35 flops!     */
1325
1326     a1 = 1 - a - b;
1327     for (m = 0; m < DIM; m++)
1328     {
1329         f[ai][m] += fv[m] - temp[m];
1330         f[aj][m] += a1 * temp[m];
1331         f[ak][m] += a * temp[m];
1332         f[al][m] += b * temp[m];
1333     }
1334     /* 26 Flops */
1335
1336     if (g)
1337     {
1338         ivec_sub(SHIFT_IVEC(g, ia[1]), SHIFT_IVEC(g, ai), di);
1339         svi = IVEC2IS(di);
1340         ivec_sub(SHIFT_IVEC(g, aj), SHIFT_IVEC(g, ai), di);
1341         sji = IVEC2IS(di);
1342         ivec_sub(SHIFT_IVEC(g, ak), SHIFT_IVEC(g, aj), di);
1343         skj = IVEC2IS(di);
1344         ivec_sub(SHIFT_IVEC(g, al), SHIFT_IVEC(g, aj), di);
1345         slj = IVEC2IS(di);
1346     }
1347     else if (pbc)
1348     {
1349         svi = pbc_rvec_sub(pbc, x[av], x[ai], xvi);
1350     }
1351     else
1352     {
1353         svi = CENTRAL;
1354     }
1355
1356     if (fshift && (svi != CENTRAL || sji != CENTRAL || skj != CENTRAL || slj != CENTRAL))
1357     {
1358         rvec_dec(fshift[svi], fv);
1359         for (m = 0; m < DIM; m++)
1360         {
1361             fshift[CENTRAL][m] += fv[m] - (1 + a + b) * temp[m];
1362             fshift[sji][m] += temp[m];
1363             fshift[skj][m] += a * temp[m];
1364             fshift[slj][m] += b * temp[m];
1365         }
1366     }
1367
1368     if (VirCorr)
1369     {
1370         rvec xiv;
1371         int  i, j;
1372
1373         pbc_rvec_sub(pbc, x[av], x[ai], xiv);
1374
1375         for (i = 0; i < DIM; i++)
1376         {
1377             for (j = 0; j < DIM; j++)
1378             {
1379                 dxdf[i][j] += -xiv[i] * fv[j] + xix[i] * temp[j];
1380             }
1381         }
1382     }
1383
1384     /* TOTAL: 77 flops */
1385 }
1386
1387
1388 static void spread_vsite4FDN(const t_iatom  ia[],
1389                              real           a,
1390                              real           b,
1391                              real           c,
1392                              const rvec     x[],
1393                              rvec           f[],
1394                              rvec           fshift[],
1395                              gmx_bool       VirCorr,
1396                              matrix         dxdf,
1397                              const t_pbc*   pbc,
1398                              const t_graph* g)
1399 {
1400     rvec xvi, xij, xik, xil, ra, rb, rja, rjb, rab, rm, rt;
1401     rvec fv, fj, fk, fl;
1402     real invrm, denom;
1403     real cfx, cfy, cfz;
1404     ivec di;
1405     int  av, ai, aj, ak, al;
1406     int  svi, sij, sik, sil;
1407
1408     /* DEBUG: check atom indices */
1409     av = ia[1];
1410     ai = ia[2];
1411     aj = ia[3];
1412     ak = ia[4];
1413     al = ia[5];
1414
1415     copy_rvec(f[av], fv);
1416
1417     sij = pbc_rvec_sub(pbc, x[aj], x[ai], xij);
1418     sik = pbc_rvec_sub(pbc, x[ak], x[ai], xik);
1419     sil = pbc_rvec_sub(pbc, x[al], x[ai], xil);
1420     /* 9 flops */
1421
1422     ra[XX] = a * xik[XX];
1423     ra[YY] = a * xik[YY];
1424     ra[ZZ] = a * xik[ZZ];
1425
1426     rb[XX] = b * xil[XX];
1427     rb[YY] = b * xil[YY];
1428     rb[ZZ] = b * xil[ZZ];
1429
1430     /* 6 flops */
1431
1432     rvec_sub(ra, xij, rja);
1433     rvec_sub(rb, xij, rjb);
1434     rvec_sub(rb, ra, rab);
1435     /* 9 flops */
1436
1437     cprod(rja, rjb, rm);
1438     /* 9 flops */
1439
1440     invrm = inverseNorm(rm);
1441     denom = invrm * invrm;
1442     /* 5+5+2 flops */
1443
1444     cfx = c * invrm * fv[XX];
1445     cfy = c * invrm * fv[YY];
1446     cfz = c * invrm * fv[ZZ];
1447     /* 6 Flops */
1448
1449     cprod(rm, rab, rt);
1450     /* 9 flops */
1451
1452     rt[XX] *= denom;
1453     rt[YY] *= denom;
1454     rt[ZZ] *= denom;
1455     /* 3flops */
1456
1457     fj[XX] = (-rm[XX] * rt[XX]) * cfx + (rab[ZZ] - rm[YY] * rt[XX]) * cfy
1458              + (-rab[YY] - rm[ZZ] * rt[XX]) * cfz;
1459     fj[YY] = (-rab[ZZ] - rm[XX] * rt[YY]) * cfx + (-rm[YY] * rt[YY]) * cfy
1460              + (rab[XX] - rm[ZZ] * rt[YY]) * cfz;
1461     fj[ZZ] = (rab[YY] - rm[XX] * rt[ZZ]) * cfx + (-rab[XX] - rm[YY] * rt[ZZ]) * cfy
1462              + (-rm[ZZ] * rt[ZZ]) * cfz;
1463     /* 30 flops */
1464
1465     cprod(rjb, rm, rt);
1466     /* 9 flops */
1467
1468     rt[XX] *= denom * a;
1469     rt[YY] *= denom * a;
1470     rt[ZZ] *= denom * a;
1471     /* 3flops */
1472
1473     fk[XX] = (-rm[XX] * rt[XX]) * cfx + (-a * rjb[ZZ] - rm[YY] * rt[XX]) * cfy
1474              + (a * rjb[YY] - rm[ZZ] * rt[XX]) * cfz;
1475     fk[YY] = (a * rjb[ZZ] - rm[XX] * rt[YY]) * cfx + (-rm[YY] * rt[YY]) * cfy
1476              + (-a * rjb[XX] - rm[ZZ] * rt[YY]) * cfz;
1477     fk[ZZ] = (-a * rjb[YY] - rm[XX] * rt[ZZ]) * cfx + (a * rjb[XX] - rm[YY] * rt[ZZ]) * cfy
1478              + (-rm[ZZ] * rt[ZZ]) * cfz;
1479     /* 36 flops */
1480
1481     cprod(rm, rja, rt);
1482     /* 9 flops */
1483
1484     rt[XX] *= denom * b;
1485     rt[YY] *= denom * b;
1486     rt[ZZ] *= denom * b;
1487     /* 3flops */
1488
1489     fl[XX] = (-rm[XX] * rt[XX]) * cfx + (b * rja[ZZ] - rm[YY] * rt[XX]) * cfy
1490              + (-b * rja[YY] - rm[ZZ] * rt[XX]) * cfz;
1491     fl[YY] = (-b * rja[ZZ] - rm[XX] * rt[YY]) * cfx + (-rm[YY] * rt[YY]) * cfy
1492              + (b * rja[XX] - rm[ZZ] * rt[YY]) * cfz;
1493     fl[ZZ] = (b * rja[YY] - rm[XX] * rt[ZZ]) * cfx + (-b * rja[XX] - rm[YY] * rt[ZZ]) * cfy
1494              + (-rm[ZZ] * rt[ZZ]) * cfz;
1495     /* 36 flops */
1496
1497     f[ai][XX] += fv[XX] - fj[XX] - fk[XX] - fl[XX];
1498     f[ai][YY] += fv[YY] - fj[YY] - fk[YY] - fl[YY];
1499     f[ai][ZZ] += fv[ZZ] - fj[ZZ] - fk[ZZ] - fl[ZZ];
1500     rvec_inc(f[aj], fj);
1501     rvec_inc(f[ak], fk);
1502     rvec_inc(f[al], fl);
1503     /* 21 flops */
1504
1505     if (g)
1506     {
1507         ivec_sub(SHIFT_IVEC(g, av), SHIFT_IVEC(g, ai), di);
1508         svi = IVEC2IS(di);
1509         ivec_sub(SHIFT_IVEC(g, aj), SHIFT_IVEC(g, ai), di);
1510         sij = IVEC2IS(di);
1511         ivec_sub(SHIFT_IVEC(g, ak), SHIFT_IVEC(g, ai), di);
1512         sik = IVEC2IS(di);
1513         ivec_sub(SHIFT_IVEC(g, al), SHIFT_IVEC(g, ai), di);
1514         sil = IVEC2IS(di);
1515     }
1516     else if (pbc)
1517     {
1518         svi = pbc_rvec_sub(pbc, x[av], x[ai], xvi);
1519     }
1520     else
1521     {
1522         svi = CENTRAL;
1523     }
1524
1525     if (fshift && (svi != CENTRAL || sij != CENTRAL || sik != CENTRAL || sil != CENTRAL))
1526     {
1527         rvec_dec(fshift[svi], fv);
1528         fshift[CENTRAL][XX] += fv[XX] - fj[XX] - fk[XX] - fl[XX];
1529         fshift[CENTRAL][YY] += fv[YY] - fj[YY] - fk[YY] - fl[YY];
1530         fshift[CENTRAL][ZZ] += fv[ZZ] - fj[ZZ] - fk[ZZ] - fl[ZZ];
1531         rvec_inc(fshift[sij], fj);
1532         rvec_inc(fshift[sik], fk);
1533         rvec_inc(fshift[sil], fl);
1534     }
1535
1536     if (VirCorr)
1537     {
1538         rvec xiv;
1539         int  i, j;
1540
1541         pbc_rvec_sub(pbc, x[av], x[ai], xiv);
1542
1543         for (i = 0; i < DIM; i++)
1544         {
1545             for (j = 0; j < DIM; j++)
1546             {
1547                 dxdf[i][j] += -xiv[i] * fv[j] + xij[i] * fj[j] + xik[i] * fk[j] + xil[i] * fl[j];
1548             }
1549         }
1550     }
1551
1552     /* Total: 207 flops (Yuck!) */
1553 }
1554
1555
1556 static int spread_vsiten(const t_iatom   ia[],
1557                          const t_iparams ip[],
1558                          const rvec      x[],
1559                          rvec            f[],
1560                          rvec            fshift[],
1561                          const t_pbc*    pbc,
1562                          const t_graph*  g)
1563 {
1564     rvec xv, dx, fi;
1565     int  n3, av, i, ai;
1566     real a;
1567     ivec di;
1568     int  siv;
1569
1570     n3 = 3 * ip[ia[0]].vsiten.n;
1571     av = ia[1];
1572     copy_rvec(x[av], xv);
1573
1574     for (i = 0; i < n3; i += 3)
1575     {
1576         ai = ia[i + 2];
1577         if (g)
1578         {
1579             ivec_sub(SHIFT_IVEC(g, ai), SHIFT_IVEC(g, av), di);
1580             siv = IVEC2IS(di);
1581         }
1582         else if (pbc)
1583         {
1584             siv = pbc_dx_aiuc(pbc, x[ai], xv, dx);
1585         }
1586         else
1587         {
1588             siv = CENTRAL;
1589         }
1590         a = ip[ia[i]].vsiten.a;
1591         svmul(a, f[av], fi);
1592         rvec_inc(f[ai], fi);
1593         if (fshift && siv != CENTRAL)
1594         {
1595             rvec_inc(fshift[siv], fi);
1596             rvec_dec(fshift[CENTRAL], fi);
1597         }
1598         /* 6 Flops */
1599     }
1600
1601     return n3;
1602 }
1603
1604
1605 static int vsite_count(const t_ilist* ilist, int ftype)
1606 {
1607     if (ftype == F_VSITEN)
1608     {
1609         return ilist[ftype].nr / 3;
1610     }
1611     else
1612     {
1613         return ilist[ftype].nr / (1 + interaction_function[ftype].nratoms);
1614     }
1615 }
1616
1617 static void spread_vsite_f_thread(const rvec     x[],
1618                                   rvec           f[],
1619                                   rvec*          fshift,
1620                                   gmx_bool       VirCorr,
1621                                   matrix         dxdf,
1622                                   t_iparams      ip[],
1623                                   const t_ilist  ilist[],
1624                                   const t_graph* g,
1625                                   const t_pbc*   pbc_null)
1626 {
1627     const PbcMode pbcMode = getPbcMode(pbc_null);
1628     /* We need another pbc pointer, as with charge groups we switch per vsite */
1629     const t_pbc*             pbc_null2 = pbc_null;
1630     gmx::ArrayRef<const int> vsite_pbc;
1631
1632     /* this loop goes backwards to be able to build *
1633      * higher type vsites from lower types         */
1634     for (int ftype = c_ftypeVsiteEnd - 1; ftype >= c_ftypeVsiteStart; ftype--)
1635     {
1636         if (ilist[ftype].nr == 0)
1637         {
1638             continue;
1639         }
1640
1641         { // TODO remove me
1642             int nra = interaction_function[ftype].nratoms;
1643             int inc = 1 + nra;
1644             int nr  = ilist[ftype].nr;
1645
1646             const t_iatom* ia = ilist[ftype].iatoms;
1647
1648             if (pbcMode == PbcMode::all)
1649             {
1650                 pbc_null2 = pbc_null;
1651             }
1652
1653             for (int i = 0; i < nr;)
1654             {
1655                 int tp = ia[0];
1656
1657                 /* Constants for constructing */
1658                 real a1, b1, c1;
1659                 a1 = ip[tp].vsite.a;
1660                 /* Construct the vsite depending on type */
1661                 switch (ftype)
1662                 {
1663                     case F_VSITE2: spread_vsite2(ia, a1, x, f, fshift, pbc_null2, g); break;
1664                     case F_VSITE2FD:
1665                         spread_vsite2FD(ia, a1, x, f, fshift, VirCorr, dxdf, pbc_null2, g);
1666                         break;
1667                     case F_VSITE3:
1668                         b1 = ip[tp].vsite.b;
1669                         spread_vsite3(ia, a1, b1, x, f, fshift, pbc_null2, g);
1670                         break;
1671                     case F_VSITE3FD:
1672                         b1 = ip[tp].vsite.b;
1673                         spread_vsite3FD(ia, a1, b1, x, f, fshift, VirCorr, dxdf, pbc_null2, g);
1674                         break;
1675                     case F_VSITE3FAD:
1676                         b1 = ip[tp].vsite.b;
1677                         spread_vsite3FAD(ia, a1, b1, x, f, fshift, VirCorr, dxdf, pbc_null2, g);
1678                         break;
1679                     case F_VSITE3OUT:
1680                         b1 = ip[tp].vsite.b;
1681                         c1 = ip[tp].vsite.c;
1682                         spread_vsite3OUT(ia, a1, b1, c1, x, f, fshift, VirCorr, dxdf, pbc_null2, g);
1683                         break;
1684                     case F_VSITE4FD:
1685                         b1 = ip[tp].vsite.b;
1686                         c1 = ip[tp].vsite.c;
1687                         spread_vsite4FD(ia, a1, b1, c1, x, f, fshift, VirCorr, dxdf, pbc_null2, g);
1688                         break;
1689                     case F_VSITE4FDN:
1690                         b1 = ip[tp].vsite.b;
1691                         c1 = ip[tp].vsite.c;
1692                         spread_vsite4FDN(ia, a1, b1, c1, x, f, fshift, VirCorr, dxdf, pbc_null2, g);
1693                         break;
1694                     case F_VSITEN: inc = spread_vsiten(ia, ip, x, f, fshift, pbc_null2, g); break;
1695                     default:
1696                         gmx_fatal(FARGS, "No such vsite type %d in %s, line %d", ftype, __FILE__, __LINE__);
1697                 }
1698                 clear_rvec(f[ia[1]]);
1699
1700                 /* Increment loop variables */
1701                 i += inc;
1702                 ia += inc;
1703             }
1704         }
1705     }
1706 }
1707
1708 /*! \brief Clears the task force buffer elements that are written by task idTask */
1709 static void clearTaskForceBufferUsedElements(InterdependentTask* idTask)
1710 {
1711     int ntask = idTask->spreadTask.size();
1712     for (int ti = 0; ti < ntask; ti++)
1713     {
1714         const AtomIndex* atomList = &idTask->atomIndex[idTask->spreadTask[ti]];
1715         int              natom    = atomList->atom.size();
1716         RVec*            force    = idTask->force.data();
1717         for (int i = 0; i < natom; i++)
1718         {
1719             clear_rvec(force[atomList->atom[i]]);
1720         }
1721     }
1722 }
1723
1724 void spread_vsite_f(const gmx_vsite_t* vsite,
1725                     const rvec* gmx_restrict x,
1726                     rvec* gmx_restrict f,
1727                     rvec* gmx_restrict fshift,
1728                     gmx_bool           VirCorr,
1729                     matrix             vir,
1730                     t_nrnb*            nrnb,
1731                     const t_idef*      idef,
1732                     int                ePBC,
1733                     gmx_bool           bMolPBC,
1734                     const t_graph*     g,
1735                     const matrix       box,
1736                     const t_commrec*   cr,
1737                     gmx_wallcycle*     wcycle)
1738 {
1739     wallcycle_start(wcycle, ewcVSITESPREAD);
1740     const bool useDomdec = vsite->useDomdec;
1741     GMX_ASSERT(!useDomdec || (cr != nullptr && DOMAINDECOMP(cr)),
1742                "When vsites are set up with domain decomposition, we need a valid commrec");
1743
1744     t_pbc pbc, *pbc_null;
1745
1746     /* We only need to do pbc when we have inter-cg vsites */
1747     if ((useDomdec || bMolPBC) && vsite->numInterUpdategroupVsites)
1748     {
1749         /* This is wasting some CPU time as we now do this multiple times
1750          * per MD step.
1751          */
1752         pbc_null = set_pbc_dd(&pbc, ePBC, useDomdec ? cr->dd->numCells : nullptr, FALSE, box);
1753     }
1754     else
1755     {
1756         pbc_null = nullptr;
1757     }
1758
1759     if (useDomdec)
1760     {
1761         dd_clear_f_vsites(cr->dd, f);
1762     }
1763
1764     if (vsite->nthreads == 1)
1765     {
1766         matrix dxdf;
1767         if (VirCorr)
1768         {
1769             clear_mat(dxdf);
1770         }
1771         spread_vsite_f_thread(x, f, fshift, VirCorr, dxdf, idef->iparams, idef->il, g, pbc_null);
1772
1773         if (VirCorr)
1774         {
1775             for (int i = 0; i < DIM; i++)
1776             {
1777                 for (int j = 0; j < DIM; j++)
1778                 {
1779                     vir[i][j] += -0.5 * dxdf[i][j];
1780                 }
1781             }
1782         }
1783     }
1784     else
1785     {
1786         /* First spread the vsites that might depend on non-local vsites */
1787         if (VirCorr)
1788         {
1789             clear_mat(vsite->tData[vsite->nthreads]->dxdf);
1790         }
1791         spread_vsite_f_thread(x, f, fshift, VirCorr, vsite->tData[vsite->nthreads]->dxdf,
1792                               idef->iparams, vsite->tData[vsite->nthreads]->ilist, g, pbc_null);
1793
1794 #pragma omp parallel num_threads(vsite->nthreads)
1795         {
1796             try
1797             {
1798                 int          thread = gmx_omp_get_thread_num();
1799                 VsiteThread& tData  = *vsite->tData[thread];
1800
1801                 rvec* fshift_t;
1802                 if (thread == 0 || fshift == nullptr)
1803                 {
1804                     fshift_t = fshift;
1805                 }
1806                 else
1807                 {
1808                     fshift_t = tData.fshift;
1809
1810                     for (int i = 0; i < SHIFTS; i++)
1811                     {
1812                         clear_rvec(fshift_t[i]);
1813                     }
1814                 }
1815                 if (VirCorr)
1816                 {
1817                     clear_mat(tData.dxdf);
1818                 }
1819
1820                 if (tData.useInterdependentTask)
1821                 {
1822                     /* Spread the vsites that spread outside our local range.
1823                      * This is done using a thread-local force buffer force.
1824                      * First we need to copy the input vsite forces to force.
1825                      */
1826                     InterdependentTask* idTask = &tData.idTask;
1827
1828                     /* Clear the buffer elements set by our task during
1829                      * the last call to spread_vsite_f.
1830                      */
1831                     clearTaskForceBufferUsedElements(idTask);
1832
1833                     int nvsite = idTask->vsite.size();
1834                     for (int i = 0; i < nvsite; i++)
1835                     {
1836                         copy_rvec(f[idTask->vsite[i]], idTask->force[idTask->vsite[i]]);
1837                     }
1838                     spread_vsite_f_thread(x, as_rvec_array(idTask->force.data()), fshift_t, VirCorr,
1839                                           tData.dxdf, idef->iparams, tData.idTask.ilist, g, pbc_null);
1840
1841                     /* We need a barrier before reducing forces below
1842                      * that have been produced by a different thread above.
1843                      */
1844 #pragma omp barrier
1845
1846                     /* Loop over all thread task and reduce forces they
1847                      * produced on atoms that fall in our range.
1848                      * Note that atomic reduction would be a simpler solution,
1849                      * but that might not have good support on all platforms.
1850                      */
1851                     int ntask = idTask->reduceTask.size();
1852                     for (int ti = 0; ti < ntask; ti++)
1853                     {
1854                         const InterdependentTask* idt_foreign =
1855                                 &vsite->tData[idTask->reduceTask[ti]]->idTask;
1856                         const AtomIndex* atomList  = &idt_foreign->atomIndex[thread];
1857                         const RVec*      f_foreign = idt_foreign->force.data();
1858
1859                         int natom = atomList->atom.size();
1860                         for (int i = 0; i < natom; i++)
1861                         {
1862                             int ind = atomList->atom[i];
1863                             rvec_inc(f[ind], f_foreign[ind]);
1864                             /* Clearing of f_foreign is done at the next step */
1865                         }
1866                     }
1867                     /* Clear the vsite forces, both in f and force */
1868                     for (int i = 0; i < nvsite; i++)
1869                     {
1870                         int ind = tData.idTask.vsite[i];
1871                         clear_rvec(f[ind]);
1872                         clear_rvec(tData.idTask.force[ind]);
1873                     }
1874                 }
1875
1876                 /* Spread the vsites that spread locally only */
1877                 spread_vsite_f_thread(x, f, fshift_t, VirCorr, tData.dxdf, idef->iparams,
1878                                       tData.ilist, g, pbc_null);
1879             }
1880             GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR
1881         }
1882
1883         if (fshift != nullptr)
1884         {
1885             for (int th = 1; th < vsite->nthreads; th++)
1886             {
1887                 for (int i = 0; i < SHIFTS; i++)
1888                 {
1889                     rvec_inc(fshift[i], vsite->tData[th]->fshift[i]);
1890                 }
1891             }
1892         }
1893
1894         if (VirCorr)
1895         {
1896             for (int th = 0; th < vsite->nthreads + 1; th++)
1897             {
1898                 /* MSVC doesn't like matrix references, so we use a pointer */
1899                 const matrix* dxdf = &vsite->tData[th]->dxdf;
1900
1901                 for (int i = 0; i < DIM; i++)
1902                 {
1903                     for (int j = 0; j < DIM; j++)
1904                     {
1905                         vir[i][j] += -0.5 * (*dxdf)[i][j];
1906                     }
1907                 }
1908             }
1909         }
1910     }
1911
1912     if (useDomdec)
1913     {
1914         dd_move_f_vsites(cr->dd, f, fshift);
1915     }
1916
1917     inc_nrnb(nrnb, eNR_VSITE2, vsite_count(idef->il, F_VSITE2));
1918     inc_nrnb(nrnb, eNR_VSITE2FD, vsite_count(idef->il, F_VSITE2FD));
1919     inc_nrnb(nrnb, eNR_VSITE3, vsite_count(idef->il, F_VSITE3));
1920     inc_nrnb(nrnb, eNR_VSITE3FD, vsite_count(idef->il, F_VSITE3FD));
1921     inc_nrnb(nrnb, eNR_VSITE3FAD, vsite_count(idef->il, F_VSITE3FAD));
1922     inc_nrnb(nrnb, eNR_VSITE3OUT, vsite_count(idef->il, F_VSITE3OUT));
1923     inc_nrnb(nrnb, eNR_VSITE4FD, vsite_count(idef->il, F_VSITE4FD));
1924     inc_nrnb(nrnb, eNR_VSITE4FDN, vsite_count(idef->il, F_VSITE4FDN));
1925     inc_nrnb(nrnb, eNR_VSITEN, vsite_count(idef->il, F_VSITEN));
1926
1927     wallcycle_stop(wcycle, ewcVSITESPREAD);
1928 }
1929
1930 /*! \brief Returns the an array with group indices for each atom
1931  *
1932  * \param[in] grouping  The paritioning of the atom range into atom groups
1933  */
1934 static std::vector<int> makeAtomToGroupMapping(const gmx::RangePartitioning& grouping)
1935 {
1936     std::vector<int> atomToGroup(grouping.fullRange().end(), 0);
1937
1938     for (int group = 0; group < grouping.numBlocks(); group++)
1939     {
1940         auto block = grouping.block(group);
1941         std::fill(atomToGroup.begin() + block.begin(), atomToGroup.begin() + block.end(), group);
1942     }
1943
1944     return atomToGroup;
1945 }
1946
1947 int countNonlinearVsites(const gmx_mtop_t& mtop)
1948 {
1949     int numNonlinearVsites = 0;
1950     for (const gmx_molblock_t& molb : mtop.molblock)
1951     {
1952         const gmx_moltype_t& molt = mtop.moltype[molb.type];
1953
1954         for (const auto& ilist : extractILists(molt.ilist, IF_VSITE))
1955         {
1956             if (ilist.functionType != F_VSITE2 && ilist.functionType != F_VSITE3
1957                 && ilist.functionType != F_VSITEN)
1958             {
1959                 numNonlinearVsites += molb.nmol * ilist.iatoms.size() / (1 + NRAL(ilist.functionType));
1960             }
1961         }
1962     }
1963
1964     return numNonlinearVsites;
1965 }
1966
1967 int countInterUpdategroupVsites(const gmx_mtop_t&                           mtop,
1968                                 gmx::ArrayRef<const gmx::RangePartitioning> updateGroupingPerMoleculetype)
1969 {
1970     int n_intercg_vsite = 0;
1971     for (const gmx_molblock_t& molb : mtop.molblock)
1972     {
1973         const gmx_moltype_t& molt = mtop.moltype[molb.type];
1974
1975         std::vector<int> atomToGroup;
1976         if (!updateGroupingPerMoleculetype.empty())
1977         {
1978             atomToGroup = makeAtomToGroupMapping(updateGroupingPerMoleculetype[molb.type]);
1979         }
1980         for (int ftype = c_ftypeVsiteStart; ftype < c_ftypeVsiteEnd; ftype++)
1981         {
1982             const int              nral = NRAL(ftype);
1983             const InteractionList& il   = molt.ilist[ftype];
1984             for (int i = 0; i < il.size(); i += 1 + nral)
1985             {
1986                 bool isInterGroup = atomToGroup.empty();
1987                 if (!isInterGroup)
1988                 {
1989                     const int group = atomToGroup[il.iatoms[1 + i]];
1990                     for (int a = 1; a < nral; a++)
1991                     {
1992                         if (atomToGroup[il.iatoms[1 + a]] != group)
1993                         {
1994                             isInterGroup = true;
1995                             break;
1996                         }
1997                     }
1998                 }
1999                 if (isInterGroup)
2000                 {
2001                     n_intercg_vsite += molb.nmol;
2002                 }
2003             }
2004         }
2005     }
2006
2007     return n_intercg_vsite;
2008 }
2009
2010 std::unique_ptr<gmx_vsite_t> initVsite(const gmx_mtop_t& mtop, const t_commrec* cr)
2011 {
2012     GMX_RELEASE_ASSERT(cr != nullptr, "We need a valid commrec");
2013
2014     std::unique_ptr<gmx_vsite_t> vsite;
2015
2016     /* check if there are vsites */
2017     int nvsite = 0;
2018     for (int ftype = 0; ftype < F_NRE; ftype++)
2019     {
2020         if (interaction_function[ftype].flags & IF_VSITE)
2021         {
2022             GMX_ASSERT(ftype >= c_ftypeVsiteStart && ftype < c_ftypeVsiteEnd,
2023                        "c_ftypeVsiteStart and/or c_ftypeVsiteEnd do not have correct values");
2024
2025             nvsite += gmx_mtop_ftype_count(&mtop, ftype);
2026         }
2027         else
2028         {
2029             GMX_ASSERT(ftype < c_ftypeVsiteStart || ftype >= c_ftypeVsiteEnd,
2030                        "c_ftypeVsiteStart and/or c_ftypeVsiteEnd do not have correct values");
2031         }
2032     }
2033
2034     if (nvsite == 0)
2035     {
2036         return vsite;
2037     }
2038
2039     vsite = std::make_unique<gmx_vsite_t>();
2040
2041     gmx::ArrayRef<const gmx::RangePartitioning> updateGroupingPerMoleculetype;
2042     if (DOMAINDECOMP(cr))
2043     {
2044         updateGroupingPerMoleculetype = getUpdateGroupingPerMoleculetype(*cr->dd);
2045     }
2046     vsite->numInterUpdategroupVsites = countInterUpdategroupVsites(mtop, updateGroupingPerMoleculetype);
2047
2048     vsite->useDomdec = (DOMAINDECOMP(cr) && cr->dd->nnodes > 1);
2049
2050     vsite->nthreads = gmx_omp_nthreads_get(emntVSITE);
2051
2052     if (vsite->nthreads > 1)
2053     {
2054         /* We need one extra thread data structure for the overlap vsites */
2055         vsite->tData.resize(vsite->nthreads + 1);
2056 #pragma omp parallel for num_threads(vsite->nthreads) schedule(static)
2057         for (int thread = 0; thread < vsite->nthreads; thread++)
2058         {
2059             try
2060             {
2061                 vsite->tData[thread] = std::make_unique<VsiteThread>();
2062
2063                 InterdependentTask& idTask = vsite->tData[thread]->idTask;
2064                 idTask.nuse                = 0;
2065                 idTask.atomIndex.resize(vsite->nthreads);
2066             }
2067             GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR
2068         }
2069         if (vsite->nthreads > 1)
2070         {
2071             vsite->tData[vsite->nthreads] = std::make_unique<VsiteThread>();
2072         }
2073     }
2074
2075     return vsite;
2076 }
2077
2078 gmx_vsite_t::gmx_vsite_t() {}
2079
2080 gmx_vsite_t::~gmx_vsite_t() {}
2081
2082 static inline void flagAtom(InterdependentTask* idTask, int atom, int thread, int nthread, int natperthread)
2083 {
2084     if (!idTask->use[atom])
2085     {
2086         idTask->use[atom] = true;
2087         thread            = atom / natperthread;
2088         /* Assign all non-local atom force writes to thread 0 */
2089         if (thread >= nthread)
2090         {
2091             thread = 0;
2092         }
2093         idTask->atomIndex[thread].atom.push_back(atom);
2094     }
2095 }
2096
2097 /*\brief Here we try to assign all vsites that are in our local range.
2098  *
2099  * Our task local atom range is tData->rangeStart - tData->rangeEnd.
2100  * Vsites that depend only on local atoms, as indicated by taskIndex[]==thread,
2101  * are assigned to task tData->ilist. Vsites that depend on non-local atoms
2102  * but not on other vsites are assigned to task tData->id_task.ilist.
2103  * taskIndex[] is set for all vsites in our range, either to our local tasks
2104  * or to the single last task as taskIndex[]=2*nthreads.
2105  */
2106 static void assignVsitesToThread(VsiteThread*          tData,
2107                                  int                   thread,
2108                                  int                   nthread,
2109                                  int                   natperthread,
2110                                  gmx::ArrayRef<int>    taskIndex,
2111                                  const t_ilist*        ilist,
2112                                  const t_iparams*      ip,
2113                                  const unsigned short* ptype)
2114 {
2115     for (int ftype = c_ftypeVsiteStart; ftype < c_ftypeVsiteEnd; ftype++)
2116     {
2117         tData->ilist[ftype].nr        = 0;
2118         tData->idTask.ilist[ftype].nr = 0;
2119
2120         int      nral1 = 1 + NRAL(ftype);
2121         int      inc   = nral1;
2122         t_iatom* iat   = ilist[ftype].iatoms;
2123         for (int i = 0; i < ilist[ftype].nr;)
2124         {
2125             if (ftype == F_VSITEN)
2126             {
2127                 /* The 3 below is from 1+NRAL(ftype)=3 */
2128                 inc = ip[iat[i]].vsiten.n * 3;
2129             }
2130
2131             if (iat[1 + i] < tData->rangeStart || iat[1 + i] >= tData->rangeEnd)
2132             {
2133                 /* This vsite belongs to a different thread */
2134                 i += inc;
2135                 continue;
2136             }
2137
2138             /* We would like to assign this vsite to task thread,
2139              * but it might depend on atoms outside the atom range of thread
2140              * or on another vsite not assigned to task thread.
2141              */
2142             int task = thread;
2143             if (ftype != F_VSITEN)
2144             {
2145                 for (int j = i + 2; j < i + nral1; j++)
2146                 {
2147                     /* Do a range check to avoid a harmless race on taskIndex */
2148                     if (iat[j] < tData->rangeStart || iat[j] >= tData->rangeEnd || taskIndex[iat[j]] != thread)
2149                     {
2150                         if (!tData->useInterdependentTask || ptype[iat[j]] == eptVSite)
2151                         {
2152                             /* At least one constructing atom is a vsite
2153                              * that is not assigned to the same thread.
2154                              * Put this vsite into a separate task.
2155                              */
2156                             task = 2 * nthread;
2157                             break;
2158                         }
2159
2160                         /* There are constructing atoms outside our range,
2161                          * put this vsite into a second task to be executed
2162                          * on the same thread. During construction no barrier
2163                          * is needed between the two tasks on the same thread.
2164                          * During spreading we need to run this task with
2165                          * an additional thread-local intermediate force buffer
2166                          * (or atomic reduction) and a barrier between the two
2167                          * tasks.
2168                          */
2169                         task = nthread + thread;
2170                     }
2171                 }
2172             }
2173             else
2174             {
2175                 for (int j = i + 2; j < i + inc; j += 3)
2176                 {
2177                     /* Do a range check to avoid a harmless race on taskIndex */
2178                     if (iat[j] < tData->rangeStart || iat[j] >= tData->rangeEnd || taskIndex[iat[j]] != thread)
2179                     {
2180                         GMX_ASSERT(ptype[iat[j]] != eptVSite,
2181                                    "A vsite to be assigned in assignVsitesToThread has a vsite as "
2182                                    "a constructing atom that does not belong to our task, such "
2183                                    "vsites should be assigned to the single 'master' task");
2184
2185                         task = nthread + thread;
2186                     }
2187                 }
2188             }
2189
2190             /* Update this vsite's thread index entry */
2191             taskIndex[iat[1 + i]] = task;
2192
2193             if (task == thread || task == nthread + thread)
2194             {
2195                 /* Copy this vsite to the thread data struct of thread */
2196                 t_ilist* il_task;
2197                 if (task == thread)
2198                 {
2199                     il_task = &tData->ilist[ftype];
2200                 }
2201                 else
2202                 {
2203                     il_task = &tData->idTask.ilist[ftype];
2204                 }
2205                 /* Ensure we have sufficient memory allocated */
2206                 if (il_task->nr + inc > il_task->nalloc)
2207                 {
2208                     il_task->nalloc = over_alloc_large(il_task->nr + inc);
2209                     srenew(il_task->iatoms, il_task->nalloc);
2210                 }
2211                 /* Copy the vsite data to the thread-task local array */
2212                 for (int j = i; j < i + inc; j++)
2213                 {
2214                     il_task->iatoms[il_task->nr++] = iat[j];
2215                 }
2216                 if (task == nthread + thread)
2217                 {
2218                     /* This vsite write outside our own task force block.
2219                      * Put it into the interdependent task list and flag
2220                      * the atoms involved for reduction.
2221                      */
2222                     tData->idTask.vsite.push_back(iat[i + 1]);
2223                     if (ftype != F_VSITEN)
2224                     {
2225                         for (int j = i + 2; j < i + nral1; j++)
2226                         {
2227                             flagAtom(&tData->idTask, iat[j], thread, nthread, natperthread);
2228                         }
2229                     }
2230                     else
2231                     {
2232                         for (int j = i + 2; j < i + inc; j += 3)
2233                         {
2234                             flagAtom(&tData->idTask, iat[j], thread, nthread, natperthread);
2235                         }
2236                     }
2237                 }
2238             }
2239
2240             i += inc;
2241         }
2242     }
2243 }
2244
2245 /*! \brief Assign all vsites with taskIndex[]==task to task tData */
2246 static void assignVsitesToSingleTask(VsiteThread*             tData,
2247                                      int                      task,
2248                                      gmx::ArrayRef<const int> taskIndex,
2249                                      const t_ilist*           ilist,
2250                                      const t_iparams*         ip)
2251 {
2252     for (int ftype = c_ftypeVsiteStart; ftype < c_ftypeVsiteEnd; ftype++)
2253     {
2254         tData->ilist[ftype].nr        = 0;
2255         tData->idTask.ilist[ftype].nr = 0;
2256
2257         int      nral1   = 1 + NRAL(ftype);
2258         int      inc     = nral1;
2259         t_iatom* iat     = ilist[ftype].iatoms;
2260         t_ilist* il_task = &tData->ilist[ftype];
2261
2262         for (int i = 0; i < ilist[ftype].nr;)
2263         {
2264             if (ftype == F_VSITEN)
2265             {
2266                 /* The 3 below is from 1+NRAL(ftype)=3 */
2267                 inc = ip[iat[i]].vsiten.n * 3;
2268             }
2269             /* Check if the vsite is assigned to our task */
2270             if (taskIndex[iat[1 + i]] == task)
2271             {
2272                 /* Ensure we have sufficient memory allocated */
2273                 if (il_task->nr + inc > il_task->nalloc)
2274                 {
2275                     il_task->nalloc = over_alloc_large(il_task->nr + inc);
2276                     srenew(il_task->iatoms, il_task->nalloc);
2277                 }
2278                 /* Copy the vsite data to the thread-task local array */
2279                 for (int j = i; j < i + inc; j++)
2280                 {
2281                     il_task->iatoms[il_task->nr++] = iat[j];
2282                 }
2283             }
2284
2285             i += inc;
2286         }
2287     }
2288 }
2289
2290 void split_vsites_over_threads(const t_ilist* ilist, const t_iparams* ip, const t_mdatoms* mdatoms, gmx_vsite_t* vsite)
2291 {
2292     int vsite_atom_range, natperthread;
2293
2294     if (vsite->nthreads == 1)
2295     {
2296         /* Nothing to do */
2297         return;
2298     }
2299
2300     /* The current way of distributing the vsites over threads in primitive.
2301      * We divide the atom range 0 - natoms_in_vsite uniformly over threads,
2302      * without taking into account how the vsites are distributed.
2303      * Without domain decomposition we at least tighten the upper bound
2304      * of the range (useful for common systems such as a vsite-protein
2305      * in 3-site water).
2306      * With domain decomposition, as long as the vsites are distributed
2307      * uniformly in each domain along the major dimension, usually x,
2308      * it will also perform well.
2309      */
2310     if (!vsite->useDomdec)
2311     {
2312         vsite_atom_range = -1;
2313         for (int ftype = c_ftypeVsiteStart; ftype < c_ftypeVsiteEnd; ftype++)
2314         {
2315             { // TODO remove me
2316                 if (ftype != F_VSITEN)
2317                 {
2318                     int            nral1 = 1 + NRAL(ftype);
2319                     const t_iatom* iat   = ilist[ftype].iatoms;
2320                     for (int i = 0; i < ilist[ftype].nr; i += nral1)
2321                     {
2322                         for (int j = i + 1; j < i + nral1; j++)
2323                         {
2324                             vsite_atom_range = std::max(vsite_atom_range, iat[j]);
2325                         }
2326                     }
2327                 }
2328                 else
2329                 {
2330                     int vs_ind_end;
2331
2332                     const t_iatom* iat = ilist[ftype].iatoms;
2333
2334                     int i = 0;
2335                     while (i < ilist[ftype].nr)
2336                     {
2337                         /* The 3 below is from 1+NRAL(ftype)=3 */
2338                         vs_ind_end = i + ip[iat[i]].vsiten.n * 3;
2339
2340                         vsite_atom_range = std::max(vsite_atom_range, iat[i + 1]);
2341                         while (i < vs_ind_end)
2342                         {
2343                             vsite_atom_range = std::max(vsite_atom_range, iat[i + 2]);
2344                             i += 3;
2345                         }
2346                     }
2347                 }
2348             }
2349         }
2350         vsite_atom_range++;
2351         natperthread = (vsite_atom_range + vsite->nthreads - 1) / vsite->nthreads;
2352     }
2353     else
2354     {
2355         /* Any local or not local atom could be involved in virtual sites.
2356          * But since we usually have very few non-local virtual sites
2357          * (only non-local vsites that depend on local vsites),
2358          * we distribute the local atom range equally over the threads.
2359          * When assigning vsites to threads, we should take care that the last
2360          * threads also covers the non-local range.
2361          */
2362         vsite_atom_range = mdatoms->nr;
2363         natperthread     = (mdatoms->homenr + vsite->nthreads - 1) / vsite->nthreads;
2364     }
2365
2366     if (debug)
2367     {
2368         fprintf(debug, "virtual site thread dist: natoms %d, range %d, natperthread %d\n",
2369                 mdatoms->nr, vsite_atom_range, natperthread);
2370     }
2371
2372     /* To simplify the vsite assignment, we make an index which tells us
2373      * to which task particles, both non-vsites and vsites, are assigned.
2374      */
2375     vsite->taskIndex.resize(mdatoms->nr);
2376
2377     /* Initialize the task index array. Here we assign the non-vsite
2378      * particles to task=thread, so we easily figure out if vsites
2379      * depend on local and/or non-local particles in assignVsitesToThread.
2380      */
2381     gmx::ArrayRef<int> taskIndex = vsite->taskIndex;
2382     {
2383         int thread = 0;
2384         for (int i = 0; i < mdatoms->nr; i++)
2385         {
2386             if (mdatoms->ptype[i] == eptVSite)
2387             {
2388                 /* vsites are not assigned to a task yet */
2389                 taskIndex[i] = -1;
2390             }
2391             else
2392             {
2393                 /* assign non-vsite particles to task thread */
2394                 taskIndex[i] = thread;
2395             }
2396             if (i == (thread + 1) * natperthread && thread < vsite->nthreads)
2397             {
2398                 thread++;
2399             }
2400         }
2401     }
2402
2403 #pragma omp parallel num_threads(vsite->nthreads)
2404     {
2405         try
2406         {
2407             int          thread = gmx_omp_get_thread_num();
2408             VsiteThread& tData  = *vsite->tData[thread];
2409
2410             /* Clear the buffer use flags that were set before */
2411             if (tData.useInterdependentTask)
2412             {
2413                 InterdependentTask& idTask = tData.idTask;
2414
2415                 /* To avoid an extra OpenMP barrier in spread_vsite_f,
2416                  * we clear the force buffer at the next step,
2417                  * so we need to do it here as well.
2418                  */
2419                 clearTaskForceBufferUsedElements(&idTask);
2420
2421                 idTask.vsite.resize(0);
2422                 for (int t = 0; t < vsite->nthreads; t++)
2423                 {
2424                     AtomIndex& atomIndex = idTask.atomIndex[t];
2425                     int        natom     = atomIndex.atom.size();
2426                     for (int i = 0; i < natom; i++)
2427                     {
2428                         idTask.use[atomIndex.atom[i]] = false;
2429                     }
2430                     atomIndex.atom.resize(0);
2431                 }
2432                 idTask.nuse = 0;
2433             }
2434
2435             /* To avoid large f_buf allocations of #threads*vsite_atom_range
2436              * we don't use task2 with more than 200000 atoms. This doesn't
2437              * affect performance, since with such a large range relatively few
2438              * vsites will end up in the separate task.
2439              * Note that useTask2 should be the same for all threads.
2440              */
2441             tData.useInterdependentTask = (vsite_atom_range <= 200000);
2442             if (tData.useInterdependentTask)
2443             {
2444                 size_t              natoms_use_in_vsites = vsite_atom_range;
2445                 InterdependentTask& idTask               = tData.idTask;
2446                 /* To avoid resizing and re-clearing every nstlist steps,
2447                  * we never down size the force buffer.
2448                  */
2449                 if (natoms_use_in_vsites > idTask.force.size() || natoms_use_in_vsites > idTask.use.size())
2450                 {
2451                     idTask.force.resize(natoms_use_in_vsites, { 0, 0, 0 });
2452                     idTask.use.resize(natoms_use_in_vsites, false);
2453                 }
2454             }
2455
2456             /* Assign all vsites that can execute independently on threads */
2457             tData.rangeStart = thread * natperthread;
2458             if (thread < vsite->nthreads - 1)
2459             {
2460                 tData.rangeEnd = (thread + 1) * natperthread;
2461             }
2462             else
2463             {
2464                 /* The last thread should cover up to the end of the range */
2465                 tData.rangeEnd = mdatoms->nr;
2466             }
2467             assignVsitesToThread(&tData, thread, vsite->nthreads, natperthread, taskIndex, ilist,
2468                                  ip, mdatoms->ptype);
2469
2470             if (tData.useInterdependentTask)
2471             {
2472                 /* In the worst case, all tasks write to force ranges of
2473                  * all other tasks, leading to #tasks^2 scaling (this is only
2474                  * the overhead, the actual flops remain constant).
2475                  * But in most cases there is far less coupling. To improve
2476                  * scaling at high thread counts we therefore construct
2477                  * an index to only loop over the actually affected tasks.
2478                  */
2479                 InterdependentTask& idTask = tData.idTask;
2480
2481                 /* Ensure assignVsitesToThread finished on other threads */
2482 #pragma omp barrier
2483
2484                 idTask.spreadTask.resize(0);
2485                 idTask.reduceTask.resize(0);
2486                 for (int t = 0; t < vsite->nthreads; t++)
2487                 {
2488                     /* Do we write to the force buffer of task t? */
2489                     if (!idTask.atomIndex[t].atom.empty())
2490                     {
2491                         idTask.spreadTask.push_back(t);
2492                     }
2493                     /* Does task t write to our force buffer? */
2494                     if (!vsite->tData[t]->idTask.atomIndex[thread].atom.empty())
2495                     {
2496                         idTask.reduceTask.push_back(t);
2497                     }
2498                 }
2499             }
2500         }
2501         GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR
2502     }
2503     /* Assign all remaining vsites, that will have taskIndex[]=2*vsite->nthreads,
2504      * to a single task that will not run in parallel with other tasks.
2505      */
2506     assignVsitesToSingleTask(vsite->tData[vsite->nthreads].get(), 2 * vsite->nthreads, taskIndex,
2507                              ilist, ip);
2508
2509     if (debug && vsite->nthreads > 1)
2510     {
2511         fprintf(debug, "virtual site useInterdependentTask %d, nuse:\n",
2512                 static_cast<int>(vsite->tData[0]->useInterdependentTask));
2513         for (int th = 0; th < vsite->nthreads + 1; th++)
2514         {
2515             fprintf(debug, " %4d", vsite->tData[th]->idTask.nuse);
2516         }
2517         fprintf(debug, "\n");
2518
2519         for (int ftype = c_ftypeVsiteStart; ftype < c_ftypeVsiteEnd; ftype++)
2520         {
2521             if (ilist[ftype].nr > 0)
2522             {
2523                 fprintf(debug, "%-20s thread dist:", interaction_function[ftype].longname);
2524                 for (int th = 0; th < vsite->nthreads + 1; th++)
2525                 {
2526                     fprintf(debug, " %4d %4d ", vsite->tData[th]->ilist[ftype].nr,
2527                             vsite->tData[th]->idTask.ilist[ftype].nr);
2528                 }
2529                 fprintf(debug, "\n");
2530             }
2531         }
2532     }
2533
2534 #ifndef NDEBUG
2535     int nrOrig     = vsiteIlistNrCount(ilist);
2536     int nrThreaded = 0;
2537     for (int th = 0; th < vsite->nthreads + 1; th++)
2538     {
2539         nrThreaded += vsiteIlistNrCount(vsite->tData[th]->ilist)
2540                       + vsiteIlistNrCount(vsite->tData[th]->idTask.ilist);
2541     }
2542     GMX_ASSERT(nrThreaded == nrOrig,
2543                "The number of virtual sites assigned to all thread task has to match the total "
2544                "number of virtual sites");
2545 #endif
2546 }
2547
2548 void set_vsite_top(gmx_vsite_t* vsite, const gmx_localtop_t* top, const t_mdatoms* md)
2549 {
2550     if (vsite->nthreads > 1)
2551     {
2552         split_vsites_over_threads(top->idef.il, top->idef.iparams, md, vsite);
2553     }
2554 }