src/gromacs/topology/mtop_util.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2008,2009,2010, The GROMACS development team.
   5  * Copyright (c) 2012,2013,2014,2015,2016 The GROMACS development team.
   6  * Copyright (c) 2017,2018,2019,2020, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 #include "gmxpre.h"
  38
  39 #include "mtop_util.h"
  40
  41 #include <climits>
  42 #include <cstddef>
  43 #include <cstdio>
  44 #include <cstdlib>
  45 #include <cstring>
  46
  47 #include "gromacs/math/vectypes.h"
  48 #include "gromacs/topology/atoms.h"
  49 #include "gromacs/topology/block.h"
  50 #include "gromacs/topology/exclusionblocks.h"
  51 #include "gromacs/topology/idef.h"
  52 #include "gromacs/topology/ifunc.h"
  53 #include "gromacs/topology/topology.h"
  54 #include "gromacs/topology/topsort.h"
  55 #include "gromacs/utility/arrayref.h"
  56 #include "gromacs/utility/fatalerror.h"
  57 #include "gromacs/utility/real.h"
  58 #include "gromacs/utility/smalloc.h"
  59
  60 static int gmx_mtop_maxresnr(const gmx_mtop_t* mtop, int maxres_renum)
  61 {
  62     int maxresnr = 0;
  63
  64     for (const gmx_moltype_t& moltype : mtop->moltype)
  65     {
  66         const t_atoms& atoms = moltype.atoms;
  67         if (atoms.nres > maxres_renum)
  68         {
  69             for (int r = 0; r < atoms.nres; r++)
  70             {
  71                 if (atoms.resinfo[r].nr > maxresnr)
  72                 {
  73                     maxresnr = atoms.resinfo[r].nr;
  74                 }
  75             }
  76         }
  77     }
  78
  79     return maxresnr;
  80 }
  81
  82 static void buildMolblockIndices(gmx_mtop_t* mtop)
  83 {
  84     mtop->moleculeBlockIndices.resize(mtop->molblock.size());
  85
  86     int atomIndex          = 0;
  87     int residueIndex       = 0;
  88     int residueNumberStart = mtop->maxresnr + 1;
  89     int moleculeIndexStart = 0;
  90     for (size_t mb = 0; mb < mtop->molblock.size(); mb++)
  91     {
  92         const gmx_molblock_t& molb         = mtop->molblock[mb];
  93         MoleculeBlockIndices& indices      = mtop->moleculeBlockIndices[mb];
  94         const int             numResPerMol = mtop->moltype[molb.type].atoms.nres;
  95
  96         indices.numAtomsPerMolecule = mtop->moltype[molb.type].atoms.nr;
  97         indices.globalAtomStart     = atomIndex;
  98         indices.globalResidueStart  = residueIndex;
  99         atomIndex += molb.nmol * indices.numAtomsPerMolecule;
 100         residueIndex += molb.nmol * numResPerMol;
 101         indices.globalAtomEnd      = atomIndex;
 102         indices.residueNumberStart = residueNumberStart;
 103         if (numResPerMol <= mtop->maxres_renum)
 104         {
 105             residueNumberStart += molb.nmol * numResPerMol;
 106         }
 107         indices.moleculeIndexStart = moleculeIndexStart;
 108         moleculeIndexStart += molb.nmol;
 109     }
 110 }
 111
 112 void gmx_mtop_finalize(gmx_mtop_t* mtop)
 113 {
 114     char* env;
 115
 116     if (mtop->molblock.size() == 1 && mtop->molblock[0].nmol == 1)
 117     {
 118         /* We have a single molecule only, no renumbering needed.
 119          * This case also covers an mtop converted from pdb/gro/... input,
 120          * so we retain the original residue numbering.
 121          */
 122         mtop->maxres_renum = 0;
 123     }
 124     else
 125     {
 126         /* We only renumber single residue molecules. Their intra-molecular
 127          * residue numbering is anyhow irrelevant.
 128          */
 129         mtop->maxres_renum = 1;
 130     }
 131
 132     env = getenv("GMX_MAXRESRENUM");
 133     if (env != nullptr)
 134     {
 135         sscanf(env, "%d", &mtop->maxres_renum);
 136     }
 137     if (mtop->maxres_renum == -1)
 138     {
 139         /* -1 signals renumber residues in all molecules */
 140         mtop->maxres_renum = INT_MAX;
 141     }
 142
 143     mtop->maxresnr = gmx_mtop_maxresnr(mtop, mtop->maxres_renum);
 144
 145     buildMolblockIndices(mtop);
 146 }
 147
 148 void gmx_mtop_count_atomtypes(const gmx_mtop_t* mtop, int state, int typecount[])
 149 {
 150     for (int i = 0; i < mtop->ffparams.atnr; ++i)
 151     {
 152         typecount[i] = 0;
 153     }
 154     for (const gmx_molblock_t& molb : mtop->molblock)
 155     {
 156         const t_atoms& atoms = mtop->moltype[molb.type].atoms;
 157         for (int i = 0; i < atoms.nr; ++i)
 158         {
 159             int tpi;
 160             if (state == 0)
 161             {
 162                 tpi = atoms.atom[i].type;
 163             }
 164             else
 165             {
 166                 tpi = atoms.atom[i].typeB;
 167             }
 168             typecount[tpi] += molb.nmol;
 169         }
 170     }
 171 }
 172
 173 int gmx_mtop_num_molecules(const gmx_mtop_t& mtop)
 174 {
 175     int numMolecules = 0;
 176     for (const gmx_molblock_t& molb : mtop.molblock)
 177     {
 178         numMolecules += molb.nmol;
 179     }
 180     return numMolecules;
 181 }
 182
 183 int gmx_mtop_nres(const gmx_mtop_t* mtop)
 184 {
 185     int nres = 0;
 186     for (const gmx_molblock_t& molb : mtop->molblock)
 187     {
 188         nres += molb.nmol * mtop->moltype[molb.type].atoms.nres;
 189     }
 190     return nres;
 191 }
 192
 193 AtomIterator::AtomIterator(const gmx_mtop_t& mtop, int globalAtomNumber) :
 194     mtop_(&mtop),
 195     mblock_(0),
 196     atoms_(&mtop.moltype[mtop.molblock[0].type].atoms),
 197     currentMolecule_(0),
 198     highestResidueNumber_(mtop.maxresnr),
 199     localAtomNumber_(0),
 200     globalAtomNumber_(globalAtomNumber)
 201 {
 202     GMX_ASSERT(globalAtomNumber == 0 || globalAtomNumber == mtop.natoms,
 203                "Starting at other atoms not implemented yet");
 204 }
 205
 206 AtomIterator& AtomIterator::operator++()
 207 {
 208     localAtomNumber_++;
 209     globalAtomNumber_++;
 210
 211     if (localAtomNumber_ >= atoms_->nr)
 212     {
 213         if (atoms_->nres <= mtop_->maxresnr)
 214         {
 215             /* Single residue molecule, increase the count with one */
 216             highestResidueNumber_ += atoms_->nres;
 217         }
 218         currentMolecule_++;
 219         localAtomNumber_ = 0;
 220         if (currentMolecule_ >= mtop_->molblock[mblock_].nmol)
 221         {
 222             mblock_++;
 223             if (mblock_ >= mtop_->molblock.size())
 224             {
 225                 return *this;
 226             }
 227             atoms_           = &mtop_->moltype[mtop_->molblock[mblock_].type].atoms;
 228             currentMolecule_ = 0;
 229         }
 230     }
 231     return *this;
 232 }
 233
 234 AtomIterator AtomIterator::operator++(int)
 235 {
 236     AtomIterator temp = *this;
 237     ++(*this);
 238     return temp;
 239 }
 240
 241 bool AtomIterator::operator==(const AtomIterator& o) const
 242 {
 243     return mtop_ == o.mtop_ && globalAtomNumber_ == o.globalAtomNumber_;
 244 }
 245
 246 bool AtomIterator::operator!=(const AtomIterator& o) const
 247 {
 248     return !(*this == o);
 249 }
 250
 251 const t_atom& AtomProxy::atom() const
 252 {
 253     return it_->atoms_->atom[it_->localAtomNumber_];
 254 }
 255
 256 int AtomProxy::globalAtomNumber() const
 257 {
 258     return it_->globalAtomNumber_;
 259 }
 260
 261 const char* AtomProxy::atomName() const
 262 {
 263     return *(it_->atoms_->atomname[it_->localAtomNumber_]);
 264 }
 265
 266 const char* AtomProxy::residueName() const
 267 {
 268     int residueIndexInMolecule = it_->atoms_->atom[it_->localAtomNumber_].resind;
 269     return *(it_->atoms_->resinfo[residueIndexInMolecule].name);
 270 }
 271
 272 int AtomProxy::residueNumber() const
 273 {
 274     int residueIndexInMolecule = it_->atoms_->atom[it_->localAtomNumber_].resind;
 275     if (it_->atoms_->nres <= it_->mtop_->maxres_renum)
 276     {
 277         return it_->highestResidueNumber_ + 1 + residueIndexInMolecule;
 278     }
 279     else
 280     {
 281         return it_->atoms_->resinfo[residueIndexInMolecule].nr;
 282     }
 283 }
 284
 285 const gmx_moltype_t& AtomProxy::moleculeType() const
 286 {
 287     return it_->mtop_->moltype[it_->mtop_->molblock[it_->mblock_].type];
 288 }
 289
 290 int AtomProxy::atomNumberInMol() const
 291 {
 292     return it_->localAtomNumber_;
 293 }
 294
 295 typedef struct gmx_mtop_atomloop_block
 296 {
 297     const gmx_mtop_t* mtop;
 298     size_t            mblock;
 299     const t_atoms*    atoms;
 300     int               at_local;
 301 } t_gmx_mtop_atomloop_block;
 302
 303 gmx_mtop_atomloop_block_t gmx_mtop_atomloop_block_init(const gmx_mtop_t* mtop)
 304 {
 305     struct gmx_mtop_atomloop_block* aloop;
 306
 307     snew(aloop, 1);
 308
 309     aloop->mtop     = mtop;
 310     aloop->mblock   = 0;
 311     aloop->atoms    = &mtop->moltype[mtop->molblock[aloop->mblock].type].atoms;
 312     aloop->at_local = -1;
 313
 314     return aloop;
 315 }
 316
 317 static void gmx_mtop_atomloop_block_destroy(gmx_mtop_atomloop_block_t aloop)
 318 {
 319     sfree(aloop);
 320 }
 321
 322 gmx_bool gmx_mtop_atomloop_block_next(gmx_mtop_atomloop_block_t aloop, const t_atom** atom, int* nmol)
 323 {
 324     if (aloop == nullptr)
 325     {
 326         gmx_incons("gmx_mtop_atomloop_all_next called without calling gmx_mtop_atomloop_all_init");
 327     }
 328
 329     aloop->at_local++;
 330
 331     if (aloop->at_local >= aloop->atoms->nr)
 332     {
 333         aloop->mblock++;
 334         if (aloop->mblock >= aloop->mtop->molblock.size())
 335         {
 336             gmx_mtop_atomloop_block_destroy(aloop);
 337             return FALSE;
 338         }
 339         aloop->atoms    = &aloop->mtop->moltype[aloop->mtop->molblock[aloop->mblock].type].atoms;
 340         aloop->at_local = 0;
 341     }
 342
 343     *atom = &aloop->atoms->atom[aloop->at_local];
 344     *nmol = aloop->mtop->molblock[aloop->mblock].nmol;
 345
 346     return TRUE;
 347 }
 348
 349 typedef struct gmx_mtop_ilistloop
 350 {
 351     const gmx_mtop_t* mtop;
 352     int               mblock;
 353 } t_gmx_mtop_ilist;
 354
 355 gmx_mtop_ilistloop_t gmx_mtop_ilistloop_init(const gmx_mtop_t* mtop)
 356 {
 357     struct gmx_mtop_ilistloop* iloop;
 358
 359     snew(iloop, 1);
 360
 361     iloop->mtop   = mtop;
 362     iloop->mblock = -1;
 363
 364     return iloop;
 365 }
 366
 367 gmx_mtop_ilistloop_t gmx_mtop_ilistloop_init(const gmx_mtop_t& mtop)
 368 {
 369     return gmx_mtop_ilistloop_init(&mtop);
 370 }
 371
 372 static void gmx_mtop_ilistloop_destroy(gmx_mtop_ilistloop_t iloop)
 373 {
 374     sfree(iloop);
 375 }
 376
 377 const InteractionLists* gmx_mtop_ilistloop_next(gmx_mtop_ilistloop_t iloop, int* nmol)
 378 {
 379     if (iloop == nullptr)
 380     {
 381         gmx_incons("gmx_mtop_ilistloop_next called without calling gmx_mtop_ilistloop_init");
 382     }
 383
 384     iloop->mblock++;
 385     if (iloop->mblock >= gmx::ssize(iloop->mtop->molblock))
 386     {
 387         if (iloop->mblock == gmx::ssize(iloop->mtop->molblock) && iloop->mtop->bIntermolecularInteractions)
 388         {
 389             *nmol = 1;
 390             return iloop->mtop->intermolecular_ilist.get();
 391         }
 392
 393         gmx_mtop_ilistloop_destroy(iloop);
 394         return nullptr;
 395     }
 396
 397     *nmol = iloop->mtop->molblock[iloop->mblock].nmol;
 398
 399     return &iloop->mtop->moltype[iloop->mtop->molblock[iloop->mblock].type].ilist;
 400 }
 401 typedef struct gmx_mtop_ilistloop_all
 402 {
 403     const gmx_mtop_t* mtop;
 404     size_t            mblock;
 405     int               mol;
 406     int               a_offset;
 407 } t_gmx_mtop_ilist_all;
 408
 409 int gmx_mtop_ftype_count(const gmx_mtop_t* mtop, int ftype)
 410 {
 411     gmx_mtop_ilistloop_t iloop;
 412     int                  n, nmol;
 413
 414     n = 0;
 415
 416     iloop = gmx_mtop_ilistloop_init(mtop);
 417     while (const InteractionLists* il = gmx_mtop_ilistloop_next(iloop, &nmol))
 418     {
 419         n += nmol * (*il)[ftype].size() / (1 + NRAL(ftype));
 420     }
 421
 422     if (mtop->bIntermolecularInteractions)
 423     {
 424         n += (*mtop->intermolecular_ilist)[ftype].size() / (1 + NRAL(ftype));
 425     }
 426
 427     return n;
 428 }
 429
 430 int gmx_mtop_ftype_count(const gmx_mtop_t& mtop, int ftype)
 431 {
 432     return gmx_mtop_ftype_count(&mtop, ftype);
 433 }
 434
 435 int gmx_mtop_interaction_count(const gmx_mtop_t& mtop, const int unsigned if_flags)
 436 {
 437     int n = 0;
 438
 439     gmx_mtop_ilistloop_t iloop = gmx_mtop_ilistloop_init(mtop);
 440     int                  nmol;
 441     while (const InteractionLists* il = gmx_mtop_ilistloop_next(iloop, &nmol))
 442     {
 443         for (int ftype = 0; ftype < F_NRE; ftype++)
 444         {
 445             if ((interaction_function[ftype].flags & if_flags) == if_flags)
 446             {
 447                 n += nmol * (*il)[ftype].size() / (1 + NRAL(ftype));
 448             }
 449         }
 450     }
 451
 452     if (mtop.bIntermolecularInteractions)
 453     {
 454         for (int ftype = 0; ftype < F_NRE; ftype++)
 455         {
 456             if ((interaction_function[ftype].flags & if_flags) == if_flags)
 457             {
 458                 n += (*mtop.intermolecular_ilist)[ftype].size() / (1 + NRAL(ftype));
 459             }
 460         }
 461     }
 462
 463     return n;
 464 }
 465
 466 std::array<int, eptNR> gmx_mtop_particletype_count(const gmx_mtop_t& mtop)
 467 {
 468     std::array<int, eptNR> count = { { 0 } };
 469
 470     for (const auto& molblock : mtop.molblock)
 471     {
 472         const t_atoms& atoms = mtop.moltype[molblock.type].atoms;
 473         for (int a = 0; a < atoms.nr; a++)
 474         {
 475             count[atoms.atom[a].ptype] += molblock.nmol;
 476         }
 477     }
 478
 479     return count;
 480 }
 481
 482 static void atomcat(t_atoms* dest, const t_atoms* src, int copies, int maxres_renum, int* maxresnr)
 483 {
 484     int i, j, l, size;
 485     int srcnr  = src->nr;
 486     int destnr = dest->nr;
 487
 488     if (dest->nr == 0)
 489     {
 490         dest->haveMass    = src->haveMass;
 491         dest->haveType    = src->haveType;
 492         dest->haveCharge  = src->haveCharge;
 493         dest->haveBState  = src->haveBState;
 494         dest->havePdbInfo = src->havePdbInfo;
 495     }
 496     else
 497     {
 498         dest->haveMass    = dest->haveMass && src->haveMass;
 499         dest->haveType    = dest->haveType && src->haveType;
 500         dest->haveCharge  = dest->haveCharge && src->haveCharge;
 501         dest->haveBState  = dest->haveBState && src->haveBState;
 502         dest->havePdbInfo = dest->havePdbInfo && src->havePdbInfo;
 503     }
 504
 505     if (srcnr)
 506     {
 507         size = destnr + copies * srcnr;
 508         srenew(dest->atom, size);
 509         srenew(dest->atomname, size);
 510         if (dest->haveType)
 511         {
 512             srenew(dest->atomtype, size);
 513             if (dest->haveBState)
 514             {
 515                 srenew(dest->atomtypeB, size);
 516             }
 517         }
 518         if (dest->havePdbInfo)
 519         {
 520             srenew(dest->pdbinfo, size);
 521         }
 522     }
 523     if (src->nres)
 524     {
 525         size = dest->nres + copies * src->nres;
 526         srenew(dest->resinfo, size);
 527     }
 528
 529     /* residue information */
 530     for (l = dest->nres, j = 0; (j < copies); j++, l += src->nres)
 531     {
 532         memcpy(reinterpret_cast<char*>(&(dest->resinfo[l])), reinterpret_cast<char*>(&(src->resinfo[0])),
 533                static_cast<size_t>(src->nres * sizeof(src->resinfo[0])));
 534     }
 535
 536     for (l = destnr, j = 0; (j < copies); j++, l += srcnr)
 537     {
 538         memcpy(reinterpret_cast<char*>(&(dest->atom[l])), reinterpret_cast<char*>(&(src->atom[0])),
 539                static_cast<size_t>(srcnr * sizeof(src->atom[0])));
 540         memcpy(reinterpret_cast<char*>(&(dest->atomname[l])),
 541                reinterpret_cast<char*>(&(src->atomname[0])),
 542                static_cast<size_t>(srcnr * sizeof(src->atomname[0])));
 543         if (dest->haveType)
 544         {
 545             memcpy(reinterpret_cast<char*>(&(dest->atomtype[l])),
 546                    reinterpret_cast<char*>(&(src->atomtype[0])),
 547                    static_cast<size_t>(srcnr * sizeof(src->atomtype[0])));
 548             if (dest->haveBState)
 549             {
 550                 memcpy(reinterpret_cast<char*>(&(dest->atomtypeB[l])),
 551                        reinterpret_cast<char*>(&(src->atomtypeB[0])),
 552                        static_cast<size_t>(srcnr * sizeof(src->atomtypeB[0])));
 553             }
 554         }
 555         if (dest->havePdbInfo)
 556         {
 557             memcpy(reinterpret_cast<char*>(&(dest->pdbinfo[l])),
 558                    reinterpret_cast<char*>(&(src->pdbinfo[0])),
 559                    static_cast<size_t>(srcnr * sizeof(src->pdbinfo[0])));
 560         }
 561     }
 562
 563     /* Increment residue indices */
 564     for (l = destnr, j = 0; (j < copies); j++)
 565     {
 566         for (i = 0; (i < srcnr); i++, l++)
 567         {
 568             dest->atom[l].resind = dest->nres + j * src->nres + src->atom[i].resind;
 569         }
 570     }
 571
 572     if (src->nres <= maxres_renum)
 573     {
 574         /* Single residue molecule, continue counting residues */
 575         for (j = 0; (j < copies); j++)
 576         {
 577             for (l = 0; l < src->nres; l++)
 578             {
 579                 (*maxresnr)++;
 580                 dest->resinfo[dest->nres + j * src->nres + l].nr = *maxresnr;
 581             }
 582         }
 583     }
 584
 585     dest->nres += copies * src->nres;
 586     dest->nr += copies * src->nr;
 587 }
 588
 589 t_atoms gmx_mtop_global_atoms(const gmx_mtop_t* mtop)
 590 {
 591     t_atoms atoms;
 592
 593     init_t_atoms(&atoms, 0, FALSE);
 594
 595     int maxresnr = mtop->maxresnr;
 596     for (const gmx_molblock_t& molb : mtop->molblock)
 597     {
 598         atomcat(&atoms, &mtop->moltype[molb.type].atoms, molb.nmol, mtop->maxres_renum, &maxresnr);
 599     }
 600
 601     return atoms;
 602 }
 603
 604 /*
 605  * The cat routines below are old code from src/kernel/topcat.c
 606  */
 607
 608 static void ilistcat(int ftype, InteractionList* dest, const InteractionList& src, int copies, int dnum, int snum)
 609 {
 610     int nral, c, i, a;
 611
 612     nral = NRAL(ftype);
 613
 614     size_t destIndex = dest->iatoms.size();
 615     dest->iatoms.resize(dest->iatoms.size() + copies * src.size());
 616
 617     for (c = 0; c < copies; c++)
 618     {
 619         for (i = 0; i < src.size();)
 620         {
 621             dest->iatoms[destIndex++] = src.iatoms[i++];
 622             for (a = 0; a < nral; a++)
 623             {
 624                 dest->iatoms[destIndex++] = dnum + src.iatoms[i++];
 625             }
 626         }
 627         dnum += snum;
 628     }
 629 }
 630
 631 static void ilistcat(int ftype, t_ilist* dest, const InteractionList& src, int copies, int dnum, int snum)
 632 {
 633     int nral, c, i, a;
 634
 635     nral = NRAL(ftype);
 636
 637     dest->nalloc = dest->nr + copies * src.size();
 638     srenew(dest->iatoms, dest->nalloc);
 639
 640     for (c = 0; c < copies; c++)
 641     {
 642         for (i = 0; i < src.size();)
 643         {
 644             dest->iatoms[dest->nr++] = src.iatoms[i++];
 645             for (a = 0; a < nral; a++)
 646             {
 647                 dest->iatoms[dest->nr++] = dnum + src.iatoms[i++];
 648             }
 649         }
 650         dnum += snum;
 651     }
 652 }
 653
 654 static const t_iparams& getIparams(const InteractionDefinitions& idef, const int index)
 655 {
 656     return idef.iparams[index];
 657 }
 658
 659 static const t_iparams& getIparams(const t_idef& idef, const int index)
 660 {
 661     return idef.iparams[index];
 662 }
 663
 664 static void resizeIParams(std::vector<t_iparams>* iparams, const int newSize)
 665 {
 666     iparams->resize(newSize);
 667 }
 668
 669 static void resizeIParams(t_iparams** iparams, const int newSize)
 670 {
 671     srenew(*iparams, newSize);
 672 }
 673
 674 template<typename IdefType>
 675 static void set_posres_params(IdefType* idef, const gmx_molblock_t* molb, int i0, int a_offset)
 676 {
 677     int        i1, i, a_molb;
 678     t_iparams* ip;
 679
 680     auto* il = &idef->il[F_POSRES];
 681     i1       = il->size() / 2;
 682     resizeIParams(&idef->iparams_posres, i1);
 683     for (i = i0; i < i1; i++)
 684     {
 685         ip = &idef->iparams_posres[i];
 686         /* Copy the force constants */
 687         *ip    = getIparams(*idef, il->iatoms[i * 2]);
 688         a_molb = il->iatoms[i * 2 + 1] - a_offset;
 689         if (molb->posres_xA.empty())
 690         {
 691             gmx_incons("Position restraint coordinates are missing");
 692         }
 693         ip->posres.pos0A[XX] = molb->posres_xA[a_molb][XX];
 694         ip->posres.pos0A[YY] = molb->posres_xA[a_molb][YY];
 695         ip->posres.pos0A[ZZ] = molb->posres_xA[a_molb][ZZ];
 696         if (!molb->posres_xB.empty())
 697         {
 698             ip->posres.pos0B[XX] = molb->posres_xB[a_molb][XX];
 699             ip->posres.pos0B[YY] = molb->posres_xB[a_molb][YY];
 700             ip->posres.pos0B[ZZ] = molb->posres_xB[a_molb][ZZ];
 701         }
 702         else
 703         {
 704             ip->posres.pos0B[XX] = ip->posres.pos0A[XX];
 705             ip->posres.pos0B[YY] = ip->posres.pos0A[YY];
 706             ip->posres.pos0B[ZZ] = ip->posres.pos0A[ZZ];
 707         }
 708         /* Set the parameter index for idef->iparams_posre */
 709         il->iatoms[i * 2] = i;
 710     }
 711 }
 712
 713 template<typename IdefType>
 714 static void set_fbposres_params(IdefType* idef, const gmx_molblock_t* molb, int i0, int a_offset)
 715 {
 716     int        i1, i, a_molb;
 717     t_iparams* ip;
 718
 719     auto* il = &idef->il[F_FBPOSRES];
 720     i1       = il->size() / 2;
 721     resizeIParams(&idef->iparams_fbposres, i1);
 722     for (i = i0; i < i1; i++)
 723     {
 724         ip = &idef->iparams_fbposres[i];
 725         /* Copy the force constants */
 726         *ip    = getIparams(*idef, il->iatoms[i * 2]);
 727         a_molb = il->iatoms[i * 2 + 1] - a_offset;
 728         if (molb->posres_xA.empty())
 729         {
 730             gmx_incons("Position restraint coordinates are missing");
 731         }
 732         /* Take flat-bottom posres reference from normal position restraints */
 733         ip->fbposres.pos0[XX] = molb->posres_xA[a_molb][XX];
 734         ip->fbposres.pos0[YY] = molb->posres_xA[a_molb][YY];
 735         ip->fbposres.pos0[ZZ] = molb->posres_xA[a_molb][ZZ];
 736         /* Note: no B-type for flat-bottom posres */
 737
 738         /* Set the parameter index for idef->iparams_posre */
 739         il->iatoms[i * 2] = i;
 740     }
 741 }
 742
 743 /*! \brief Copy parameters to idef structure from mtop.
 744  *
 745  * Makes a deep copy of the force field parameters data structure from a gmx_mtop_t.
 746  * Used to initialize legacy topology types.
 747  *
 748  * \param[in] mtop Reference to input mtop.
 749  * \param[in] idef Pointer to idef to populate.
 750  */
 751 static void copyFFParametersFromMtop(const gmx_mtop_t& mtop, t_idef* idef)
 752 {
 753     const gmx_ffparams_t* ffp = &mtop.ffparams;
 754
 755     idef->ntypes = ffp->numTypes();
 756     idef->atnr   = ffp->atnr;
 757     /* we can no longer copy the pointers to the mtop members,
 758      * because they will become invalid as soon as mtop gets free'd.
 759      * We also need to make sure to only operate on valid data!
 760      */
 761
 762     if (!ffp->functype.empty())
 763     {
 764         snew(idef->functype, ffp->functype.size());
 765         std::copy(ffp->functype.data(), ffp->functype.data() + ffp->functype.size(), idef->functype);
 766     }
 767     else
 768     {
 769         idef->functype = nullptr;
 770     }
 771     if (!ffp->iparams.empty())
 772     {
 773         snew(idef->iparams, ffp->iparams.size());
 774         std::copy(ffp->iparams.data(), ffp->iparams.data() + ffp->iparams.size(), idef->iparams);
 775     }
 776     else
 777     {
 778         idef->iparams = nullptr;
 779     }
 780     idef->iparams_posres   = nullptr;
 781     idef->iparams_fbposres = nullptr;
 782     idef->fudgeQQ          = ffp->fudgeQQ;
 783     idef->ilsort           = ilsortUNKNOWN;
 784 }
 785
 786 /*! \brief Copy idef structure from mtop.
 787  *
 788  * Makes a deep copy of an idef data structure from a gmx_mtop_t.
 789  * Used to initialize legacy topology types.
 790  *
 791  * \param[in] mtop Reference to input mtop.
 792  * \param[in] idef Pointer to idef to populate.
 793  * \param[in] mergeConstr Decide if constraints will be merged.
 794  */
 795 template<typename IdefType>
 796 static void copyIListsFromMtop(const gmx_mtop_t& mtop, IdefType* idef, bool mergeConstr)
 797 {
 798     int natoms = 0;
 799     for (const gmx_molblock_t& molb : mtop.molblock)
 800     {
 801         const gmx_moltype_t& molt = mtop.moltype[molb.type];
 802
 803         int srcnr  = molt.atoms.nr;
 804         int destnr = natoms;
 805
 806         int nposre_old   = idef->il[F_POSRES].size();
 807         int nfbposre_old = idef->il[F_FBPOSRES].size();
 808         for (int ftype = 0; ftype < F_NRE; ftype++)
 809         {
 810             if (mergeConstr && ftype == F_CONSTR && !molt.ilist[F_CONSTRNC].empty())
 811             {
 812                 /* Merge all constrains into one ilist.
 813                  * This simplifies the constraint code.
 814                  */
 815                 for (int mol = 0; mol < molb.nmol; mol++)
 816                 {
 817                     ilistcat(ftype, &idef->il[F_CONSTR], molt.ilist[F_CONSTR], 1,
 818                              destnr + mol * srcnr, srcnr);
 819                     ilistcat(ftype, &idef->il[F_CONSTR], molt.ilist[F_CONSTRNC], 1,
 820                              destnr + mol * srcnr, srcnr);
 821                 }
 822             }
 823             else if (!(mergeConstr && ftype == F_CONSTRNC))
 824             {
 825                 ilistcat(ftype, &idef->il[ftype], molt.ilist[ftype], molb.nmol, destnr, srcnr);
 826             }
 827         }
 828         if (idef->il[F_POSRES].size() > nposre_old)
 829         {
 830             /* Executing this line line stops gmxdump -sys working
 831              * correctly. I'm not aware there's an elegant fix. */
 832             set_posres_params(idef, &molb, nposre_old / 2, natoms);
 833         }
 834         if (idef->il[F_FBPOSRES].size() > nfbposre_old)
 835         {
 836             set_fbposres_params(idef, &molb, nfbposre_old / 2, natoms);
 837         }
 838
 839         natoms += molb.nmol * srcnr;
 840     }
 841
 842     if (mtop.bIntermolecularInteractions)
 843     {
 844         for (int ftype = 0; ftype < F_NRE; ftype++)
 845         {
 846             ilistcat(ftype, &idef->il[ftype], (*mtop.intermolecular_ilist)[ftype], 1, 0, mtop.natoms);
 847         }
 848     }
 849
 850     // We have not (yet) sorted free-energy interactions to the end of the ilists
 851     idef->ilsort = ilsortNO_FE;
 852 }
 853
 854 /*! \brief Copy atomtypes from mtop
 855  *
 856  * Makes a deep copy of t_atomtypes from gmx_mtop_t.
 857  * Used to initialize legacy topology types.
 858  *
 859  * \param[in] mtop Reference to input mtop.
 860  * \param[in] atomtypes Pointer to atomtypes to populate.
 861  */
 862 static void copyAtomtypesFromMtop(const gmx_mtop_t& mtop, t_atomtypes* atomtypes)
 863 {
 864     atomtypes->nr = mtop.atomtypes.nr;
 865     if (mtop.atomtypes.atomnumber)
 866     {
 867         snew(atomtypes->atomnumber, mtop.atomtypes.nr);
 868         std::copy(mtop.atomtypes.atomnumber, mtop.atomtypes.atomnumber + mtop.atomtypes.nr,
 869                   atomtypes->atomnumber);
 870     }
 871     else
 872     {
 873         atomtypes->atomnumber = nullptr;
 874     }
 875 }
 876
 877 /*! \brief Generate a single list of lists of exclusions for the whole system
 878  *
 879  * \param[in] mtop  Reference to input mtop.
 880  */
 881 static gmx::ListOfLists<int> globalExclusionLists(const gmx_mtop_t& mtop)
 882 {
 883     gmx::ListOfLists<int> excls;
 884
 885     int atomIndex = 0;
 886     for (const gmx_molblock_t& molb : mtop.molblock)
 887     {
 888         const gmx_moltype_t& molt = mtop.moltype[molb.type];
 889
 890         for (int mol = 0; mol < molb.nmol; mol++)
 891         {
 892             excls.appendListOfLists(molt.excls, atomIndex);
 893
 894             atomIndex += molt.atoms.nr;
 895         }
 896     }
 897
 898     return excls;
 899 }
 900
 901 /*! \brief Updates inter-molecular exclusion lists
 902  *
 903  * This function updates inter-molecular exclusions to exclude all
 904  * non-bonded interactions between a given list of atoms
 905  *
 906  * \param[inout]    excls   existing exclusions in local topology
 907  * \param[in]       ids     list of global IDs of atoms
 908  */
 909 static void addMimicExclusions(gmx::ListOfLists<int>* excls, const gmx::ArrayRef<const int> ids)
 910 {
 911     t_blocka inter_excl{};
 912     init_blocka(&inter_excl);
 913     size_t n_q = ids.size();
 914
 915     inter_excl.nr  = excls->ssize();
 916     inter_excl.nra = n_q * n_q;
 917
 918     size_t total_nra = n_q * n_q;
 919
 920     snew(inter_excl.index, excls->ssize() + 1);
 921     snew(inter_excl.a, total_nra);
 922
 923     for (int i = 0; i < inter_excl.nr; ++i)
 924     {
 925         inter_excl.index[i] = 0;
 926     }
 927
 928     /* Here we loop over the list of QM atom ids
 929      *  and create exclusions between all of them resulting in
 930      *  n_q * n_q sized exclusion list
 931      */
 932     int prev_index = 0;
 933     for (int k = 0; k < inter_excl.nr; ++k)
 934     {
 935         inter_excl.index[k] = prev_index;
 936         for (long i = 0; i < ids.ssize(); i++)
 937         {
 938             if (k != ids[i])
 939             {
 940                 continue;
 941             }
 942             size_t index             = n_q * i;
 943             inter_excl.index[ids[i]] = index;
 944             prev_index               = index + n_q;
 945             for (size_t j = 0; j < n_q; ++j)
 946             {
 947                 inter_excl.a[n_q * i + j] = ids[j];
 948             }
 949         }
 950     }
 951     inter_excl.index[ids[n_q - 1] + 1] = n_q * n_q;
 952
 953     inter_excl.index[inter_excl.nr] = n_q * n_q;
 954
 955     std::vector<gmx::ExclusionBlock> qmexcl2(excls->size());
 956     gmx::blockaToExclusionBlocks(&inter_excl, qmexcl2);
 957
 958     // Merge the created exclusion list with the existing one
 959     gmx::mergeExclusions(excls, qmexcl2);
 960 }
 961
 962 static void sortFreeEnergyInteractionsAtEnd(const gmx_mtop_t& mtop, InteractionDefinitions* idef)
 963 {
 964     std::vector<real> qA(mtop.natoms);
 965     std::vector<real> qB(mtop.natoms);
 966     for (const AtomProxy atomP : AtomRange(mtop))
 967     {
 968         const t_atom& local = atomP.atom();
 969         int           index = atomP.globalAtomNumber();
 970         qA[index]           = local.q;
 971         qB[index]           = local.qB;
 972     }
 973     gmx_sort_ilist_fe(idef, qA.data(), qB.data());
 974 }
 975
 976 static void gen_local_top(const gmx_mtop_t& mtop,
 977                           bool              freeEnergyInteractionsAtEnd,
 978                           bool              bMergeConstr,
 979                           gmx_localtop_t*   top)
 980 {
 981     copyIListsFromMtop(mtop, &top->idef, bMergeConstr);
 982     if (freeEnergyInteractionsAtEnd)
 983     {
 984         sortFreeEnergyInteractionsAtEnd(mtop, &top->idef);
 985     }
 986     top->excls = globalExclusionLists(mtop);
 987     if (!mtop.intermolecularExclusionGroup.empty())
 988     {
 989         addMimicExclusions(&top->excls, mtop.intermolecularExclusionGroup);
 990     }
 991 }
 992
 993 void gmx_mtop_generate_local_top(const gmx_mtop_t& mtop, gmx_localtop_t* top, bool freeEnergyInteractionsAtEnd)
 994 {
 995     gen_local_top(mtop, freeEnergyInteractionsAtEnd, true, top);
 996 }
 997
 998 /*! \brief Fills an array with molecule begin/end atom indices
 999  *
1000  * \param[in]  mtop   The global topology
1001  * \param[out] index  Array of size nr. of molecules + 1 to be filled with molecule begin/end indices
1002  */
1003 static void fillMoleculeIndices(const gmx_mtop_t& mtop, gmx::ArrayRef<int> index)
1004 {
1005     int globalAtomIndex   = 0;
1006     int globalMolIndex    = 0;
1007     index[globalMolIndex] = globalAtomIndex;
1008     for (const gmx_molblock_t& molb : mtop.molblock)
1009     {
1010         int numAtomsPerMolecule = mtop.moltype[molb.type].atoms.nr;
1011         for (int mol = 0; mol < molb.nmol; mol++)
1012         {
1013             globalAtomIndex += numAtomsPerMolecule;
1014             globalMolIndex += 1;
1015             index[globalMolIndex] = globalAtomIndex;
1016         }
1017     }
1018 }
1019
1020 gmx::RangePartitioning gmx_mtop_molecules(const gmx_mtop_t& mtop)
1021 {
1022     gmx::RangePartitioning mols;
1023
1024     for (const gmx_molblock_t& molb : mtop.molblock)
1025     {
1026         int numAtomsPerMolecule = mtop.moltype[molb.type].atoms.nr;
1027         for (int mol = 0; mol < molb.nmol; mol++)
1028         {
1029             mols.appendBlock(numAtomsPerMolecule);
1030         }
1031     }
1032
1033     return mols;
1034 }
1035
1036 /*! \brief Creates and returns a deprecated t_block struct with molecule indices
1037  *
1038  * \param[in] mtop  The global topology
1039  */
1040 static t_block gmx_mtop_molecules_t_block(const gmx_mtop_t& mtop)
1041 {
1042     t_block mols;
1043
1044     mols.nr           = gmx_mtop_num_molecules(mtop);
1045     mols.nalloc_index = mols.nr + 1;
1046     snew(mols.index, mols.nalloc_index);
1047
1048     fillMoleculeIndices(mtop, gmx::arrayRefFromArray(mols.index, mols.nr + 1));
1049
1050     return mols;
1051 }
1052
1053 static void gen_t_topology(const gmx_mtop_t& mtop, bool bMergeConstr, t_topology* top)
1054 {
1055     copyAtomtypesFromMtop(mtop, &top->atomtypes);
1056     for (int ftype = 0; ftype < F_NRE; ftype++)
1057     {
1058         top->idef.il[ftype].nr     = 0;
1059         top->idef.il[ftype].nalloc = 0;
1060         top->idef.il[ftype].iatoms = nullptr;
1061     }
1062     copyFFParametersFromMtop(mtop, &top->idef);
1063     copyIListsFromMtop(mtop, &top->idef, bMergeConstr);
1064
1065     top->name                        = mtop.name;
1066     top->atoms                       = gmx_mtop_global_atoms(&mtop);
1067     top->mols                        = gmx_mtop_molecules_t_block(mtop);
1068     top->bIntermolecularInteractions = mtop.bIntermolecularInteractions;
1069     top->symtab                      = mtop.symtab;
1070 }
1071
1072 t_topology gmx_mtop_t_to_t_topology(gmx_mtop_t* mtop, bool freeMTop)
1073 {
1074     t_topology top;
1075
1076     gen_t_topology(*mtop, false, &top);
1077
1078     if (freeMTop)
1079     {
1080         // Clear pointers and counts, such that the pointers copied to top
1081         // keep pointing to valid data after destroying mtop.
1082         mtop->symtab.symbuf = nullptr;
1083         mtop->symtab.nr     = 0;
1084     }
1085     return top;
1086 }
1087
1088 std::vector<int> get_atom_index(const gmx_mtop_t* mtop)
1089 {
1090
1091     std::vector<int> atom_index;
1092     for (const AtomProxy atomP : AtomRange(*mtop))
1093     {
1094         const t_atom& local = atomP.atom();
1095         int           index = atomP.globalAtomNumber();
1096         if (local.ptype == eptAtom)
1097         {
1098             atom_index.push_back(index);
1099         }
1100     }
1101     return atom_index;
1102 }
1103
1104 void convertAtomsToMtop(t_symtab* symtab, char** name, t_atoms* atoms, gmx_mtop_t* mtop)
1105 {
1106     mtop->symtab = *symtab;
1107
1108     mtop->name = name;
1109
1110     mtop->moltype.clear();
1111     mtop->moltype.resize(1);
1112     mtop->moltype.back().atoms = *atoms;
1113
1114     mtop->molblock.resize(1);
1115     mtop->molblock[0].type = 0;
1116     mtop->molblock[0].nmol = 1;
1117
1118     mtop->bIntermolecularInteractions = FALSE;
1119
1120     mtop->natoms = atoms->nr;
1121
1122     mtop->haveMoleculeIndices = false;
1123
1124     gmx_mtop_finalize(mtop);
1125 }
1126
1127 bool haveFepPerturbedNBInteractions(const gmx_mtop_t* mtop)
1128 {
1129     for (size_t mb = 0; mb < mtop->molblock.size(); mb++)
1130     {
1131         const gmx_molblock_t& molb = mtop->molblock[mb];
1132         const gmx_moltype_t&  molt = mtop->moltype[molb.type];
1133         for (int m = 0; m < molb.nmol; m++)
1134         {
1135             for (int a = 0; a < molt.atoms.nr; a++)
1136             {
1137                 const t_atom& atom = molt.atoms.atom[a];
1138                 if (PERTURBED(atom))
1139                 {
1140                     return true;
1141                 }
1142             }
1143         }
1144     }
1145     return false;
1146 }