src/gromacs/domdec/domdec_topology.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2006 - 2014, The GROMACS development team.
   5  * Copyright (c) 2015,2016,2017,2018,2019, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36
  37 /*! \internal \file
  38  *
  39  * \brief This file defines functions used by the domdec module
  40  * while managing the construction, use and error checking for
  41  * topologies local to a DD rank.
  42  *
  43  * \author Berk Hess <hess@kth.se>
  44  * \ingroup module_domdec
  45  */
  46
  47 #include "gmxpre.h"
  48
  49 #include <cassert>
  50 #include <cstdlib>
  51 #include <cstring>
  52
  53 #include <algorithm>
  54 #include <memory>
  55 #include <string>
  56
  57 #include "gromacs/domdec/domdec.h"
  58 #include "gromacs/domdec/domdec_network.h"
  59 #include "gromacs/domdec/ga2la.h"
  60 #include "gromacs/gmxlib/chargegroup.h"
  61 #include "gromacs/gmxlib/network.h"
  62 #include "gromacs/math/vec.h"
  63 #include "gromacs/mdlib/forcerec.h"
  64 #include "gromacs/mdlib/gmx_omp_nthreads.h"
  65 #include "gromacs/mdtypes/commrec.h"
  66 #include "gromacs/mdtypes/inputrec.h"
  67 #include "gromacs/mdtypes/md_enums.h"
  68 #include "gromacs/mdtypes/mdatom.h"
  69 #include "gromacs/mdtypes/state.h"
  70 #include "gromacs/pbcutil/mshift.h"
  71 #include "gromacs/pbcutil/pbc.h"
  72 #include "gromacs/topology/ifunc.h"
  73 #include "gromacs/topology/mtop_util.h"
  74 #include "gromacs/topology/topsort.h"
  75 #include "gromacs/utility/cstringutil.h"
  76 #include "gromacs/utility/exceptions.h"
  77 #include "gromacs/utility/fatalerror.h"
  78 #include "gromacs/utility/gmxassert.h"
  79 #include "gromacs/utility/logger.h"
  80 #include "gromacs/utility/smalloc.h"
  81 #include "gromacs/utility/strconvert.h"
  82 #include "gromacs/utility/stringstream.h"
  83 #include "gromacs/utility/stringutil.h"
  84 #include "gromacs/utility/textwriter.h"
  85
  86 #include "domdec_constraints.h"
  87 #include "domdec_internal.h"
  88 #include "domdec_vsite.h"
  89 #include "dump.h"
  90
  91 /*! \brief The number of integer item in the local state, used for broadcasting of the state */
  92 #define NITEM_DD_INIT_LOCAL_STATE 5
  93
  94 struct reverse_ilist_t
  95 {
  96     std::vector<int> index;              /* Index for each atom into il          */
  97     std::vector<int> il;                 /* ftype|type|a0|...|an|ftype|...       */
  98     int              numAtomsInMolecule; /* The number of atoms in this molecule */
  99 };
 100
 101 struct MolblockIndices
 102 {
 103     int  a_start;
 104     int  a_end;
 105     int  natoms_mol;
 106     int  type;
 107 };
 108
 109 /*! \brief Struct for thread local work data for local topology generation */
 110 struct thread_work_t
 111 {
 112     t_idef                    idef;       /**< Partial local topology */
 113     std::unique_ptr<VsitePbc> vsitePbc;   /**< vsite PBC structure */
 114     int                       nbonded;    /**< The number of bondeds in this struct */
 115     t_blocka                  excl;       /**< List of exclusions */
 116     int                       excl_count; /**< The total exclusion count for \p excl */
 117 };
 118
 119 /*! \brief Struct for the reverse topology: links bonded interactions to atomsx */
 120 struct gmx_reverse_top_t
 121 {
 122     //! @cond Doxygen_Suppress
 123     //! \brief Do we require all exclusions to be assigned?
 124     bool                         bExclRequired = false;
 125     //! \brief The maximum number of exclusions one atom can have
 126     int                          n_excl_at_max = 0;
 127     //! \brief Are there constraints in this revserse top?
 128     bool                         bConstr = false;
 129     //! \brief Are there settles in this revserse top?
 130     bool                         bSettle = false;
 131     //! \brief All bonded interactions have to be assigned?
 132     bool                         bBCheck = false;
 133     //! \brief Are there bondeds/exclusions between charge-groups?
 134     bool                         bInterCGInteractions = false;
 135     //! \brief Reverse ilist for all moltypes
 136     std::vector<reverse_ilist_t> ril_mt;
 137     //! \brief The size of ril_mt[?].index summed over all entries
 138     int                          ril_mt_tot_size = 0;
 139     //! \brief The sorting state of bondeds for free energy
 140     int                          ilsort = ilsortUNKNOWN;
 141     //! \brief molblock to global atom index for quick lookup of molblocks on atom index
 142     std::vector<MolblockIndices> mbi;
 143
 144     //! \brief Do we have intermolecular interactions?
 145     bool             bIntermolecularInteractions = false;
 146     //! \brief Intermolecular reverse ilist
 147     reverse_ilist_t  ril_intermol;
 148
 149     /* Work data structures for multi-threading */
 150     //! \brief Thread work array for local topology generation
 151     std::vector<thread_work_t> th_work;
 152     //! @endcond
 153 };
 154
 155 /*! \brief Returns the number of atom entries for il in gmx_reverse_top_t */
 156 static int nral_rt(int ftype)
 157 {
 158     int nral;
 159
 160     nral = NRAL(ftype);
 161     if (interaction_function[ftype].flags & IF_VSITE)
 162     {
 163         /* With vsites the reverse topology contains an extra entry
 164          * for storing if constructing atoms are vsites.
 165          */
 166         nral += 1;
 167     }
 168
 169     return nral;
 170 }
 171
 172 /*! \brief Return whether interactions of type \p ftype need to be assigned exactly once */
 173 static gmx_bool dd_check_ftype(int ftype, gmx_bool bBCheck,
 174                                gmx_bool bConstr, gmx_bool bSettle)
 175 {
 176     return ((((interaction_function[ftype].flags & IF_BOND) != 0U) &&
 177              ((interaction_function[ftype].flags & IF_VSITE) == 0U) &&
 178              (bBCheck || ((interaction_function[ftype].flags & IF_LIMZERO) == 0U))) ||
 179             (bConstr && (ftype == F_CONSTR || ftype == F_CONSTRNC)) ||
 180             (bSettle && ftype == F_SETTLE));
 181 }
 182
 183 /*! \brief Help print error output when interactions are missing */
 184 static std::string
 185 print_missing_interactions_mb(t_commrec *cr,
 186                               const gmx_reverse_top_t *rt,
 187                               const char *moltypename,
 188                               const reverse_ilist_t *ril,
 189                               int a_start, int a_end,
 190                               int nat_mol, int nmol,
 191                               const t_idef *idef)
 192 {
 193     int                     *assigned;
 194     int                      nril_mol = ril->index[nat_mol];
 195     snew(assigned, nmol*nril_mol);
 196     gmx::StringOutputStream  stream;
 197     gmx::TextWriter          log(&stream);
 198
 199     gmx::ArrayRef<const int> gatindex = cr->dd->globalAtomIndices;
 200     for (int ftype = 0; ftype < F_NRE; ftype++)
 201     {
 202         if (dd_check_ftype(ftype, rt->bBCheck, rt->bConstr, rt->bSettle))
 203         {
 204             int            nral = NRAL(ftype);
 205             const t_ilist *il   = &idef->il[ftype];
 206             const t_iatom *ia   = il->iatoms;
 207             for (int i = 0; i < il->nr; i += 1+nral)
 208             {
 209                 int a0 = gatindex[ia[1]];
 210                 /* Check if this interaction is in
 211                  * the currently checked molblock.
 212                  */
 213                 if (a0 >= a_start && a0 < a_end)
 214                 {
 215                     int  mol    = (a0 - a_start)/nat_mol;
 216                     int  a0_mol = (a0 - a_start) - mol*nat_mol;
 217                     int  j_mol  = ril->index[a0_mol];
 218                     bool found  = false;
 219                     while (j_mol < ril->index[a0_mol+1] && !found)
 220                     {
 221                         int j       = mol*nril_mol + j_mol;
 222                         int ftype_j = ril->il[j_mol];
 223                         /* Here we need to check if this interaction has
 224                          * not already been assigned, since we could have
 225                          * multiply defined interactions.
 226                          */
 227                         if (ftype == ftype_j && ia[0] == ril->il[j_mol+1] &&
 228                             assigned[j] == 0)
 229                         {
 230                             /* Check the atoms */
 231                             found = true;
 232                             for (int a = 0; a < nral; a++)
 233                             {
 234                                 if (gatindex[ia[1+a]] !=
 235                                     a_start + mol*nat_mol + ril->il[j_mol+2+a])
 236                                 {
 237                                     found = false;
 238                                 }
 239                             }
 240                             if (found)
 241                             {
 242                                 assigned[j] = 1;
 243                             }
 244                         }
 245                         j_mol += 2 + nral_rt(ftype_j);
 246                     }
 247                     if (!found)
 248                     {
 249                         gmx_incons("Some interactions seem to be assigned multiple times");
 250                     }
 251                 }
 252                 ia += 1 + nral;
 253             }
 254         }
 255     }
 256
 257     gmx_sumi(nmol*nril_mol, assigned, cr);
 258
 259     int nprint = 10;
 260     int i      = 0;
 261     for (int mol = 0; mol < nmol; mol++)
 262     {
 263         int j_mol = 0;
 264         while (j_mol < nril_mol)
 265         {
 266             int ftype = ril->il[j_mol];
 267             int nral  = NRAL(ftype);
 268             int j     = mol*nril_mol + j_mol;
 269             if (assigned[j] == 0 &&
 270                 !(interaction_function[ftype].flags & IF_VSITE))
 271             {
 272                 if (DDMASTER(cr->dd))
 273                 {
 274                     if (i == 0)
 275                     {
 276                         log.writeLineFormatted("Molecule type '%s'", moltypename);
 277                         log.writeLineFormatted(
 278                                 "the first %d missing interactions, except for exclusions:", nprint);
 279                     }
 280                     log.writeStringFormatted("%20s atoms",
 281                                              interaction_function[ftype].longname);
 282                     int a;
 283                     for (a = 0; a < nral; a++)
 284                     {
 285                         log.writeStringFormatted("%5d", ril->il[j_mol+2+a]+1);
 286                     }
 287                     while (a < 4)
 288                     {
 289                         log.writeString("     ");
 290                         a++;
 291                     }
 292                     log.writeString(" global");
 293                     for (a = 0; a < nral; a++)
 294                     {
 295                         log.writeStringFormatted("%6d",
 296                                                  a_start+mol*nat_mol+ril->il[j_mol+2+a]+1);
 297                     }
 298                     log.ensureLineBreak();
 299                 }
 300                 i++;
 301                 if (i >= nprint)
 302                 {
 303                     break;
 304                 }
 305             }
 306             j_mol += 2 + nral_rt(ftype);
 307         }
 308     }
 309
 310     sfree(assigned);
 311     return stream.toString();
 312 }
 313
 314 /*! \brief Help print error output when interactions are missing */
 315 static void print_missing_interactions_atoms(const gmx::MDLogger &mdlog,
 316                                              t_commrec           *cr,
 317                                              const gmx_mtop_t    *mtop,
 318                                              const t_idef        *idef)
 319 {
 320     const gmx_reverse_top_t *rt = cr->dd->reverse_top;
 321
 322     /* Print the atoms in the missing interactions per molblock */
 323     int a_end = 0;
 324     for (const gmx_molblock_t &molb :  mtop->molblock)
 325     {
 326         const gmx_moltype_t &moltype  = mtop->moltype[molb.type];
 327         int                  a_start  = a_end;
 328         a_end                        = a_start + molb.nmol*moltype.atoms.nr;
 329
 330         GMX_LOG(mdlog.warning).appendText(
 331                 print_missing_interactions_mb(cr, rt,
 332                                               *(moltype.name),
 333                                               &rt->ril_mt[molb.type],
 334                                               a_start, a_end, moltype.atoms.nr,
 335                                               molb.nmol,
 336                                               idef));
 337     }
 338 }
 339
 340 void dd_print_missing_interactions(const gmx::MDLogger  &mdlog,
 341                                    t_commrec            *cr,
 342                                    int                   local_count,
 343                                    const gmx_mtop_t     *top_global,
 344                                    const gmx_localtop_t *top_local,
 345                                    const rvec           *x,
 346                                    const matrix          box)
 347 {
 348     int             ndiff_tot, cl[F_NRE], n, ndiff, rest_global, rest_local;
 349     int             ftype, nral;
 350     gmx_domdec_t   *dd;
 351
 352     dd = cr->dd;
 353
 354     GMX_LOG(mdlog.warning).appendText(
 355             "Not all bonded interactions have been properly assigned to the domain decomposition cells");
 356
 357     ndiff_tot = local_count - dd->nbonded_global;
 358
 359     for (ftype = 0; ftype < F_NRE; ftype++)
 360     {
 361         nral      = NRAL(ftype);
 362         cl[ftype] = top_local->idef.il[ftype].nr/(1+nral);
 363     }
 364
 365     gmx_sumi(F_NRE, cl, cr);
 366
 367     if (DDMASTER(dd))
 368     {
 369         GMX_LOG(mdlog.warning).appendText("A list of missing interactions:");
 370         rest_global = dd->nbonded_global;
 371         rest_local  = local_count;
 372         for (ftype = 0; ftype < F_NRE; ftype++)
 373         {
 374             /* In the reverse and local top all constraints are merged
 375              * into F_CONSTR. So in the if statement we skip F_CONSTRNC
 376              * and add these constraints when doing F_CONSTR.
 377              */
 378             if (((interaction_function[ftype].flags & IF_BOND) &&
 379                  (dd->reverse_top->bBCheck
 380                   || !(interaction_function[ftype].flags & IF_LIMZERO)))
 381                 || (dd->reverse_top->bConstr && ftype == F_CONSTR)
 382                 || (dd->reverse_top->bSettle && ftype == F_SETTLE))
 383             {
 384                 n    = gmx_mtop_ftype_count(top_global, ftype);
 385                 if (ftype == F_CONSTR)
 386                 {
 387                     n += gmx_mtop_ftype_count(top_global, F_CONSTRNC);
 388                 }
 389                 ndiff = cl[ftype] - n;
 390                 if (ndiff != 0)
 391                 {
 392                     GMX_LOG(mdlog.warning).appendTextFormatted(
 393                             "%20s of %6d missing %6d",
 394                             interaction_function[ftype].longname, n, -ndiff);
 395                 }
 396                 rest_global -= n;
 397                 rest_local  -= cl[ftype];
 398             }
 399         }
 400
 401         ndiff = rest_local - rest_global;
 402         if (ndiff != 0)
 403         {
 404             GMX_LOG(mdlog.warning).appendTextFormatted(
 405                     "%20s of %6d missing %6d", "exclusions",
 406                     rest_global, -ndiff);
 407         }
 408     }
 409
 410     print_missing_interactions_atoms(mdlog, cr, top_global, &top_local->idef);
 411     write_dd_pdb("dd_dump_err", 0, "dump", top_global, cr,
 412                  -1, x, box);
 413
 414     std::string errorMessage;
 415
 416     if (ndiff_tot > 0)
 417     {
 418         errorMessage = "One or more interactions were assigned to multiple domains of the domain decompostion. Please report this bug.";
 419     }
 420     else
 421     {
 422         errorMessage = gmx::formatString("%d of the %d bonded interactions could not be calculated because some atoms involved moved further apart than the multi-body cut-off distance (%g nm) or the two-body cut-off distance (%g nm), see option -rdd, for pairs and tabulated bonds also see option -ddcheck", -ndiff_tot, cr->dd->nbonded_global, dd_cutoff_multibody(dd), dd_cutoff_twobody(dd));
 423     }
 424     gmx_fatal_collective(FARGS, cr->mpi_comm_mygroup, MASTER(cr), "%s", errorMessage.c_str());
 425 }
 426
 427 /*! \brief Return global topology molecule information for global atom index \p i_gl */
 428 static void global_atomnr_to_moltype_ind(const gmx_reverse_top_t *rt,
 429                                          int i_gl,
 430                                          int *mb, int *mt, int *mol, int *i_mol)
 431 {
 432     const MolblockIndices *mbi   = rt->mbi.data();
 433     int                    start = 0;
 434     int                    end   = rt->mbi.size(); /* exclusive */
 435     int                    mid;
 436
 437     /* binary search for molblock_ind */
 438     while (TRUE)
 439     {
 440         mid = (start+end)/2;
 441         if (i_gl >= mbi[mid].a_end)
 442         {
 443             start = mid+1;
 444         }
 445         else if (i_gl < mbi[mid].a_start)
 446         {
 447             end = mid;
 448         }
 449         else
 450         {
 451             break;
 452         }
 453     }
 454
 455     *mb  = mid;
 456     mbi += mid;
 457
 458     *mt    = mbi->type;
 459     *mol   = (i_gl - mbi->a_start) / mbi->natoms_mol;
 460     *i_mol = (i_gl - mbi->a_start) - (*mol)*mbi->natoms_mol;
 461 }
 462
 463 /*! \brief Count the exclusions for all atoms in \p cgs */
 464 static void count_excls(const t_block *cgs, const t_blocka *excls,
 465                         int *n_excl, int *n_intercg_excl, int *n_excl_at_max)
 466 {
 467     int cg, at0, at1, at, excl, atj;
 468
 469     *n_excl         = 0;
 470     *n_intercg_excl = 0;
 471     *n_excl_at_max  = 0;
 472     for (cg = 0; cg < cgs->nr; cg++)
 473     {
 474         at0 = cgs->index[cg];
 475         at1 = cgs->index[cg+1];
 476         for (at = at0; at < at1; at++)
 477         {
 478             for (excl = excls->index[at]; excl < excls->index[at+1]; excl++)
 479             {
 480                 atj = excls->a[excl];
 481                 if (atj > at)
 482                 {
 483                     (*n_excl)++;
 484                     if (atj < at0 || atj >= at1)
 485                     {
 486                         (*n_intercg_excl)++;
 487                     }
 488                 }
 489             }
 490
 491             *n_excl_at_max = std::max(*n_excl_at_max,
 492                                       excls->index[at+1] - excls->index[at]);
 493         }
 494     }
 495 }
 496
 497 /*! \brief Run the reverse ilist generation and store it in r_il when \p bAssign = TRUE */
 498 static int low_make_reverse_ilist(const InteractionLists &il_mt,
 499                                   const t_atom *atom,
 500                                   int *count,
 501                                   gmx_bool bConstr, gmx_bool bSettle,
 502                                   gmx_bool bBCheck,
 503                                   gmx::ArrayRef<const int> r_index,
 504                                   gmx::ArrayRef<int>       r_il,
 505                                   gmx_bool bLinkToAllAtoms,
 506                                   gmx_bool bAssign)
 507 {
 508     int            ftype, j, nlink, link;
 509     int            a;
 510     int            nint;
 511
 512     nint = 0;
 513     for (ftype = 0; ftype < F_NRE; ftype++)
 514     {
 515         if ((interaction_function[ftype].flags & (IF_BOND | IF_VSITE)) ||
 516             (bConstr && (ftype == F_CONSTR || ftype == F_CONSTRNC)) ||
 517             (bSettle && ftype == F_SETTLE))
 518         {
 519             const bool  bVSite = ((interaction_function[ftype].flags & IF_VSITE) != 0U);
 520             const int   nral   = NRAL(ftype);
 521             const auto &il     = il_mt[ftype];
 522             for (int i = 0; i < il.size(); i += 1+nral)
 523             {
 524                 const int* ia = il.iatoms.data() + i;
 525                 if (bLinkToAllAtoms)
 526                 {
 527                     if (bVSite)
 528                     {
 529                         /* We don't need the virtual sites for the cg-links */
 530                         nlink = 0;
 531                     }
 532                     else
 533                     {
 534                         nlink = nral;
 535                     }
 536                 }
 537                 else
 538                 {
 539                     /* Couple to the first atom in the interaction */
 540                     nlink = 1;
 541                 }
 542                 for (link = 0; link < nlink; link++)
 543                 {
 544                     a = ia[1+link];
 545                     if (bAssign)
 546                     {
 547                         GMX_ASSERT(!r_il.empty(), "with bAssign not allowed to be empty");
 548                         GMX_ASSERT(!r_index.empty(), "with bAssign not allowed to be empty");
 549                         r_il[r_index[a]+count[a]] =
 550                             (ftype == F_CONSTRNC ? F_CONSTR : ftype);
 551                         r_il[r_index[a]+count[a]+1] = ia[0];
 552                         for (j = 1; j < 1+nral; j++)
 553                         {
 554                             /* Store the molecular atom number */
 555                             r_il[r_index[a]+count[a]+1+j] = ia[j];
 556                         }
 557                     }
 558                     if (interaction_function[ftype].flags & IF_VSITE)
 559                     {
 560                         if (bAssign)
 561                         {
 562                             /* Add an entry to iatoms for storing
 563                              * which of the constructing atoms are
 564                              * vsites again.
 565                              */
 566                             r_il[r_index[a]+count[a]+2+nral] = 0;
 567                             for (j = 2; j < 1+nral; j++)
 568                             {
 569                                 if (atom[ia[j]].ptype == eptVSite)
 570                                 {
 571                                     r_il[r_index[a]+count[a]+2+nral] |= (2<<j);
 572                                 }
 573                             }
 574                         }
 575                     }
 576                     else
 577                     {
 578                         /* We do not count vsites since they are always
 579                          * uniquely assigned and can be assigned
 580                          * to multiple nodes with recursive vsites.
 581                          */
 582                         if (bBCheck ||
 583                             !(interaction_function[ftype].flags & IF_LIMZERO))
 584                         {
 585                             nint++;
 586                         }
 587                     }
 588                     count[a] += 2 + nral_rt(ftype);
 589                 }
 590             }
 591         }
 592     }
 593
 594     return nint;
 595 }
 596
 597 /*! \brief Make the reverse ilist: a list of bonded interactions linked to atoms */
 598 static int make_reverse_ilist(const InteractionLists &ilist,
 599                               const t_atoms *atoms,
 600                               gmx_bool bConstr, gmx_bool bSettle,
 601                               gmx_bool bBCheck,
 602                               gmx_bool bLinkToAllAtoms,
 603                               reverse_ilist_t *ril_mt)
 604 {
 605     int nat_mt, *count, i, nint_mt;
 606
 607     /* Count the interactions */
 608     nat_mt = atoms->nr;
 609     snew(count, nat_mt);
 610     low_make_reverse_ilist(ilist, atoms->atom,
 611                            count,
 612                            bConstr, bSettle, bBCheck,
 613                            {}, {},
 614                            bLinkToAllAtoms, FALSE);
 615
 616     ril_mt->index.push_back(0);
 617     for (i = 0; i < nat_mt; i++)
 618     {
 619         ril_mt->index.push_back(ril_mt->index[i] + count[i]);
 620         count[i] = 0;
 621     }
 622     ril_mt->il.resize(ril_mt->index[nat_mt]);
 623
 624     /* Store the interactions */
 625     nint_mt =
 626         low_make_reverse_ilist(ilist, atoms->atom,
 627                                count,
 628                                bConstr, bSettle, bBCheck,
 629                                ril_mt->index, ril_mt->il,
 630                                bLinkToAllAtoms, TRUE);
 631
 632     sfree(count);
 633
 634     ril_mt->numAtomsInMolecule = atoms->nr;
 635
 636     return nint_mt;
 637 }
 638
 639 /*! \brief Generate the reverse topology */
 640 static gmx_reverse_top_t make_reverse_top(const gmx_mtop_t *mtop, gmx_bool bFE,
 641                                           gmx_bool bConstr, gmx_bool bSettle,
 642                                           gmx_bool bBCheck, int *nint)
 643 {
 644     gmx_reverse_top_t  rt;
 645
 646     /* Should we include constraints (for SHAKE) in rt? */
 647     rt.bConstr = bConstr;
 648     rt.bSettle = bSettle;
 649     rt.bBCheck = bBCheck;
 650
 651     rt.bInterCGInteractions = mtop->bIntermolecularInteractions;
 652     rt.ril_mt.resize(mtop->moltype.size());
 653     rt.ril_mt_tot_size = 0;
 654     std::vector<int> nint_mt;
 655     for (size_t mt = 0; mt < mtop->moltype.size(); mt++)
 656     {
 657         const gmx_moltype_t &molt = mtop->moltype[mt];
 658         if (molt.cgs.nr > 1)
 659         {
 660             rt.bInterCGInteractions = true;
 661         }
 662
 663         /* Make the atom to interaction list for this molecule type */
 664         int numberOfInteractions =
 665             make_reverse_ilist(molt.ilist, &molt.atoms,
 666                                rt.bConstr, rt.bSettle, rt.bBCheck, FALSE,
 667                                &rt.ril_mt[mt]);
 668         nint_mt.push_back(numberOfInteractions);
 669
 670         rt.ril_mt_tot_size += rt.ril_mt[mt].index[molt.atoms.nr];
 671     }
 672     if (debug)
 673     {
 674         fprintf(debug, "The total size of the atom to interaction index is %d integers\n", rt.ril_mt_tot_size);
 675     }
 676
 677     *nint = 0;
 678     for (const gmx_molblock_t &molblock : mtop->molblock)
 679     {
 680         *nint += molblock.nmol*nint_mt[molblock.type];
 681     }
 682
 683     /* Make an intermolecular reverse top, if necessary */
 684     rt.bIntermolecularInteractions = mtop->bIntermolecularInteractions;
 685     if (rt.bIntermolecularInteractions)
 686     {
 687         t_atoms atoms_global;
 688
 689         atoms_global.nr   = mtop->natoms;
 690         atoms_global.atom = nullptr; /* Only used with virtual sites */
 691
 692         GMX_RELEASE_ASSERT(mtop->intermolecular_ilist, "We should have an ilist when intermolecular interactions are on");
 693
 694         *nint +=
 695             make_reverse_ilist(*mtop->intermolecular_ilist,
 696                                &atoms_global,
 697                                rt.bConstr, rt.bSettle, rt.bBCheck, FALSE,
 698                                &rt.ril_intermol);
 699     }
 700
 701     if (bFE && gmx_mtop_bondeds_free_energy(mtop))
 702     {
 703         rt.ilsort = ilsortFE_UNSORTED;
 704     }
 705     else
 706     {
 707         rt.ilsort = ilsortNO_FE;
 708     }
 709
 710     /* Make a molblock index for fast searching */
 711     int i         = 0;
 712     for (size_t mb = 0; mb < mtop->molblock.size(); mb++)
 713     {
 714         const gmx_molblock_t &molb           = mtop->molblock[mb];
 715         const int             numAtomsPerMol = mtop->moltype[molb.type].atoms.nr;
 716         MolblockIndices       mbi;
 717         mbi.a_start                          = i;
 718         i                                   += molb.nmol*numAtomsPerMol;
 719         mbi.a_end                            = i;
 720         mbi.natoms_mol                       = numAtomsPerMol;
 721         mbi.type                             = molb.type;
 722         rt.mbi.push_back(mbi);
 723     }
 724
 725     rt.th_work.resize(gmx_omp_nthreads_get(emntDomdec));
 726
 727     return rt;
 728 }
 729
 730 void dd_make_reverse_top(FILE *fplog,
 731                          gmx_domdec_t *dd, const gmx_mtop_t *mtop,
 732                          const gmx_vsite_t *vsite,
 733                          const t_inputrec *ir, gmx_bool bBCheck)
 734 {
 735     if (fplog)
 736     {
 737         fprintf(fplog, "\nLinking all bonded interactions to atoms\n");
 738     }
 739
 740     /* If normal and/or settle constraints act only within charge groups,
 741      * we can store them in the reverse top and simply assign them to domains.
 742      * Otherwise we need to assign them to multiple domains and set up
 743      * the parallel version constraint algorithm(s).
 744      */
 745
 746     dd->reverse_top  = new gmx_reverse_top_t;
 747     *dd->reverse_top =
 748         make_reverse_top(mtop, ir->efep != efepNO,
 749                          !dd->comm->systemInfo.haveSplitConstraints,
 750                          !dd->comm->systemInfo.haveSplitSettles,
 751                          bBCheck, &dd->nbonded_global);
 752
 753     gmx_reverse_top_t *rt = dd->reverse_top;
 754
 755     /* With the Verlet scheme, exclusions are handled in the non-bonded
 756      * kernels and only exclusions inside the cut-off lead to exclusion
 757      * forces. Since each atom pair is treated at most once in the non-bonded
 758      * kernels, it doesn't matter if the exclusions for the same atom pair
 759      * appear multiple times in the exclusion list.
 760      */
 761     rt->bExclRequired = (ir->cutoff_scheme == ecutsGROUP &&
 762                          inputrecExclForces(ir));
 763
 764     int nexcl          = 0;
 765     dd->n_intercg_excl = 0;
 766     rt->n_excl_at_max  = 0;
 767     for (const gmx_molblock_t &molb : mtop->molblock)
 768     {
 769         int                  n_excl_mol, n_excl_icg, n_excl_at_max;
 770
 771         const gmx_moltype_t &molt = mtop->moltype[molb.type];
 772         count_excls(&molt.cgs, &molt.excls,
 773                     &n_excl_mol, &n_excl_icg, &n_excl_at_max);
 774         nexcl              += molb.nmol*n_excl_mol;
 775         dd->n_intercg_excl += molb.nmol*n_excl_icg;
 776         rt->n_excl_at_max   = std::max(rt->n_excl_at_max, n_excl_at_max);
 777     }
 778     if (rt->bExclRequired)
 779     {
 780         dd->nbonded_global += nexcl;
 781         if (EEL_FULL(ir->coulombtype) && dd->n_intercg_excl > 0 && fplog)
 782         {
 783             fprintf(fplog, "There are %d inter charge-group exclusions,\n"
 784                     "will use an extra communication step for exclusion forces for %s\n",
 785                     dd->n_intercg_excl, eel_names[ir->coulombtype]);
 786         }
 787     }
 788
 789     if (vsite && vsite->numInterUpdategroupVsites > 0)
 790     {
 791         if (fplog)
 792         {
 793             fprintf(fplog, "There are %d inter update-group virtual sites,\n"
 794                     "will an extra communication step for selected coordinates and forces\n",
 795                     vsite->numInterUpdategroupVsites);
 796         }
 797         init_domdec_vsites(dd, vsite->numInterUpdategroupVsites);
 798     }
 799
 800     if (dd->comm->systemInfo.haveSplitConstraints || dd->comm->systemInfo.haveSplitSettles)
 801     {
 802         init_domdec_constraints(dd, mtop);
 803     }
 804     if (fplog)
 805     {
 806         fprintf(fplog, "\n");
 807     }
 808 }
 809
 810 /*! \brief Store a vsite interaction at the end of \p il
 811  *
 812  * This routine is very similar to add_ifunc, but vsites interactions
 813  * have more work to do than other kinds of interactions, and the
 814  * complex way nral (and thus vector contents) depends on ftype
 815  * confuses static analysis tools unless we fuse the vsite
 816  * atom-indexing organization code with the ifunc-adding code, so that
 817  * they can see that nral is the same value. */
 818 static inline void
 819 add_ifunc_for_vsites(t_iatom *tiatoms, const gmx_ga2la_t &ga2la,
 820                      int nral, gmx_bool bHomeA,
 821                      int a, int a_gl, int a_mol,
 822                      const t_iatom *iatoms,
 823                      t_ilist *il)
 824 {
 825     t_iatom *liatoms;
 826
 827     if (il->nr+1+nral > il->nalloc)
 828     {
 829         il->nalloc = over_alloc_large(il->nr+1+nral);
 830         srenew(il->iatoms, il->nalloc);
 831     }
 832     liatoms = il->iatoms + il->nr;
 833     il->nr += 1 + nral;
 834
 835     /* Copy the type */
 836     tiatoms[0] = iatoms[0];
 837
 838     if (bHomeA)
 839     {
 840         /* We know the local index of the first atom */
 841         tiatoms[1] = a;
 842     }
 843     else
 844     {
 845         /* Convert later in make_local_vsites */
 846         tiatoms[1] = -a_gl - 1;
 847     }
 848
 849     for (int k = 2; k < 1+nral; k++)
 850     {
 851         int ak_gl = a_gl + iatoms[k] - a_mol;
 852         if (const int *homeIndex = ga2la.findHome(ak_gl))
 853         {
 854             tiatoms[k] = *homeIndex;
 855         }
 856         else
 857         {
 858             /* Copy the global index, convert later in make_local_vsites */
 859             tiatoms[k] = -(ak_gl + 1);
 860         }
 861         // Note that ga2la_get_home always sets the third parameter if
 862         // it returns TRUE
 863     }
 864     for (int k = 0; k < 1+nral; k++)
 865     {
 866         liatoms[k] = tiatoms[k];
 867     }
 868 }
 869
 870 /*! \brief Store a bonded interaction at the end of \p il */
 871 static inline void add_ifunc(int nral, const t_iatom *tiatoms, t_ilist *il)
 872 {
 873     t_iatom *liatoms;
 874     int      k;
 875
 876     if (il->nr+1+nral > il->nalloc)
 877     {
 878         il->nalloc = over_alloc_large(il->nr+1+nral);
 879         srenew(il->iatoms, il->nalloc);
 880     }
 881     liatoms = il->iatoms + il->nr;
 882     for (k = 0; k <= nral; k++)
 883     {
 884         liatoms[k] = tiatoms[k];
 885     }
 886     il->nr += 1 + nral;
 887 }
 888
 889 /*! \brief Store a position restraint in idef and iatoms, complex because the parameters are different for each entry */
 890 static void add_posres(int mol, int a_mol, int numAtomsInMolecule,
 891                        const gmx_molblock_t *molb,
 892                        t_iatom *iatoms, const t_iparams *ip_in,
 893                        t_idef *idef)
 894 {
 895     int        n, a_molb;
 896     t_iparams *ip;
 897
 898     /* This position restraint has not been added yet,
 899      * so it's index is the current number of position restraints.
 900      */
 901     n = idef->il[F_POSRES].nr/2;
 902     if (n+1 > idef->iparams_posres_nalloc)
 903     {
 904         idef->iparams_posres_nalloc = over_alloc_dd(n+1);
 905         srenew(idef->iparams_posres, idef->iparams_posres_nalloc);
 906     }
 907     ip = &idef->iparams_posres[n];
 908     /* Copy the force constants */
 909     *ip = ip_in[iatoms[0]];
 910
 911     /* Get the position restraint coordinates from the molblock */
 912     a_molb = mol*numAtomsInMolecule + a_mol;
 913     GMX_ASSERT(a_molb < ssize(molb->posres_xA), "We need a sufficient number of position restraint coordinates");
 914     ip->posres.pos0A[XX] = molb->posres_xA[a_molb][XX];
 915     ip->posres.pos0A[YY] = molb->posres_xA[a_molb][YY];
 916     ip->posres.pos0A[ZZ] = molb->posres_xA[a_molb][ZZ];
 917     if (!molb->posres_xB.empty())
 918     {
 919         ip->posres.pos0B[XX] = molb->posres_xB[a_molb][XX];
 920         ip->posres.pos0B[YY] = molb->posres_xB[a_molb][YY];
 921         ip->posres.pos0B[ZZ] = molb->posres_xB[a_molb][ZZ];
 922     }
 923     else
 924     {
 925         ip->posres.pos0B[XX] = ip->posres.pos0A[XX];
 926         ip->posres.pos0B[YY] = ip->posres.pos0A[YY];
 927         ip->posres.pos0B[ZZ] = ip->posres.pos0A[ZZ];
 928     }
 929     /* Set the parameter index for idef->iparams_posre */
 930     iatoms[0] = n;
 931 }
 932
 933 /*! \brief Store a flat-bottomed position restraint in idef and iatoms, complex because the parameters are different for each entry */
 934 static void add_fbposres(int mol, int a_mol, int numAtomsInMolecule,
 935                          const gmx_molblock_t *molb,
 936                          t_iatom *iatoms, const t_iparams *ip_in,
 937                          t_idef *idef)
 938 {
 939     int        n, a_molb;
 940     t_iparams *ip;
 941
 942     /* This flat-bottom position restraint has not been added yet,
 943      * so it's index is the current number of position restraints.
 944      */
 945     n = idef->il[F_FBPOSRES].nr/2;
 946     if (n+1 > idef->iparams_fbposres_nalloc)
 947     {
 948         idef->iparams_fbposres_nalloc = over_alloc_dd(n+1);
 949         srenew(idef->iparams_fbposres, idef->iparams_fbposres_nalloc);
 950     }
 951     ip = &idef->iparams_fbposres[n];
 952     /* Copy the force constants */
 953     *ip = ip_in[iatoms[0]];
 954
 955     /* Get the position restraint coordinats from the molblock */
 956     a_molb = mol*numAtomsInMolecule + a_mol;
 957     GMX_ASSERT(a_molb < ssize(molb->posres_xA), "We need a sufficient number of position restraint coordinates");
 958     /* Take reference positions from A position of normal posres */
 959     ip->fbposres.pos0[XX] = molb->posres_xA[a_molb][XX];
 960     ip->fbposres.pos0[YY] = molb->posres_xA[a_molb][YY];
 961     ip->fbposres.pos0[ZZ] = molb->posres_xA[a_molb][ZZ];
 962
 963     /* Note: no B-type for flat-bottom posres */
 964
 965     /* Set the parameter index for idef->iparams_posre */
 966     iatoms[0] = n;
 967 }
 968
 969 /*! \brief Store a virtual site interaction, complex because of PBC and recursion */
 970 static void add_vsite(const gmx_ga2la_t &ga2la,
 971                       gmx::ArrayRef<const int> index,
 972                       gmx::ArrayRef<const int> rtil,
 973                       int ftype, int nral,
 974                       gmx_bool bHomeA, int a, int a_gl, int a_mol,
 975                       const t_iatom *iatoms,
 976                       t_idef *idef)
 977 {
 978     int     k;
 979     t_iatom tiatoms[1+MAXATOMLIST];
 980     int     j, ftype_r, nral_r;
 981
 982     /* Add this interaction to the local topology */
 983     add_ifunc_for_vsites(tiatoms, ga2la, nral, bHomeA, a, a_gl, a_mol, iatoms, &idef->il[ftype]);
 984
 985     if (iatoms[1+nral])
 986     {
 987         /* Check for recursion */
 988         for (k = 2; k < 1+nral; k++)
 989         {
 990             if ((iatoms[1+nral] & (2<<k)) && (tiatoms[k] < 0))
 991             {
 992                 /* This construction atoms is a vsite and not a home atom */
 993                 if (gmx_debug_at)
 994                 {
 995                     fprintf(debug, "Constructing atom %d of vsite atom %d is a vsite and non-home\n", iatoms[k]+1, a_mol+1);
 996                 }
 997                 /* Find the vsite construction */
 998
 999                 /* Check all interactions assigned to this atom */
1000                 j = index[iatoms[k]];
1001                 while (j < index[iatoms[k]+1])
1002                 {
1003                     ftype_r = rtil[j++];
1004                     nral_r  = NRAL(ftype_r);
1005                     if (interaction_function[ftype_r].flags & IF_VSITE)
1006                     {
1007                         /* Add this vsite (recursion) */
1008                         add_vsite(ga2la, index, rtil, ftype_r, nral_r,
1009                                   FALSE, -1, a_gl+iatoms[k]-iatoms[1], iatoms[k],
1010                                   rtil.data() + j,
1011                                   idef);
1012                     }
1013                     j += 1 + nral_rt(ftype_r);
1014                 }
1015             }
1016         }
1017     }
1018 }
1019
1020 /*! \brief Returns the squared distance between atoms \p i and \p j */
1021 static real dd_dist2(t_pbc *pbc_null, const rvec *x, const int i, int j)
1022 {
1023     rvec dx;
1024
1025     if (pbc_null)
1026     {
1027         pbc_dx_aiuc(pbc_null, x[i], x[j], dx);
1028     }
1029     else
1030     {
1031         rvec_sub(x[i], x[j], dx);
1032     }
1033
1034     return norm2(dx);
1035 }
1036
1037 /*! \brief Append t_blocka block structures 1 to nsrc in src to *dest */
1038 static void combine_blocka(t_blocka                           *dest,
1039                            gmx::ArrayRef<const thread_work_t>  src)
1040 {
1041     int ni = src.back().excl.nr;
1042     int na = 0;
1043     for (const thread_work_t &th_work : src)
1044     {
1045         na += th_work.excl.nra;
1046     }
1047     if (ni + 1 > dest->nalloc_index)
1048     {
1049         dest->nalloc_index = over_alloc_large(ni+1);
1050         srenew(dest->index, dest->nalloc_index);
1051     }
1052     if (dest->nra + na > dest->nalloc_a)
1053     {
1054         dest->nalloc_a = over_alloc_large(dest->nra+na);
1055         srenew(dest->a, dest->nalloc_a);
1056     }
1057     for (gmx::index s = 1; s < src.ssize(); s++)
1058     {
1059         for (int i = dest->nr + 1; i < src[s].excl.nr + 1; i++)
1060         {
1061             dest->index[i] = dest->nra + src[s].excl.index[i];
1062         }
1063         for (int i = 0; i < src[s].excl.nra; i++)
1064         {
1065             dest->a[dest->nra+i] = src[s].excl.a[i];
1066         }
1067         dest->nr   = src[s].excl.nr;
1068         dest->nra += src[s].excl.nra;
1069     }
1070 }
1071
1072 /*! \brief Append t_idef structures 1 to nsrc in src to *dest */
1073 static void combine_idef(t_idef                             *dest,
1074                          gmx::ArrayRef<const thread_work_t>  src)
1075 {
1076     int ftype;
1077
1078     for (ftype = 0; ftype < F_NRE; ftype++)
1079     {
1080         int n = 0;
1081         for (gmx::index s = 1; s < src.ssize(); s++)
1082         {
1083             n += src[s].idef.il[ftype].nr;
1084         }
1085         if (n > 0)
1086         {
1087             t_ilist *ild;
1088
1089             ild = &dest->il[ftype];
1090
1091             if (ild->nr + n > ild->nalloc)
1092             {
1093                 ild->nalloc = over_alloc_large(ild->nr+n);
1094                 srenew(ild->iatoms, ild->nalloc);
1095             }
1096
1097             for (gmx::index s = 1; s < src.ssize(); s++)
1098             {
1099                 const t_ilist &ils = src[s].idef.il[ftype];
1100
1101                 for (int i = 0; i < ils.nr; i++)
1102                 {
1103                     ild->iatoms[ild->nr + i] = ils.iatoms[i];
1104                 }
1105
1106                 ild->nr += ils.nr;
1107             }
1108
1109             /* Position restraints need an additional treatment */
1110             if (ftype == F_POSRES || ftype == F_FBPOSRES)
1111             {
1112                 int          nposres       = dest->il[ftype].nr/2;
1113                 // TODO: Simplify this code using std::vector
1114                 t_iparams * &iparams_dest  = (ftype == F_POSRES ? dest->iparams_posres : dest->iparams_fbposres);
1115                 int         &posres_nalloc = (ftype == F_POSRES ? dest->iparams_posres_nalloc : dest->iparams_fbposres_nalloc);
1116                 if (nposres > posres_nalloc)
1117                 {
1118                     posres_nalloc = over_alloc_large(nposres);
1119                     srenew(iparams_dest, posres_nalloc);
1120                 }
1121
1122                 /* Set nposres to the number of original position restraints in dest */
1123                 for (gmx::index s = 1; s < src.ssize(); s++)
1124                 {
1125                     nposres -= src[s].idef.il[ftype].nr/2;
1126                 }
1127
1128                 for (gmx::index s = 1; s < src.ssize(); s++)
1129                 {
1130                     const t_iparams *iparams_src = (ftype == F_POSRES ? src[s].idef.iparams_posres : src[s].idef.iparams_fbposres);
1131
1132                     for (int i = 0; i < src[s].idef.il[ftype].nr/2; i++)
1133                     {
1134                         /* Correct the index into iparams_posres */
1135                         dest->il[ftype].iatoms[nposres*2] = nposres;
1136                         /* Copy the position restraint force parameters */
1137                         iparams_dest[nposres]             = iparams_src[i];
1138                         nposres++;
1139                     }
1140                 }
1141             }
1142         }
1143     }
1144 }
1145
1146 /*! \brief Check and when available assign bonded interactions for local atom i
1147  */
1148 static inline void
1149 check_assign_interactions_atom(int i, int i_gl,
1150                                int mol, int i_mol,
1151                                int numAtomsInMolecule,
1152                                gmx::ArrayRef<const int> index,
1153                                gmx::ArrayRef<const int> rtil,
1154                                gmx_bool bInterMolInteractions,
1155                                int ind_start, int ind_end,
1156                                const gmx_domdec_t *dd,
1157                                const gmx_domdec_zones_t *zones,
1158                                const gmx_molblock_t *molb,
1159                                gmx_bool bRCheckMB, const ivec rcheck, gmx_bool bRCheck2B,
1160                                real rc2,
1161                                t_pbc *pbc_null,
1162                                rvec *cg_cm,
1163                                const t_iparams *ip_in,
1164                                t_idef *idef,
1165                                int iz,
1166                                gmx_bool bBCheck,
1167                                int *nbonded_local)
1168 {
1169     int j;
1170
1171     j = ind_start;
1172     while (j < ind_end)
1173     {
1174         t_iatom   tiatoms[1 + MAXATOMLIST];
1175
1176         const int ftype  = rtil[j++];
1177         auto      iatoms = gmx::constArrayRefFromArray(rtil.data() + j, rtil.size() - j);
1178         const int nral   = NRAL(ftype);
1179         if (interaction_function[ftype].flags & IF_VSITE)
1180         {
1181             assert(!bInterMolInteractions);
1182             /* The vsite construction goes where the vsite itself is */
1183             if (iz == 0)
1184             {
1185                 add_vsite(*dd->ga2la, index, rtil, ftype, nral,
1186                           TRUE, i, i_gl, i_mol,
1187                           iatoms.data(), idef);
1188             }
1189             j += 1 + nral + 2;
1190         }
1191         else
1192         {
1193             gmx_bool bUse;
1194
1195             /* Copy the type */
1196             tiatoms[0] = iatoms[0];
1197
1198             if (nral == 1)
1199             {
1200                 assert(!bInterMolInteractions);
1201                 /* Assign single-body interactions to the home zone */
1202                 if (iz == 0)
1203                 {
1204                     bUse       = TRUE;
1205                     tiatoms[1] = i;
1206                     if (ftype == F_POSRES)
1207                     {
1208                         add_posres(mol, i_mol, numAtomsInMolecule,
1209                                    molb, tiatoms, ip_in, idef);
1210                     }
1211                     else if (ftype == F_FBPOSRES)
1212                     {
1213                         add_fbposres(mol, i_mol, numAtomsInMolecule,
1214                                      molb, tiatoms, ip_in, idef);
1215                     }
1216                 }
1217                 else
1218                 {
1219                     bUse = FALSE;
1220                 }
1221             }
1222             else if (nral == 2)
1223             {
1224                 /* This is a two-body interaction, we can assign
1225                  * analogous to the non-bonded assignments.
1226                  */
1227                 int k_gl;
1228
1229                 if (!bInterMolInteractions)
1230                 {
1231                     /* Get the global index using the offset in the molecule */
1232                     k_gl = i_gl + iatoms[2] - i_mol;
1233                 }
1234                 else
1235                 {
1236                     k_gl = iatoms[2];
1237                 }
1238                 if (const auto *entry = dd->ga2la->find(k_gl))
1239                 {
1240                     int kz = entry->cell;
1241                     if (kz >= zones->n)
1242                     {
1243                         kz -= zones->n;
1244                     }
1245                     /* Check zone interaction assignments */
1246                     bUse = ((iz < zones->nizone &&
1247                              iz <= kz &&
1248                              kz >= zones->izone[iz].j0 &&
1249                              kz <  zones->izone[iz].j1) ||
1250                             (kz < zones->nizone &&
1251                                   iz > kz &&
1252                              iz >= zones->izone[kz].j0 &&
1253                              iz <  zones->izone[kz].j1));
1254                     if (bUse)
1255                     {
1256                         GMX_ASSERT(ftype != F_CONSTR || (iz == 0 && kz == 0),
1257                                    "Constraint assigned here should only involve home atoms");
1258
1259                         tiatoms[1] = i;
1260                         tiatoms[2] = entry->la;
1261                         /* If necessary check the cgcm distance */
1262                         if (bRCheck2B &&
1263                             dd_dist2(pbc_null, cg_cm,
1264                                      tiatoms[1], tiatoms[2]) >= rc2)
1265                         {
1266                             bUse = FALSE;
1267                         }
1268                     }
1269                 }
1270                 else
1271                 {
1272                     bUse = false;
1273                 }
1274             }
1275             else
1276             {
1277                 /* Assign this multi-body bonded interaction to
1278                  * the local node if we have all the atoms involved
1279                  * (local or communicated) and the minimum zone shift
1280                  * in each dimension is zero, for dimensions
1281                  * with 2 DD cells an extra check may be necessary.
1282                  */
1283                 ivec k_zero, k_plus;
1284                 int  k;
1285
1286                 bUse = TRUE;
1287                 clear_ivec(k_zero);
1288                 clear_ivec(k_plus);
1289                 for (k = 1; k <= nral && bUse; k++)
1290                 {
1291                     int k_gl;
1292                     if (!bInterMolInteractions)
1293                     {
1294                         /* Get the global index using the offset in the molecule */
1295                         k_gl = i_gl + iatoms[k] - i_mol;
1296                     }
1297                     else
1298                     {
1299                         k_gl = iatoms[k];
1300                     }
1301                     const auto *entry = dd->ga2la->find(k_gl);
1302                     if (entry == nullptr || entry->cell >= zones->n)
1303                     {
1304                         /* We do not have this atom of this interaction
1305                          * locally, or it comes from more than one cell
1306                          * away.
1307                          */
1308                         bUse = FALSE;
1309                     }
1310                     else
1311                     {
1312                         int d;
1313
1314                         tiatoms[k] = entry->la;
1315                         for (d = 0; d < DIM; d++)
1316                         {
1317                             if (zones->shift[entry->cell][d] == 0)
1318                             {
1319                                 k_zero[d] = k;
1320                             }
1321                             else
1322                             {
1323                                 k_plus[d] = k;
1324                             }
1325                         }
1326                     }
1327                 }
1328                 bUse = (bUse &&
1329                         (k_zero[XX] != 0) && (k_zero[YY] != 0) && (k_zero[ZZ] != 0));
1330                 if (bRCheckMB)
1331                 {
1332                     int d;
1333
1334                     for (d = 0; (d < DIM && bUse); d++)
1335                     {
1336                         /* Check if the cg_cm distance falls within
1337                          * the cut-off to avoid possible multiple
1338                          * assignments of bonded interactions.
1339                          */
1340                         if (rcheck[d] &&
1341                             k_plus[d] &&
1342                             dd_dist2(pbc_null, cg_cm,
1343                                      tiatoms[k_zero[d]], tiatoms[k_plus[d]]) >= rc2)
1344                         {
1345                             bUse = FALSE;
1346                         }
1347                     }
1348                 }
1349             }
1350             if (bUse)
1351             {
1352                 /* Add this interaction to the local topology */
1353                 add_ifunc(nral, tiatoms, &idef->il[ftype]);
1354                 /* Sum so we can check in global_stat
1355                  * if we have everything.
1356                  */
1357                 if (bBCheck ||
1358                     !(interaction_function[ftype].flags & IF_LIMZERO))
1359                 {
1360                     (*nbonded_local)++;
1361                 }
1362             }
1363             j += 1 + nral;
1364         }
1365     }
1366 }
1367
1368 /*! \brief This function looks up and assigns bonded interactions for zone iz.
1369  *
1370  * With thread parallelizing each thread acts on a different atom range:
1371  * at_start to at_end.
1372  */
1373 static int make_bondeds_zone(gmx_domdec_t *dd,
1374                              const gmx_domdec_zones_t *zones,
1375                              const std::vector<gmx_molblock_t> &molb,
1376                              gmx_bool bRCheckMB, ivec rcheck, gmx_bool bRCheck2B,
1377                              real rc2,
1378                              t_pbc *pbc_null, rvec *cg_cm,
1379                              const t_iparams *ip_in,
1380                              t_idef *idef,
1381                              int izone,
1382                              gmx::RangePartitioning::Block atomRange)
1383 {
1384     int                mb, mt, mol, i_mol;
1385     gmx_bool           bBCheck;
1386     gmx_reverse_top_t *rt;
1387     int                nbonded_local;
1388
1389     rt = dd->reverse_top;
1390
1391     bBCheck = rt->bBCheck;
1392
1393     nbonded_local = 0;
1394
1395     for (int i : atomRange)
1396     {
1397         /* Get the global atom number */
1398         const int i_gl = dd->globalAtomIndices[i];
1399         global_atomnr_to_moltype_ind(rt, i_gl, &mb, &mt, &mol, &i_mol);
1400         /* Check all intramolecular interactions assigned to this atom */
1401         gmx::ArrayRef<const int>       index = rt->ril_mt[mt].index;
1402         gmx::ArrayRef<const t_iatom>   rtil  = rt->ril_mt[mt].il;
1403
1404         check_assign_interactions_atom(i, i_gl, mol, i_mol,
1405                                        rt->ril_mt[mt].numAtomsInMolecule,
1406                                        index, rtil, FALSE,
1407                                        index[i_mol], index[i_mol+1],
1408                                        dd, zones,
1409                                        &molb[mb],
1410                                        bRCheckMB, rcheck, bRCheck2B, rc2,
1411                                        pbc_null,
1412                                        cg_cm,
1413                                        ip_in,
1414                                        idef,
1415                                        izone,
1416                                        bBCheck,
1417                                        &nbonded_local);
1418
1419
1420         if (rt->bIntermolecularInteractions)
1421         {
1422             /* Check all intermolecular interactions assigned to this atom */
1423             index = rt->ril_intermol.index;
1424             rtil  = rt->ril_intermol.il;
1425
1426             check_assign_interactions_atom(i, i_gl, mol, i_mol,
1427                                            rt->ril_mt[mt].numAtomsInMolecule,
1428                                            index, rtil, TRUE,
1429                                            index[i_gl], index[i_gl + 1],
1430                                            dd, zones,
1431                                            &molb[mb],
1432                                            bRCheckMB, rcheck, bRCheck2B, rc2,
1433                                            pbc_null,
1434                                            cg_cm,
1435                                            ip_in,
1436                                            idef,
1437                                            izone,
1438                                            bBCheck,
1439                                            &nbonded_local);
1440         }
1441     }
1442
1443     return nbonded_local;
1444 }
1445
1446 /*! \brief Set the exclusion data for i-zone \p iz for the case of no exclusions */
1447 static void set_no_exclusions_zone(const gmx_domdec_zones_t *zones,
1448                                    int                       iz,
1449                                    t_blocka                 *lexcls)
1450 {
1451     for (int a = zones->cg_range[iz]; a < zones->cg_range[iz + 1]; a++)
1452     {
1453         lexcls->index[a + 1] = lexcls->nra;
1454     }
1455 }
1456
1457 /*! \brief Set the exclusion data for i-zone \p iz
1458  *
1459  * This is a legacy version for the group scheme of the same routine below.
1460  * Here charge groups and distance checks to ensure unique exclusions
1461  * are supported.
1462  */
1463 static int make_exclusions_zone_cg(gmx_domdec_t *dd, gmx_domdec_zones_t *zones,
1464                                    const std::vector<gmx_moltype_t> &moltype,
1465                                    gmx_bool bRCheck, real rc2,
1466                                    t_pbc *pbc_null, rvec *cg_cm,
1467                                    const int *cginfo,
1468                                    t_blocka *lexcls,
1469                                    int iz,
1470                                    int cg_start, int cg_end)
1471 {
1472     int                n_excl_at_max;
1473     int                mb, mt, mol;
1474     const t_blocka    *excls;
1475
1476     const gmx_ga2la_t &ga2la  = *dd->ga2la;
1477
1478     // TODO: Replace this by a more standard range
1479     const gmx::RangePartitioning::Block jRange(zones->izone[iz].jcg0,
1480                                                zones->izone[iz].jcg1);
1481
1482     n_excl_at_max = dd->reverse_top->n_excl_at_max;
1483
1484     /* We set the end index, but note that we might not start at zero here */
1485     lexcls->nr = cg_end;
1486
1487     int n     = lexcls->nra;
1488     int count = 0;
1489     for (int la = cg_start; la < cg_end; la++)
1490     {
1491         if (n + (cg_end - cg_start)*n_excl_at_max > lexcls->nalloc_a)
1492         {
1493             lexcls->nalloc_a = over_alloc_large(n + (cg_end - cg_start)*n_excl_at_max);
1494             srenew(lexcls->a, lexcls->nalloc_a);
1495         }
1496         if (GET_CGINFO_EXCL_INTER(cginfo[la]) ||
1497             !GET_CGINFO_EXCL_INTRA(cginfo[la]))
1498         {
1499             /* Copy the exclusions from the global top */
1500             lexcls->index[la] = n;
1501             int a_gl          = dd->globalAtomIndices[la];
1502             int a_mol;
1503             global_atomnr_to_moltype_ind(dd->reverse_top, a_gl, &mb, &mt, &mol, &a_mol);
1504             excls = &moltype[mt].excls;
1505             for (int j = excls->index[a_mol]; j < excls->index[a_mol+1]; j++)
1506             {
1507                 int aj_mol = excls->a[j];
1508                 /* Since exclusions are pair interactions,
1509                  * just like non-bonded interactions,
1510                  * they can be assigned properly up
1511                  * to the DD cutoff (not cutoff_min as
1512                  * for the other bonded interactions).
1513                  */
1514                 if (const auto *jEntry = ga2la.find(a_gl + aj_mol - a_mol))
1515                 {
1516                     if (iz == 0 && jEntry->cell == 0)
1517                     {
1518                         lexcls->a[n++] = jEntry->la;
1519                         /* Check to avoid double counts */
1520                         if (jEntry->la > la)
1521                         {
1522                             count++;
1523                         }
1524                     }
1525                     else if (jRange.inRange(jEntry->la) &&
1526                              (!bRCheck ||
1527                               dd_dist2(pbc_null, cg_cm, la, jEntry->la) < rc2))
1528                     {
1529                         /* jla > la, since jRange.begin() > la */
1530                         lexcls->a[n++] = jEntry->la;
1531                         count++;
1532                     }
1533                 }
1534             }
1535         }
1536         else
1537         {
1538             /* There are no inter-atomic excls and this atom is self-excluded.
1539              * These exclusions are only required for zone 0,
1540              * since other zones do not see themselves.
1541              */
1542             if (iz == 0)
1543             {
1544                 lexcls->index[la] = n;
1545                 lexcls->a[n++]    = la;
1546             }
1547             else
1548             {
1549                 lexcls->index[la] = n;
1550             }
1551         }
1552     }
1553
1554     lexcls->index[lexcls->nr] = n;
1555     lexcls->nra               = n;
1556
1557     return count;
1558 }
1559
1560 /*! \brief Set the exclusion data for i-zone \p iz */
1561 static void make_exclusions_zone(gmx_domdec_t *dd, gmx_domdec_zones_t *zones,
1562                                  const std::vector<gmx_moltype_t> &moltype,
1563                                  const int *cginfo, t_blocka *lexcls, int iz,
1564                                  int at_start, int at_end,
1565                                  const gmx::ArrayRef<const int> intermolecularExclusionGroup)
1566 {
1567     int                n_excl_at_max, n, at;
1568
1569     const gmx_ga2la_t &ga2la  = *dd->ga2la;
1570
1571     // TODO: Replace this by a more standard range
1572     const gmx::RangePartitioning::Block jRange(zones->izone[iz].jcg0,
1573                                                zones->izone[iz].jcg1);
1574
1575     n_excl_at_max = dd->reverse_top->n_excl_at_max;
1576
1577     /* We set the end index, but note that we might not start at zero here */
1578     lexcls->nr = at_end;
1579
1580     n = lexcls->nra;
1581     for (at = at_start; at < at_end; at++)
1582     {
1583         if (n + 1000 > lexcls->nalloc_a)
1584         {
1585             lexcls->nalloc_a = over_alloc_large(n + 1000);
1586             srenew(lexcls->a, lexcls->nalloc_a);
1587         }
1588
1589         if (GET_CGINFO_EXCL_INTER(cginfo[at]))
1590         {
1591             int             a_gl, mb, mt, mol, a_mol, j;
1592             const t_blocka *excls;
1593
1594             if (n + n_excl_at_max > lexcls->nalloc_a)
1595             {
1596                 lexcls->nalloc_a = over_alloc_large(n + n_excl_at_max);
1597                 srenew(lexcls->a, lexcls->nalloc_a);
1598             }
1599
1600             /* Copy the exclusions from the global top */
1601             lexcls->index[at] = n;
1602             a_gl              = dd->globalAtomIndices[at];
1603             global_atomnr_to_moltype_ind(dd->reverse_top, a_gl,
1604                                          &mb, &mt, &mol, &a_mol);
1605             excls = &moltype[mt].excls;
1606             for (j = excls->index[a_mol]; j < excls->index[a_mol + 1]; j++)
1607             {
1608                 const int aj_mol = excls->a[j];
1609
1610                 if (const auto *jEntry = ga2la.find(a_gl + aj_mol - a_mol))
1611                 {
1612                     /* This check is not necessary, but it can reduce
1613                      * the number of exclusions in the list, which in turn
1614                      * can speed up the pair list construction a bit.
1615                      */
1616                     if (jRange.inRange(jEntry->la))
1617                     {
1618                         lexcls->a[n++] = jEntry->la;
1619                     }
1620                 }
1621             }
1622         }
1623         else
1624         {
1625             /* We don't need exclusions for this atom */
1626             lexcls->index[at] = n;
1627         }
1628
1629         bool isExcludedAtom = !intermolecularExclusionGroup.empty() &&
1630             std::find(intermolecularExclusionGroup.begin(),
1631                       intermolecularExclusionGroup.end(),
1632                       dd->globalAtomIndices[at]) !=
1633             intermolecularExclusionGroup.end();
1634
1635         if (isExcludedAtom)
1636         {
1637             if (n + intermolecularExclusionGroup.ssize() > lexcls->nalloc_a)
1638             {
1639                 lexcls->nalloc_a =
1640                     over_alloc_large(n + intermolecularExclusionGroup.size());
1641                 srenew(lexcls->a, lexcls->nalloc_a);
1642             }
1643             for (int qmAtomGlobalIndex : intermolecularExclusionGroup)
1644             {
1645                 if (const auto *entry = dd->ga2la->find(qmAtomGlobalIndex))
1646                 {
1647                     lexcls->a[n++] = entry->la;
1648                 }
1649             }
1650         }
1651     }
1652
1653     lexcls->index[lexcls->nr] = n;
1654     lexcls->nra               = n;
1655 }
1656
1657
1658 /*! \brief Ensure we have enough space in \p ba for \p nindex_max indices */
1659 static void check_alloc_index(t_blocka *ba, int nindex_max)
1660 {
1661     if (nindex_max+1 > ba->nalloc_index)
1662     {
1663         ba->nalloc_index = over_alloc_dd(nindex_max+1);
1664         srenew(ba->index, ba->nalloc_index);
1665     }
1666 }
1667
1668 /*! \brief Ensure that we have enough space for exclusion storate in \p lexcls */
1669 static void check_exclusions_alloc(gmx_domdec_t *dd, gmx_domdec_zones_t *zones,
1670                                    t_blocka *lexcls)
1671 {
1672     const int nr = zones->izone[zones->nizone - 1].cg1;
1673
1674     check_alloc_index(lexcls, nr);
1675
1676     for (size_t thread = 1; thread < dd->reverse_top->th_work.size(); thread++)
1677     {
1678         check_alloc_index(&dd->reverse_top->th_work[thread].excl, nr);
1679     }
1680 }
1681
1682 /*! \brief Set the total count indexes for the local exclusions, needed by several functions */
1683 static void finish_local_exclusions(gmx_domdec_t *dd, gmx_domdec_zones_t *zones,
1684                                     t_blocka *lexcls)
1685 {
1686     // TODO: Replace this by a more standard range
1687     const gmx::RangePartitioning::Block nonhomeIzonesAtomRange(zones->izone[0].cg1,
1688                                                                zones->izone[zones->nizone - 1].cg1);
1689
1690     if (dd->n_intercg_excl == 0)
1691     {
1692         /* There are no exclusions involving non-home charge groups,
1693          * but we need to set the indices for neighborsearching.
1694          */
1695         for (int la : nonhomeIzonesAtomRange)
1696         {
1697             lexcls->index[la] = lexcls->nra;
1698         }
1699
1700         /* nr is only used to loop over the exclusions for Ewald and RF,
1701          * so we can set it to the number of home atoms for efficiency.
1702          */
1703         lexcls->nr = nonhomeIzonesAtomRange.begin();
1704     }
1705     else
1706     {
1707         lexcls->nr = nonhomeIzonesAtomRange.end();
1708     }
1709 }
1710
1711 /*! \brief Clear a t_idef struct */
1712 static void clear_idef(t_idef *idef)
1713 {
1714     int  ftype;
1715
1716     /* Clear the counts */
1717     for (ftype = 0; ftype < F_NRE; ftype++)
1718     {
1719         idef->il[ftype].nr = 0;
1720     }
1721 }
1722
1723 /*! \brief Generate and store all required local bonded interactions in \p idef and local exclusions in \p lexcls */
1724 static int make_local_bondeds_excls(gmx_domdec_t *dd,
1725                                     gmx_domdec_zones_t *zones,
1726                                     const gmx_mtop_t *mtop,
1727                                     const int *cginfo,
1728                                     gmx_bool bRCheckMB, ivec rcheck, gmx_bool bRCheck2B,
1729                                     real rc,
1730                                     t_pbc *pbc_null, rvec *cg_cm,
1731                                     t_idef *idef,
1732                                     t_blocka *lexcls, int *excl_count)
1733 {
1734     int                nzone_bondeds, nzone_excl;
1735     int                izone, cg0, cg1;
1736     real               rc2;
1737     int                nbonded_local;
1738     gmx_reverse_top_t *rt;
1739
1740     if (dd->reverse_top->bInterCGInteractions)
1741     {
1742         nzone_bondeds = zones->n;
1743     }
1744     else
1745     {
1746         /* Only single charge group (or atom) molecules, so interactions don't
1747          * cross zone boundaries and we only need to assign in the home zone.
1748          */
1749         nzone_bondeds = 1;
1750     }
1751
1752     if (dd->n_intercg_excl > 0)
1753     {
1754         /* We only use exclusions from i-zones to i- and j-zones */
1755         nzone_excl = zones->nizone;
1756     }
1757     else
1758     {
1759         /* There are no inter-cg exclusions and only zone 0 sees itself */
1760         nzone_excl = 1;
1761     }
1762
1763     check_exclusions_alloc(dd, zones, lexcls);
1764
1765     rt = dd->reverse_top;
1766
1767     rc2 = rc*rc;
1768
1769     /* Clear the counts */
1770     clear_idef(idef);
1771     nbonded_local = 0;
1772
1773     lexcls->nr    = 0;
1774     lexcls->nra   = 0;
1775     *excl_count   = 0;
1776
1777     for (izone = 0; izone < nzone_bondeds; izone++)
1778     {
1779         cg0 = zones->cg_range[izone];
1780         cg1 = zones->cg_range[izone + 1];
1781
1782         const int numThreads = rt->th_work.size();
1783 #pragma omp parallel for num_threads(numThreads) schedule(static)
1784         for (int thread = 0; thread < numThreads; thread++)
1785         {
1786             try
1787             {
1788                 int       cg0t, cg1t;
1789                 t_idef   *idef_t;
1790                 t_blocka *excl_t;
1791
1792                 cg0t = cg0 + ((cg1 - cg0)* thread   )/numThreads;
1793                 cg1t = cg0 + ((cg1 - cg0)*(thread+1))/numThreads;
1794
1795                 if (thread == 0)
1796                 {
1797                     idef_t = idef;
1798                 }
1799                 else
1800                 {
1801                     idef_t = &rt->th_work[thread].idef;
1802                     clear_idef(idef_t);
1803                 }
1804
1805                 rt->th_work[thread].nbonded =
1806                     make_bondeds_zone(dd, zones,
1807                                       mtop->molblock,
1808                                       bRCheckMB, rcheck, bRCheck2B, rc2,
1809                                       pbc_null, cg_cm, idef->iparams,
1810                                       idef_t,
1811                                       izone,
1812                                       gmx::RangePartitioning::Block(cg0t, cg1t));
1813
1814                 if (izone < nzone_excl)
1815                 {
1816                     if (thread == 0)
1817                     {
1818                         excl_t = lexcls;
1819                     }
1820                     else
1821                     {
1822                         excl_t      = &rt->th_work[thread].excl;
1823                         excl_t->nr  = 0;
1824                         excl_t->nra = 0;
1825                     }
1826
1827                     if (!rt->bExclRequired)
1828                     {
1829                         /* No charge groups and no distance check required */
1830                         make_exclusions_zone(dd, zones, mtop->moltype, cginfo,
1831                                              excl_t, izone, cg0t,
1832                                              cg1t,
1833                                              mtop->intermolecularExclusionGroup);
1834                     }
1835                     else
1836                     {
1837                         rt->th_work[thread].excl_count =
1838                             make_exclusions_zone_cg(dd, zones,
1839                                                     mtop->moltype, bRCheck2B, rc2,
1840                                                     pbc_null, cg_cm, cginfo,
1841                                                     excl_t,
1842                                                     izone,
1843                                                     cg0t, cg1t);
1844                     }
1845                 }
1846             }
1847             GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
1848         }
1849
1850         if (rt->th_work.size() > 1)
1851         {
1852             combine_idef(idef, rt->th_work);
1853         }
1854
1855         for (const thread_work_t &th_work : rt->th_work)
1856         {
1857             nbonded_local += th_work.nbonded;
1858         }
1859
1860         if (izone < nzone_excl)
1861         {
1862             if (rt->th_work.size() > 1)
1863             {
1864                 combine_blocka(lexcls, rt->th_work);
1865             }
1866
1867             for (const thread_work_t &th_work : rt->th_work)
1868             {
1869                 *excl_count += th_work.excl_count;
1870             }
1871         }
1872     }
1873
1874     /* Some zones might not have exclusions, but some code still needs to
1875      * loop over the index, so we set the indices here.
1876      */
1877     for (izone = nzone_excl; izone < zones->nizone; izone++)
1878     {
1879         set_no_exclusions_zone(zones, izone, lexcls);
1880     }
1881
1882     finish_local_exclusions(dd, zones, lexcls);
1883     if (debug)
1884     {
1885         fprintf(debug, "We have %d exclusions, check count %d\n",
1886                 lexcls->nra, *excl_count);
1887     }
1888
1889     return nbonded_local;
1890 }
1891
1892 void dd_make_local_top(gmx_domdec_t *dd, gmx_domdec_zones_t *zones,
1893                        int npbcdim, matrix box,
1894                        rvec cellsize_min, const ivec npulse,
1895                        t_forcerec *fr,
1896                        rvec *cgcm_or_x,
1897                        const gmx_mtop_t &mtop, gmx_localtop_t *ltop)
1898 {
1899     gmx_bool bRCheckMB, bRCheck2B;
1900     real     rc = -1;
1901     ivec     rcheck;
1902     int      d, nexcl;
1903     t_pbc    pbc, *pbc_null = nullptr;
1904
1905     if (debug)
1906     {
1907         fprintf(debug, "Making local topology\n");
1908     }
1909
1910     bRCheckMB   = FALSE;
1911     bRCheck2B   = FALSE;
1912
1913     if (dd->reverse_top->bInterCGInteractions)
1914     {
1915         /* We need to check to which cell bondeds should be assigned */
1916         rc = dd_cutoff_twobody(dd);
1917         if (debug)
1918         {
1919             fprintf(debug, "Two-body bonded cut-off distance is %g\n", rc);
1920         }
1921
1922         /* Should we check cg_cm distances when assigning bonded interactions? */
1923         for (d = 0; d < DIM; d++)
1924         {
1925             rcheck[d] = FALSE;
1926             /* Only need to check for dimensions where the part of the box
1927              * that is not communicated is smaller than the cut-off.
1928              */
1929             if (d < npbcdim && dd->nc[d] > 1 &&
1930                 (dd->nc[d] - npulse[d])*cellsize_min[d] < 2*rc)
1931             {
1932                 if (dd->nc[d] == 2)
1933                 {
1934                     rcheck[d] = TRUE;
1935                     bRCheckMB = TRUE;
1936                 }
1937                 /* Check for interactions between two atoms,
1938                  * where we can allow interactions up to the cut-off,
1939                  * instead of up to the smallest cell dimension.
1940                  */
1941                 bRCheck2B = TRUE;
1942             }
1943             if (debug)
1944             {
1945                 fprintf(debug,
1946                         "dim %d cellmin %f bonded rcheck[%d] = %d, bRCheck2B = %s\n",
1947                         d, cellsize_min[d], d, rcheck[d], gmx::boolToString(bRCheck2B));
1948             }
1949         }
1950         if (bRCheckMB || bRCheck2B)
1951         {
1952             if (fr->bMolPBC)
1953             {
1954                 pbc_null = set_pbc_dd(&pbc, fr->ePBC, dd->nc, TRUE, box);
1955             }
1956             else
1957             {
1958                 pbc_null = nullptr;
1959             }
1960         }
1961     }
1962
1963     dd->nbonded_local =
1964         make_local_bondeds_excls(dd, zones, &mtop, fr->cginfo.data(),
1965                                  bRCheckMB, rcheck, bRCheck2B, rc,
1966                                  pbc_null, cgcm_or_x,
1967                                  &ltop->idef,
1968                                  &ltop->excls, &nexcl);
1969
1970     /* The ilist is not sorted yet,
1971      * we can only do this when we have the charge arrays.
1972      */
1973     ltop->idef.ilsort = ilsortUNKNOWN;
1974
1975     if (dd->reverse_top->bExclRequired)
1976     {
1977         dd->nbonded_local += nexcl;
1978     }
1979
1980     ltop->atomtypes  = mtop.atomtypes;
1981 }
1982
1983 void dd_sort_local_top(gmx_domdec_t *dd, const t_mdatoms *mdatoms,
1984                        gmx_localtop_t *ltop)
1985 {
1986     if (dd->reverse_top->ilsort == ilsortNO_FE)
1987     {
1988         ltop->idef.ilsort = ilsortNO_FE;
1989     }
1990     else
1991     {
1992         gmx_sort_ilist_fe(&ltop->idef, mdatoms->chargeA, mdatoms->chargeB);
1993     }
1994 }
1995
1996 void dd_init_local_top(const gmx_mtop_t &top_global,
1997                        gmx_localtop_t   *top)
1998 {
1999     /* TODO: Get rid of the const casts below, e.g. by using a reference */
2000     top->idef.ntypes     = top_global.ffparams.numTypes();
2001     top->idef.atnr       = top_global.ffparams.atnr;
2002     top->idef.functype   = const_cast<t_functype *>(top_global.ffparams.functype.data());
2003     top->idef.iparams    = const_cast<t_iparams *>(top_global.ffparams.iparams.data());
2004     top->idef.fudgeQQ    = top_global.ffparams.fudgeQQ;
2005     top->idef.cmap_grid  = new gmx_cmap_t;
2006     *top->idef.cmap_grid = top_global.ffparams.cmap_grid;
2007
2008     top->idef.ilsort        = ilsortUNKNOWN;
2009     top->useInDomainDecomp_ = true;
2010 }
2011
2012 void dd_init_local_state(gmx_domdec_t *dd,
2013                          const t_state *state_global, t_state *state_local)
2014 {
2015     int buf[NITEM_DD_INIT_LOCAL_STATE];
2016
2017     if (DDMASTER(dd))
2018     {
2019         buf[0] = state_global->flags;
2020         buf[1] = state_global->ngtc;
2021         buf[2] = state_global->nnhpres;
2022         buf[3] = state_global->nhchainlength;
2023         buf[4] = state_global->dfhist ? state_global->dfhist->nlambda : 0;
2024     }
2025     dd_bcast(dd, NITEM_DD_INIT_LOCAL_STATE*sizeof(int), buf);
2026
2027     init_gtc_state(state_local, buf[1], buf[2], buf[3]);
2028     init_dfhist_state(state_local, buf[4]);
2029     state_local->flags = buf[0];
2030 }
2031
2032 /*! \brief Check if a link is stored in \p link between charge groups \p cg_gl and \p cg_gl_j and if not so, store a link */
2033 static void check_link(t_blocka *link, int cg_gl, int cg_gl_j)
2034 {
2035     int      k;
2036     gmx_bool bFound;
2037
2038     bFound = FALSE;
2039     for (k = link->index[cg_gl]; k < link->index[cg_gl+1]; k++)
2040     {
2041         GMX_RELEASE_ASSERT(link->a, "Inconsistent NULL pointer while making charge-group links");
2042         if (link->a[k] == cg_gl_j)
2043         {
2044             bFound = TRUE;
2045         }
2046     }
2047     if (!bFound)
2048     {
2049         GMX_RELEASE_ASSERT(link->a || link->index[cg_gl+1]+1 > link->nalloc_a,
2050                            "Inconsistent allocation of link");
2051         /* Add this charge group link */
2052         if (link->index[cg_gl+1]+1 > link->nalloc_a)
2053         {
2054             link->nalloc_a = over_alloc_large(link->index[cg_gl+1]+1);
2055             srenew(link->a, link->nalloc_a);
2056         }
2057         link->a[link->index[cg_gl+1]] = cg_gl_j;
2058         link->index[cg_gl+1]++;
2059     }
2060 }
2061
2062 /*! \brief Return a vector of the charge group index for all atoms */
2063 static std::vector<int> make_at2cg(const t_block &cgs)
2064 {
2065     std::vector<int> at2cg(cgs.index[cgs.nr]);
2066     for (int cg = 0; cg < cgs.nr; cg++)
2067     {
2068         for (int a = cgs.index[cg]; a < cgs.index[cg + 1]; a++)
2069         {
2070             at2cg[a] = cg;
2071         }
2072     }
2073
2074     return at2cg;
2075 }
2076
2077 t_blocka *make_charge_group_links(const gmx_mtop_t *mtop, gmx_domdec_t *dd,
2078                                   cginfo_mb_t *cginfo_mb)
2079 {
2080     gmx_bool            bExclRequired;
2081     t_blocka           *link;
2082     cginfo_mb_t        *cgi_mb;
2083
2084     /* For each charge group make a list of other charge groups
2085      * in the system that a linked to it via bonded interactions
2086      * which are also stored in reverse_top.
2087      */
2088
2089     bExclRequired = dd->reverse_top->bExclRequired;
2090
2091     reverse_ilist_t ril_intermol;
2092     if (mtop->bIntermolecularInteractions)
2093     {
2094         if (ncg_mtop(mtop) < mtop->natoms)
2095         {
2096             gmx_fatal(FARGS, "The combination of intermolecular interactions, charge groups and domain decomposition is not supported. Use cutoff-scheme=Verlet (which removes the charge groups) or run without domain decomposition.");
2097         }
2098
2099         t_atoms atoms;
2100
2101         atoms.nr   = mtop->natoms;
2102         atoms.atom = nullptr;
2103
2104         GMX_RELEASE_ASSERT(mtop->intermolecular_ilist, "We should have an ilist when intermolecular interactions are on");
2105
2106         make_reverse_ilist(*mtop->intermolecular_ilist,
2107                            &atoms,
2108                            FALSE, FALSE, FALSE, TRUE, &ril_intermol);
2109     }
2110
2111     snew(link, 1);
2112     snew(link->index, ncg_mtop(mtop)+1);
2113     link->nalloc_a = 0;
2114     link->a        = nullptr;
2115
2116     link->index[0] = 0;
2117     int cg_offset  = 0;
2118     int ncgi       = 0;
2119     for (size_t mb = 0; mb < mtop->molblock.size(); mb++)
2120     {
2121         const gmx_molblock_t &molb = mtop->molblock[mb];
2122         if (molb.nmol == 0)
2123         {
2124             continue;
2125         }
2126         const gmx_moltype_t &molt  = mtop->moltype[molb.type];
2127         const t_block       &cgs   = molt.cgs;
2128         const t_blocka      &excls = molt.excls;
2129         std::vector<int>     a2c   = make_at2cg(cgs);
2130         /* Make a reverse ilist in which the interactions are linked
2131          * to all atoms, not only the first atom as in gmx_reverse_top.
2132          * The constraints are discarded here.
2133          */
2134         reverse_ilist_t ril;
2135         make_reverse_ilist(molt.ilist, &molt.atoms,
2136                            FALSE, FALSE, FALSE, TRUE, &ril);
2137
2138         cgi_mb = &cginfo_mb[mb];
2139
2140         int mol;
2141         for (mol = 0; mol < (mtop->bIntermolecularInteractions ? molb.nmol : 1); mol++)
2142         {
2143             for (int cg = 0; cg < cgs.nr; cg++)
2144             {
2145                 int cg_gl            = cg_offset + cg;
2146                 link->index[cg_gl+1] = link->index[cg_gl];
2147                 for (int a = cgs.index[cg]; a < cgs.index[cg + 1]; a++)
2148                 {
2149                     int i = ril.index[a];
2150                     while (i < ril.index[a+1])
2151                     {
2152                         int ftype = ril.il[i++];
2153                         int nral  = NRAL(ftype);
2154                         /* Skip the ifunc index */
2155                         i++;
2156                         for (int j = 0; j < nral; j++)
2157                         {
2158                             int aj = ril.il[i + j];
2159                             if (a2c[aj] != cg)
2160                             {
2161                                 check_link(link, cg_gl, cg_offset+a2c[aj]);
2162                             }
2163                         }
2164                         i += nral_rt(ftype);
2165                     }
2166                     if (bExclRequired)
2167                     {
2168                         /* Exclusions always go both ways */
2169                         for (int j = excls.index[a]; j < excls.index[a + 1]; j++)
2170                         {
2171                             int aj = excls.a[j];
2172                             if (a2c[aj] != cg)
2173                             {
2174                                 check_link(link, cg_gl, cg_offset+a2c[aj]);
2175                             }
2176                         }
2177                     }
2178
2179                     if (mtop->bIntermolecularInteractions)
2180                     {
2181                         int i = ril_intermol.index[a];
2182                         while (i < ril_intermol.index[a+1])
2183                         {
2184                             int ftype = ril_intermol.il[i++];
2185                             int nral  = NRAL(ftype);
2186                             /* Skip the ifunc index */
2187                             i++;
2188                             for (int j = 0; j < nral; j++)
2189                             {
2190                                 /* Here we assume we have no charge groups;
2191                                  * this has been checked above.
2192                                  */
2193                                 int aj = ril_intermol.il[i + j];
2194                                 check_link(link, cg_gl, aj);
2195                             }
2196                             i += nral_rt(ftype);
2197                         }
2198                     }
2199                 }
2200                 if (link->index[cg_gl+1] - link->index[cg_gl] > 0)
2201                 {
2202                     SET_CGINFO_BOND_INTER(cgi_mb->cginfo[cg]);
2203                     ncgi++;
2204                 }
2205             }
2206
2207             cg_offset += cgs.nr;
2208         }
2209         int nlink_mol = link->index[cg_offset] - link->index[cg_offset - cgs.nr];
2210
2211         if (debug)
2212         {
2213             fprintf(debug, "molecule type '%s' %d cgs has %d cg links through bonded interac.\n", *molt.name, cgs.nr, nlink_mol);
2214         }
2215
2216         if (molb.nmol > mol)
2217         {
2218             /* Copy the data for the rest of the molecules in this block */
2219             link->nalloc_a += (molb.nmol - mol)*nlink_mol;
2220             srenew(link->a, link->nalloc_a);
2221             for (; mol < molb.nmol; mol++)
2222             {
2223                 for (int cg = 0; cg < cgs.nr; cg++)
2224                 {
2225                     int cg_gl              = cg_offset + cg;
2226                     link->index[cg_gl + 1] =
2227                         link->index[cg_gl + 1 - cgs.nr] + nlink_mol;
2228                     for (int j = link->index[cg_gl]; j < link->index[cg_gl+1]; j++)
2229                     {
2230                         link->a[j] = link->a[j - nlink_mol] + cgs.nr;
2231                     }
2232                     if (link->index[cg_gl+1] - link->index[cg_gl] > 0 &&
2233                         cg_gl - cgi_mb->cg_start < cgi_mb->cg_mod)
2234                     {
2235                         SET_CGINFO_BOND_INTER(cgi_mb->cginfo[cg_gl - cgi_mb->cg_start]);
2236                         ncgi++;
2237                     }
2238                 }
2239                 cg_offset += cgs.nr;
2240             }
2241         }
2242     }
2243
2244     if (debug)
2245     {
2246         fprintf(debug, "Of the %d charge groups %d are linked via bonded interactions\n", ncg_mtop(mtop), ncgi);
2247     }
2248
2249     return link;
2250 }
2251
2252 typedef struct {
2253     real r2;
2254     int  ftype;
2255     int  a1;
2256     int  a2;
2257 } bonded_distance_t;
2258
2259 /*! \brief Compare distance^2 \p r2 against the distance in \p bd and if larger store it along with \p ftype and atom indices \p a1 and \p a2 */
2260 static void update_max_bonded_distance(real r2, int ftype, int a1, int a2,
2261                                        bonded_distance_t *bd)
2262 {
2263     if (r2 > bd->r2)
2264     {
2265         bd->r2    = r2;
2266         bd->ftype = ftype;
2267         bd->a1    = a1;
2268         bd->a2    = a2;
2269     }
2270 }
2271
2272 /*! \brief Set the distance, function type and atom indices for the longest distance between charge-groups of molecule type \p molt for two-body and multi-body bonded interactions */
2273 static void bonded_cg_distance_mol(const gmx_moltype_t *molt,
2274                                    const std::vector<int> &at2cg,
2275                                    gmx_bool bBCheck, gmx_bool bExcl, rvec *cg_cm,
2276                                    bonded_distance_t *bd_2b,
2277                                    bonded_distance_t *bd_mb)
2278 {
2279     for (int ftype = 0; ftype < F_NRE; ftype++)
2280     {
2281         if (dd_check_ftype(ftype, bBCheck, FALSE, FALSE))
2282         {
2283             const auto    &il   = molt->ilist[ftype];
2284             int            nral = NRAL(ftype);
2285             if (nral > 1)
2286             {
2287                 for (int i = 0; i < il.size(); i += 1+nral)
2288                 {
2289                     for (int ai = 0; ai < nral; ai++)
2290                     {
2291                         int cgi = at2cg[il.iatoms[i+1+ai]];
2292                         for (int aj = ai + 1; aj < nral; aj++)
2293                         {
2294                             int cgj = at2cg[il.iatoms[i+1+aj]];
2295                             if (cgi != cgj)
2296                             {
2297                                 real rij2 = distance2(cg_cm[cgi], cg_cm[cgj]);
2298
2299                                 update_max_bonded_distance(rij2, ftype,
2300                                                            il.iatoms[i+1+ai],
2301                                                            il.iatoms[i+1+aj],
2302                                                            (nral == 2) ? bd_2b : bd_mb);
2303                             }
2304                         }
2305                     }
2306                 }
2307             }
2308         }
2309     }
2310     if (bExcl)
2311     {
2312         const t_blocka *excls = &molt->excls;
2313         for (int ai = 0; ai < excls->nr; ai++)
2314         {
2315             int cgi = at2cg[ai];
2316             for (int j = excls->index[ai]; j < excls->index[ai+1]; j++)
2317             {
2318                 int cgj = at2cg[excls->a[j]];
2319                 if (cgi != cgj)
2320                 {
2321                     real rij2 = distance2(cg_cm[cgi], cg_cm[cgj]);
2322
2323                     /* There is no function type for exclusions, use -1 */
2324                     update_max_bonded_distance(rij2, -1, ai, excls->a[j], bd_2b);
2325                 }
2326             }
2327         }
2328     }
2329 }
2330
2331 /*! \brief Set the distance, function type and atom indices for the longest atom distance involved in intermolecular interactions for two-body and multi-body bonded interactions */
2332 static void bonded_distance_intermol(const InteractionLists &ilists_intermol,
2333                                      gmx_bool bBCheck,
2334                                      const rvec *x, int ePBC, const matrix box,
2335                                      bonded_distance_t *bd_2b,
2336                                      bonded_distance_t *bd_mb)
2337 {
2338     t_pbc pbc;
2339
2340     set_pbc(&pbc, ePBC, box);
2341
2342     for (int ftype = 0; ftype < F_NRE; ftype++)
2343     {
2344         if (dd_check_ftype(ftype, bBCheck, FALSE, FALSE))
2345         {
2346             const auto    &il   = ilists_intermol[ftype];
2347             int            nral = NRAL(ftype);
2348
2349             /* No nral>1 check here, since intermol interactions always
2350              * have nral>=2 (and the code is also correct for nral=1).
2351              */
2352             for (int i = 0; i < il.size(); i += 1+nral)
2353             {
2354                 for (int ai = 0; ai < nral; ai++)
2355                 {
2356                     int atom_i = il.iatoms[i + 1 + ai];
2357
2358                     for (int aj = ai + 1; aj < nral; aj++)
2359                     {
2360                         rvec dx;
2361                         real rij2;
2362
2363                         int  atom_j = il.iatoms[i + 1 + aj];
2364
2365                         pbc_dx(&pbc, x[atom_i], x[atom_j], dx);
2366
2367                         rij2 = norm2(dx);
2368
2369                         update_max_bonded_distance(rij2, ftype,
2370                                                    atom_i, atom_j,
2371                                                    (nral == 2) ? bd_2b : bd_mb);
2372                     }
2373                 }
2374             }
2375         }
2376     }
2377 }
2378
2379 //! Returns whether \p molt has at least one virtual site
2380 static bool moltypeHasVsite(const gmx_moltype_t &molt)
2381 {
2382     bool hasVsite = false;
2383     for (int i = 0; i < F_NRE; i++)
2384     {
2385         if ((interaction_function[i].flags & IF_VSITE) &&
2386             molt.ilist[i].size() > 0)
2387         {
2388             hasVsite = true;
2389         }
2390     }
2391
2392     return hasVsite;
2393 }
2394
2395 //! Compute charge group centers of mass for molecule \p molt
2396 static void get_cgcm_mol(const gmx_moltype_t *molt,
2397                          const gmx_ffparams_t *ffparams,
2398                          int ePBC, t_graph *graph, const matrix box,
2399                          const rvec *x, rvec *xs, rvec *cg_cm)
2400 {
2401     int n, i;
2402
2403     if (ePBC != epbcNONE)
2404     {
2405         mk_mshift(nullptr, graph, ePBC, box, x);
2406
2407         shift_x(graph, box, x, xs);
2408         /* By doing an extra mk_mshift the molecules that are broken
2409          * because they were e.g. imported from another software
2410          * will be made whole again. Such are the healing powers
2411          * of GROMACS.
2412          */
2413         mk_mshift(nullptr, graph, ePBC, box, xs);
2414     }
2415     else
2416     {
2417         /* We copy the coordinates so the original coordinates remain
2418          * unchanged, just to be 100% sure that we do not affect
2419          * binary reproducibility of simulations.
2420          */
2421         n = molt->cgs.index[molt->cgs.nr];
2422         for (i = 0; i < n; i++)
2423         {
2424             copy_rvec(x[i], xs[i]);
2425         }
2426     }
2427
2428     if (moltypeHasVsite(*molt))
2429     {
2430         /* Convert to old, deprecated format */
2431         t_ilist ilist[F_NRE];
2432         for (int ftype = 0; ftype < F_NRE; ftype++)
2433         {
2434             if (interaction_function[ftype].flags & IF_VSITE)
2435             {
2436                 ilist[ftype].nr     = molt->ilist[ftype].size();
2437                 ilist[ftype].iatoms = const_cast<int *>(molt->ilist[ftype].iatoms.data());
2438             }
2439         }
2440
2441         construct_vsites(nullptr, xs, 0.0, nullptr,
2442                          ffparams->iparams.data(), ilist,
2443                          epbcNONE, TRUE, nullptr, nullptr);
2444     }
2445
2446     calc_cgcm(nullptr, 0, molt->cgs.nr, &molt->cgs, xs, cg_cm);
2447 }
2448
2449 void dd_bonded_cg_distance(const gmx::MDLogger &mdlog,
2450                            const gmx_mtop_t *mtop,
2451                            const t_inputrec *ir,
2452                            const rvec *x, const matrix box,
2453                            gmx_bool bBCheck,
2454                            real *r_2b, real *r_mb)
2455 {
2456     gmx_bool           bExclRequired;
2457     int                at_offset;
2458     t_graph            graph;
2459     rvec              *xs, *cg_cm;
2460     bonded_distance_t  bd_2b = { 0, -1, -1, -1 };
2461     bonded_distance_t  bd_mb = { 0, -1, -1, -1 };
2462
2463     bExclRequired = inputrecExclForces(ir);
2464
2465     *r_2b     = 0;
2466     *r_mb     = 0;
2467     at_offset = 0;
2468     for (const gmx_molblock_t &molb : mtop->molblock)
2469     {
2470         const gmx_moltype_t &molt = mtop->moltype[molb.type];
2471         if (molt.cgs.nr == 1 || molb.nmol == 0)
2472         {
2473             at_offset += molb.nmol*molt.atoms.nr;
2474         }
2475         else
2476         {
2477             if (ir->ePBC != epbcNONE)
2478             {
2479                 mk_graph_moltype(molt, &graph);
2480             }
2481
2482             std::vector<int> at2cg = make_at2cg(molt.cgs);
2483             snew(xs, molt.atoms.nr);
2484             snew(cg_cm, molt.cgs.nr);
2485             for (int mol = 0; mol < molb.nmol; mol++)
2486             {
2487                 get_cgcm_mol(&molt, &mtop->ffparams, ir->ePBC, &graph, box,
2488                              x+at_offset, xs, cg_cm);
2489
2490                 bonded_distance_t bd_mol_2b = { 0, -1, -1, -1 };
2491                 bonded_distance_t bd_mol_mb = { 0, -1, -1, -1 };
2492
2493                 bonded_cg_distance_mol(&molt, at2cg, bBCheck, bExclRequired, cg_cm,
2494                                        &bd_mol_2b, &bd_mol_mb);
2495
2496                 /* Process the mol data adding the atom index offset */
2497                 update_max_bonded_distance(bd_mol_2b.r2, bd_mol_2b.ftype,
2498                                            at_offset + bd_mol_2b.a1,
2499                                            at_offset + bd_mol_2b.a2,
2500                                            &bd_2b);
2501                 update_max_bonded_distance(bd_mol_mb.r2, bd_mol_mb.ftype,
2502                                            at_offset + bd_mol_mb.a1,
2503                                            at_offset + bd_mol_mb.a2,
2504                                            &bd_mb);
2505
2506                 at_offset += molt.atoms.nr;
2507             }
2508             sfree(cg_cm);
2509             sfree(xs);
2510             if (ir->ePBC != epbcNONE)
2511             {
2512                 done_graph(&graph);
2513             }
2514         }
2515     }
2516
2517     if (mtop->bIntermolecularInteractions)
2518     {
2519         if (ncg_mtop(mtop) < mtop->natoms)
2520         {
2521             gmx_fatal(FARGS, "The combination of intermolecular interactions, charge groups and domain decomposition is not supported. Use cutoff-scheme=Verlet (which removes the charge groups) or run without domain decomposition.");
2522         }
2523
2524         GMX_RELEASE_ASSERT(mtop->intermolecular_ilist, "We should have an ilist when intermolecular interactions are on");
2525
2526         bonded_distance_intermol(*mtop->intermolecular_ilist,
2527                                  bBCheck,
2528                                  x, ir->ePBC, box,
2529                                  &bd_2b, &bd_mb);
2530     }
2531
2532     *r_2b = sqrt(bd_2b.r2);
2533     *r_mb = sqrt(bd_mb.r2);
2534
2535     if (*r_2b > 0 || *r_mb > 0)
2536     {
2537         GMX_LOG(mdlog.info).appendText("Initial maximum distances in bonded interactions:");
2538         if (*r_2b > 0)
2539         {
2540             GMX_LOG(mdlog.info).appendTextFormatted(
2541                     "    two-body bonded interactions: %5.3f nm, %s, atoms %d %d",
2542                     *r_2b, (bd_2b.ftype >= 0) ? interaction_function[bd_2b.ftype].longname : "Exclusion",
2543                     bd_2b.a1 + 1, bd_2b.a2 + 1);
2544         }
2545         if (*r_mb > 0)
2546         {
2547             GMX_LOG(mdlog.info).appendTextFormatted(
2548                     "  multi-body bonded interactions: %5.3f nm, %s, atoms %d %d",
2549                     *r_mb, interaction_function[bd_mb.ftype].longname,
2550                     bd_mb.a1 + 1, bd_mb.a2 + 1);
2551         }
2552     }
2553 }