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,2020, 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/network.h"
  61 #include "gromacs/math/vec.h"
  62 #include "gromacs/mdlib/forcerec.h"
  63 #include "gromacs/mdlib/gmx_omp_nthreads.h"
  64 #include "gromacs/mdlib/vsite.h"
  65 #include "gromacs/mdtypes/commrec.h"
  66 #include "gromacs/mdtypes/forcerec.h"
  67 #include "gromacs/mdtypes/inputrec.h"
  68 #include "gromacs/mdtypes/md_enums.h"
  69 #include "gromacs/mdtypes/mdatom.h"
  70 #include "gromacs/mdtypes/state.h"
  71 #include "gromacs/pbcutil/mshift.h"
  72 #include "gromacs/pbcutil/pbc.h"
  73 #include "gromacs/topology/ifunc.h"
  74 #include "gromacs/topology/mtop_util.h"
  75 #include "gromacs/topology/topsort.h"
  76 #include "gromacs/utility/cstringutil.h"
  77 #include "gromacs/utility/exceptions.h"
  78 #include "gromacs/utility/fatalerror.h"
  79 #include "gromacs/utility/gmxassert.h"
  80 #include "gromacs/utility/listoflists.h"
  81 #include "gromacs/utility/logger.h"
  82 #include "gromacs/utility/smalloc.h"
  83 #include "gromacs/utility/strconvert.h"
  84 #include "gromacs/utility/stringstream.h"
  85 #include "gromacs/utility/stringutil.h"
  86 #include "gromacs/utility/textwriter.h"
  87
  88 #include "domdec_constraints.h"
  89 #include "domdec_internal.h"
  90 #include "domdec_vsite.h"
  91 #include "dump.h"
  92
  93 using gmx::ArrayRef;
  94 using gmx::ListOfLists;
  95 using gmx::RVec;
  96
  97 /*! \brief The number of integer item in the local state, used for broadcasting of the state */
  98 #define NITEM_DD_INIT_LOCAL_STATE 5
  99
 100 struct reverse_ilist_t
 101 {
 102     std::vector<int> index;              /* Index for each atom into il          */
 103     std::vector<int> il;                 /* ftype|type|a0|...|an|ftype|...       */
 104     int              numAtomsInMolecule; /* The number of atoms in this molecule */
 105 };
 106
 107 struct MolblockIndices
 108 {
 109     int a_start;
 110     int a_end;
 111     int natoms_mol;
 112     int type;
 113 };
 114
 115 /*! \brief Struct for thread local work data for local topology generation */
 116 struct thread_work_t
 117 {
 118     /*! \brief Constructor
 119      *
 120      * \param[in] ffparams  The interaction parameters, the lifetime of the created object should not exceed the lifetime of the passed parameters
 121      */
 122     thread_work_t(const gmx_ffparams_t& ffparams) : idef(ffparams) {}
 123
 124     InteractionDefinitions         idef;       /**< Partial local topology */
 125     std::unique_ptr<gmx::VsitePbc> vsitePbc;   /**< vsite PBC structure */
 126     int                            nbonded;    /**< The number of bondeds in this struct */
 127     ListOfLists<int>               excl;       /**< List of exclusions */
 128     int                            excl_count; /**< The total exclusion count for \p excl */
 129 };
 130
 131 /*! \brief Struct for the reverse topology: links bonded interactions to atomsx */
 132 struct gmx_reverse_top_t
 133 {
 134     //! @cond Doxygen_Suppress
 135     //! \brief Are there constraints in this revserse top?
 136     bool bConstr = false;
 137     //! \brief Are there settles in this revserse top?
 138     bool bSettle = false;
 139     //! \brief All bonded interactions have to be assigned?
 140     bool bBCheck = false;
 141     //! \brief Are there bondeds/exclusions between atoms?
 142     bool bInterAtomicInteractions = false;
 143     //! \brief Reverse ilist for all moltypes
 144     std::vector<reverse_ilist_t> ril_mt;
 145     //! \brief The size of ril_mt[?].index summed over all entries
 146     int ril_mt_tot_size = 0;
 147     //! \brief The sorting state of bondeds for free energy
 148     int ilsort = ilsortUNKNOWN;
 149     //! \brief molblock to global atom index for quick lookup of molblocks on atom index
 150     std::vector<MolblockIndices> mbi;
 151
 152     //! \brief Do we have intermolecular interactions?
 153     bool bIntermolecularInteractions = false;
 154     //! \brief Intermolecular reverse ilist
 155     reverse_ilist_t ril_intermol;
 156
 157     /* Work data structures for multi-threading */
 158     //! \brief Thread work array for local topology generation
 159     std::vector<thread_work_t> th_work;
 160     //! @endcond
 161 };
 162
 163 /*! \brief Returns the number of atom entries for il in gmx_reverse_top_t */
 164 static int nral_rt(int ftype)
 165 {
 166     int nral;
 167
 168     nral = NRAL(ftype);
 169     if (interaction_function[ftype].flags & IF_VSITE)
 170     {
 171         /* With vsites the reverse topology contains an extra entry
 172          * for storing if constructing atoms are vsites.
 173          */
 174         nral += 1;
 175     }
 176
 177     return nral;
 178 }
 179
 180 /*! \brief Return whether interactions of type \p ftype need to be assigned exactly once */
 181 static gmx_bool dd_check_ftype(int ftype, gmx_bool bBCheck, gmx_bool bConstr, gmx_bool bSettle)
 182 {
 183     return ((((interaction_function[ftype].flags & IF_BOND) != 0U)
 184              && ((interaction_function[ftype].flags & IF_VSITE) == 0U)
 185              && (bBCheck || ((interaction_function[ftype].flags & IF_LIMZERO) == 0U)))
 186             || (bConstr && (ftype == F_CONSTR || ftype == F_CONSTRNC)) || (bSettle && ftype == F_SETTLE));
 187 }
 188
 189 /*! \brief Checks whether interactions have been assigned for one function type
 190  *
 191  * Loops over a list of interactions in the local topology of one function type
 192  * and flags each of the interactions as assigned in the global \p isAssigned list.
 193  * Exits with an inconsistency error when an interaction is assigned more than once.
 194  */
 195 static void flagInteractionsForType(const int                ftype,
 196                                     const InteractionList&   il,
 197                                     const reverse_ilist_t&   ril,
 198                                     const gmx::Range<int>&   atomRange,
 199                                     const int                numAtomsPerMolecule,
 200                                     gmx::ArrayRef<const int> globalAtomIndices,
 201                                     gmx::ArrayRef<int>       isAssigned)
 202 {
 203     const int nril_mol = ril.index[numAtomsPerMolecule];
 204     const int nral     = NRAL(ftype);
 205
 206     for (int i = 0; i < il.size(); i += 1 + nral)
 207     {
 208         // ia[0] is the interaction type, ia[1, ...] the atom indices
 209         const int* ia = il.iatoms.data() + i;
 210         // Extract the global atom index of the first atom in this interaction
 211         const int a0 = globalAtomIndices[ia[1]];
 212         /* Check if this interaction is in
 213          * the currently checked molblock.
 214          */
 215         if (atomRange.isInRange(a0))
 216         {
 217             // The molecule index in the list of this molecule type
 218             const int moleculeIndex = (a0 - atomRange.begin()) / numAtomsPerMolecule;
 219             const int atomOffset = (a0 - atomRange.begin()) - moleculeIndex * numAtomsPerMolecule;
 220             const int globalAtomStartInMolecule = atomRange.begin() + moleculeIndex * numAtomsPerMolecule;
 221             int       j_mol                     = ril.index[atomOffset];
 222             bool found                          = false;
 223             while (j_mol < ril.index[atomOffset + 1] && !found)
 224             {
 225                 const int j       = moleculeIndex * nril_mol + j_mol;
 226                 const int ftype_j = ril.il[j_mol];
 227                 /* Here we need to check if this interaction has
 228                  * not already been assigned, since we could have
 229                  * multiply defined interactions.
 230                  */
 231                 if (ftype == ftype_j && ia[0] == ril.il[j_mol + 1] && isAssigned[j] == 0)
 232                 {
 233                     /* Check the atoms */
 234                     found = true;
 235                     for (int a = 0; a < nral; a++)
 236                     {
 237                         if (globalAtomIndices[ia[1 + a]]
 238                             != globalAtomStartInMolecule + ril.il[j_mol + 2 + a])
 239                         {
 240                             found = false;
 241                         }
 242                     }
 243                     if (found)
 244                     {
 245                         isAssigned[j] = 1;
 246                     }
 247                 }
 248                 j_mol += 2 + nral_rt(ftype_j);
 249             }
 250             if (!found)
 251             {
 252                 gmx_incons("Some interactions seem to be assigned multiple times");
 253             }
 254         }
 255     }
 256 }
 257
 258 /*! \brief Help print error output when interactions are missing in a molblock
 259  *
 260  * \note This function needs to be called on all ranks (contains a global summation)
 261  */
 262 static std::string printMissingInteractionsMolblock(t_commrec*               cr,
 263                                                     const gmx_reverse_top_t& rt,
 264                                                     const char*              moltypename,
 265                                                     const reverse_ilist_t&   ril,
 266                                                     const gmx::Range<int>&   atomRange,
 267                                                     const int                numAtomsPerMolecule,
 268                                                     const int                numMolecules,
 269                                                     const InteractionDefinitions& idef)
 270 {
 271     const int               nril_mol = ril.index[numAtomsPerMolecule];
 272     std::vector<int>        isAssigned(numMolecules * nril_mol, 0);
 273     gmx::StringOutputStream stream;
 274     gmx::TextWriter         log(&stream);
 275
 276     for (int ftype = 0; ftype < F_NRE; ftype++)
 277     {
 278         if (dd_check_ftype(ftype, rt.bBCheck, rt.bConstr, rt.bSettle))
 279         {
 280             flagInteractionsForType(ftype, idef.il[ftype], ril, atomRange, numAtomsPerMolecule,
 281                                     cr->dd->globalAtomIndices, isAssigned);
 282         }
 283     }
 284
 285     gmx_sumi(isAssigned.size(), isAssigned.data(), cr);
 286
 287     const int numMissingToPrint = 10;
 288     int       i                 = 0;
 289     for (int mol = 0; mol < numMolecules; mol++)
 290     {
 291         int j_mol = 0;
 292         while (j_mol < nril_mol)
 293         {
 294             int ftype = ril.il[j_mol];
 295             int nral  = NRAL(ftype);
 296             int j     = mol * nril_mol + j_mol;
 297             if (isAssigned[j] == 0 && !(interaction_function[ftype].flags & IF_VSITE))
 298             {
 299                 if (DDMASTER(cr->dd))
 300                 {
 301                     if (i == 0)
 302                     {
 303                         log.writeLineFormatted("Molecule type '%s'", moltypename);
 304                         log.writeLineFormatted(
 305                                 "the first %d missing interactions, except for exclusions:",
 306                                 numMissingToPrint);
 307                     }
 308                     log.writeStringFormatted("%20s atoms", interaction_function[ftype].longname);
 309                     int a;
 310                     for (a = 0; a < nral; a++)
 311                     {
 312                         log.writeStringFormatted("%5d", ril.il[j_mol + 2 + a] + 1);
 313                     }
 314                     while (a < 4)
 315                     {
 316                         log.writeString("     ");
 317                         a++;
 318                     }
 319                     log.writeString(" global");
 320                     for (a = 0; a < nral; a++)
 321                     {
 322                         log.writeStringFormatted("%6d", atomRange.begin() + mol * numAtomsPerMolecule
 323                                                                 + ril.il[j_mol + 2 + a] + 1);
 324                     }
 325                     log.ensureLineBreak();
 326                 }
 327                 i++;
 328                 if (i >= numMissingToPrint)
 329                 {
 330                     break;
 331                 }
 332             }
 333             j_mol += 2 + nral_rt(ftype);
 334         }
 335     }
 336
 337     return stream.toString();
 338 }
 339
 340 /*! \brief Help print error output when interactions are missing */
 341 static void printMissingInteractionsAtoms(const gmx::MDLogger&          mdlog,
 342                                           t_commrec*                    cr,
 343                                           const gmx_mtop_t&             mtop,
 344                                           const InteractionDefinitions& idef)
 345 {
 346     const gmx_reverse_top_t& rt = *cr->dd->reverse_top;
 347
 348     /* Print the atoms in the missing interactions per molblock */
 349     int a_end = 0;
 350     for (const gmx_molblock_t& molb : mtop.molblock)
 351     {
 352         const gmx_moltype_t& moltype = mtop.moltype[molb.type];
 353         const int            a_start = a_end;
 354         a_end                        = a_start + molb.nmol * moltype.atoms.nr;
 355         const gmx::Range<int> atomRange(a_start, a_end);
 356
 357         auto warning = printMissingInteractionsMolblock(cr, rt, *(moltype.name), rt.ril_mt[molb.type],
 358                                                         atomRange, moltype.atoms.nr, molb.nmol, idef);
 359
 360         GMX_LOG(mdlog.warning).appendText(warning);
 361     }
 362 }
 363
 364 void dd_print_missing_interactions(const gmx::MDLogger&           mdlog,
 365                                    t_commrec*                     cr,
 366                                    int                            local_count,
 367                                    const gmx_mtop_t*              top_global,
 368                                    const gmx_localtop_t*          top_local,
 369                                    gmx::ArrayRef<const gmx::RVec> x,
 370                                    const matrix                   box)
 371 {
 372     int           ndiff_tot, cl[F_NRE], n, ndiff, rest_global, rest_local;
 373     int           ftype, nral;
 374     gmx_domdec_t* dd;
 375
 376     dd = cr->dd;
 377
 378     GMX_LOG(mdlog.warning)
 379             .appendText(
 380                     "Not all bonded interactions have been properly assigned to the domain "
 381                     "decomposition cells");
 382
 383     ndiff_tot = local_count - dd->nbonded_global;
 384
 385     for (ftype = 0; ftype < F_NRE; ftype++)
 386     {
 387         nral      = NRAL(ftype);
 388         cl[ftype] = top_local->idef.il[ftype].size() / (1 + nral);
 389     }
 390
 391     gmx_sumi(F_NRE, cl, cr);
 392
 393     if (DDMASTER(dd))
 394     {
 395         GMX_LOG(mdlog.warning).appendText("A list of missing interactions:");
 396         rest_global = dd->nbonded_global;
 397         rest_local  = local_count;
 398         for (ftype = 0; ftype < F_NRE; ftype++)
 399         {
 400             /* In the reverse and local top all constraints are merged
 401              * into F_CONSTR. So in the if statement we skip F_CONSTRNC
 402              * and add these constraints when doing F_CONSTR.
 403              */
 404             if (((interaction_function[ftype].flags & IF_BOND)
 405                  && (dd->reverse_top->bBCheck || !(interaction_function[ftype].flags & IF_LIMZERO)))
 406                 || (dd->reverse_top->bConstr && ftype == F_CONSTR)
 407                 || (dd->reverse_top->bSettle && ftype == F_SETTLE))
 408             {
 409                 n = gmx_mtop_ftype_count(top_global, ftype);
 410                 if (ftype == F_CONSTR)
 411                 {
 412                     n += gmx_mtop_ftype_count(top_global, F_CONSTRNC);
 413                 }
 414                 ndiff = cl[ftype] - n;
 415                 if (ndiff != 0)
 416                 {
 417                     GMX_LOG(mdlog.warning)
 418                             .appendTextFormatted("%20s of %6d missing %6d",
 419                                                  interaction_function[ftype].longname, n, -ndiff);
 420                 }
 421                 rest_global -= n;
 422                 rest_local -= cl[ftype];
 423             }
 424         }
 425
 426         ndiff = rest_local - rest_global;
 427         if (ndiff != 0)
 428         {
 429             GMX_LOG(mdlog.warning).appendTextFormatted("%20s of %6d missing %6d", "exclusions", rest_global, -ndiff);
 430         }
 431     }
 432
 433     printMissingInteractionsAtoms(mdlog, cr, *top_global, top_local->idef);
 434     write_dd_pdb("dd_dump_err", 0, "dump", top_global, cr, -1, as_rvec_array(x.data()), box);
 435
 436     std::string errorMessage;
 437
 438     if (ndiff_tot > 0)
 439     {
 440         errorMessage =
 441                 "One or more interactions were assigned to multiple domains of the domain "
 442                 "decompostion. Please report this bug.";
 443     }
 444     else
 445     {
 446         errorMessage = gmx::formatString(
 447                 "%d of the %d bonded interactions could not be calculated because some atoms "
 448                 "involved moved further apart than the multi-body cut-off distance (%g nm) or the "
 449                 "two-body cut-off distance (%g nm), see option -rdd, for pairs and tabulated bonds "
 450                 "also see option -ddcheck",
 451                 -ndiff_tot, cr->dd->nbonded_global, dd_cutoff_multibody(dd), dd_cutoff_twobody(dd));
 452     }
 453     gmx_fatal_collective(FARGS, cr->mpi_comm_mygroup, MASTER(cr), "%s", errorMessage.c_str());
 454 }
 455
 456 /*! \brief Return global topology molecule information for global atom index \p i_gl */
 457 static void global_atomnr_to_moltype_ind(const gmx_reverse_top_t* rt, int i_gl, int* mb, int* mt, int* mol, int* i_mol)
 458 {
 459     const MolblockIndices* mbi   = rt->mbi.data();
 460     int                    start = 0;
 461     int                    end   = rt->mbi.size(); /* exclusive */
 462     int                    mid;
 463
 464     /* binary search for molblock_ind */
 465     while (TRUE)
 466     {
 467         mid = (start + end) / 2;
 468         if (i_gl >= mbi[mid].a_end)
 469         {
 470             start = mid + 1;
 471         }
 472         else if (i_gl < mbi[mid].a_start)
 473         {
 474             end = mid;
 475         }
 476         else
 477         {
 478             break;
 479         }
 480     }
 481
 482     *mb = mid;
 483     mbi += mid;
 484
 485     *mt    = mbi->type;
 486     *mol   = (i_gl - mbi->a_start) / mbi->natoms_mol;
 487     *i_mol = (i_gl - mbi->a_start) - (*mol) * mbi->natoms_mol;
 488 }
 489
 490 /*! \brief Returns the maximum number of exclusions per atom */
 491 static int getMaxNumExclusionsPerAtom(const ListOfLists<int>& excls)
 492 {
 493     int maxNumExcls = 0;
 494     for (gmx::index at = 0; at < excls.ssize(); at++)
 495     {
 496         const auto list     = excls[at];
 497         const int  numExcls = list.ssize();
 498
 499         GMX_RELEASE_ASSERT(numExcls != 1 || list[0] == at,
 500                            "With 1 exclusion we expect a self-exclusion");
 501
 502         maxNumExcls = std::max(maxNumExcls, numExcls);
 503     }
 504
 505     return maxNumExcls;
 506 }
 507
 508 /*! \brief Run the reverse ilist generation and store it in r_il when \p bAssign = TRUE */
 509 static int low_make_reverse_ilist(const InteractionLists&  il_mt,
 510                                   const t_atom*            atom,
 511                                   int*                     count,
 512                                   gmx_bool                 bConstr,
 513                                   gmx_bool                 bSettle,
 514                                   gmx_bool                 bBCheck,
 515                                   gmx::ArrayRef<const int> r_index,
 516                                   gmx::ArrayRef<int>       r_il,
 517                                   gmx_bool                 bLinkToAllAtoms,
 518                                   gmx_bool                 bAssign)
 519 {
 520     int ftype, j, nlink, link;
 521     int a;
 522     int nint;
 523
 524     nint = 0;
 525     for (ftype = 0; ftype < F_NRE; ftype++)
 526     {
 527         if ((interaction_function[ftype].flags & (IF_BOND | IF_VSITE))
 528             || (bConstr && (ftype == F_CONSTR || ftype == F_CONSTRNC)) || (bSettle && ftype == F_SETTLE))
 529         {
 530             const bool  bVSite = ((interaction_function[ftype].flags & IF_VSITE) != 0U);
 531             const int   nral   = NRAL(ftype);
 532             const auto& il     = il_mt[ftype];
 533             for (int i = 0; i < il.size(); i += 1 + nral)
 534             {
 535                 const int* ia = il.iatoms.data() + i;
 536                 if (bLinkToAllAtoms)
 537                 {
 538                     if (bVSite)
 539                     {
 540                         /* We don't need the virtual sites for the cg-links */
 541                         nlink = 0;
 542                     }
 543                     else
 544                     {
 545                         nlink = nral;
 546                     }
 547                 }
 548                 else
 549                 {
 550                     /* Couple to the first atom in the interaction */
 551                     nlink = 1;
 552                 }
 553                 for (link = 0; link < nlink; link++)
 554                 {
 555                     a = ia[1 + link];
 556                     if (bAssign)
 557                     {
 558                         GMX_ASSERT(!r_il.empty(), "with bAssign not allowed to be empty");
 559                         GMX_ASSERT(!r_index.empty(), "with bAssign not allowed to be empty");
 560                         r_il[r_index[a] + count[a]]     = (ftype == F_CONSTRNC ? F_CONSTR : ftype);
 561                         r_il[r_index[a] + count[a] + 1] = ia[0];
 562                         for (j = 1; j < 1 + nral; j++)
 563                         {
 564                             /* Store the molecular atom number */
 565                             r_il[r_index[a] + count[a] + 1 + j] = ia[j];
 566                         }
 567                     }
 568                     if (interaction_function[ftype].flags & IF_VSITE)
 569                     {
 570                         if (bAssign)
 571                         {
 572                             /* Add an entry to iatoms for storing
 573                              * which of the constructing atoms are
 574                              * vsites again.
 575                              */
 576                             r_il[r_index[a] + count[a] + 2 + nral] = 0;
 577                             for (j = 2; j < 1 + nral; j++)
 578                             {
 579                                 if (atom[ia[j]].ptype == eptVSite)
 580                                 {
 581                                     r_il[r_index[a] + count[a] + 2 + nral] |= (2 << j);
 582                                 }
 583                             }
 584                         }
 585                     }
 586                     else
 587                     {
 588                         /* We do not count vsites since they are always
 589                          * uniquely assigned and can be assigned
 590                          * to multiple nodes with recursive vsites.
 591                          */
 592                         if (bBCheck || !(interaction_function[ftype].flags & IF_LIMZERO))
 593                         {
 594                             nint++;
 595                         }
 596                     }
 597                     count[a] += 2 + nral_rt(ftype);
 598                 }
 599             }
 600         }
 601     }
 602
 603     return nint;
 604 }
 605
 606 /*! \brief Make the reverse ilist: a list of bonded interactions linked to atoms */
 607 static int make_reverse_ilist(const InteractionLists& ilist,
 608                               const t_atoms*          atoms,
 609                               gmx_bool                bConstr,
 610                               gmx_bool                bSettle,
 611                               gmx_bool                bBCheck,
 612                               gmx_bool                bLinkToAllAtoms,
 613                               reverse_ilist_t*        ril_mt)
 614 {
 615     int nat_mt, *count, i, nint_mt;
 616
 617     /* Count the interactions */
 618     nat_mt = atoms->nr;
 619     snew(count, nat_mt);
 620     low_make_reverse_ilist(ilist, atoms->atom, count, bConstr, bSettle, bBCheck, {}, {},
 621                            bLinkToAllAtoms, FALSE);
 622
 623     ril_mt->index.push_back(0);
 624     for (i = 0; i < nat_mt; i++)
 625     {
 626         ril_mt->index.push_back(ril_mt->index[i] + count[i]);
 627         count[i] = 0;
 628     }
 629     ril_mt->il.resize(ril_mt->index[nat_mt]);
 630
 631     /* Store the interactions */
 632     nint_mt = low_make_reverse_ilist(ilist, atoms->atom, count, bConstr, bSettle, bBCheck,
 633                                      ril_mt->index, ril_mt->il, bLinkToAllAtoms, TRUE);
 634
 635     sfree(count);
 636
 637     ril_mt->numAtomsInMolecule = atoms->nr;
 638
 639     return nint_mt;
 640 }
 641
 642 /*! \brief Generate the reverse topology */
 643 static gmx_reverse_top_t make_reverse_top(const gmx_mtop_t* mtop,
 644                                           gmx_bool          bFE,
 645                                           gmx_bool          bConstr,
 646                                           gmx_bool          bSettle,
 647                                           gmx_bool          bBCheck,
 648                                           int*              nint)
 649 {
 650     gmx_reverse_top_t rt;
 651
 652     /* Should we include constraints (for SHAKE) in rt? */
 653     rt.bConstr = bConstr;
 654     rt.bSettle = bSettle;
 655     rt.bBCheck = bBCheck;
 656
 657     rt.bInterAtomicInteractions = mtop->bIntermolecularInteractions;
 658     rt.ril_mt.resize(mtop->moltype.size());
 659     rt.ril_mt_tot_size = 0;
 660     std::vector<int> nint_mt;
 661     for (size_t mt = 0; mt < mtop->moltype.size(); mt++)
 662     {
 663         const gmx_moltype_t& molt = mtop->moltype[mt];
 664         if (molt.atoms.nr > 1)
 665         {
 666             rt.bInterAtomicInteractions = true;
 667         }
 668
 669         /* Make the atom to interaction list for this molecule type */
 670         int numberOfInteractions = make_reverse_ilist(
 671                 molt.ilist, &molt.atoms, rt.bConstr, rt.bSettle, rt.bBCheck, FALSE, &rt.ril_mt[mt]);
 672         nint_mt.push_back(numberOfInteractions);
 673
 674         rt.ril_mt_tot_size += rt.ril_mt[mt].index[molt.atoms.nr];
 675     }
 676     if (debug)
 677     {
 678         fprintf(debug, "The total size of the atom to interaction index is %d integers\n",
 679                 rt.ril_mt_tot_size);
 680     }
 681
 682     *nint = 0;
 683     for (const gmx_molblock_t& molblock : mtop->molblock)
 684     {
 685         *nint += molblock.nmol * nint_mt[molblock.type];
 686     }
 687
 688     /* Make an intermolecular reverse top, if necessary */
 689     rt.bIntermolecularInteractions = mtop->bIntermolecularInteractions;
 690     if (rt.bIntermolecularInteractions)
 691     {
 692         t_atoms atoms_global;
 693
 694         atoms_global.nr   = mtop->natoms;
 695         atoms_global.atom = nullptr; /* Only used with virtual sites */
 696
 697         GMX_RELEASE_ASSERT(mtop->intermolecular_ilist,
 698                            "We should have an ilist when intermolecular interactions are on");
 699
 700         *nint += make_reverse_ilist(*mtop->intermolecular_ilist, &atoms_global, rt.bConstr,
 701                                     rt.bSettle, rt.bBCheck, FALSE, &rt.ril_intermol);
 702     }
 703
 704     if (bFE && gmx_mtop_bondeds_free_energy(mtop))
 705     {
 706         rt.ilsort = ilsortFE_UNSORTED;
 707     }
 708     else
 709     {
 710         rt.ilsort = ilsortNO_FE;
 711     }
 712
 713     /* Make a molblock index for fast searching */
 714     int i = 0;
 715     for (size_t mb = 0; mb < mtop->molblock.size(); mb++)
 716     {
 717         const gmx_molblock_t& molb           = mtop->molblock[mb];
 718         const int             numAtomsPerMol = mtop->moltype[molb.type].atoms.nr;
 719         MolblockIndices       mbi;
 720         mbi.a_start = i;
 721         i += molb.nmol * numAtomsPerMol;
 722         mbi.a_end      = i;
 723         mbi.natoms_mol = numAtomsPerMol;
 724         mbi.type       = molb.type;
 725         rt.mbi.push_back(mbi);
 726     }
 727
 728     for (int th = 0; th < gmx_omp_nthreads_get(emntDomdec); th++)
 729     {
 730         rt.th_work.emplace_back(mtop->ffparams);
 731     }
 732
 733     return rt;
 734 }
 735
 736 void dd_make_reverse_top(FILE*                           fplog,
 737                          gmx_domdec_t*                   dd,
 738                          const gmx_mtop_t*               mtop,
 739                          const gmx::VirtualSitesHandler* vsite,
 740                          const t_inputrec*               ir,
 741                          gmx_bool                        bBCheck)
 742 {
 743     if (fplog)
 744     {
 745         fprintf(fplog, "\nLinking all bonded interactions to atoms\n");
 746     }
 747
 748     /* If normal and/or settle constraints act only within charge groups,
 749      * we can store them in the reverse top and simply assign them to domains.
 750      * Otherwise we need to assign them to multiple domains and set up
 751      * the parallel version constraint algorithm(s).
 752      */
 753
 754     dd->reverse_top = new gmx_reverse_top_t;
 755     *dd->reverse_top =
 756             make_reverse_top(mtop, ir->efep != efepNO, !dd->comm->systemInfo.haveSplitConstraints,
 757                              !dd->comm->systemInfo.haveSplitSettles, bBCheck, &dd->nbonded_global);
 758
 759     dd->haveExclusions = false;
 760     for (const gmx_molblock_t& molb : mtop->molblock)
 761     {
 762         const int maxNumExclusionsPerAtom = getMaxNumExclusionsPerAtom(mtop->moltype[molb.type].excls);
 763         // We checked above that max 1 exclusion means only self exclusions
 764         if (maxNumExclusionsPerAtom > 1)
 765         {
 766             dd->haveExclusions = true;
 767         }
 768     }
 769
 770     if (vsite && vsite->numInterUpdategroupVirtualSites() > 0)
 771     {
 772         if (fplog)
 773         {
 774             fprintf(fplog,
 775                     "There are %d inter update-group virtual sites,\n"
 776                     "will an extra communication step for selected coordinates and forces\n",
 777                     vsite->numInterUpdategroupVirtualSites());
 778         }
 779         init_domdec_vsites(dd, vsite->numInterUpdategroupVirtualSites());
 780     }
 781
 782     if (dd->comm->systemInfo.haveSplitConstraints || dd->comm->systemInfo.haveSplitSettles)
 783     {
 784         init_domdec_constraints(dd, mtop);
 785     }
 786     if (fplog)
 787     {
 788         fprintf(fplog, "\n");
 789     }
 790 }
 791
 792 /*! \brief Store a vsite interaction at the end of \p il
 793  *
 794  * This routine is very similar to add_ifunc, but vsites interactions
 795  * have more work to do than other kinds of interactions, and the
 796  * complex way nral (and thus vector contents) depends on ftype
 797  * confuses static analysis tools unless we fuse the vsite
 798  * atom-indexing organization code with the ifunc-adding code, so that
 799  * they can see that nral is the same value. */
 800 static inline void add_ifunc_for_vsites(t_iatom*           tiatoms,
 801                                         const gmx_ga2la_t& ga2la,
 802                                         int                nral,
 803                                         gmx_bool           bHomeA,
 804                                         int                a,
 805                                         int                a_gl,
 806                                         int                a_mol,
 807                                         const t_iatom*     iatoms,
 808                                         InteractionList*   il)
 809 {
 810     /* Copy the type */
 811     tiatoms[0] = iatoms[0];
 812
 813     if (bHomeA)
 814     {
 815         /* We know the local index of the first atom */
 816         tiatoms[1] = a;
 817     }
 818     else
 819     {
 820         /* Convert later in make_local_vsites */
 821         tiatoms[1] = -a_gl - 1;
 822     }
 823
 824     GMX_ASSERT(nral >= 2 && nral <= 5, "Invalid nral for vsites");
 825     for (int k = 2; k < 1 + nral; k++)
 826     {
 827         int ak_gl = a_gl + iatoms[k] - a_mol;
 828         if (const int* homeIndex = ga2la.findHome(ak_gl))
 829         {
 830             tiatoms[k] = *homeIndex;
 831         }
 832         else
 833         {
 834             /* Copy the global index, convert later in make_local_vsites */
 835             tiatoms[k] = -(ak_gl + 1);
 836         }
 837         // Note that ga2la_get_home always sets the third parameter if
 838         // it returns TRUE
 839     }
 840     il->push_back(tiatoms[0], nral, tiatoms + 1);
 841 }
 842
 843 /*! \brief Store a position restraint in idef and iatoms, complex because the parameters are different for each entry */
 844 static void add_posres(int                     mol,
 845                        int                     a_mol,
 846                        int                     numAtomsInMolecule,
 847                        const gmx_molblock_t*   molb,
 848                        t_iatom*                iatoms,
 849                        const t_iparams*        ip_in,
 850                        InteractionDefinitions* idef)
 851 {
 852     /* This position restraint has not been added yet,
 853      * so it's index is the current number of position restraints.
 854      */
 855     const int n = idef->il[F_POSRES].size() / 2;
 856
 857     /* Get the position restraint coordinates from the molblock */
 858     const int a_molb = mol * numAtomsInMolecule + a_mol;
 859     GMX_ASSERT(a_molb < ssize(molb->posres_xA),
 860                "We need a sufficient number of position restraint coordinates");
 861     /* Copy the force constants */
 862     t_iparams ip        = ip_in[iatoms[0]];
 863     ip.posres.pos0A[XX] = molb->posres_xA[a_molb][XX];
 864     ip.posres.pos0A[YY] = molb->posres_xA[a_molb][YY];
 865     ip.posres.pos0A[ZZ] = molb->posres_xA[a_molb][ZZ];
 866     if (!molb->posres_xB.empty())
 867     {
 868         ip.posres.pos0B[XX] = molb->posres_xB[a_molb][XX];
 869         ip.posres.pos0B[YY] = molb->posres_xB[a_molb][YY];
 870         ip.posres.pos0B[ZZ] = molb->posres_xB[a_molb][ZZ];
 871     }
 872     else
 873     {
 874         ip.posres.pos0B[XX] = ip.posres.pos0A[XX];
 875         ip.posres.pos0B[YY] = ip.posres.pos0A[YY];
 876         ip.posres.pos0B[ZZ] = ip.posres.pos0A[ZZ];
 877     }
 878     /* Set the parameter index for idef->iparams_posres */
 879     iatoms[0] = n;
 880     idef->iparams_posres.push_back(ip);
 881
 882     GMX_ASSERT(int(idef->iparams_posres.size()) == n + 1,
 883                "The index of the parameter type should match n");
 884 }
 885
 886 /*! \brief Store a flat-bottomed position restraint in idef and iatoms, complex because the parameters are different for each entry */
 887 static void add_fbposres(int                     mol,
 888                          int                     a_mol,
 889                          int                     numAtomsInMolecule,
 890                          const gmx_molblock_t*   molb,
 891                          t_iatom*                iatoms,
 892                          const t_iparams*        ip_in,
 893                          InteractionDefinitions* idef)
 894 {
 895     /* This flat-bottom position restraint has not been added yet,
 896      * so it's index is the current number of position restraints.
 897      */
 898     const int n = idef->il[F_FBPOSRES].size() / 2;
 899
 900     /* Get the position restraint coordinats from the molblock */
 901     const int a_molb = mol * numAtomsInMolecule + a_mol;
 902     GMX_ASSERT(a_molb < ssize(molb->posres_xA),
 903                "We need a sufficient number of position restraint coordinates");
 904     /* Copy the force constants */
 905     t_iparams ip = ip_in[iatoms[0]];
 906     /* Take reference positions from A position of normal posres */
 907     ip.fbposres.pos0[XX] = molb->posres_xA[a_molb][XX];
 908     ip.fbposres.pos0[YY] = molb->posres_xA[a_molb][YY];
 909     ip.fbposres.pos0[ZZ] = molb->posres_xA[a_molb][ZZ];
 910
 911     /* Note: no B-type for flat-bottom posres */
 912
 913     /* Set the parameter index for idef->iparams_fbposres */
 914     iatoms[0] = n;
 915     idef->iparams_fbposres.push_back(ip);
 916
 917     GMX_ASSERT(int(idef->iparams_fbposres.size()) == n + 1,
 918                "The index of the parameter type should match n");
 919 }
 920
 921 /*! \brief Store a virtual site interaction, complex because of PBC and recursion */
 922 static void add_vsite(const gmx_ga2la_t&       ga2la,
 923                       gmx::ArrayRef<const int> index,
 924                       gmx::ArrayRef<const int> rtil,
 925                       int                      ftype,
 926                       int                      nral,
 927                       gmx_bool                 bHomeA,
 928                       int                      a,
 929                       int                      a_gl,
 930                       int                      a_mol,
 931                       const t_iatom*           iatoms,
 932                       InteractionDefinitions*  idef)
 933 {
 934     int     k;
 935     t_iatom tiatoms[1 + MAXATOMLIST];
 936     int     j, ftype_r, nral_r;
 937
 938     /* Add this interaction to the local topology */
 939     add_ifunc_for_vsites(tiatoms, ga2la, nral, bHomeA, a, a_gl, a_mol, iatoms, &idef->il[ftype]);
 940
 941     if (iatoms[1 + nral])
 942     {
 943         /* Check for recursion */
 944         for (k = 2; k < 1 + nral; k++)
 945         {
 946             if ((iatoms[1 + nral] & (2 << k)) && (tiatoms[k] < 0))
 947             {
 948                 /* This construction atoms is a vsite and not a home atom */
 949                 if (gmx_debug_at)
 950                 {
 951                     fprintf(debug, "Constructing atom %d of vsite atom %d is a vsite and non-home\n",
 952                             iatoms[k] + 1, a_mol + 1);
 953                 }
 954                 /* Find the vsite construction */
 955
 956                 /* Check all interactions assigned to this atom */
 957                 j = index[iatoms[k]];
 958                 while (j < index[iatoms[k] + 1])
 959                 {
 960                     ftype_r = rtil[j++];
 961                     nral_r  = NRAL(ftype_r);
 962                     if (interaction_function[ftype_r].flags & IF_VSITE)
 963                     {
 964                         /* Add this vsite (recursion) */
 965                         add_vsite(ga2la, index, rtil, ftype_r, nral_r, FALSE, -1,
 966                                   a_gl + iatoms[k] - iatoms[1], iatoms[k], rtil.data() + j, idef);
 967                     }
 968                     j += 1 + nral_rt(ftype_r);
 969                 }
 970             }
 971         }
 972     }
 973 }
 974
 975 /*! \brief Returns the squared distance between atoms \p i and \p j */
 976 static real dd_dist2(t_pbc* pbc_null, const rvec* x, const int i, int j)
 977 {
 978     rvec dx;
 979
 980     if (pbc_null)
 981     {
 982         pbc_dx_aiuc(pbc_null, x[i], x[j], dx);
 983     }
 984     else
 985     {
 986         rvec_sub(x[i], x[j], dx);
 987     }
 988
 989     return norm2(dx);
 990 }
 991
 992 /*! \brief Append t_idef structures 1 to nsrc in src to *dest */
 993 static void combine_idef(InteractionDefinitions* dest, gmx::ArrayRef<const thread_work_t> src)
 994 {
 995     int ftype;
 996
 997     for (ftype = 0; ftype < F_NRE; ftype++)
 998     {
 999         int n = 0;
1000         for (gmx::index s = 1; s < src.ssize(); s++)
1001         {
1002             n += src[s].idef.il[ftype].size();
1003         }
1004         if (n > 0)
1005         {
1006             for (gmx::index s = 1; s < src.ssize(); s++)
1007             {
1008                 dest->il[ftype].append(src[s].idef.il[ftype]);
1009             }
1010
1011             /* Position restraints need an additional treatment */
1012             if (ftype == F_POSRES || ftype == F_FBPOSRES)
1013             {
1014                 int                     nposres = dest->il[ftype].size() / 2;
1015                 std::vector<t_iparams>& iparams_dest =
1016                         (ftype == F_POSRES ? dest->iparams_posres : dest->iparams_fbposres);
1017
1018                 /* Set nposres to the number of original position restraints in dest */
1019                 for (gmx::index s = 1; s < src.ssize(); s++)
1020                 {
1021                     nposres -= src[s].idef.il[ftype].size() / 2;
1022                 }
1023
1024                 for (gmx::index s = 1; s < src.ssize(); s++)
1025                 {
1026                     const std::vector<t_iparams>& iparams_src =
1027                             (ftype == F_POSRES ? src[s].idef.iparams_posres : src[s].idef.iparams_fbposres);
1028                     iparams_dest.insert(iparams_dest.end(), iparams_src.begin(), iparams_src.end());
1029
1030                     /* Correct the indices into iparams_posres */
1031                     for (int i = 0; i < src[s].idef.il[ftype].size() / 2; i++)
1032                     {
1033                         /* Correct the index into iparams_posres */
1034                         dest->il[ftype].iatoms[nposres * 2] = nposres;
1035                         nposres++;
1036                     }
1037                 }
1038                 GMX_RELEASE_ASSERT(
1039                         int(iparams_dest.size()) == nposres,
1040                         "The number of parameters should match the number of restraints");
1041             }
1042         }
1043     }
1044 }
1045
1046 /*! \brief Check and when available assign bonded interactions for local atom i
1047  */
1048 static inline void check_assign_interactions_atom(int                       i,
1049                                                   int                       i_gl,
1050                                                   int                       mol,
1051                                                   int                       i_mol,
1052                                                   int                       numAtomsInMolecule,
1053                                                   gmx::ArrayRef<const int>  index,
1054                                                   gmx::ArrayRef<const int>  rtil,
1055                                                   gmx_bool                  bInterMolInteractions,
1056                                                   int                       ind_start,
1057                                                   int                       ind_end,
1058                                                   const gmx_domdec_t*       dd,
1059                                                   const gmx_domdec_zones_t* zones,
1060                                                   const gmx_molblock_t*     molb,
1061                                                   gmx_bool                  bRCheckMB,
1062                                                   const ivec                rcheck,
1063                                                   gmx_bool                  bRCheck2B,
1064                                                   real                      rc2,
1065                                                   t_pbc*                    pbc_null,
1066                                                   rvec*                     cg_cm,
1067                                                   const t_iparams*          ip_in,
1068                                                   InteractionDefinitions*   idef,
1069                                                   int                       iz,
1070                                                   gmx_bool                  bBCheck,
1071                                                   int*                      nbonded_local)
1072 {
1073     gmx::ArrayRef<const DDPairInteractionRanges> iZones = zones->iZones;
1074
1075     int j = ind_start;
1076     while (j < ind_end)
1077     {
1078         t_iatom tiatoms[1 + MAXATOMLIST];
1079
1080         const int ftype  = rtil[j++];
1081         auto      iatoms = gmx::constArrayRefFromArray(rtil.data() + j, rtil.size() - j);
1082         const int nral   = NRAL(ftype);
1083         if (interaction_function[ftype].flags & IF_VSITE)
1084         {
1085             assert(!bInterMolInteractions);
1086             /* The vsite construction goes where the vsite itself is */
1087             if (iz == 0)
1088             {
1089                 add_vsite(*dd->ga2la, index, rtil, ftype, nral, TRUE, i, i_gl, i_mol, iatoms.data(), idef);
1090             }
1091             j += 1 + nral + 2;
1092         }
1093         else
1094         {
1095             gmx_bool bUse;
1096
1097             /* Copy the type */
1098             tiatoms[0] = iatoms[0];
1099
1100             if (nral == 1)
1101             {
1102                 assert(!bInterMolInteractions);
1103                 /* Assign single-body interactions to the home zone */
1104                 if (iz == 0)
1105                 {
1106                     bUse       = TRUE;
1107                     tiatoms[1] = i;
1108                     if (ftype == F_POSRES)
1109                     {
1110                         add_posres(mol, i_mol, numAtomsInMolecule, molb, tiatoms, ip_in, idef);
1111                     }
1112                     else if (ftype == F_FBPOSRES)
1113                     {
1114                         add_fbposres(mol, i_mol, numAtomsInMolecule, molb, tiatoms, ip_in, idef);
1115                     }
1116                 }
1117                 else
1118                 {
1119                     bUse = FALSE;
1120                 }
1121             }
1122             else if (nral == 2)
1123             {
1124                 /* This is a two-body interaction, we can assign
1125                  * analogous to the non-bonded assignments.
1126                  */
1127                 int k_gl;
1128
1129                 if (!bInterMolInteractions)
1130                 {
1131                     /* Get the global index using the offset in the molecule */
1132                     k_gl = i_gl + iatoms[2] - i_mol;
1133                 }
1134                 else
1135                 {
1136                     k_gl = iatoms[2];
1137                 }
1138                 if (const auto* entry = dd->ga2la->find(k_gl))
1139                 {
1140                     int kz = entry->cell;
1141                     if (kz >= zones->n)
1142                     {
1143                         kz -= zones->n;
1144                     }
1145                     /* Check zone interaction assignments */
1146                     bUse = ((iz < iZones.ssize() && iz <= kz && iZones[iz].jZoneRange.isInRange(kz))
1147                             || (kz < iZones.ssize() && iz > kz && iZones[kz].jZoneRange.isInRange(iz)));
1148                     if (bUse)
1149                     {
1150                         GMX_ASSERT(ftype != F_CONSTR || (iz == 0 && kz == 0),
1151                                    "Constraint assigned here should only involve home atoms");
1152
1153                         tiatoms[1] = i;
1154                         tiatoms[2] = entry->la;
1155                         /* If necessary check the cgcm distance */
1156                         if (bRCheck2B && dd_dist2(pbc_null, cg_cm, tiatoms[1], tiatoms[2]) >= rc2)
1157                         {
1158                             bUse = FALSE;
1159                         }
1160                     }
1161                 }
1162                 else
1163                 {
1164                     bUse = false;
1165                 }
1166             }
1167             else
1168             {
1169                 /* Assign this multi-body bonded interaction to
1170                  * the local node if we have all the atoms involved
1171                  * (local or communicated) and the minimum zone shift
1172                  * in each dimension is zero, for dimensions
1173                  * with 2 DD cells an extra check may be necessary.
1174                  */
1175                 ivec k_zero, k_plus;
1176                 int  k;
1177
1178                 bUse = TRUE;
1179                 clear_ivec(k_zero);
1180                 clear_ivec(k_plus);
1181                 for (k = 1; k <= nral && bUse; k++)
1182                 {
1183                     int k_gl;
1184                     if (!bInterMolInteractions)
1185                     {
1186                         /* Get the global index using the offset in the molecule */
1187                         k_gl = i_gl + iatoms[k] - i_mol;
1188                     }
1189                     else
1190                     {
1191                         k_gl = iatoms[k];
1192                     }
1193                     const auto* entry = dd->ga2la->find(k_gl);
1194                     if (entry == nullptr || entry->cell >= zones->n)
1195                     {
1196                         /* We do not have this atom of this interaction
1197                          * locally, or it comes from more than one cell
1198                          * away.
1199                          */
1200                         bUse = FALSE;
1201                     }
1202                     else
1203                     {
1204                         int d;
1205
1206                         tiatoms[k] = entry->la;
1207                         for (d = 0; d < DIM; d++)
1208                         {
1209                             if (zones->shift[entry->cell][d] == 0)
1210                             {
1211                                 k_zero[d] = k;
1212                             }
1213                             else
1214                             {
1215                                 k_plus[d] = k;
1216                             }
1217                         }
1218                     }
1219                 }
1220                 bUse = (bUse && (k_zero[XX] != 0) && (k_zero[YY] != 0) && (k_zero[ZZ] != 0));
1221                 if (bRCheckMB)
1222                 {
1223                     int d;
1224
1225                     for (d = 0; (d < DIM && bUse); d++)
1226                     {
1227                         /* Check if the cg_cm distance falls within
1228                          * the cut-off to avoid possible multiple
1229                          * assignments of bonded interactions.
1230                          */
1231                         if (rcheck[d] && k_plus[d]
1232                             && dd_dist2(pbc_null, cg_cm, tiatoms[k_zero[d]], tiatoms[k_plus[d]]) >= rc2)
1233                         {
1234                             bUse = FALSE;
1235                         }
1236                     }
1237                 }
1238             }
1239             if (bUse)
1240             {
1241                 /* Add this interaction to the local topology */
1242                 idef->il[ftype].push_back(tiatoms[0], nral, tiatoms + 1);
1243                 /* Sum so we can check in global_stat
1244                  * if we have everything.
1245                  */
1246                 if (bBCheck || !(interaction_function[ftype].flags & IF_LIMZERO))
1247                 {
1248                     (*nbonded_local)++;
1249                 }
1250             }
1251             j += 1 + nral;
1252         }
1253     }
1254 }
1255
1256 /*! \brief This function looks up and assigns bonded interactions for zone iz.
1257  *
1258  * With thread parallelizing each thread acts on a different atom range:
1259  * at_start to at_end.
1260  */
1261 static int make_bondeds_zone(gmx_domdec_t*                      dd,
1262                              const gmx_domdec_zones_t*          zones,
1263                              const std::vector<gmx_molblock_t>& molb,
1264                              gmx_bool                           bRCheckMB,
1265                              ivec                               rcheck,
1266                              gmx_bool                           bRCheck2B,
1267                              real                               rc2,
1268                              t_pbc*                             pbc_null,
1269                              rvec*                              cg_cm,
1270                              const t_iparams*                   ip_in,
1271                              InteractionDefinitions*            idef,
1272                              int                                izone,
1273                              const gmx::Range<int>&             atomRange)
1274 {
1275     int                mb, mt, mol, i_mol;
1276     gmx_bool           bBCheck;
1277     gmx_reverse_top_t* rt;
1278     int                nbonded_local;
1279
1280     rt = dd->reverse_top;
1281
1282     bBCheck = rt->bBCheck;
1283
1284     nbonded_local = 0;
1285
1286     for (int i : atomRange)
1287     {
1288         /* Get the global atom number */
1289         const int i_gl = dd->globalAtomIndices[i];
1290         global_atomnr_to_moltype_ind(rt, i_gl, &mb, &mt, &mol, &i_mol);
1291         /* Check all intramolecular interactions assigned to this atom */
1292         gmx::ArrayRef<const int>     index = rt->ril_mt[mt].index;
1293         gmx::ArrayRef<const t_iatom> rtil  = rt->ril_mt[mt].il;
1294
1295         check_assign_interactions_atom(i, i_gl, mol, i_mol, rt->ril_mt[mt].numAtomsInMolecule,
1296                                        index, rtil, FALSE, index[i_mol], index[i_mol + 1], dd,
1297                                        zones, &molb[mb], bRCheckMB, rcheck, bRCheck2B, rc2,
1298                                        pbc_null, cg_cm, ip_in, idef, izone, bBCheck, &nbonded_local);
1299
1300
1301         if (rt->bIntermolecularInteractions)
1302         {
1303             /* Check all intermolecular interactions assigned to this atom */
1304             index = rt->ril_intermol.index;
1305             rtil  = rt->ril_intermol.il;
1306
1307             check_assign_interactions_atom(i, i_gl, mol, i_mol, rt->ril_mt[mt].numAtomsInMolecule,
1308                                            index, rtil, TRUE, index[i_gl], index[i_gl + 1], dd, zones,
1309                                            &molb[mb], bRCheckMB, rcheck, bRCheck2B, rc2, pbc_null,
1310                                            cg_cm, ip_in, idef, izone, bBCheck, &nbonded_local);
1311         }
1312     }
1313
1314     return nbonded_local;
1315 }
1316
1317 /*! \brief Set the exclusion data for i-zone \p iz */
1318 static void make_exclusions_zone(gmx_domdec_t*                     dd,
1319                                  gmx_domdec_zones_t*               zones,
1320                                  const std::vector<gmx_moltype_t>& moltype,
1321                                  const int*                        cginfo,
1322                                  ListOfLists<int>*                 lexcls,
1323                                  int                               iz,
1324                                  int                               at_start,
1325                                  int                               at_end,
1326                                  const gmx::ArrayRef<const int>    intermolecularExclusionGroup)
1327 {
1328     const gmx_ga2la_t& ga2la = *dd->ga2la;
1329
1330     const auto& jAtomRange = zones->iZones[iz].jAtomRange;
1331
1332     const gmx::index oldNumLists = lexcls->ssize();
1333
1334     std::vector<int> exclusionsForAtom;
1335     for (int at = at_start; at < at_end; at++)
1336     {
1337         exclusionsForAtom.clear();
1338
1339         if (GET_CGINFO_EXCL_INTER(cginfo[at]))
1340         {
1341             int a_gl, mb, mt, mol, a_mol;
1342
1343             /* Copy the exclusions from the global top */
1344             a_gl = dd->globalAtomIndices[at];
1345             global_atomnr_to_moltype_ind(dd->reverse_top, a_gl, &mb, &mt, &mol, &a_mol);
1346             const auto excls = moltype[mt].excls[a_mol];
1347             for (const int aj_mol : excls)
1348             {
1349                 if (const auto* jEntry = ga2la.find(a_gl + aj_mol - a_mol))
1350                 {
1351                     /* This check is not necessary, but it can reduce
1352                      * the number of exclusions in the list, which in turn
1353                      * can speed up the pair list construction a bit.
1354                      */
1355                     if (jAtomRange.isInRange(jEntry->la))
1356                     {
1357                         exclusionsForAtom.push_back(jEntry->la);
1358                     }
1359                 }
1360             }
1361         }
1362
1363         bool isExcludedAtom = !intermolecularExclusionGroup.empty()
1364                               && std::find(intermolecularExclusionGroup.begin(),
1365                                            intermolecularExclusionGroup.end(), dd->globalAtomIndices[at])
1366                                          != intermolecularExclusionGroup.end();
1367
1368         if (isExcludedAtom)
1369         {
1370             for (int qmAtomGlobalIndex : intermolecularExclusionGroup)
1371             {
1372                 if (const auto* entry = dd->ga2la->find(qmAtomGlobalIndex))
1373                 {
1374                     exclusionsForAtom.push_back(entry->la);
1375                 }
1376             }
1377         }
1378
1379         /* Append the exclusions for this atom to the topology */
1380         lexcls->pushBack(exclusionsForAtom);
1381     }
1382
1383     GMX_RELEASE_ASSERT(
1384             lexcls->ssize() - oldNumLists == at_end - at_start,
1385             "The number of exclusion list should match the number of atoms in the range");
1386 }
1387
1388 /*! \brief Generate and store all required local bonded interactions in \p idef and local exclusions in \p lexcls */
1389 static int make_local_bondeds_excls(gmx_domdec_t*           dd,
1390                                     gmx_domdec_zones_t*     zones,
1391                                     const gmx_mtop_t*       mtop,
1392                                     const int*              cginfo,
1393                                     gmx_bool                bRCheckMB,
1394                                     ivec                    rcheck,
1395                                     gmx_bool                bRCheck2B,
1396                                     real                    rc,
1397                                     t_pbc*                  pbc_null,
1398                                     rvec*                   cg_cm,
1399                                     InteractionDefinitions* idef,
1400                                     ListOfLists<int>*       lexcls,
1401                                     int*                    excl_count)
1402 {
1403     int                nzone_bondeds;
1404     int                cg0, cg1;
1405     real               rc2;
1406     int                nbonded_local;
1407     gmx_reverse_top_t* rt;
1408
1409     if (dd->reverse_top->bInterAtomicInteractions)
1410     {
1411         nzone_bondeds = zones->n;
1412     }
1413     else
1414     {
1415         /* Only single charge group (or atom) molecules, so interactions don't
1416          * cross zone boundaries and we only need to assign in the home zone.
1417          */
1418         nzone_bondeds = 1;
1419     }
1420
1421     /* We only use exclusions from i-zones to i- and j-zones */
1422     const int numIZonesForExclusions = (dd->haveExclusions ? zones->iZones.size() : 0);
1423
1424     rt = dd->reverse_top;
1425
1426     rc2 = rc * rc;
1427
1428     /* Clear the counts */
1429     idef->clear();
1430     nbonded_local = 0;
1431
1432     lexcls->clear();
1433     *excl_count = 0;
1434
1435     for (int izone = 0; izone < nzone_bondeds; izone++)
1436     {
1437         cg0 = zones->cg_range[izone];
1438         cg1 = zones->cg_range[izone + 1];
1439
1440         const int numThreads = rt->th_work.size();
1441 #pragma omp parallel for num_threads(numThreads) schedule(static)
1442         for (int thread = 0; thread < numThreads; thread++)
1443         {
1444             try
1445             {
1446                 int                     cg0t, cg1t;
1447                 InteractionDefinitions* idef_t;
1448
1449                 cg0t = cg0 + ((cg1 - cg0) * thread) / numThreads;
1450                 cg1t = cg0 + ((cg1 - cg0) * (thread + 1)) / numThreads;
1451
1452                 if (thread == 0)
1453                 {
1454                     idef_t = idef;
1455                 }
1456                 else
1457                 {
1458                     idef_t = &rt->th_work[thread].idef;
1459                     idef_t->clear();
1460                 }
1461
1462                 rt->th_work[thread].nbonded = make_bondeds_zone(
1463                         dd, zones, mtop->molblock, bRCheckMB, rcheck, bRCheck2B, rc2, pbc_null,
1464                         cg_cm, idef->iparams.data(), idef_t, izone, gmx::Range<int>(cg0t, cg1t));
1465
1466                 if (izone < numIZonesForExclusions)
1467                 {
1468                     ListOfLists<int>* excl_t;
1469                     if (thread == 0)
1470                     {
1471                         // Thread 0 stores exclusions directly in the final storage
1472                         excl_t = lexcls;
1473                     }
1474                     else
1475                     {
1476                         // Threads > 0 store in temporary storage, starting at list index 0
1477                         excl_t = &rt->th_work[thread].excl;
1478                         excl_t->clear();
1479                     }
1480
1481                     /* No charge groups and no distance check required */
1482                     make_exclusions_zone(dd, zones, mtop->moltype, cginfo, excl_t, izone, cg0t,
1483                                          cg1t, mtop->intermolecularExclusionGroup);
1484                 }
1485             }
1486             GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR
1487         }
1488
1489         if (rt->th_work.size() > 1)
1490         {
1491             combine_idef(idef, rt->th_work);
1492         }
1493
1494         for (const thread_work_t& th_work : rt->th_work)
1495         {
1496             nbonded_local += th_work.nbonded;
1497         }
1498
1499         if (izone < numIZonesForExclusions)
1500         {
1501             for (std::size_t th = 1; th < rt->th_work.size(); th++)
1502             {
1503                 lexcls->appendListOfLists(rt->th_work[th].excl);
1504             }
1505             for (const thread_work_t& th_work : rt->th_work)
1506             {
1507                 *excl_count += th_work.excl_count;
1508             }
1509         }
1510     }
1511
1512     if (debug)
1513     {
1514         fprintf(debug, "We have %d exclusions, check count %d\n", lexcls->numElements(), *excl_count);
1515     }
1516
1517     return nbonded_local;
1518 }
1519
1520 void dd_make_local_top(gmx_domdec_t*       dd,
1521                        gmx_domdec_zones_t* zones,
1522                        int                 npbcdim,
1523                        matrix              box,
1524                        rvec                cellsize_min,
1525                        const ivec          npulse,
1526                        t_forcerec*         fr,
1527                        rvec*               cgcm_or_x,
1528                        const gmx_mtop_t&   mtop,
1529                        gmx_localtop_t*     ltop)
1530 {
1531     gmx_bool bRCheckMB, bRCheck2B;
1532     real     rc = -1;
1533     ivec     rcheck;
1534     int      d, nexcl;
1535     t_pbc    pbc, *pbc_null = nullptr;
1536
1537     if (debug)
1538     {
1539         fprintf(debug, "Making local topology\n");
1540     }
1541
1542     bRCheckMB = FALSE;
1543     bRCheck2B = FALSE;
1544
1545     if (dd->reverse_top->bInterAtomicInteractions)
1546     {
1547         /* We need to check to which cell bondeds should be assigned */
1548         rc = dd_cutoff_twobody(dd);
1549         if (debug)
1550         {
1551             fprintf(debug, "Two-body bonded cut-off distance is %g\n", rc);
1552         }
1553
1554         /* Should we check cg_cm distances when assigning bonded interactions? */
1555         for (d = 0; d < DIM; d++)
1556         {
1557             rcheck[d] = FALSE;
1558             /* Only need to check for dimensions where the part of the box
1559              * that is not communicated is smaller than the cut-off.
1560              */
1561             if (d < npbcdim && dd->numCells[d] > 1
1562                 && (dd->numCells[d] - npulse[d]) * cellsize_min[d] < 2 * rc)
1563             {
1564                 if (dd->numCells[d] == 2)
1565                 {
1566                     rcheck[d] = TRUE;
1567                     bRCheckMB = TRUE;
1568                 }
1569                 /* Check for interactions between two atoms,
1570                  * where we can allow interactions up to the cut-off,
1571                  * instead of up to the smallest cell dimension.
1572                  */
1573                 bRCheck2B = TRUE;
1574             }
1575             if (debug)
1576             {
1577                 fprintf(debug, "dim %d cellmin %f bonded rcheck[%d] = %d, bRCheck2B = %s\n", d,
1578                         cellsize_min[d], d, rcheck[d], gmx::boolToString(bRCheck2B));
1579             }
1580         }
1581         if (bRCheckMB || bRCheck2B)
1582         {
1583             if (fr->bMolPBC)
1584             {
1585                 pbc_null = set_pbc_dd(&pbc, fr->pbcType, dd->numCells, TRUE, box);
1586             }
1587             else
1588             {
1589                 pbc_null = nullptr;
1590             }
1591         }
1592     }
1593
1594     dd->nbonded_local = make_local_bondeds_excls(dd, zones, &mtop, fr->cginfo.data(), bRCheckMB,
1595                                                  rcheck, bRCheck2B, rc, pbc_null, cgcm_or_x,
1596                                                  &ltop->idef, &ltop->excls, &nexcl);
1597
1598     /* The ilist is not sorted yet,
1599      * we can only do this when we have the charge arrays.
1600      */
1601     ltop->idef.ilsort = ilsortUNKNOWN;
1602 }
1603
1604 void dd_sort_local_top(gmx_domdec_t* dd, const t_mdatoms* mdatoms, gmx_localtop_t* ltop)
1605 {
1606     if (dd->reverse_top->ilsort == ilsortNO_FE)
1607     {
1608         ltop->idef.ilsort = ilsortNO_FE;
1609     }
1610     else
1611     {
1612         gmx_sort_ilist_fe(&ltop->idef, mdatoms->chargeA, mdatoms->chargeB);
1613     }
1614 }
1615
1616 void dd_init_local_state(gmx_domdec_t* dd, const t_state* state_global, t_state* state_local)
1617 {
1618     int buf[NITEM_DD_INIT_LOCAL_STATE];
1619
1620     if (DDMASTER(dd))
1621     {
1622         buf[0] = state_global->flags;
1623         buf[1] = state_global->ngtc;
1624         buf[2] = state_global->nnhpres;
1625         buf[3] = state_global->nhchainlength;
1626         buf[4] = state_global->dfhist ? state_global->dfhist->nlambda : 0;
1627     }
1628     dd_bcast(dd, NITEM_DD_INIT_LOCAL_STATE * sizeof(int), buf);
1629
1630     init_gtc_state(state_local, buf[1], buf[2], buf[3]);
1631     init_dfhist_state(state_local, buf[4]);
1632     state_local->flags = buf[0];
1633 }
1634
1635 /*! \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 */
1636 static void check_link(t_blocka* link, int cg_gl, int cg_gl_j)
1637 {
1638     int      k;
1639     gmx_bool bFound;
1640
1641     bFound = FALSE;
1642     for (k = link->index[cg_gl]; k < link->index[cg_gl + 1]; k++)
1643     {
1644         GMX_RELEASE_ASSERT(link->a, "Inconsistent NULL pointer while making charge-group links");
1645         if (link->a[k] == cg_gl_j)
1646         {
1647             bFound = TRUE;
1648         }
1649     }
1650     if (!bFound)
1651     {
1652         GMX_RELEASE_ASSERT(link->a || link->index[cg_gl + 1] + 1 > link->nalloc_a,
1653                            "Inconsistent allocation of link");
1654         /* Add this charge group link */
1655         if (link->index[cg_gl + 1] + 1 > link->nalloc_a)
1656         {
1657             link->nalloc_a = over_alloc_large(link->index[cg_gl + 1] + 1);
1658             srenew(link->a, link->nalloc_a);
1659         }
1660         link->a[link->index[cg_gl + 1]] = cg_gl_j;
1661         link->index[cg_gl + 1]++;
1662     }
1663 }
1664
1665 t_blocka* makeBondedLinks(const gmx_mtop_t& mtop, gmx::ArrayRef<cginfo_mb_t> cginfo_mb)
1666 {
1667     t_blocka*    link;
1668     cginfo_mb_t* cgi_mb;
1669
1670     /* For each atom make a list of other atoms in the system
1671      * that a linked to it via bonded interactions
1672      * which are also stored in reverse_top.
1673      */
1674
1675     reverse_ilist_t ril_intermol;
1676     if (mtop.bIntermolecularInteractions)
1677     {
1678         t_atoms atoms;
1679
1680         atoms.nr   = mtop.natoms;
1681         atoms.atom = nullptr;
1682
1683         GMX_RELEASE_ASSERT(mtop.intermolecular_ilist,
1684                            "We should have an ilist when intermolecular interactions are on");
1685
1686         make_reverse_ilist(*mtop.intermolecular_ilist, &atoms, FALSE, FALSE, FALSE, TRUE, &ril_intermol);
1687     }
1688
1689     snew(link, 1);
1690     snew(link->index, mtop.natoms + 1);
1691     link->nalloc_a = 0;
1692     link->a        = nullptr;
1693
1694     link->index[0] = 0;
1695     int cg_offset  = 0;
1696     int ncgi       = 0;
1697     for (size_t mb = 0; mb < mtop.molblock.size(); mb++)
1698     {
1699         const gmx_molblock_t& molb = mtop.molblock[mb];
1700         if (molb.nmol == 0)
1701         {
1702             continue;
1703         }
1704         const gmx_moltype_t& molt = mtop.moltype[molb.type];
1705         /* Make a reverse ilist in which the interactions are linked
1706          * to all atoms, not only the first atom as in gmx_reverse_top.
1707          * The constraints are discarded here.
1708          */
1709         reverse_ilist_t ril;
1710         make_reverse_ilist(molt.ilist, &molt.atoms, FALSE, FALSE, FALSE, TRUE, &ril);
1711
1712         cgi_mb = &cginfo_mb[mb];
1713
1714         int mol;
1715         for (mol = 0; mol < (mtop.bIntermolecularInteractions ? molb.nmol : 1); mol++)
1716         {
1717             for (int a = 0; a < molt.atoms.nr; a++)
1718             {
1719                 int cg_gl              = cg_offset + a;
1720                 link->index[cg_gl + 1] = link->index[cg_gl];
1721                 int i                  = ril.index[a];
1722                 while (i < ril.index[a + 1])
1723                 {
1724                     int ftype = ril.il[i++];
1725                     int nral  = NRAL(ftype);
1726                     /* Skip the ifunc index */
1727                     i++;
1728                     for (int j = 0; j < nral; j++)
1729                     {
1730                         int aj = ril.il[i + j];
1731                         if (aj != a)
1732                         {
1733                             check_link(link, cg_gl, cg_offset + aj);
1734                         }
1735                     }
1736                     i += nral_rt(ftype);
1737                 }
1738
1739                 if (mtop.bIntermolecularInteractions)
1740                 {
1741                     int i = ril_intermol.index[cg_gl];
1742                     while (i < ril_intermol.index[cg_gl + 1])
1743                     {
1744                         int ftype = ril_intermol.il[i++];
1745                         int nral  = NRAL(ftype);
1746                         /* Skip the ifunc index */
1747                         i++;
1748                         for (int j = 0; j < nral; j++)
1749                         {
1750                             /* Here we assume we have no charge groups;
1751                              * this has been checked above.
1752                              */
1753                             int aj = ril_intermol.il[i + j];
1754                             check_link(link, cg_gl, aj);
1755                         }
1756                         i += nral_rt(ftype);
1757                     }
1758                 }
1759                 if (link->index[cg_gl + 1] - link->index[cg_gl] > 0)
1760                 {
1761                     SET_CGINFO_BOND_INTER(cgi_mb->cginfo[a]);
1762                     ncgi++;
1763                 }
1764             }
1765
1766             cg_offset += molt.atoms.nr;
1767         }
1768         int nlink_mol = link->index[cg_offset] - link->index[cg_offset - molt.atoms.nr];
1769
1770         if (debug)
1771         {
1772             fprintf(debug, "molecule type '%s' %d atoms has %d atom links through bonded interac.\n",
1773                     *molt.name, molt.atoms.nr, nlink_mol);
1774         }
1775
1776         if (molb.nmol > mol)
1777         {
1778             /* Copy the data for the rest of the molecules in this block */
1779             link->nalloc_a += (molb.nmol - mol) * nlink_mol;
1780             srenew(link->a, link->nalloc_a);
1781             for (; mol < molb.nmol; mol++)
1782             {
1783                 for (int a = 0; a < molt.atoms.nr; a++)
1784                 {
1785                     int cg_gl              = cg_offset + a;
1786                     link->index[cg_gl + 1] = link->index[cg_gl + 1 - molt.atoms.nr] + nlink_mol;
1787                     for (int j = link->index[cg_gl]; j < link->index[cg_gl + 1]; j++)
1788                     {
1789                         link->a[j] = link->a[j - nlink_mol] + molt.atoms.nr;
1790                     }
1791                     if (link->index[cg_gl + 1] - link->index[cg_gl] > 0
1792                         && cg_gl - cgi_mb->cg_start < cgi_mb->cg_mod)
1793                     {
1794                         SET_CGINFO_BOND_INTER(cgi_mb->cginfo[cg_gl - cgi_mb->cg_start]);
1795                         ncgi++;
1796                     }
1797                 }
1798                 cg_offset += molt.atoms.nr;
1799             }
1800         }
1801     }
1802
1803     if (debug)
1804     {
1805         fprintf(debug, "Of the %d atoms %d are linked via bonded interactions\n", mtop.natoms, ncgi);
1806     }
1807
1808     return link;
1809 }
1810
1811 typedef struct
1812 {
1813     real r2;
1814     int  ftype;
1815     int  a1;
1816     int  a2;
1817 } bonded_distance_t;
1818
1819 /*! \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 */
1820 static void update_max_bonded_distance(real r2, int ftype, int a1, int a2, bonded_distance_t* bd)
1821 {
1822     if (r2 > bd->r2)
1823     {
1824         bd->r2    = r2;
1825         bd->ftype = ftype;
1826         bd->a1    = a1;
1827         bd->a2    = a2;
1828     }
1829 }
1830
1831 /*! \brief Set the distance, function type and atom indices for the longest distance between atoms of molecule type \p molt for two-body and multi-body bonded interactions */
1832 static void bonded_cg_distance_mol(const gmx_moltype_t* molt,
1833                                    gmx_bool             bBCheck,
1834                                    gmx_bool             bExcl,
1835                                    ArrayRef<const RVec> x,
1836                                    bonded_distance_t*   bd_2b,
1837                                    bonded_distance_t*   bd_mb)
1838 {
1839     for (int ftype = 0; ftype < F_NRE; ftype++)
1840     {
1841         if (dd_check_ftype(ftype, bBCheck, FALSE, FALSE))
1842         {
1843             const auto& il   = molt->ilist[ftype];
1844             int         nral = NRAL(ftype);
1845             if (nral > 1)
1846             {
1847                 for (int i = 0; i < il.size(); i += 1 + nral)
1848                 {
1849                     for (int ai = 0; ai < nral; ai++)
1850                     {
1851                         int atomI = il.iatoms[i + 1 + ai];
1852                         for (int aj = ai + 1; aj < nral; aj++)
1853                         {
1854                             int atomJ = il.iatoms[i + 1 + aj];
1855                             if (atomI != atomJ)
1856                             {
1857                                 real rij2 = distance2(x[atomI], x[atomJ]);
1858
1859                                 update_max_bonded_distance(rij2, ftype, atomI, atomJ,
1860                                                            (nral == 2) ? bd_2b : bd_mb);
1861                             }
1862                         }
1863                     }
1864                 }
1865             }
1866         }
1867     }
1868     if (bExcl)
1869     {
1870         const auto& excls = molt->excls;
1871         for (gmx::index ai = 0; ai < excls.ssize(); ai++)
1872         {
1873             for (const int aj : excls[ai])
1874             {
1875                 if (ai != aj)
1876                 {
1877                     real rij2 = distance2(x[ai], x[aj]);
1878
1879                     /* There is no function type for exclusions, use -1 */
1880                     update_max_bonded_distance(rij2, -1, ai, aj, bd_2b);
1881                 }
1882             }
1883         }
1884     }
1885 }
1886
1887 /*! \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 */
1888 static void bonded_distance_intermol(const InteractionLists& ilists_intermol,
1889                                      gmx_bool                bBCheck,
1890                                      ArrayRef<const RVec>    x,
1891                                      PbcType                 pbcType,
1892                                      const matrix            box,
1893                                      bonded_distance_t*      bd_2b,
1894                                      bonded_distance_t*      bd_mb)
1895 {
1896     t_pbc pbc;
1897
1898     set_pbc(&pbc, pbcType, box);
1899
1900     for (int ftype = 0; ftype < F_NRE; ftype++)
1901     {
1902         if (dd_check_ftype(ftype, bBCheck, FALSE, FALSE))
1903         {
1904             const auto& il   = ilists_intermol[ftype];
1905             int         nral = NRAL(ftype);
1906
1907             /* No nral>1 check here, since intermol interactions always
1908              * have nral>=2 (and the code is also correct for nral=1).
1909              */
1910             for (int i = 0; i < il.size(); i += 1 + nral)
1911             {
1912                 for (int ai = 0; ai < nral; ai++)
1913                 {
1914                     int atom_i = il.iatoms[i + 1 + ai];
1915
1916                     for (int aj = ai + 1; aj < nral; aj++)
1917                     {
1918                         rvec dx;
1919                         real rij2;
1920
1921                         int atom_j = il.iatoms[i + 1 + aj];
1922
1923                         pbc_dx(&pbc, x[atom_i], x[atom_j], dx);
1924
1925                         rij2 = norm2(dx);
1926
1927                         update_max_bonded_distance(rij2, ftype, atom_i, atom_j, (nral == 2) ? bd_2b : bd_mb);
1928                     }
1929                 }
1930             }
1931         }
1932     }
1933 }
1934
1935 //! Returns whether \p molt has at least one virtual site
1936 static bool moltypeHasVsite(const gmx_moltype_t& molt)
1937 {
1938     bool hasVsite = false;
1939     for (int i = 0; i < F_NRE; i++)
1940     {
1941         if ((interaction_function[i].flags & IF_VSITE) && !molt.ilist[i].empty())
1942         {
1943             hasVsite = true;
1944         }
1945     }
1946
1947     return hasVsite;
1948 }
1949
1950 //! Returns coordinates not broken over PBC for a molecule
1951 static void getWholeMoleculeCoordinates(const gmx_moltype_t*  molt,
1952                                         const gmx_ffparams_t* ffparams,
1953                                         PbcType               pbcType,
1954                                         t_graph*              graph,
1955                                         const matrix          box,
1956                                         ArrayRef<const RVec>  x,
1957                                         ArrayRef<RVec>        xs)
1958 {
1959     int n, i;
1960
1961     if (pbcType != PbcType::No)
1962     {
1963         mk_mshift(nullptr, graph, pbcType, box, as_rvec_array(x.data()));
1964
1965         shift_x(graph, box, as_rvec_array(x.data()), as_rvec_array(xs.data()));
1966         /* By doing an extra mk_mshift the molecules that are broken
1967          * because they were e.g. imported from another software
1968          * will be made whole again. Such are the healing powers
1969          * of GROMACS.
1970          */
1971         mk_mshift(nullptr, graph, pbcType, box, as_rvec_array(xs.data()));
1972     }
1973     else
1974     {
1975         /* We copy the coordinates so the original coordinates remain
1976          * unchanged, just to be 100% sure that we do not affect
1977          * binary reproducibility of simulations.
1978          */
1979         n = molt->atoms.nr;
1980         for (i = 0; i < n; i++)
1981         {
1982             copy_rvec(x[i], xs[i]);
1983         }
1984     }
1985
1986     if (moltypeHasVsite(*molt))
1987     {
1988         gmx::constructVirtualSites(xs, ffparams->iparams, molt->ilist);
1989     }
1990 }
1991
1992 void dd_bonded_cg_distance(const gmx::MDLogger& mdlog,
1993                            const gmx_mtop_t*    mtop,
1994                            const t_inputrec*    ir,
1995                            ArrayRef<const RVec> x,
1996                            const matrix         box,
1997                            gmx_bool             bBCheck,
1998                            real*                r_2b,
1999                            real*                r_mb)
2000 {
2001     gmx_bool          bExclRequired;
2002     int               at_offset;
2003     bonded_distance_t bd_2b = { 0, -1, -1, -1 };
2004     bonded_distance_t bd_mb = { 0, -1, -1, -1 };
2005
2006     bExclRequired = inputrecExclForces(ir);
2007
2008     *r_2b     = 0;
2009     *r_mb     = 0;
2010     at_offset = 0;
2011     for (const gmx_molblock_t& molb : mtop->molblock)
2012     {
2013         const gmx_moltype_t& molt = mtop->moltype[molb.type];
2014         if (molt.atoms.nr == 1 || molb.nmol == 0)
2015         {
2016             at_offset += molb.nmol * molt.atoms.nr;
2017         }
2018         else
2019         {
2020             t_graph graph;
2021             if (ir->pbcType != PbcType::No)
2022             {
2023                 graph = mk_graph_moltype(molt);
2024             }
2025
2026             std::vector<RVec> xs(molt.atoms.nr);
2027             for (int mol = 0; mol < molb.nmol; mol++)
2028             {
2029                 getWholeMoleculeCoordinates(&molt, &mtop->ffparams, ir->pbcType, &graph, box,
2030                                             x.subArray(at_offset, molt.atoms.nr), xs);
2031
2032                 bonded_distance_t bd_mol_2b = { 0, -1, -1, -1 };
2033                 bonded_distance_t bd_mol_mb = { 0, -1, -1, -1 };
2034
2035                 bonded_cg_distance_mol(&molt, bBCheck, bExclRequired, xs, &bd_mol_2b, &bd_mol_mb);
2036
2037                 /* Process the mol data adding the atom index offset */
2038                 update_max_bonded_distance(bd_mol_2b.r2, bd_mol_2b.ftype, at_offset + bd_mol_2b.a1,
2039                                            at_offset + bd_mol_2b.a2, &bd_2b);
2040                 update_max_bonded_distance(bd_mol_mb.r2, bd_mol_mb.ftype, at_offset + bd_mol_mb.a1,
2041                                            at_offset + bd_mol_mb.a2, &bd_mb);
2042
2043                 at_offset += molt.atoms.nr;
2044             }
2045         }
2046     }
2047
2048     if (mtop->bIntermolecularInteractions)
2049     {
2050         GMX_RELEASE_ASSERT(mtop->intermolecular_ilist,
2051                            "We should have an ilist when intermolecular interactions are on");
2052
2053         bonded_distance_intermol(*mtop->intermolecular_ilist, bBCheck, x, ir->pbcType, box, &bd_2b, &bd_mb);
2054     }
2055
2056     *r_2b = sqrt(bd_2b.r2);
2057     *r_mb = sqrt(bd_mb.r2);
2058
2059     if (*r_2b > 0 || *r_mb > 0)
2060     {
2061         GMX_LOG(mdlog.info).appendText("Initial maximum distances in bonded interactions:");
2062         if (*r_2b > 0)
2063         {
2064             GMX_LOG(mdlog.info)
2065                     .appendTextFormatted(
2066                             "    two-body bonded interactions: %5.3f nm, %s, atoms %d %d", *r_2b,
2067                             (bd_2b.ftype >= 0) ? interaction_function[bd_2b.ftype].longname : "Exclusion",
2068                             bd_2b.a1 + 1, bd_2b.a2 + 1);
2069         }
2070         if (*r_mb > 0)
2071         {
2072             GMX_LOG(mdlog.info)
2073                     .appendTextFormatted(
2074                             "  multi-body bonded interactions: %5.3f nm, %s, atoms %d %d", *r_mb,
2075                             interaction_function[bd_mb.ftype].longname, bd_mb.a1 + 1, bd_mb.a2 + 1);
2076         }
2077     }
2078 }