src/gromacs/fileio/tpxio.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015,2016,2017 by the GROMACS development team.
   7  * Copyright (c) 2018,2019,2020, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 #include "gmxpre.h"
  39
  40 /* This file is completely threadsafe - keep it that way! */
  41
  42 #include "gromacs/fileio/tpxio.h"
  43
  44 #include <cstdio>
  45 #include <cstdlib>
  46 #include <cstring>
  47
  48 #include <algorithm>
  49 #include <memory>
  50 #include <vector>
  51
  52 #include "gromacs/fileio/filetypes.h"
  53 #include "gromacs/fileio/gmxfio.h"
  54 #include "gromacs/fileio/gmxfio_xdr.h"
  55 #include "gromacs/math/units.h"
  56 #include "gromacs/math/vec.h"
  57 #include "gromacs/mdtypes/awh_history.h"
  58 #include "gromacs/mdtypes/awh_params.h"
  59 #include "gromacs/mdtypes/inputrec.h"
  60 #include "gromacs/mdtypes/md_enums.h"
  61 #include "gromacs/mdtypes/multipletimestepping.h"
  62 #include "gromacs/mdtypes/pull_params.h"
  63 #include "gromacs/mdtypes/state.h"
  64 #include "gromacs/pbcutil/boxutilities.h"
  65 #include "gromacs/pbcutil/pbc.h"
  66 #include "gromacs/topology/block.h"
  67 #include "gromacs/topology/ifunc.h"
  68 #include "gromacs/topology/mtop_util.h"
  69 #include "gromacs/topology/symtab.h"
  70 #include "gromacs/topology/topology.h"
  71 #include "gromacs/utility/arraysize.h"
  72 #include "gromacs/utility/baseversion.h"
  73 #include "gromacs/utility/cstringutil.h"
  74 #include "gromacs/utility/fatalerror.h"
  75 #include "gromacs/utility/futil.h"
  76 #include "gromacs/utility/gmxassert.h"
  77 #include "gromacs/utility/inmemoryserializer.h"
  78 #include "gromacs/utility/keyvaluetreebuilder.h"
  79 #include "gromacs/utility/keyvaluetreeserializer.h"
  80 #include "gromacs/utility/smalloc.h"
  81 #include "gromacs/utility/snprintf.h"
  82 #include "gromacs/utility/txtdump.h"
  83
  84 #define TPX_TAG_RELEASE "release"
  85
  86 /*! \brief Tag string for the file format written to run input files
  87  * written by this version of the code.
  88  *
  89  * Change this if you want to change the run input format in a feature
  90  * branch. This ensures that there will not be different run input
  91  * formats around which cannot be distinguished, while not causing
  92  * problems rebasing the feature branch onto upstream changes. When
  93  * merging with mainstream GROMACS, set this tag string back to
  94  * TPX_TAG_RELEASE, and instead add an element to tpxv.
  95  */
  96 static const char* tpx_tag = TPX_TAG_RELEASE;
  97
  98 /*! \brief Enum of values that describe the contents of a tpr file
  99  * whose format matches a version number
 100  *
 101  * The enum helps the code be more self-documenting and ensure merges
 102  * do not silently resolve when two patches make the same bump. When
 103  * adding new functionality, add a new element just above tpxv_Count
 104  * in this enumeration, and write code below that does the right thing
 105  * according to the value of file_version.
 106  */
 107 enum tpxv
 108 {
 109     tpxv_ComputationalElectrophysiology =
 110             96, /**< support for ion/water position swaps (computational electrophysiology) */
 111     tpxv_Use64BitRandomSeed, /**< change ld_seed from int to int64_t */
 112     tpxv_RestrictedBendingAndCombinedAngleTorsionPotentials, /**< potentials for supporting coarse-grained force fields */
 113     tpxv_InteractiveMolecularDynamics, /**< interactive molecular dynamics (IMD) */
 114     tpxv_RemoveObsoleteParameters1,    /**< remove optimize_fft, dihre_fc, nstcheckpoint */
 115     tpxv_PullCoordTypeGeom,            /**< add pull type and geometry per group and flat-bottom */
 116     tpxv_PullGeomDirRel,               /**< add pull geometry direction-relative */
 117     tpxv_IntermolecularBondeds, /**< permit inter-molecular bonded interactions in the topology */
 118     tpxv_CompElWithSwapLayerOffset, /**< added parameters for improved CompEl setups */
 119     tpxv_CompElPolyatomicIonsAndMultipleIonTypes, /**< CompEl now can handle polyatomic ions and more than two types of ions */
 120     tpxv_RemoveAdress,                            /**< removed support for AdResS */
 121     tpxv_PullCoordNGroup,               /**< add ngroup to pull coord */
 122     tpxv_RemoveTwinRange,               /**< removed support for twin-range interactions */
 123     tpxv_ReplacePullPrintCOM12,         /**< Replaced print-com-1, 2 with pull-print-com */
 124     tpxv_PullExternalPotential,         /**< Added pull type external potential */
 125     tpxv_GenericParamsForElectricField, /**< Introduced KeyValueTree and moved electric field parameters */
 126     tpxv_AcceleratedWeightHistogram, /**< sampling with accelerated weight histogram method (AWH) */
 127     tpxv_RemoveImplicitSolvation,    /**< removed support for implicit solvation */
 128     tpxv_PullPrevStepCOMAsReference, /**< Enabled using the COM of the pull group of the last frame as reference for PBC */
 129     tpxv_MimicQMMM,   /**< Introduced support for MiMiC QM/MM interface */
 130     tpxv_PullAverage, /**< Added possibility to output average pull force and position */
 131     tpxv_GenericInternalParameters, /**< Added internal parameters for mdrun modules*/
 132     tpxv_VSite2FD,                  /**< Added 2FD type virtual site */
 133     tpxv_AddSizeField, /**< Added field with information about the size of the serialized tpr file in bytes, excluding the header */
 134     tpxv_StoreNonBondedInteractionExclusionGroup, /**< Store the non bonded interaction exclusion group in the topology */
 135     tpxv_VSite1,                                  /**< Added 1 type virtual site */
 136     tpxv_MTS,                                     /**< Added multiple time stepping */
 137     tpxv_Count                                    /**< the total number of tpxv versions */
 138 };
 139
 140 /*! \brief Version number of the file format written to run input
 141  * files by this version of the code.
 142  *
 143  * The tpx_version increases whenever the file format in the main
 144  * development branch changes, due to an extension of the tpxv enum above.
 145  * Backward compatibility for reading old run input files is maintained
 146  * by checking this version number against that of the file and then using
 147  * the correct code path.
 148  *
 149  * When developing a feature branch that needs to change the run input
 150  * file format, change tpx_tag instead. */
 151 static const int tpx_version = tpxv_Count - 1;
 152
 153
 154 /* This number should only be increased when you edit the TOPOLOGY section
 155  * or the HEADER of the tpx format.
 156  * This way we can maintain forward compatibility too for all analysis tools
 157  * and/or external programs that only need to know the atom/residue names,
 158  * charges, and bond connectivity.
 159  *
 160  * It first appeared in tpx version 26, when I also moved the inputrecord
 161  * to the end of the tpx file, so we can just skip it if we only
 162  * want the topology.
 163  *
 164  * In particular, it must be increased when adding new elements to
 165  * ftupd, so that old code can read new .tpr files.
 166  *
 167  * Updated for added field that contains the number of bytes of the tpr body, excluding the header.
 168  */
 169 static const int tpx_generation = 27;
 170
 171 /* This number should be the most recent backwards incompatible version
 172  * I.e., if this number is 9, we cannot read tpx version 9 with this code.
 173  */
 174 static const int tpx_incompatible_version = 57; // GMX4.0 has version 58
 175
 176
 177 /* Struct used to maintain tpx compatibility when function types are added */
 178 typedef struct
 179 {
 180     int fvnr;  /* file version number in which the function type first appeared */
 181     int ftype; /* function type */
 182 } t_ftupd;
 183
 184 /*
 185  * TODO The following three lines make little sense, please clarify if
 186  * you've had to work out how ftupd works.
 187  *
 188  * The entries should be ordered in:
 189  * 1. ascending function type number
 190  * 2. ascending file version number
 191  *
 192  * Because we support reading of old .tpr file versions (even when
 193  * mdrun can no longer run the simulation), we need to be able to read
 194  * obsolete t_interaction_function types. Any data read from such
 195  * fields is discarded. Their names have _NOLONGERUSED appended to
 196  * them to make things clear.
 197  */
 198 static const t_ftupd ftupd[] = {
 199     { 70, F_RESTRBONDS },
 200     { tpxv_RestrictedBendingAndCombinedAngleTorsionPotentials, F_RESTRANGLES },
 201     { 76, F_LINEAR_ANGLES },
 202     { tpxv_RestrictedBendingAndCombinedAngleTorsionPotentials, F_RESTRDIHS },
 203     { tpxv_RestrictedBendingAndCombinedAngleTorsionPotentials, F_CBTDIHS },
 204     { 65, F_CMAP },
 205     { 60, F_GB12_NOLONGERUSED },
 206     { 61, F_GB13_NOLONGERUSED },
 207     { 61, F_GB14_NOLONGERUSED },
 208     { 72, F_GBPOL_NOLONGERUSED },
 209     { 72, F_NPSOLVATION_NOLONGERUSED },
 210     { 93, F_LJ_RECIP },
 211     { 76, F_ANHARM_POL },
 212     { 90, F_FBPOSRES },
 213     { tpxv_VSite1, F_VSITE1 },
 214     { tpxv_VSite2FD, F_VSITE2FD },
 215     { tpxv_GenericInternalParameters, F_DENSITYFITTING },
 216     { 69, F_VTEMP_NOLONGERUSED },
 217     { 66, F_PDISPCORR },
 218     { 79, F_DVDL_COUL },
 219     {
 220             79,
 221             F_DVDL_VDW,
 222     },
 223     {
 224             79,
 225             F_DVDL_BONDED,
 226     },
 227     { 79, F_DVDL_RESTRAINT },
 228     { 79, F_DVDL_TEMPERATURE },
 229 };
 230 #define NFTUPD asize(ftupd)
 231
 232 /* Needed for backward compatibility */
 233 #define MAXNODES 256
 234
 235 /**************************************************************
 236  *
 237  * Now the higer level routines that do io of the structures and arrays
 238  *
 239  **************************************************************/
 240 static void do_pullgrp_tpx_pre95(gmx::ISerializer* serializer, t_pull_group* pgrp, t_pull_coord* pcrd)
 241 {
 242     rvec tmp;
 243
 244     int numAtoms = pgrp->ind.size();
 245     serializer->doInt(&numAtoms);
 246     pgrp->ind.resize(numAtoms);
 247     serializer->doIntArray(pgrp->ind.data(), numAtoms);
 248     int numWeights = pgrp->weight.size();
 249     serializer->doInt(&numWeights);
 250     pgrp->weight.resize(numWeights);
 251     serializer->doRealArray(pgrp->weight.data(), numWeights);
 252     serializer->doInt(&pgrp->pbcatom);
 253     serializer->doRvec(&pcrd->vec.as_vec());
 254     clear_rvec(pcrd->origin);
 255     serializer->doRvec(&tmp);
 256     pcrd->init = tmp[0];
 257     serializer->doReal(&pcrd->rate);
 258     serializer->doReal(&pcrd->k);
 259     serializer->doReal(&pcrd->kB);
 260 }
 261
 262 static void do_pull_group(gmx::ISerializer* serializer, t_pull_group* pgrp)
 263 {
 264     int numAtoms = pgrp->ind.size();
 265     serializer->doInt(&numAtoms);
 266     pgrp->ind.resize(numAtoms);
 267     serializer->doIntArray(pgrp->ind.data(), numAtoms);
 268     int numWeights = pgrp->weight.size();
 269     serializer->doInt(&numWeights);
 270     pgrp->weight.resize(numWeights);
 271     serializer->doRealArray(pgrp->weight.data(), numWeights);
 272     serializer->doInt(&pgrp->pbcatom);
 273 }
 274
 275 static void do_pull_coord(gmx::ISerializer* serializer,
 276                           t_pull_coord*     pcrd,
 277                           int               file_version,
 278                           int               ePullOld,
 279                           int               eGeomOld,
 280                           ivec              dimOld)
 281 {
 282     if (file_version >= tpxv_PullCoordNGroup)
 283     {
 284         serializer->doInt(&pcrd->eType);
 285         if (file_version >= tpxv_PullExternalPotential)
 286         {
 287             if (pcrd->eType == epullEXTERNAL)
 288             {
 289                 std::string buf;
 290                 if (serializer->reading())
 291                 {
 292                     serializer->doString(&buf);
 293                     pcrd->externalPotentialProvider = gmx_strdup(buf.c_str());
 294                 }
 295                 else
 296                 {
 297                     buf = pcrd->externalPotentialProvider;
 298                     serializer->doString(&buf);
 299                 }
 300             }
 301             else
 302             {
 303                 pcrd->externalPotentialProvider.clear();
 304             }
 305         }
 306         else
 307         {
 308             if (serializer->reading())
 309             {
 310                 pcrd->externalPotentialProvider.clear();
 311             }
 312         }
 313         /* Note that we try to support adding new geometries without
 314          * changing the tpx version. This requires checks when printing the
 315          * geometry string and a check and fatal_error in init_pull.
 316          */
 317         serializer->doInt(&pcrd->eGeom);
 318         serializer->doInt(&pcrd->ngroup);
 319         if (pcrd->ngroup <= c_pullCoordNgroupMax)
 320         {
 321             serializer->doIntArray(pcrd->group.data(), pcrd->ngroup);
 322         }
 323         else
 324         {
 325             /* More groups in file than supported, this must be a new geometry
 326              * that is not supported by our current code. Since we will not
 327              * use the groups for this coord (checks in the pull and WHAM code
 328              * ensure this), we can ignore the groups and set ngroup=0.
 329              */
 330             int* dum;
 331             snew(dum, pcrd->ngroup);
 332             serializer->doIntArray(dum, pcrd->ngroup);
 333             sfree(dum);
 334
 335             pcrd->ngroup = 0;
 336         }
 337         serializer->doIvec(&pcrd->dim.as_vec());
 338     }
 339     else
 340     {
 341         pcrd->ngroup = 2;
 342         serializer->doInt(&pcrd->group[0]);
 343         serializer->doInt(&pcrd->group[1]);
 344         if (file_version >= tpxv_PullCoordTypeGeom)
 345         {
 346             pcrd->ngroup = (pcrd->eGeom == epullgDIRRELATIVE ? 4 : 2);
 347             serializer->doInt(&pcrd->eType);
 348             serializer->doInt(&pcrd->eGeom);
 349             if (pcrd->ngroup == 4)
 350             {
 351                 serializer->doInt(&pcrd->group[2]);
 352                 serializer->doInt(&pcrd->group[3]);
 353             }
 354             serializer->doIvec(&pcrd->dim.as_vec());
 355         }
 356         else
 357         {
 358             pcrd->eType = ePullOld;
 359             pcrd->eGeom = eGeomOld;
 360             copy_ivec(dimOld, pcrd->dim);
 361         }
 362     }
 363     serializer->doRvec(&pcrd->origin.as_vec());
 364     serializer->doRvec(&pcrd->vec.as_vec());
 365     if (file_version >= tpxv_PullCoordTypeGeom)
 366     {
 367         serializer->doBool(&pcrd->bStart);
 368     }
 369     else
 370     {
 371         /* This parameter is only printed, but not actually used by mdrun */
 372         pcrd->bStart = FALSE;
 373     }
 374     serializer->doReal(&pcrd->init);
 375     serializer->doReal(&pcrd->rate);
 376     serializer->doReal(&pcrd->k);
 377     serializer->doReal(&pcrd->kB);
 378 }
 379
 380 static void do_expandedvals(gmx::ISerializer* serializer, t_expanded* expand, t_lambda* fepvals, int file_version)
 381 {
 382     int n_lambda = fepvals->n_lambda;
 383
 384     /* reset the lambda calculation window */
 385     fepvals->lambda_start_n = 0;
 386     fepvals->lambda_stop_n  = n_lambda;
 387     if (file_version >= 79)
 388     {
 389         if (n_lambda > 0)
 390         {
 391             if (serializer->reading())
 392             {
 393                 snew(expand->init_lambda_weights, n_lambda);
 394             }
 395             serializer->doRealArray(expand->init_lambda_weights, n_lambda);
 396             serializer->doBool(&expand->bInit_weights);
 397         }
 398
 399         serializer->doInt(&expand->nstexpanded);
 400         serializer->doInt(&expand->elmcmove);
 401         serializer->doInt(&expand->elamstats);
 402         serializer->doInt(&expand->lmc_repeats);
 403         serializer->doInt(&expand->gibbsdeltalam);
 404         serializer->doInt(&expand->lmc_forced_nstart);
 405         serializer->doInt(&expand->lmc_seed);
 406         serializer->doReal(&expand->mc_temp);
 407         serializer->doBool(&expand->bSymmetrizedTMatrix);
 408         serializer->doInt(&expand->nstTij);
 409         serializer->doInt(&expand->minvarmin);
 410         serializer->doInt(&expand->c_range);
 411         serializer->doReal(&expand->wl_scale);
 412         serializer->doReal(&expand->wl_ratio);
 413         serializer->doReal(&expand->init_wl_delta);
 414         serializer->doBool(&expand->bWLoneovert);
 415         serializer->doInt(&expand->elmceq);
 416         serializer->doInt(&expand->equil_steps);
 417         serializer->doInt(&expand->equil_samples);
 418         serializer->doInt(&expand->equil_n_at_lam);
 419         serializer->doReal(&expand->equil_wl_delta);
 420         serializer->doReal(&expand->equil_ratio);
 421     }
 422 }
 423
 424 static void do_simtempvals(gmx::ISerializer* serializer, t_simtemp* simtemp, int n_lambda, int file_version)
 425 {
 426     if (file_version >= 79)
 427     {
 428         serializer->doInt(&simtemp->eSimTempScale);
 429         serializer->doReal(&simtemp->simtemp_high);
 430         serializer->doReal(&simtemp->simtemp_low);
 431         if (n_lambda > 0)
 432         {
 433             if (serializer->reading())
 434             {
 435                 snew(simtemp->temperatures, n_lambda);
 436             }
 437             serializer->doRealArray(simtemp->temperatures, n_lambda);
 438         }
 439     }
 440 }
 441
 442 static void do_imd(gmx::ISerializer* serializer, t_IMD* imd)
 443 {
 444     serializer->doInt(&imd->nat);
 445     if (serializer->reading())
 446     {
 447         snew(imd->ind, imd->nat);
 448     }
 449     serializer->doIntArray(imd->ind, imd->nat);
 450 }
 451
 452 static void do_fepvals(gmx::ISerializer* serializer, t_lambda* fepvals, int file_version)
 453 {
 454     /* i is defined in the ndo_double macro; use g to iterate. */
 455     int  g;
 456     real rdum;
 457
 458     /* free energy values */
 459
 460     if (file_version >= 79)
 461     {
 462         serializer->doInt(&fepvals->init_fep_state);
 463         serializer->doDouble(&fepvals->init_lambda);
 464         serializer->doDouble(&fepvals->delta_lambda);
 465     }
 466     else if (file_version >= 59)
 467     {
 468         serializer->doDouble(&fepvals->init_lambda);
 469         serializer->doDouble(&fepvals->delta_lambda);
 470     }
 471     else
 472     {
 473         serializer->doReal(&rdum);
 474         fepvals->init_lambda = rdum;
 475         serializer->doReal(&rdum);
 476         fepvals->delta_lambda = rdum;
 477     }
 478     if (file_version >= 79)
 479     {
 480         serializer->doInt(&fepvals->n_lambda);
 481         if (serializer->reading())
 482         {
 483             snew(fepvals->all_lambda, efptNR);
 484         }
 485         for (g = 0; g < efptNR; g++)
 486         {
 487             if (fepvals->n_lambda > 0)
 488             {
 489                 if (serializer->reading())
 490                 {
 491                     snew(fepvals->all_lambda[g], fepvals->n_lambda);
 492                 }
 493                 serializer->doDoubleArray(fepvals->all_lambda[g], fepvals->n_lambda);
 494                 serializer->doBoolArray(fepvals->separate_dvdl, efptNR);
 495             }
 496             else if (fepvals->init_lambda >= 0)
 497             {
 498                 fepvals->separate_dvdl[efptFEP] = TRUE;
 499             }
 500         }
 501     }
 502     else if (file_version >= 64)
 503     {
 504         serializer->doInt(&fepvals->n_lambda);
 505         if (serializer->reading())
 506         {
 507             int g;
 508
 509             snew(fepvals->all_lambda, efptNR);
 510             /* still allocate the all_lambda array's contents. */
 511             for (g = 0; g < efptNR; g++)
 512             {
 513                 if (fepvals->n_lambda > 0)
 514                 {
 515                     snew(fepvals->all_lambda[g], fepvals->n_lambda);
 516                 }
 517             }
 518         }
 519         serializer->doDoubleArray(fepvals->all_lambda[efptFEP], fepvals->n_lambda);
 520         if (fepvals->init_lambda >= 0)
 521         {
 522             int g, h;
 523
 524             fepvals->separate_dvdl[efptFEP] = TRUE;
 525
 526             if (serializer->reading())
 527             {
 528                 /* copy the contents of the efptFEP lambda component to all
 529                    the other components */
 530                 for (g = 0; g < efptNR; g++)
 531                 {
 532                     for (h = 0; h < fepvals->n_lambda; h++)
 533                     {
 534                         if (g != efptFEP)
 535                         {
 536                             fepvals->all_lambda[g][h] = fepvals->all_lambda[efptFEP][h];
 537                         }
 538                     }
 539                 }
 540             }
 541         }
 542     }
 543     else
 544     {
 545         fepvals->n_lambda   = 0;
 546         fepvals->all_lambda = nullptr;
 547         if (fepvals->init_lambda >= 0)
 548         {
 549             fepvals->separate_dvdl[efptFEP] = TRUE;
 550         }
 551     }
 552     serializer->doReal(&fepvals->sc_alpha);
 553     serializer->doInt(&fepvals->sc_power);
 554     if (file_version >= 79)
 555     {
 556         serializer->doReal(&fepvals->sc_r_power);
 557     }
 558     else
 559     {
 560         fepvals->sc_r_power = 6.0;
 561     }
 562     if (fepvals->sc_r_power != 6.0)
 563     {
 564         gmx_fatal(FARGS, "sc-r-power=48 is no longer supported");
 565     }
 566     serializer->doReal(&fepvals->sc_sigma);
 567     if (serializer->reading())
 568     {
 569         if (file_version >= 71)
 570         {
 571             fepvals->sc_sigma_min = fepvals->sc_sigma;
 572         }
 573         else
 574         {
 575             fepvals->sc_sigma_min = 0;
 576         }
 577     }
 578     if (file_version >= 79)
 579     {
 580         serializer->doBool(&fepvals->bScCoul);
 581     }
 582     else
 583     {
 584         fepvals->bScCoul = TRUE;
 585     }
 586     if (file_version >= 64)
 587     {
 588         serializer->doInt(&fepvals->nstdhdl);
 589     }
 590     else
 591     {
 592         fepvals->nstdhdl = 1;
 593     }
 594
 595     if (file_version >= 73)
 596     {
 597         serializer->doInt(&fepvals->separate_dhdl_file);
 598         serializer->doInt(&fepvals->dhdl_derivatives);
 599     }
 600     else
 601     {
 602         fepvals->separate_dhdl_file = esepdhdlfileYES;
 603         fepvals->dhdl_derivatives   = edhdlderivativesYES;
 604     }
 605     if (file_version >= 71)
 606     {
 607         serializer->doInt(&fepvals->dh_hist_size);
 608         serializer->doDouble(&fepvals->dh_hist_spacing);
 609     }
 610     else
 611     {
 612         fepvals->dh_hist_size    = 0;
 613         fepvals->dh_hist_spacing = 0.1;
 614     }
 615     if (file_version >= 79)
 616     {
 617         serializer->doInt(&fepvals->edHdLPrintEnergy);
 618     }
 619     else
 620     {
 621         fepvals->edHdLPrintEnergy = edHdLPrintEnergyNO;
 622     }
 623
 624     /* handle lambda_neighbors */
 625     if ((file_version >= 83 && file_version < 90) || file_version >= 92)
 626     {
 627         serializer->doInt(&fepvals->lambda_neighbors);
 628         if ((fepvals->lambda_neighbors >= 0) && (fepvals->init_fep_state >= 0)
 629             && (fepvals->init_lambda < 0))
 630         {
 631             fepvals->lambda_start_n = (fepvals->init_fep_state - fepvals->lambda_neighbors);
 632             fepvals->lambda_stop_n  = (fepvals->init_fep_state + fepvals->lambda_neighbors + 1);
 633             if (fepvals->lambda_start_n < 0)
 634             {
 635                 fepvals->lambda_start_n = 0;
 636             }
 637             if (fepvals->lambda_stop_n >= fepvals->n_lambda)
 638             {
 639                 fepvals->lambda_stop_n = fepvals->n_lambda;
 640             }
 641         }
 642         else
 643         {
 644             fepvals->lambda_start_n = 0;
 645             fepvals->lambda_stop_n  = fepvals->n_lambda;
 646         }
 647     }
 648     else
 649     {
 650         fepvals->lambda_start_n = 0;
 651         fepvals->lambda_stop_n  = fepvals->n_lambda;
 652     }
 653 }
 654
 655 static void do_awhBias(gmx::ISerializer* serializer, gmx::AwhBiasParams* awhBiasParams, int gmx_unused file_version)
 656 {
 657     serializer->doInt(&awhBiasParams->eTarget);
 658     serializer->doDouble(&awhBiasParams->targetBetaScaling);
 659     serializer->doDouble(&awhBiasParams->targetCutoff);
 660     serializer->doInt(&awhBiasParams->eGrowth);
 661     serializer->doInt(&awhBiasParams->bUserData);
 662     serializer->doDouble(&awhBiasParams->errorInitial);
 663     serializer->doInt(&awhBiasParams->ndim);
 664     serializer->doInt(&awhBiasParams->shareGroup);
 665     serializer->doBool(&awhBiasParams->equilibrateHistogram);
 666
 667     if (serializer->reading())
 668     {
 669         snew(awhBiasParams->dimParams, awhBiasParams->ndim);
 670     }
 671
 672     for (int d = 0; d < awhBiasParams->ndim; d++)
 673     {
 674         gmx::AwhDimParams* dimParams = &awhBiasParams->dimParams[d];
 675
 676         serializer->doInt(&dimParams->eCoordProvider);
 677         serializer->doInt(&dimParams->coordIndex);
 678         serializer->doDouble(&dimParams->origin);
 679         serializer->doDouble(&dimParams->end);
 680         serializer->doDouble(&dimParams->period);
 681         serializer->doDouble(&dimParams->forceConstant);
 682         serializer->doDouble(&dimParams->diffusion);
 683         serializer->doDouble(&dimParams->coordValueInit);
 684         serializer->doDouble(&dimParams->coverDiameter);
 685     }
 686 }
 687
 688 static void do_awh(gmx::ISerializer* serializer, gmx::AwhParams* awhParams, int gmx_unused file_version)
 689 {
 690     serializer->doInt(&awhParams->numBias);
 691     serializer->doInt(&awhParams->nstOut);
 692     serializer->doInt64(&awhParams->seed);
 693     serializer->doInt(&awhParams->nstSampleCoord);
 694     serializer->doInt(&awhParams->numSamplesUpdateFreeEnergy);
 695     serializer->doInt(&awhParams->ePotential);
 696     serializer->doBool(&awhParams->shareBiasMultisim);
 697
 698     if (awhParams->numBias > 0)
 699     {
 700         if (serializer->reading())
 701         {
 702             snew(awhParams->awhBiasParams, awhParams->numBias);
 703         }
 704
 705         for (int k = 0; k < awhParams->numBias; k++)
 706         {
 707             do_awhBias(serializer, &awhParams->awhBiasParams[k], file_version);
 708         }
 709     }
 710 }
 711
 712 static void do_pull(gmx::ISerializer* serializer, pull_params_t* pull, int file_version, int ePullOld)
 713 {
 714     int  eGeomOld = -1;
 715     ivec dimOld;
 716     int  g;
 717
 718     if (file_version >= 95)
 719     {
 720         serializer->doInt(&pull->ngroup);
 721     }
 722     serializer->doInt(&pull->ncoord);
 723     if (file_version < 95)
 724     {
 725         pull->ngroup = pull->ncoord + 1;
 726     }
 727     if (file_version < tpxv_PullCoordTypeGeom)
 728     {
 729         real dum;
 730
 731         serializer->doInt(&eGeomOld);
 732         serializer->doIvec(&dimOld);
 733         /* The inner cylinder radius, now removed */
 734         serializer->doReal(&dum);
 735     }
 736     serializer->doReal(&pull->cylinder_r);
 737     serializer->doReal(&pull->constr_tol);
 738     if (file_version >= 95)
 739     {
 740         serializer->doBool(&pull->bPrintCOM);
 741         /* With file_version < 95 this value is set below */
 742     }
 743     if (file_version >= tpxv_ReplacePullPrintCOM12)
 744     {
 745         serializer->doBool(&pull->bPrintRefValue);
 746         serializer->doBool(&pull->bPrintComp);
 747     }
 748     else if (file_version >= tpxv_PullCoordTypeGeom)
 749     {
 750         int idum;
 751         serializer->doInt(&idum); /* used to be bPrintCOM2 */
 752         serializer->doBool(&pull->bPrintRefValue);
 753         serializer->doBool(&pull->bPrintComp);
 754     }
 755     else
 756     {
 757         pull->bPrintRefValue = FALSE;
 758         pull->bPrintComp     = TRUE;
 759     }
 760     serializer->doInt(&pull->nstxout);
 761     serializer->doInt(&pull->nstfout);
 762     if (file_version >= tpxv_PullPrevStepCOMAsReference)
 763     {
 764         serializer->doBool(&pull->bSetPbcRefToPrevStepCOM);
 765     }
 766     else
 767     {
 768         pull->bSetPbcRefToPrevStepCOM = FALSE;
 769     }
 770     pull->group.resize(pull->ngroup);
 771     pull->coord.resize(pull->ncoord);
 772     if (file_version < 95)
 773     {
 774         /* epullgPOS for position pulling, before epullgDIRPBC was removed */
 775         if (eGeomOld == epullgDIRPBC)
 776         {
 777             gmx_fatal(FARGS, "pull-geometry=position is no longer supported");
 778         }
 779         if (eGeomOld > epullgDIRPBC)
 780         {
 781             eGeomOld -= 1;
 782         }
 783
 784         for (g = 0; g < pull->ngroup; g++)
 785         {
 786             /* We read and ignore a pull coordinate for group 0 */
 787             do_pullgrp_tpx_pre95(serializer, &pull->group[g], &pull->coord[std::max(g - 1, 0)]);
 788             if (g > 0)
 789             {
 790                 pull->coord[g - 1].group[0] = 0;
 791                 pull->coord[g - 1].group[1] = g;
 792             }
 793         }
 794
 795         pull->bPrintCOM = (!pull->group[0].ind.empty());
 796     }
 797     else
 798     {
 799         for (g = 0; g < pull->ngroup; g++)
 800         {
 801             do_pull_group(serializer, &pull->group[g]);
 802         }
 803         for (g = 0; g < pull->ncoord; g++)
 804         {
 805             do_pull_coord(serializer, &pull->coord[g], file_version, ePullOld, eGeomOld, dimOld);
 806         }
 807     }
 808     if (file_version >= tpxv_PullAverage)
 809     {
 810         gmx_bool v;
 811
 812         v = pull->bXOutAverage;
 813         serializer->doBool(&v);
 814         pull->bXOutAverage = v;
 815         v                  = pull->bFOutAverage;
 816         serializer->doBool(&v);
 817         pull->bFOutAverage = v;
 818     }
 819 }
 820
 821
 822 static void do_rotgrp(gmx::ISerializer* serializer, t_rotgrp* rotg)
 823 {
 824     serializer->doInt(&rotg->eType);
 825     serializer->doInt(&rotg->bMassW);
 826     serializer->doInt(&rotg->nat);
 827     if (serializer->reading())
 828     {
 829         snew(rotg->ind, rotg->nat);
 830     }
 831     serializer->doIntArray(rotg->ind, rotg->nat);
 832     if (serializer->reading())
 833     {
 834         snew(rotg->x_ref, rotg->nat);
 835     }
 836     serializer->doRvecArray(rotg->x_ref, rotg->nat);
 837     serializer->doRvec(&rotg->inputVec);
 838     serializer->doRvec(&rotg->pivot);
 839     serializer->doReal(&rotg->rate);
 840     serializer->doReal(&rotg->k);
 841     serializer->doReal(&rotg->slab_dist);
 842     serializer->doReal(&rotg->min_gaussian);
 843     serializer->doReal(&rotg->eps);
 844     serializer->doInt(&rotg->eFittype);
 845     serializer->doInt(&rotg->PotAngle_nstep);
 846     serializer->doReal(&rotg->PotAngle_step);
 847 }
 848
 849 static void do_rot(gmx::ISerializer* serializer, t_rot* rot)
 850 {
 851     int g;
 852
 853     serializer->doInt(&rot->ngrp);
 854     serializer->doInt(&rot->nstrout);
 855     serializer->doInt(&rot->nstsout);
 856     if (serializer->reading())
 857     {
 858         snew(rot->grp, rot->ngrp);
 859     }
 860     for (g = 0; g < rot->ngrp; g++)
 861     {
 862         do_rotgrp(serializer, &rot->grp[g]);
 863     }
 864 }
 865
 866
 867 static void do_swapgroup(gmx::ISerializer* serializer, t_swapGroup* g)
 868 {
 869
 870     /* Name of the group or molecule */
 871     std::string buf;
 872     if (serializer->reading())
 873     {
 874         serializer->doString(&buf);
 875         g->molname = gmx_strdup(buf.c_str());
 876     }
 877     else
 878     {
 879         buf = g->molname;
 880         serializer->doString(&buf);
 881     }
 882
 883     /* Number of atoms in the group */
 884     serializer->doInt(&g->nat);
 885
 886     /* The group's atom indices */
 887     if (serializer->reading())
 888     {
 889         snew(g->ind, g->nat);
 890     }
 891     serializer->doIntArray(g->ind, g->nat);
 892
 893     /* Requested counts for compartments A and B */
 894     serializer->doIntArray(g->nmolReq, eCompNR);
 895 }
 896
 897 static void do_swapcoords_tpx(gmx::ISerializer* serializer, t_swapcoords* swap, int file_version)
 898 {
 899     /* Enums for better readability of the code */
 900     enum
 901     {
 902         eCompA = 0,
 903         eCompB
 904     };
 905     enum
 906     {
 907         eChannel0 = 0,
 908         eChannel1
 909     };
 910
 911
 912     if (file_version >= tpxv_CompElPolyatomicIonsAndMultipleIonTypes)
 913     {
 914         /* The total number of swap groups is the sum of the fixed groups
 915          * (split0, split1, solvent), and the user-defined groups (2+ types of ions)
 916          */
 917         serializer->doInt(&swap->ngrp);
 918         if (serializer->reading())
 919         {
 920             snew(swap->grp, swap->ngrp);
 921         }
 922         for (int ig = 0; ig < swap->ngrp; ig++)
 923         {
 924             do_swapgroup(serializer, &swap->grp[ig]);
 925         }
 926         serializer->doBool(&swap->massw_split[eChannel0]);
 927         serializer->doBool(&swap->massw_split[eChannel1]);
 928         serializer->doInt(&swap->nstswap);
 929         serializer->doInt(&swap->nAverage);
 930         serializer->doReal(&swap->threshold);
 931         serializer->doReal(&swap->cyl0r);
 932         serializer->doReal(&swap->cyl0u);
 933         serializer->doReal(&swap->cyl0l);
 934         serializer->doReal(&swap->cyl1r);
 935         serializer->doReal(&swap->cyl1u);
 936         serializer->doReal(&swap->cyl1l);
 937     }
 938     else
 939     {
 940         /*** Support reading older CompEl .tpr files ***/
 941
 942         /* In the original CompEl .tpr files, we always have 5 groups: */
 943         swap->ngrp = 5;
 944         snew(swap->grp, swap->ngrp);
 945
 946         swap->grp[eGrpSplit0].molname  = gmx_strdup("split0");  // group 0: split0
 947         swap->grp[eGrpSplit1].molname  = gmx_strdup("split1");  // group 1: split1
 948         swap->grp[eGrpSolvent].molname = gmx_strdup("solvent"); // group 2: solvent
 949         swap->grp[3].molname           = gmx_strdup("anions");  // group 3: anions
 950         swap->grp[4].molname           = gmx_strdup("cations"); // group 4: cations
 951
 952         serializer->doInt(&swap->grp[3].nat);
 953         serializer->doInt(&swap->grp[eGrpSolvent].nat);
 954         serializer->doInt(&swap->grp[eGrpSplit0].nat);
 955         serializer->doBool(&swap->massw_split[eChannel0]);
 956         serializer->doInt(&swap->grp[eGrpSplit1].nat);
 957         serializer->doBool(&swap->massw_split[eChannel1]);
 958         serializer->doInt(&swap->nstswap);
 959         serializer->doInt(&swap->nAverage);
 960         serializer->doReal(&swap->threshold);
 961         serializer->doReal(&swap->cyl0r);
 962         serializer->doReal(&swap->cyl0u);
 963         serializer->doReal(&swap->cyl0l);
 964         serializer->doReal(&swap->cyl1r);
 965         serializer->doReal(&swap->cyl1u);
 966         serializer->doReal(&swap->cyl1l);
 967
 968         // The order[] array keeps compatibility with older .tpr files
 969         // by reading in the groups in the classic order
 970         {
 971             const int order[4] = { 3, eGrpSolvent, eGrpSplit0, eGrpSplit1 };
 972
 973             for (int ig = 0; ig < 4; ig++)
 974             {
 975                 int g = order[ig];
 976                 snew(swap->grp[g].ind, swap->grp[g].nat);
 977                 serializer->doIntArray(swap->grp[g].ind, swap->grp[g].nat);
 978             }
 979         }
 980
 981         for (int j = eCompA; j <= eCompB; j++)
 982         {
 983             serializer->doInt(&swap->grp[3].nmolReq[j]); // group 3 = anions
 984             serializer->doInt(&swap->grp[4].nmolReq[j]); // group 4 = cations
 985         }
 986     } /* End support reading older CompEl .tpr files */
 987
 988     if (file_version >= tpxv_CompElWithSwapLayerOffset)
 989     {
 990         serializer->doReal(&swap->bulkOffset[eCompA]);
 991         serializer->doReal(&swap->bulkOffset[eCompB]);
 992     }
 993 }
 994
 995 static void do_legacy_efield(gmx::ISerializer* serializer, gmx::KeyValueTreeObjectBuilder* root)
 996 {
 997     const char* const dimName[] = { "x", "y", "z" };
 998
 999     auto appliedForcesObj = root->addObject("applied-forces");
1000     auto efieldObj        = appliedForcesObj.addObject("electric-field");
1001     // The content of the tpr file for this feature has
1002     // been the same since gromacs 4.0 that was used for
1003     // developing.
1004     for (int j = 0; j < DIM; ++j)
1005     {
1006         int n, nt;
1007         serializer->doInt(&n);
1008         serializer->doInt(&nt);
1009         std::vector<real> aa(n + 1), phi(nt + 1), at(nt + 1), phit(nt + 1);
1010         serializer->doRealArray(aa.data(), n);
1011         serializer->doRealArray(phi.data(), n);
1012         serializer->doRealArray(at.data(), nt);
1013         serializer->doRealArray(phit.data(), nt);
1014         if (n > 0)
1015         {
1016             if (n > 1 || nt > 1)
1017             {
1018                 gmx_fatal(FARGS,
1019                           "Can not handle tpr files with more than one electric field term per "
1020                           "direction.");
1021             }
1022             auto dimObj = efieldObj.addObject(dimName[j]);
1023             dimObj.addValue<real>("E0", aa[0]);
1024             dimObj.addValue<real>("omega", at[0]);
1025             dimObj.addValue<real>("t0", phi[0]);
1026             dimObj.addValue<real>("sigma", phit[0]);
1027         }
1028     }
1029 }
1030
1031
1032 static void do_inputrec(gmx::ISerializer* serializer, t_inputrec* ir, int file_version)
1033 {
1034     int      i, j, k, idum = 0;
1035     real     rdum;
1036     gmx_bool bdum = false;
1037
1038     if (file_version != tpx_version)
1039     {
1040         /* Give a warning about features that are not accessible */
1041         fprintf(stderr, "Note: file tpx version %d, software tpx version %d\n", file_version, tpx_version);
1042     }
1043
1044     if (file_version == 0)
1045     {
1046         return;
1047     }
1048
1049     gmx::KeyValueTreeBuilder       paramsBuilder;
1050     gmx::KeyValueTreeObjectBuilder paramsObj = paramsBuilder.rootObject();
1051
1052     /* Basic inputrec stuff */
1053     serializer->doInt(&ir->eI);
1054     if (file_version >= 62)
1055     {
1056         serializer->doInt64(&ir->nsteps);
1057     }
1058     else
1059     {
1060         serializer->doInt(&idum);
1061         ir->nsteps = idum;
1062     }
1063
1064     if (file_version >= 62)
1065     {
1066         serializer->doInt64(&ir->init_step);
1067     }
1068     else
1069     {
1070         serializer->doInt(&idum);
1071         ir->init_step = idum;
1072     }
1073
1074     serializer->doInt(&ir->simulation_part);
1075
1076     if (file_version >= tpxv_MTS)
1077     {
1078         serializer->doBool(&ir->useMts);
1079         int numLevels = ir->mtsLevels.size();
1080         if (ir->useMts)
1081         {
1082             serializer->doInt(&numLevels);
1083         }
1084         ir->mtsLevels.resize(numLevels);
1085         for (auto& mtsLevel : ir->mtsLevels)
1086         {
1087             int forceGroups = mtsLevel.forceGroups.to_ulong();
1088             serializer->doInt(&forceGroups);
1089             mtsLevel.forceGroups = std::bitset<static_cast<int>(gmx::MtsForceGroups::Count)>(forceGroups);
1090             serializer->doInt(&mtsLevel.stepFactor);
1091         }
1092     }
1093     else
1094     {
1095         ir->useMts = false;
1096         ir->mtsLevels.clear();
1097     }
1098
1099     if (file_version >= 67)
1100     {
1101         serializer->doInt(&ir->nstcalcenergy);
1102     }
1103     else
1104     {
1105         ir->nstcalcenergy = 1;
1106     }
1107     if (file_version >= 81)
1108     {
1109         serializer->doInt(&ir->cutoff_scheme);
1110         if (file_version < 94)
1111         {
1112             ir->cutoff_scheme = 1 - ir->cutoff_scheme;
1113         }
1114     }
1115     else
1116     {
1117         ir->cutoff_scheme = ecutsGROUP;
1118     }
1119     serializer->doInt(&idum); /* used to be ns_type; not used anymore */
1120     serializer->doInt(&ir->nstlist);
1121     serializer->doInt(&idum); /* used to be ndelta; not used anymore */
1122
1123     serializer->doReal(&ir->rtpi);
1124
1125     serializer->doInt(&ir->nstcomm);
1126     serializer->doInt(&ir->comm_mode);
1127
1128     /* ignore nstcheckpoint */
1129     if (file_version < tpxv_RemoveObsoleteParameters1)
1130     {
1131         serializer->doInt(&idum);
1132     }
1133
1134     serializer->doInt(&ir->nstcgsteep);
1135
1136     serializer->doInt(&ir->nbfgscorr);
1137
1138     serializer->doInt(&ir->nstlog);
1139     serializer->doInt(&ir->nstxout);
1140     serializer->doInt(&ir->nstvout);
1141     serializer->doInt(&ir->nstfout);
1142     serializer->doInt(&ir->nstenergy);
1143     serializer->doInt(&ir->nstxout_compressed);
1144     if (file_version >= 59)
1145     {
1146         serializer->doDouble(&ir->init_t);
1147         serializer->doDouble(&ir->delta_t);
1148     }
1149     else
1150     {
1151         serializer->doReal(&rdum);
1152         ir->init_t = rdum;
1153         serializer->doReal(&rdum);
1154         ir->delta_t = rdum;
1155     }
1156     serializer->doReal(&ir->x_compression_precision);
1157     if (file_version >= 81)
1158     {
1159         serializer->doReal(&ir->verletbuf_tol);
1160     }
1161     else
1162     {
1163         ir->verletbuf_tol = 0;
1164     }
1165     serializer->doReal(&ir->rlist);
1166     if (file_version >= 67 && file_version < tpxv_RemoveTwinRange)
1167     {
1168         if (serializer->reading())
1169         {
1170             // Reading such a file version could invoke the twin-range
1171             // scheme, about which mdrun should give a fatal error.
1172             real dummy_rlistlong = -1;
1173             serializer->doReal(&dummy_rlistlong);
1174
1175             ir->useTwinRange = (ir->rlist > 0 && (dummy_rlistlong == 0 || dummy_rlistlong > ir->rlist));
1176             // When true, this forces mdrun to issue an error (regardless of
1177             // ir->cutoff_scheme).
1178             //
1179             // Otherwise, grompp used to set rlistlong actively. Users
1180             // were probably also confused and set rlistlong == rlist.
1181             // However, in all remaining cases, it is safe to let
1182             // mdrun proceed normally.
1183         }
1184     }
1185     else
1186     {
1187         // No need to read or write anything
1188         ir->useTwinRange = false;
1189     }
1190     if (file_version >= 82 && file_version != 90)
1191     {
1192         // Multiple time-stepping is no longer enabled, but the old
1193         // support required the twin-range scheme, for which mdrun
1194         // already emits a fatal error.
1195         int dummy_nstcalclr = -1;
1196         serializer->doInt(&dummy_nstcalclr);
1197     }
1198     serializer->doInt(&ir->coulombtype);
1199     if (file_version >= 81)
1200     {
1201         serializer->doInt(&ir->coulomb_modifier);
1202     }
1203     else
1204     {
1205         ir->coulomb_modifier = (ir->cutoff_scheme == ecutsVERLET ? eintmodPOTSHIFT : eintmodNONE);
1206     }
1207     serializer->doReal(&ir->rcoulomb_switch);
1208     serializer->doReal(&ir->rcoulomb);
1209     serializer->doInt(&ir->vdwtype);
1210     if (file_version >= 81)
1211     {
1212         serializer->doInt(&ir->vdw_modifier);
1213     }
1214     else
1215     {
1216         ir->vdw_modifier = (ir->cutoff_scheme == ecutsVERLET ? eintmodPOTSHIFT : eintmodNONE);
1217     }
1218     serializer->doReal(&ir->rvdw_switch);
1219     serializer->doReal(&ir->rvdw);
1220     serializer->doInt(&ir->eDispCorr);
1221     serializer->doReal(&ir->epsilon_r);
1222     serializer->doReal(&ir->epsilon_rf);
1223     serializer->doReal(&ir->tabext);
1224
1225     // This permits reading a .tpr file that used implicit solvent,
1226     // and later permitting mdrun to refuse to run it.
1227     if (serializer->reading())
1228     {
1229         if (file_version < tpxv_RemoveImplicitSolvation)
1230         {
1231             serializer->doInt(&idum);
1232             serializer->doInt(&idum);
1233             serializer->doReal(&rdum);
1234             serializer->doReal(&rdum);
1235             serializer->doInt(&idum);
1236             ir->implicit_solvent = (idum > 0);
1237         }
1238         else
1239         {
1240             ir->implicit_solvent = false;
1241         }
1242         if (file_version < tpxv_RemoveImplicitSolvation)
1243         {
1244             serializer->doReal(&rdum);
1245             serializer->doReal(&rdum);
1246             serializer->doReal(&rdum);
1247             serializer->doReal(&rdum);
1248             if (file_version >= 60)
1249             {
1250                 serializer->doReal(&rdum);
1251                 serializer->doInt(&idum);
1252             }
1253             serializer->doReal(&rdum);
1254         }
1255     }
1256
1257     if (file_version >= 81)
1258     {
1259         serializer->doReal(&ir->fourier_spacing);
1260     }
1261     else
1262     {
1263         ir->fourier_spacing = 0.0;
1264     }
1265     serializer->doInt(&ir->nkx);
1266     serializer->doInt(&ir->nky);
1267     serializer->doInt(&ir->nkz);
1268     serializer->doInt(&ir->pme_order);
1269     serializer->doReal(&ir->ewald_rtol);
1270
1271     if (file_version >= 93)
1272     {
1273         serializer->doReal(&ir->ewald_rtol_lj);
1274     }
1275     else
1276     {
1277         ir->ewald_rtol_lj = ir->ewald_rtol;
1278     }
1279     serializer->doInt(&ir->ewald_geometry);
1280     serializer->doReal(&ir->epsilon_surface);
1281
1282     /* ignore bOptFFT */
1283     if (file_version < tpxv_RemoveObsoleteParameters1)
1284     {
1285         serializer->doBool(&bdum);
1286     }
1287
1288     if (file_version >= 93)
1289     {
1290         serializer->doInt(&ir->ljpme_combination_rule);
1291     }
1292     serializer->doBool(&ir->bContinuation);
1293     serializer->doInt(&ir->etc);
1294     /* before version 18, ir->etc was a gmx_bool (ir->btc),
1295      * but the values 0 and 1 still mean no and
1296      * berendsen temperature coupling, respectively.
1297      */
1298     if (file_version >= 79)
1299     {
1300         serializer->doBool(&ir->bPrintNHChains);
1301     }
1302     if (file_version >= 71)
1303     {
1304         serializer->doInt(&ir->nsttcouple);
1305     }
1306     else
1307     {
1308         ir->nsttcouple = ir->nstcalcenergy;
1309     }
1310     serializer->doInt(&ir->epc);
1311     serializer->doInt(&ir->epct);
1312     if (file_version >= 71)
1313     {
1314         serializer->doInt(&ir->nstpcouple);
1315     }
1316     else
1317     {
1318         ir->nstpcouple = ir->nstcalcenergy;
1319     }
1320     serializer->doReal(&ir->tau_p);
1321     serializer->doRvec(&ir->ref_p[XX]);
1322     serializer->doRvec(&ir->ref_p[YY]);
1323     serializer->doRvec(&ir->ref_p[ZZ]);
1324     serializer->doRvec(&ir->compress[XX]);
1325     serializer->doRvec(&ir->compress[YY]);
1326     serializer->doRvec(&ir->compress[ZZ]);
1327     serializer->doInt(&ir->refcoord_scaling);
1328     serializer->doRvec(&ir->posres_com);
1329     serializer->doRvec(&ir->posres_comB);
1330
1331     if (file_version < 79)
1332     {
1333         serializer->doInt(&ir->andersen_seed);
1334     }
1335     else
1336     {
1337         ir->andersen_seed = 0;
1338     }
1339
1340     serializer->doReal(&ir->shake_tol);
1341
1342     serializer->doInt(&ir->efep);
1343     do_fepvals(serializer, ir->fepvals, file_version);
1344
1345     if (file_version >= 79)
1346     {
1347         serializer->doBool(&ir->bSimTemp);
1348         if (ir->bSimTemp)
1349         {
1350             ir->bSimTemp = TRUE;
1351         }
1352     }
1353     else
1354     {
1355         ir->bSimTemp = FALSE;
1356     }
1357     if (ir->bSimTemp)
1358     {
1359         do_simtempvals(serializer, ir->simtempvals, ir->fepvals->n_lambda, file_version);
1360     }
1361
1362     if (file_version >= 79)
1363     {
1364         serializer->doBool(&ir->bExpanded);
1365     }
1366     if (ir->bExpanded)
1367     {
1368         do_expandedvals(serializer, ir->expandedvals, ir->fepvals, file_version);
1369     }
1370
1371     serializer->doInt(&ir->eDisre);
1372     serializer->doInt(&ir->eDisreWeighting);
1373     serializer->doBool(&ir->bDisreMixed);
1374     serializer->doReal(&ir->dr_fc);
1375     serializer->doReal(&ir->dr_tau);
1376     serializer->doInt(&ir->nstdisreout);
1377     serializer->doReal(&ir->orires_fc);
1378     serializer->doReal(&ir->orires_tau);
1379     serializer->doInt(&ir->nstorireout);
1380
1381     /* ignore dihre_fc */
1382     if (file_version < 79)
1383     {
1384         serializer->doReal(&rdum);
1385     }
1386
1387     serializer->doReal(&ir->em_stepsize);
1388     serializer->doReal(&ir->em_tol);
1389     serializer->doBool(&ir->bShakeSOR);
1390     serializer->doInt(&ir->niter);
1391     serializer->doReal(&ir->fc_stepsize);
1392     serializer->doInt(&ir->eConstrAlg);
1393     serializer->doInt(&ir->nProjOrder);
1394     serializer->doReal(&ir->LincsWarnAngle);
1395     serializer->doInt(&ir->nLincsIter);
1396     serializer->doReal(&ir->bd_fric);
1397     if (file_version >= tpxv_Use64BitRandomSeed)
1398     {
1399         serializer->doInt64(&ir->ld_seed);
1400     }
1401     else
1402     {
1403         serializer->doInt(&idum);
1404         ir->ld_seed = idum;
1405     }
1406
1407     for (i = 0; i < DIM; i++)
1408     {
1409         serializer->doRvec(&ir->deform[i]);
1410     }
1411     serializer->doReal(&ir->cos_accel);
1412
1413     serializer->doInt(&ir->userint1);
1414     serializer->doInt(&ir->userint2);
1415     serializer->doInt(&ir->userint3);
1416     serializer->doInt(&ir->userint4);
1417     serializer->doReal(&ir->userreal1);
1418     serializer->doReal(&ir->userreal2);
1419     serializer->doReal(&ir->userreal3);
1420     serializer->doReal(&ir->userreal4);
1421
1422     /* AdResS is removed, but we need to be able to read old files,
1423        and let mdrun refuse to run them */
1424     if (file_version >= 77 && file_version < tpxv_RemoveAdress)
1425     {
1426         serializer->doBool(&ir->bAdress);
1427         if (ir->bAdress)
1428         {
1429             int  idum, numThermoForceGroups, numEnergyGroups;
1430             real rdum;
1431             rvec rvecdum;
1432             serializer->doInt(&idum);
1433             serializer->doReal(&rdum);
1434             serializer->doReal(&rdum);
1435             serializer->doReal(&rdum);
1436             serializer->doInt(&idum);
1437             serializer->doInt(&idum);
1438             serializer->doRvec(&rvecdum);
1439             serializer->doInt(&numThermoForceGroups);
1440             serializer->doReal(&rdum);
1441             serializer->doInt(&numEnergyGroups);
1442             serializer->doInt(&idum);
1443
1444             if (numThermoForceGroups > 0)
1445             {
1446                 std::vector<int> idumn(numThermoForceGroups);
1447                 serializer->doIntArray(idumn.data(), idumn.size());
1448             }
1449             if (numEnergyGroups > 0)
1450             {
1451                 std::vector<int> idumn(numEnergyGroups);
1452                 serializer->doIntArray(idumn.data(), idumn.size());
1453             }
1454         }
1455     }
1456     else
1457     {
1458         ir->bAdress = FALSE;
1459     }
1460
1461     /* pull stuff */
1462     {
1463         int ePullOld = 0;
1464
1465         if (file_version >= tpxv_PullCoordTypeGeom)
1466         {
1467             serializer->doBool(&ir->bPull);
1468         }
1469         else
1470         {
1471             serializer->doInt(&ePullOld);
1472             ir->bPull = (ePullOld > 0);
1473             /* We removed the first ePull=ePullNo for the enum */
1474             ePullOld -= 1;
1475         }
1476         if (ir->bPull)
1477         {
1478             if (serializer->reading())
1479             {
1480                 ir->pull = std::make_unique<pull_params_t>();
1481             }
1482             do_pull(serializer, ir->pull.get(), file_version, ePullOld);
1483         }
1484     }
1485
1486     if (file_version >= tpxv_AcceleratedWeightHistogram)
1487     {
1488         serializer->doBool(&ir->bDoAwh);
1489
1490         if (ir->bDoAwh)
1491         {
1492             if (serializer->reading())
1493             {
1494                 snew(ir->awhParams, 1);
1495             }
1496             do_awh(serializer, ir->awhParams, file_version);
1497         }
1498     }
1499     else
1500     {
1501         ir->bDoAwh = FALSE;
1502     }
1503
1504     /* Enforced rotation */
1505     if (file_version >= 74)
1506     {
1507         serializer->doBool(&ir->bRot);
1508         if (ir->bRot)
1509         {
1510             if (serializer->reading())
1511             {
1512                 snew(ir->rot, 1);
1513             }
1514             do_rot(serializer, ir->rot);
1515         }
1516     }
1517     else
1518     {
1519         ir->bRot = FALSE;
1520     }
1521
1522     /* Interactive molecular dynamics */
1523     if (file_version >= tpxv_InteractiveMolecularDynamics)
1524     {
1525         serializer->doBool(&ir->bIMD);
1526         if (ir->bIMD)
1527         {
1528             if (serializer->reading())
1529             {
1530                 snew(ir->imd, 1);
1531             }
1532             do_imd(serializer, ir->imd);
1533         }
1534     }
1535     else
1536     {
1537         /* We don't support IMD sessions for old .tpr files */
1538         ir->bIMD = FALSE;
1539     }
1540
1541     /* grpopts stuff */
1542     serializer->doInt(&ir->opts.ngtc);
1543     if (file_version >= 69)
1544     {
1545         serializer->doInt(&ir->opts.nhchainlength);
1546     }
1547     else
1548     {
1549         ir->opts.nhchainlength = 1;
1550     }
1551     serializer->doInt(&ir->opts.ngacc);
1552     serializer->doInt(&ir->opts.ngfrz);
1553     serializer->doInt(&ir->opts.ngener);
1554
1555     if (serializer->reading())
1556     {
1557         snew(ir->opts.nrdf, ir->opts.ngtc);
1558         snew(ir->opts.ref_t, ir->opts.ngtc);
1559         snew(ir->opts.annealing, ir->opts.ngtc);
1560         snew(ir->opts.anneal_npoints, ir->opts.ngtc);
1561         snew(ir->opts.anneal_time, ir->opts.ngtc);
1562         snew(ir->opts.anneal_temp, ir->opts.ngtc);
1563         snew(ir->opts.tau_t, ir->opts.ngtc);
1564         snew(ir->opts.nFreeze, ir->opts.ngfrz);
1565         snew(ir->opts.acc, ir->opts.ngacc);
1566         snew(ir->opts.egp_flags, ir->opts.ngener * ir->opts.ngener);
1567     }
1568     if (ir->opts.ngtc > 0)
1569     {
1570         serializer->doRealArray(ir->opts.nrdf, ir->opts.ngtc);
1571         serializer->doRealArray(ir->opts.ref_t, ir->opts.ngtc);
1572         serializer->doRealArray(ir->opts.tau_t, ir->opts.ngtc);
1573     }
1574     if (ir->opts.ngfrz > 0)
1575     {
1576         serializer->doIvecArray(ir->opts.nFreeze, ir->opts.ngfrz);
1577     }
1578     if (ir->opts.ngacc > 0)
1579     {
1580         serializer->doRvecArray(ir->opts.acc, ir->opts.ngacc);
1581     }
1582     serializer->doIntArray(ir->opts.egp_flags, ir->opts.ngener * ir->opts.ngener);
1583
1584     /* First read the lists with annealing and npoints for each group */
1585     serializer->doIntArray(ir->opts.annealing, ir->opts.ngtc);
1586     serializer->doIntArray(ir->opts.anneal_npoints, ir->opts.ngtc);
1587     for (j = 0; j < (ir->opts.ngtc); j++)
1588     {
1589         k = ir->opts.anneal_npoints[j];
1590         if (serializer->reading())
1591         {
1592             snew(ir->opts.anneal_time[j], k);
1593             snew(ir->opts.anneal_temp[j], k);
1594         }
1595         serializer->doRealArray(ir->opts.anneal_time[j], k);
1596         serializer->doRealArray(ir->opts.anneal_temp[j], k);
1597     }
1598     /* Walls */
1599     {
1600         serializer->doInt(&ir->nwall);
1601         serializer->doInt(&ir->wall_type);
1602         serializer->doReal(&ir->wall_r_linpot);
1603         serializer->doInt(&ir->wall_atomtype[0]);
1604         serializer->doInt(&ir->wall_atomtype[1]);
1605         serializer->doReal(&ir->wall_density[0]);
1606         serializer->doReal(&ir->wall_density[1]);
1607         serializer->doReal(&ir->wall_ewald_zfac);
1608     }
1609
1610     /* Cosine stuff for electric fields */
1611     if (file_version < tpxv_GenericParamsForElectricField)
1612     {
1613         do_legacy_efield(serializer, &paramsObj);
1614     }
1615
1616     /* Swap ions */
1617     if (file_version >= tpxv_ComputationalElectrophysiology)
1618     {
1619         serializer->doInt(&ir->eSwapCoords);
1620         if (ir->eSwapCoords != eswapNO)
1621         {
1622             if (serializer->reading())
1623             {
1624                 snew(ir->swap, 1);
1625             }
1626             do_swapcoords_tpx(serializer, ir->swap, file_version);
1627         }
1628     }
1629
1630     /* QMMM reading - despite defunct we require reading for backwards
1631      * compability and correct serialization
1632      */
1633     {
1634         serializer->doBool(&ir->bQMMM);
1635         int qmmmScheme;
1636         serializer->doInt(&qmmmScheme);
1637         real unusedScalefactor;
1638         serializer->doReal(&unusedScalefactor);
1639
1640         // this is still used in Mimic
1641         serializer->doInt(&ir->opts.ngQM);
1642         if (ir->opts.ngQM > 0 && ir->bQMMM)
1643         {
1644             /* We leave in dummy i/o for removed parameters to avoid
1645              * changing the tpr format.
1646              */
1647             std::vector<int> dummyIntVec(4 * ir->opts.ngQM, 0);
1648             serializer->doIntArray(dummyIntVec.data(), dummyIntVec.size());
1649             dummyIntVec.clear();
1650
1651             // std::vector<bool> has no data()
1652             std::vector<char> dummyBoolVec(ir->opts.ngQM * sizeof(bool) / sizeof(char));
1653             serializer->doBoolArray(reinterpret_cast<bool*>(dummyBoolVec.data()), dummyBoolVec.size());
1654             dummyBoolVec.clear();
1655
1656             dummyIntVec.resize(2 * ir->opts.ngQM, 0);
1657             serializer->doIntArray(dummyIntVec.data(), dummyIntVec.size());
1658             dummyIntVec.clear();
1659
1660             std::vector<real> dummyRealVec(2 * ir->opts.ngQM, 0);
1661             serializer->doRealArray(dummyRealVec.data(), dummyRealVec.size());
1662             dummyRealVec.clear();
1663
1664             dummyIntVec.resize(3 * ir->opts.ngQM, 0);
1665             serializer->doIntArray(dummyIntVec.data(), dummyIntVec.size());
1666             dummyIntVec.clear();
1667         }
1668         /* end of QMMM stuff */
1669     }
1670
1671     if (file_version >= tpxv_GenericParamsForElectricField)
1672     {
1673         if (serializer->reading())
1674         {
1675             paramsObj.mergeObject(gmx::deserializeKeyValueTree(serializer));
1676         }
1677         else
1678         {
1679             GMX_RELEASE_ASSERT(ir->params != nullptr,
1680                                "Parameters should be present when writing inputrec");
1681             gmx::serializeKeyValueTree(*ir->params, serializer);
1682         }
1683     }
1684     if (serializer->reading())
1685     {
1686         ir->params = new gmx::KeyValueTreeObject(paramsBuilder.build());
1687         // Initialize internal parameters to an empty kvt for all tpr versions
1688         ir->internalParameters = std::make_unique<gmx::KeyValueTreeObject>();
1689     }
1690
1691     if (file_version >= tpxv_GenericInternalParameters)
1692     {
1693         if (serializer->reading())
1694         {
1695             ir->internalParameters =
1696                     std::make_unique<gmx::KeyValueTreeObject>(gmx::deserializeKeyValueTree(serializer));
1697         }
1698         else
1699         {
1700             GMX_RELEASE_ASSERT(ir->internalParameters != nullptr,
1701                                "Parameters should be present when writing inputrec");
1702             gmx::serializeKeyValueTree(*ir->internalParameters, serializer);
1703         }
1704     }
1705 }
1706
1707
1708 static void do_harm(gmx::ISerializer* serializer, t_iparams* iparams)
1709 {
1710     serializer->doReal(&iparams->harmonic.rA);
1711     serializer->doReal(&iparams->harmonic.krA);
1712     serializer->doReal(&iparams->harmonic.rB);
1713     serializer->doReal(&iparams->harmonic.krB);
1714 }
1715
1716 static void do_iparams(gmx::ISerializer* serializer, t_functype ftype, t_iparams* iparams, int file_version)
1717 {
1718     int  idum;
1719     real rdum;
1720
1721     switch (ftype)
1722     {
1723         case F_ANGLES:
1724         case F_G96ANGLES:
1725         case F_BONDS:
1726         case F_G96BONDS:
1727         case F_HARMONIC:
1728         case F_IDIHS:
1729             do_harm(serializer, iparams);
1730             if ((ftype == F_ANGRES || ftype == F_ANGRESZ) && serializer->reading())
1731             {
1732                 /* Correct incorrect storage of parameters */
1733                 iparams->pdihs.phiB = iparams->pdihs.phiA;
1734                 iparams->pdihs.cpB  = iparams->pdihs.cpA;
1735             }
1736             break;
1737         case F_RESTRANGLES:
1738             serializer->doReal(&iparams->harmonic.rA);
1739             serializer->doReal(&iparams->harmonic.krA);
1740             break;
1741         case F_LINEAR_ANGLES:
1742             serializer->doReal(&iparams->linangle.klinA);
1743             serializer->doReal(&iparams->linangle.aA);
1744             serializer->doReal(&iparams->linangle.klinB);
1745             serializer->doReal(&iparams->linangle.aB);
1746             break;
1747         case F_FENEBONDS:
1748             serializer->doReal(&iparams->fene.bm);
1749             serializer->doReal(&iparams->fene.kb);
1750             break;
1751
1752         case F_RESTRBONDS:
1753             serializer->doReal(&iparams->restraint.lowA);
1754             serializer->doReal(&iparams->restraint.up1A);
1755             serializer->doReal(&iparams->restraint.up2A);
1756             serializer->doReal(&iparams->restraint.kA);
1757             serializer->doReal(&iparams->restraint.lowB);
1758             serializer->doReal(&iparams->restraint.up1B);
1759             serializer->doReal(&iparams->restraint.up2B);
1760             serializer->doReal(&iparams->restraint.kB);
1761             break;
1762         case F_TABBONDS:
1763         case F_TABBONDSNC:
1764         case F_TABANGLES:
1765         case F_TABDIHS:
1766             serializer->doReal(&iparams->tab.kA);
1767             serializer->doInt(&iparams->tab.table);
1768             serializer->doReal(&iparams->tab.kB);
1769             break;
1770         case F_CROSS_BOND_BONDS:
1771             serializer->doReal(&iparams->cross_bb.r1e);
1772             serializer->doReal(&iparams->cross_bb.r2e);
1773             serializer->doReal(&iparams->cross_bb.krr);
1774             break;
1775         case F_CROSS_BOND_ANGLES:
1776             serializer->doReal(&iparams->cross_ba.r1e);
1777             serializer->doReal(&iparams->cross_ba.r2e);
1778             serializer->doReal(&iparams->cross_ba.r3e);
1779             serializer->doReal(&iparams->cross_ba.krt);
1780             break;
1781         case F_UREY_BRADLEY:
1782             serializer->doReal(&iparams->u_b.thetaA);
1783             serializer->doReal(&iparams->u_b.kthetaA);
1784             serializer->doReal(&iparams->u_b.r13A);
1785             serializer->doReal(&iparams->u_b.kUBA);
1786             if (file_version >= 79)
1787             {
1788                 serializer->doReal(&iparams->u_b.thetaB);
1789                 serializer->doReal(&iparams->u_b.kthetaB);
1790                 serializer->doReal(&iparams->u_b.r13B);
1791                 serializer->doReal(&iparams->u_b.kUBB);
1792             }
1793             else
1794             {
1795                 iparams->u_b.thetaB  = iparams->u_b.thetaA;
1796                 iparams->u_b.kthetaB = iparams->u_b.kthetaA;
1797                 iparams->u_b.r13B    = iparams->u_b.r13A;
1798                 iparams->u_b.kUBB    = iparams->u_b.kUBA;
1799             }
1800             break;
1801         case F_QUARTIC_ANGLES:
1802             serializer->doReal(&iparams->qangle.theta);
1803             serializer->doRealArray(iparams->qangle.c, 5);
1804             break;
1805         case F_BHAM:
1806             serializer->doReal(&iparams->bham.a);
1807             serializer->doReal(&iparams->bham.b);
1808             serializer->doReal(&iparams->bham.c);
1809             break;
1810         case F_MORSE:
1811             serializer->doReal(&iparams->morse.b0A);
1812             serializer->doReal(&iparams->morse.cbA);
1813             serializer->doReal(&iparams->morse.betaA);
1814             if (file_version >= 79)
1815             {
1816                 serializer->doReal(&iparams->morse.b0B);
1817                 serializer->doReal(&iparams->morse.cbB);
1818                 serializer->doReal(&iparams->morse.betaB);
1819             }
1820             else
1821             {
1822                 iparams->morse.b0B   = iparams->morse.b0A;
1823                 iparams->morse.cbB   = iparams->morse.cbA;
1824                 iparams->morse.betaB = iparams->morse.betaA;
1825             }
1826             break;
1827         case F_CUBICBONDS:
1828             serializer->doReal(&iparams->cubic.b0);
1829             serializer->doReal(&iparams->cubic.kb);
1830             serializer->doReal(&iparams->cubic.kcub);
1831             break;
1832         case F_CONNBONDS: break;
1833         case F_POLARIZATION: serializer->doReal(&iparams->polarize.alpha); break;
1834         case F_ANHARM_POL:
1835             serializer->doReal(&iparams->anharm_polarize.alpha);
1836             serializer->doReal(&iparams->anharm_polarize.drcut);
1837             serializer->doReal(&iparams->anharm_polarize.khyp);
1838             break;
1839         case F_WATER_POL:
1840             serializer->doReal(&iparams->wpol.al_x);
1841             serializer->doReal(&iparams->wpol.al_y);
1842             serializer->doReal(&iparams->wpol.al_z);
1843             serializer->doReal(&iparams->wpol.rOH);
1844             serializer->doReal(&iparams->wpol.rHH);
1845             serializer->doReal(&iparams->wpol.rOD);
1846             break;
1847         case F_THOLE_POL:
1848             serializer->doReal(&iparams->thole.a);
1849             serializer->doReal(&iparams->thole.alpha1);
1850             serializer->doReal(&iparams->thole.alpha2);
1851             serializer->doReal(&iparams->thole.rfac);
1852             break;
1853         case F_LJ:
1854             serializer->doReal(&iparams->lj.c6);
1855             serializer->doReal(&iparams->lj.c12);
1856             break;
1857         case F_LJ14:
1858             serializer->doReal(&iparams->lj14.c6A);
1859             serializer->doReal(&iparams->lj14.c12A);
1860             serializer->doReal(&iparams->lj14.c6B);
1861             serializer->doReal(&iparams->lj14.c12B);
1862             break;
1863         case F_LJC14_Q:
1864             serializer->doReal(&iparams->ljc14.fqq);
1865             serializer->doReal(&iparams->ljc14.qi);
1866             serializer->doReal(&iparams->ljc14.qj);
1867             serializer->doReal(&iparams->ljc14.c6);
1868             serializer->doReal(&iparams->ljc14.c12);
1869             break;
1870         case F_LJC_PAIRS_NB:
1871             serializer->doReal(&iparams->ljcnb.qi);
1872             serializer->doReal(&iparams->ljcnb.qj);
1873             serializer->doReal(&iparams->ljcnb.c6);
1874             serializer->doReal(&iparams->ljcnb.c12);
1875             break;
1876         case F_PDIHS:
1877         case F_PIDIHS:
1878         case F_ANGRES:
1879         case F_ANGRESZ:
1880             serializer->doReal(&iparams->pdihs.phiA);
1881             serializer->doReal(&iparams->pdihs.cpA);
1882             serializer->doReal(&iparams->pdihs.phiB);
1883             serializer->doReal(&iparams->pdihs.cpB);
1884             serializer->doInt(&iparams->pdihs.mult);
1885             break;
1886         case F_RESTRDIHS:
1887             serializer->doReal(&iparams->pdihs.phiA);
1888             serializer->doReal(&iparams->pdihs.cpA);
1889             break;
1890         case F_DISRES:
1891             serializer->doInt(&iparams->disres.label);
1892             serializer->doInt(&iparams->disres.type);
1893             serializer->doReal(&iparams->disres.low);
1894             serializer->doReal(&iparams->disres.up1);
1895             serializer->doReal(&iparams->disres.up2);
1896             serializer->doReal(&iparams->disres.kfac);
1897             break;
1898         case F_ORIRES:
1899             serializer->doInt(&iparams->orires.ex);
1900             serializer->doInt(&iparams->orires.label);
1901             serializer->doInt(&iparams->orires.power);
1902             serializer->doReal(&iparams->orires.c);
1903             serializer->doReal(&iparams->orires.obs);
1904             serializer->doReal(&iparams->orires.kfac);
1905             break;
1906         case F_DIHRES:
1907             if (file_version < 82)
1908             {
1909                 serializer->doInt(&idum);
1910                 serializer->doInt(&idum);
1911             }
1912             serializer->doReal(&iparams->dihres.phiA);
1913             serializer->doReal(&iparams->dihres.dphiA);
1914             serializer->doReal(&iparams->dihres.kfacA);
1915             if (file_version >= 82)
1916             {
1917                 serializer->doReal(&iparams->dihres.phiB);
1918                 serializer->doReal(&iparams->dihres.dphiB);
1919                 serializer->doReal(&iparams->dihres.kfacB);
1920             }
1921             else
1922             {
1923                 iparams->dihres.phiB  = iparams->dihres.phiA;
1924                 iparams->dihres.dphiB = iparams->dihres.dphiA;
1925                 iparams->dihres.kfacB = iparams->dihres.kfacA;
1926             }
1927             break;
1928         case F_POSRES:
1929             serializer->doRvec(&iparams->posres.pos0A);
1930             serializer->doRvec(&iparams->posres.fcA);
1931             serializer->doRvec(&iparams->posres.pos0B);
1932             serializer->doRvec(&iparams->posres.fcB);
1933             break;
1934         case F_FBPOSRES:
1935             serializer->doInt(&iparams->fbposres.geom);
1936             serializer->doRvec(&iparams->fbposres.pos0);
1937             serializer->doReal(&iparams->fbposres.r);
1938             serializer->doReal(&iparams->fbposres.k);
1939             break;
1940         case F_CBTDIHS: serializer->doRealArray(iparams->cbtdihs.cbtcA, NR_CBTDIHS); break;
1941         case F_RBDIHS:
1942             // Fall-through intended
1943         case F_FOURDIHS:
1944             /* Fourier dihedrals are internally represented
1945              * as Ryckaert-Bellemans since those are faster to compute.
1946              */
1947             serializer->doRealArray(iparams->rbdihs.rbcA, NR_RBDIHS);
1948             serializer->doRealArray(iparams->rbdihs.rbcB, NR_RBDIHS);
1949             break;
1950         case F_CONSTR:
1951         case F_CONSTRNC:
1952             serializer->doReal(&iparams->constr.dA);
1953             serializer->doReal(&iparams->constr.dB);
1954             break;
1955         case F_SETTLE:
1956             serializer->doReal(&iparams->settle.doh);
1957             serializer->doReal(&iparams->settle.dhh);
1958             break;
1959         case F_VSITE1: break; // VSite1 has 0 parameters
1960         case F_VSITE2:
1961         case F_VSITE2FD: serializer->doReal(&iparams->vsite.a); break;
1962         case F_VSITE3:
1963         case F_VSITE3FD:
1964         case F_VSITE3FAD:
1965             serializer->doReal(&iparams->vsite.a);
1966             serializer->doReal(&iparams->vsite.b);
1967             break;
1968         case F_VSITE3OUT:
1969         case F_VSITE4FD:
1970         case F_VSITE4FDN:
1971             serializer->doReal(&iparams->vsite.a);
1972             serializer->doReal(&iparams->vsite.b);
1973             serializer->doReal(&iparams->vsite.c);
1974             break;
1975         case F_VSITEN:
1976             serializer->doInt(&iparams->vsiten.n);
1977             serializer->doReal(&iparams->vsiten.a);
1978             break;
1979         case F_GB12_NOLONGERUSED:
1980         case F_GB13_NOLONGERUSED:
1981         case F_GB14_NOLONGERUSED:
1982             // Implicit solvent parameters can still be read, but never used
1983             if (serializer->reading())
1984             {
1985                 if (file_version < 68)
1986                 {
1987                     serializer->doReal(&rdum);
1988                     serializer->doReal(&rdum);
1989                     serializer->doReal(&rdum);
1990                     serializer->doReal(&rdum);
1991                 }
1992                 if (file_version < tpxv_RemoveImplicitSolvation)
1993                 {
1994                     serializer->doReal(&rdum);
1995                     serializer->doReal(&rdum);
1996                     serializer->doReal(&rdum);
1997                     serializer->doReal(&rdum);
1998                     serializer->doReal(&rdum);
1999                 }
2000             }
2001             break;
2002         case F_CMAP:
2003             serializer->doInt(&iparams->cmap.cmapA);
2004             serializer->doInt(&iparams->cmap.cmapB);
2005             break;
2006         default:
2007             gmx_fatal(FARGS, "unknown function type %d (%s) in %s line %d", ftype,
2008                       interaction_function[ftype].name, __FILE__, __LINE__);
2009     }
2010 }
2011
2012 static void do_ilist(gmx::ISerializer* serializer, InteractionList* ilist)
2013 {
2014     int nr = ilist->size();
2015     serializer->doInt(&nr);
2016     if (serializer->reading())
2017     {
2018         ilist->iatoms.resize(nr);
2019     }
2020     serializer->doIntArray(ilist->iatoms.data(), ilist->size());
2021 }
2022
2023 static void do_ffparams(gmx::ISerializer* serializer, gmx_ffparams_t* ffparams, int file_version)
2024 {
2025     serializer->doInt(&ffparams->atnr);
2026     int numTypes = ffparams->numTypes();
2027     serializer->doInt(&numTypes);
2028     if (serializer->reading())
2029     {
2030         ffparams->functype.resize(numTypes);
2031         ffparams->iparams.resize(numTypes);
2032     }
2033     /* Read/write all the function types */
2034     serializer->doIntArray(ffparams->functype.data(), ffparams->functype.size());
2035
2036     if (file_version >= 66)
2037     {
2038         serializer->doDouble(&ffparams->reppow);
2039     }
2040     else
2041     {
2042         ffparams->reppow = 12.0;
2043     }
2044
2045     serializer->doReal(&ffparams->fudgeQQ);
2046
2047     /* Check whether all these function types are supported by the code.
2048      * In practice the code is backwards compatible, which means that the
2049      * numbering may have to be altered from old numbering to new numbering
2050      */
2051     for (int i = 0; i < ffparams->numTypes(); i++)
2052     {
2053         if (serializer->reading())
2054         {
2055             /* Loop over file versions */
2056             for (int k = 0; k < NFTUPD; k++)
2057             {
2058                 /* Compare the read file_version to the update table */
2059                 if ((file_version < ftupd[k].fvnr) && (ffparams->functype[i] >= ftupd[k].ftype))
2060                 {
2061                     ffparams->functype[i] += 1;
2062                 }
2063             }
2064         }
2065
2066         do_iparams(serializer, ffparams->functype[i], &ffparams->iparams[i], file_version);
2067     }
2068 }
2069
2070 static void add_settle_atoms(InteractionList* ilist)
2071 {
2072     int i;
2073
2074     /* Settle used to only store the first atom: add the other two */
2075     ilist->iatoms.resize(2 * ilist->size());
2076     for (i = ilist->size() / 4 - 1; i >= 0; i--)
2077     {
2078         ilist->iatoms[4 * i + 0] = ilist->iatoms[2 * i + 0];
2079         ilist->iatoms[4 * i + 1] = ilist->iatoms[2 * i + 1];
2080         ilist->iatoms[4 * i + 2] = ilist->iatoms[2 * i + 1] + 1;
2081         ilist->iatoms[4 * i + 3] = ilist->iatoms[2 * i + 1] + 2;
2082     }
2083 }
2084
2085 static void do_ilists(gmx::ISerializer* serializer, InteractionLists* ilists, int file_version)
2086 {
2087     GMX_RELEASE_ASSERT(ilists, "Need a valid ilists object");
2088     GMX_RELEASE_ASSERT(ilists->size() == F_NRE,
2089                        "The code needs to be in sync with InteractionLists");
2090
2091     for (int j = 0; j < F_NRE; j++)
2092     {
2093         InteractionList& ilist  = (*ilists)[j];
2094         gmx_bool         bClear = FALSE;
2095         if (serializer->reading())
2096         {
2097             for (int k = 0; k < NFTUPD; k++)
2098             {
2099                 if ((file_version < ftupd[k].fvnr) && (j == ftupd[k].ftype))
2100                 {
2101                     bClear = TRUE;
2102                 }
2103             }
2104         }
2105         if (bClear)
2106         {
2107             ilist.iatoms.clear();
2108         }
2109         else
2110         {
2111             do_ilist(serializer, &ilist);
2112             if (file_version < 78 && j == F_SETTLE && !ilist.empty())
2113             {
2114                 add_settle_atoms(&ilist);
2115             }
2116         }
2117     }
2118 }
2119
2120 static void do_block(gmx::ISerializer* serializer, t_block* block)
2121 {
2122     serializer->doInt(&block->nr);
2123     if (serializer->reading())
2124     {
2125         if ((block->nalloc_index > 0) && (nullptr != block->index))
2126         {
2127             sfree(block->index);
2128         }
2129         block->nalloc_index = block->nr + 1;
2130         snew(block->index, block->nalloc_index);
2131     }
2132     serializer->doIntArray(block->index, block->nr + 1);
2133 }
2134
2135 static void doListOfLists(gmx::ISerializer* serializer, gmx::ListOfLists<int>* listOfLists)
2136 {
2137     int numLists = listOfLists->ssize();
2138     serializer->doInt(&numLists);
2139     int numElements = listOfLists->elementsView().ssize();
2140     serializer->doInt(&numElements);
2141     if (serializer->reading())
2142     {
2143         std::vector<int> listRanges(numLists + 1);
2144         serializer->doIntArray(listRanges.data(), numLists + 1);
2145         std::vector<int> elements(numElements);
2146         serializer->doIntArray(elements.data(), numElements);
2147         *listOfLists = gmx::ListOfLists<int>(std::move(listRanges), std::move(elements));
2148     }
2149     else
2150     {
2151         serializer->doIntArray(const_cast<int*>(listOfLists->listRangesView().data()), numLists + 1);
2152         serializer->doIntArray(const_cast<int*>(listOfLists->elementsView().data()), numElements);
2153     }
2154 }
2155
2156 /* This is a primitive routine to make it possible to translate atomic numbers
2157  * to element names when reading TPR files, without making the Gromacs library
2158  * directory a dependency on mdrun (which is the case if we need elements.dat).
2159  */
2160 static const char* atomicnumber_to_element(int atomicnumber)
2161 {
2162     const char* p;
2163
2164     /* This does not have to be complete, so we only include elements likely
2165      * to occur in PDB files.
2166      */
2167     switch (atomicnumber)
2168     {
2169         case 1: p = "H"; break;
2170         case 5: p = "B"; break;
2171         case 6: p = "C"; break;
2172         case 7: p = "N"; break;
2173         case 8: p = "O"; break;
2174         case 9: p = "F"; break;
2175         case 11: p = "Na"; break;
2176         case 12: p = "Mg"; break;
2177         case 15: p = "P"; break;
2178         case 16: p = "S"; break;
2179         case 17: p = "Cl"; break;
2180         case 18: p = "Ar"; break;
2181         case 19: p = "K"; break;
2182         case 20: p = "Ca"; break;
2183         case 25: p = "Mn"; break;
2184         case 26: p = "Fe"; break;
2185         case 28: p = "Ni"; break;
2186         case 29: p = "Cu"; break;
2187         case 30: p = "Zn"; break;
2188         case 35: p = "Br"; break;
2189         case 47: p = "Ag"; break;
2190         default: p = ""; break;
2191     }
2192     return p;
2193 }
2194
2195
2196 static void do_atom(gmx::ISerializer* serializer, t_atom* atom)
2197 {
2198     serializer->doReal(&atom->m);
2199     serializer->doReal(&atom->q);
2200     serializer->doReal(&atom->mB);
2201     serializer->doReal(&atom->qB);
2202     serializer->doUShort(&atom->type);
2203     serializer->doUShort(&atom->typeB);
2204     serializer->doInt(&atom->ptype);
2205     serializer->doInt(&atom->resind);
2206     serializer->doInt(&atom->atomnumber);
2207     if (serializer->reading())
2208     {
2209         /* Set element string from atomic number if present.
2210          * This routine returns an empty string if the name is not found.
2211          */
2212         std::strncpy(atom->elem, atomicnumber_to_element(atom->atomnumber), 4);
2213         /* avoid warnings about potentially unterminated string */
2214         atom->elem[3] = '\0';
2215     }
2216 }
2217
2218 static void do_grps(gmx::ISerializer* serializer, gmx::ArrayRef<AtomGroupIndices> grps)
2219 {
2220     for (auto& group : grps)
2221     {
2222         int size = group.size();
2223         serializer->doInt(&size);
2224         if (serializer->reading())
2225         {
2226             group.resize(size);
2227         }
2228         serializer->doIntArray(group.data(), size);
2229     }
2230 }
2231
2232 static void do_symstr(gmx::ISerializer* serializer, char*** nm, t_symtab* symtab)
2233 {
2234     int ls;
2235
2236     if (serializer->reading())
2237     {
2238         serializer->doInt(&ls);
2239         *nm = get_symtab_handle(symtab, ls);
2240     }
2241     else
2242     {
2243         ls = lookup_symtab(symtab, *nm);
2244         serializer->doInt(&ls);
2245     }
2246 }
2247
2248 static void do_strstr(gmx::ISerializer* serializer, int nstr, char*** nm, t_symtab* symtab)
2249 {
2250     int j;
2251
2252     for (j = 0; (j < nstr); j++)
2253     {
2254         do_symstr(serializer, &(nm[j]), symtab);
2255     }
2256 }
2257
2258 static void do_resinfo(gmx::ISerializer* serializer, int n, t_resinfo* ri, t_symtab* symtab, int file_version)
2259 {
2260     int j;
2261
2262     for (j = 0; (j < n); j++)
2263     {
2264         do_symstr(serializer, &(ri[j].name), symtab);
2265         if (file_version >= 63)
2266         {
2267             serializer->doInt(&ri[j].nr);
2268             serializer->doUChar(&ri[j].ic);
2269         }
2270         else
2271         {
2272             ri[j].nr = j + 1;
2273             ri[j].ic = ' ';
2274         }
2275     }
2276 }
2277
2278 static void do_atoms(gmx::ISerializer* serializer, t_atoms* atoms, t_symtab* symtab, int file_version)
2279 {
2280     int i;
2281
2282     serializer->doInt(&atoms->nr);
2283     serializer->doInt(&atoms->nres);
2284     if (serializer->reading())
2285     {
2286         /* Since we have always written all t_atom properties in the tpr file
2287          * (at least for all backward compatible versions), we don't store
2288          * but simple set the booleans here.
2289          */
2290         atoms->haveMass    = TRUE;
2291         atoms->haveCharge  = TRUE;
2292         atoms->haveType    = TRUE;
2293         atoms->haveBState  = TRUE;
2294         atoms->havePdbInfo = FALSE;
2295
2296         snew(atoms->atom, atoms->nr);
2297         snew(atoms->atomname, atoms->nr);
2298         snew(atoms->atomtype, atoms->nr);
2299         snew(atoms->atomtypeB, atoms->nr);
2300         snew(atoms->resinfo, atoms->nres);
2301         atoms->pdbinfo = nullptr;
2302     }
2303     else
2304     {
2305         GMX_RELEASE_ASSERT(atoms->haveMass && atoms->haveCharge && atoms->haveType && atoms->haveBState,
2306                            "Mass, charge, atomtype and B-state parameters should be present in "
2307                            "t_atoms when writing a tpr file");
2308     }
2309     for (i = 0; (i < atoms->nr); i++)
2310     {
2311         do_atom(serializer, &atoms->atom[i]);
2312     }
2313     do_strstr(serializer, atoms->nr, atoms->atomname, symtab);
2314     do_strstr(serializer, atoms->nr, atoms->atomtype, symtab);
2315     do_strstr(serializer, atoms->nr, atoms->atomtypeB, symtab);
2316
2317     do_resinfo(serializer, atoms->nres, atoms->resinfo, symtab, file_version);
2318 }
2319
2320 static void do_groups(gmx::ISerializer* serializer, SimulationGroups* groups, t_symtab* symtab)
2321 {
2322     do_grps(serializer, groups->groups);
2323     int numberOfGroupNames = groups->groupNames.size();
2324     serializer->doInt(&numberOfGroupNames);
2325     if (serializer->reading())
2326     {
2327         groups->groupNames.resize(numberOfGroupNames);
2328     }
2329     do_strstr(serializer, numberOfGroupNames, groups->groupNames.data(), symtab);
2330     for (auto group : gmx::keysOf(groups->groupNumbers))
2331     {
2332         int numberOfGroupNumbers = groups->numberOfGroupNumbers(group);
2333         serializer->doInt(&numberOfGroupNumbers);
2334         if (numberOfGroupNumbers != 0)
2335         {
2336             if (serializer->reading())
2337             {
2338                 groups->groupNumbers[group].resize(numberOfGroupNumbers);
2339             }
2340             serializer->doUCharArray(groups->groupNumbers[group].data(), numberOfGroupNumbers);
2341         }
2342     }
2343 }
2344
2345 static void do_atomtypes(gmx::ISerializer* serializer, t_atomtypes* atomtypes, int file_version)
2346 {
2347     int j;
2348
2349     serializer->doInt(&atomtypes->nr);
2350     j = atomtypes->nr;
2351     if (serializer->reading())
2352     {
2353         snew(atomtypes->atomnumber, j);
2354     }
2355     if (serializer->reading() && file_version < tpxv_RemoveImplicitSolvation)
2356     {
2357         std::vector<real> dummy(atomtypes->nr, 0);
2358         serializer->doRealArray(dummy.data(), dummy.size());
2359         serializer->doRealArray(dummy.data(), dummy.size());
2360         serializer->doRealArray(dummy.data(), dummy.size());
2361     }
2362     serializer->doIntArray(atomtypes->atomnumber, j);
2363
2364     if (serializer->reading() && file_version >= 60 && file_version < tpxv_RemoveImplicitSolvation)
2365     {
2366         std::vector<real> dummy(atomtypes->nr, 0);
2367         serializer->doRealArray(dummy.data(), dummy.size());
2368         serializer->doRealArray(dummy.data(), dummy.size());
2369     }
2370 }
2371
2372 static void do_symtab(gmx::ISerializer* serializer, t_symtab* symtab)
2373 {
2374     int       i, nr;
2375     t_symbuf* symbuf;
2376
2377     serializer->doInt(&symtab->nr);
2378     nr = symtab->nr;
2379     if (serializer->reading())
2380     {
2381         snew(symtab->symbuf, 1);
2382         symbuf          = symtab->symbuf;
2383         symbuf->bufsize = nr;
2384         snew(symbuf->buf, nr);
2385         for (i = 0; (i < nr); i++)
2386         {
2387             std::string buf;
2388             serializer->doString(&buf);
2389             symbuf->buf[i] = gmx_strdup(buf.c_str());
2390         }
2391     }
2392     else
2393     {
2394         symbuf = symtab->symbuf;
2395         while (symbuf != nullptr)
2396         {
2397             for (i = 0; (i < symbuf->bufsize) && (i < nr); i++)
2398             {
2399                 std::string buf = symbuf->buf[i];
2400                 serializer->doString(&buf);
2401             }
2402             nr -= i;
2403             symbuf = symbuf->next;
2404         }
2405         if (nr != 0)
2406         {
2407             gmx_fatal(FARGS, "nr of symtab strings left: %d", nr);
2408         }
2409     }
2410 }
2411
2412 static void do_cmap(gmx::ISerializer* serializer, gmx_cmap_t* cmap_grid)
2413 {
2414
2415     int ngrid = cmap_grid->cmapdata.size();
2416     serializer->doInt(&ngrid);
2417     serializer->doInt(&cmap_grid->grid_spacing);
2418
2419     int gs    = cmap_grid->grid_spacing;
2420     int nelem = gs * gs;
2421
2422     if (serializer->reading())
2423     {
2424         cmap_grid->cmapdata.resize(ngrid);
2425
2426         for (int i = 0; i < ngrid; i++)
2427         {
2428             cmap_grid->cmapdata[i].cmap.resize(4 * nelem);
2429         }
2430     }
2431
2432     for (int i = 0; i < ngrid; i++)
2433     {
2434         for (int j = 0; j < nelem; j++)
2435         {
2436             serializer->doReal(&cmap_grid->cmapdata[i].cmap[j * 4]);
2437             serializer->doReal(&cmap_grid->cmapdata[i].cmap[j * 4 + 1]);
2438             serializer->doReal(&cmap_grid->cmapdata[i].cmap[j * 4 + 2]);
2439             serializer->doReal(&cmap_grid->cmapdata[i].cmap[j * 4 + 3]);
2440         }
2441     }
2442 }
2443
2444
2445 static void do_moltype(gmx::ISerializer* serializer, gmx_moltype_t* molt, t_symtab* symtab, int file_version)
2446 {
2447     do_symstr(serializer, &(molt->name), symtab);
2448
2449     do_atoms(serializer, &molt->atoms, symtab, file_version);
2450
2451     do_ilists(serializer, &molt->ilist, file_version);
2452
2453     /* TODO: Remove the obsolete charge group index from the file */
2454     t_block cgs;
2455     cgs.nr           = molt->atoms.nr;
2456     cgs.nalloc_index = cgs.nr + 1;
2457     snew(cgs.index, cgs.nalloc_index);
2458     for (int i = 0; i < cgs.nr + 1; i++)
2459     {
2460         cgs.index[i] = i;
2461     }
2462     do_block(serializer, &cgs);
2463     sfree(cgs.index);
2464
2465     /* This used to be in the atoms struct */
2466     doListOfLists(serializer, &molt->excls);
2467 }
2468
2469 static void do_molblock(gmx::ISerializer* serializer, gmx_molblock_t* molb, int numAtomsPerMolecule)
2470 {
2471     serializer->doInt(&molb->type);
2472     serializer->doInt(&molb->nmol);
2473     /* To maintain forward topology reading compatibility, we store #atoms.
2474      * TODO: Change this to conditional reading of a dummy int when we
2475      *       increase tpx_generation.
2476      */
2477     serializer->doInt(&numAtomsPerMolecule);
2478     /* Position restraint coordinates */
2479     int numPosres_xA = molb->posres_xA.size();
2480     serializer->doInt(&numPosres_xA);
2481     if (numPosres_xA > 0)
2482     {
2483         if (serializer->reading())
2484         {
2485             molb->posres_xA.resize(numPosres_xA);
2486         }
2487         serializer->doRvecArray(as_rvec_array(molb->posres_xA.data()), numPosres_xA);
2488     }
2489     int numPosres_xB = molb->posres_xB.size();
2490     serializer->doInt(&numPosres_xB);
2491     if (numPosres_xB > 0)
2492     {
2493         if (serializer->reading())
2494         {
2495             molb->posres_xB.resize(numPosres_xB);
2496         }
2497         serializer->doRvecArray(as_rvec_array(molb->posres_xB.data()), numPosres_xB);
2498     }
2499 }
2500
2501 static void set_disres_npair(gmx_mtop_t* mtop)
2502 {
2503     gmx_mtop_ilistloop_t iloop;
2504     int                  nmol;
2505
2506     gmx::ArrayRef<t_iparams> ip = mtop->ffparams.iparams;
2507
2508     iloop = gmx_mtop_ilistloop_init(mtop);
2509     while (const InteractionLists* ilist = gmx_mtop_ilistloop_next(iloop, &nmol))
2510     {
2511         const InteractionList& il = (*ilist)[F_DISRES];
2512
2513         if (!il.empty())
2514         {
2515             gmx::ArrayRef<const int> a     = il.iatoms;
2516             int                      npair = 0;
2517             for (int i = 0; i < il.size(); i += 3)
2518             {
2519                 npair++;
2520                 if (i + 3 == il.size() || ip[a[i]].disres.label != ip[a[i + 3]].disres.label)
2521                 {
2522                     ip[a[i]].disres.npair = npair;
2523                     npair                 = 0;
2524                 }
2525             }
2526         }
2527     }
2528 }
2529
2530 static void do_mtop(gmx::ISerializer* serializer, gmx_mtop_t* mtop, int file_version)
2531 {
2532     do_symtab(serializer, &(mtop->symtab));
2533
2534     do_symstr(serializer, &(mtop->name), &(mtop->symtab));
2535
2536     do_ffparams(serializer, &mtop->ffparams, file_version);
2537
2538     int nmoltype = mtop->moltype.size();
2539     serializer->doInt(&nmoltype);
2540     if (serializer->reading())
2541     {
2542         mtop->moltype.resize(nmoltype);
2543     }
2544     for (gmx_moltype_t& moltype : mtop->moltype)
2545     {
2546         do_moltype(serializer, &moltype, &mtop->symtab, file_version);
2547     }
2548
2549     int nmolblock = mtop->molblock.size();
2550     serializer->doInt(&nmolblock);
2551     if (serializer->reading())
2552     {
2553         mtop->molblock.resize(nmolblock);
2554     }
2555     for (gmx_molblock_t& molblock : mtop->molblock)
2556     {
2557         int numAtomsPerMolecule = (serializer->reading() ? 0 : mtop->moltype[molblock.type].atoms.nr);
2558         do_molblock(serializer, &molblock, numAtomsPerMolecule);
2559     }
2560     serializer->doInt(&mtop->natoms);
2561
2562     if (file_version >= tpxv_IntermolecularBondeds)
2563     {
2564         serializer->doBool(&mtop->bIntermolecularInteractions);
2565         if (mtop->bIntermolecularInteractions)
2566         {
2567             if (serializer->reading())
2568             {
2569                 mtop->intermolecular_ilist = std::make_unique<InteractionLists>();
2570             }
2571             do_ilists(serializer, mtop->intermolecular_ilist.get(), file_version);
2572         }
2573     }
2574     else
2575     {
2576         mtop->bIntermolecularInteractions = FALSE;
2577     }
2578
2579     do_atomtypes(serializer, &(mtop->atomtypes), file_version);
2580
2581     if (file_version >= 65)
2582     {
2583         do_cmap(serializer, &mtop->ffparams.cmap_grid);
2584     }
2585     else
2586     {
2587         mtop->ffparams.cmap_grid.grid_spacing = 0;
2588         mtop->ffparams.cmap_grid.cmapdata.clear();
2589     }
2590
2591     do_groups(serializer, &mtop->groups, &(mtop->symtab));
2592
2593     mtop->haveMoleculeIndices = true;
2594
2595     if (file_version >= tpxv_StoreNonBondedInteractionExclusionGroup)
2596     {
2597         std::int64_t intermolecularExclusionGroupSize = gmx::ssize(mtop->intermolecularExclusionGroup);
2598         serializer->doInt64(&intermolecularExclusionGroupSize);
2599         GMX_RELEASE_ASSERT(intermolecularExclusionGroupSize >= 0,
2600                            "Number of atoms with excluded intermolecular non-bonded interactions "
2601                            "is negative.");
2602         mtop->intermolecularExclusionGroup.resize(intermolecularExclusionGroupSize); // no effect when writing
2603         serializer->doIntArray(mtop->intermolecularExclusionGroup.data(),
2604                                mtop->intermolecularExclusionGroup.size());
2605     }
2606
2607     if (serializer->reading())
2608     {
2609         close_symtab(&(mtop->symtab));
2610     }
2611 }
2612
2613 /*! \brief
2614  * Read the first part of the TPR file to find general system information.
2615  *
2616  * If \p TopOnlyOK is true then we can read even future versions
2617  * of tpx files, provided the \p fileGeneration hasn't changed.
2618  * If it is false, we need the \p ir too, and bail out
2619  * if the file is newer than the program.
2620  *
2621  * The version and generation of the topology (see top of this file)
2622  * are returned in the two last arguments, if those arguments are non-nullptr.
2623  *
2624  * If possible, we will read the \p ir even when \p TopOnlyOK is true.
2625  *
2626  * \param[in,out] serializer The serializer used to handle header processing.
2627  * \param[in,out] tpx File header datastructure.
2628  * \param[in]     filename The name of the file being read/written
2629  * \param[in,out] fio File handle.
2630  * \param[in] TopOnlyOK If not reading \p ir is fine or not.
2631  */
2632 static void do_tpxheader(gmx::FileIOXdrSerializer* serializer,
2633                          TpxFileHeader*            tpx,
2634                          const char*               filename,
2635                          t_fileio*                 fio,
2636                          bool                      TopOnlyOK)
2637 {
2638     int  precision;
2639     int  idum = 0;
2640     real rdum = 0;
2641
2642     /* XDR binary topology file */
2643     precision = sizeof(real);
2644     std::string buf;
2645     std::string fileTag;
2646     if (serializer->reading())
2647     {
2648         serializer->doString(&buf);
2649         if (std::strncmp(buf.c_str(), "VERSION", 7) != 0)
2650         {
2651             gmx_fatal(
2652                     FARGS,
2653                     "Can not read file %s,\n"
2654                     "             this file is from a GROMACS version which is older than 2.0\n"
2655                     "             Make a new one with grompp or use a gro or pdb file, if possible",
2656                     filename);
2657         }
2658         // We need to know the precision used to write the TPR file, to match it
2659         // to the precision of the currently running binary. If the precisions match
2660         // there is no problem, but mismatching precision needs to be accounted for
2661         // by reading into temporary variables of the correct precision instead
2662         // of the desired target datastructures.
2663         serializer->doInt(&precision);
2664         tpx->isDouble = (precision == sizeof(double));
2665         if ((precision != sizeof(float)) && !tpx->isDouble)
2666         {
2667             gmx_fatal(FARGS,
2668                       "Unknown precision in file %s: real is %d bytes "
2669                       "instead of %zu or %zu",
2670                       filename, precision, sizeof(float), sizeof(double));
2671         }
2672         gmx_fio_setprecision(fio, tpx->isDouble);
2673         fprintf(stderr, "Reading file %s, %s (%s precision)\n", filename, buf.c_str(),
2674                 tpx->isDouble ? "double" : "single");
2675     }
2676     else
2677     {
2678         buf = gmx::formatString("VERSION %s", gmx_version());
2679         serializer->doString(&buf);
2680         gmx_fio_setprecision(fio, tpx->isDouble);
2681         serializer->doInt(&precision);
2682         fileTag = gmx::formatString("%s", tpx_tag);
2683     }
2684
2685     /* Check versions! */
2686     serializer->doInt(&tpx->fileVersion);
2687
2688     /* This is for backward compatibility with development versions 77-79
2689      * where the tag was, mistakenly, placed before the generation,
2690      * which would cause a segv instead of a proper error message
2691      * when reading the topology only from tpx with <77 code.
2692      */
2693     if (tpx->fileVersion >= 77 && tpx->fileVersion <= 79)
2694     {
2695         serializer->doString(&fileTag);
2696     }
2697
2698     serializer->doInt(&tpx->fileGeneration);
2699
2700     if (tpx->fileVersion >= 81)
2701     {
2702         serializer->doString(&fileTag);
2703     }
2704     if (serializer->reading())
2705     {
2706         if (tpx->fileVersion < 77)
2707         {
2708             /* Versions before 77 don't have the tag, set it to release */
2709             fileTag = gmx::formatString("%s", TPX_TAG_RELEASE);
2710         }
2711
2712         if (fileTag != tpx_tag)
2713         {
2714             fprintf(stderr, "Note: file tpx tag '%s', software tpx tag '%s'\n", fileTag.c_str(), tpx_tag);
2715
2716             /* We only support reading tpx files with the same tag as the code
2717              * or tpx files with the release tag and with lower version number.
2718              */
2719             if (fileTag != TPX_TAG_RELEASE && tpx->fileVersion < tpx_version)
2720             {
2721                 gmx_fatal(FARGS,
2722                           "tpx tag/version mismatch: reading tpx file (%s) version %d, tag '%s' "
2723                           "with program for tpx version %d, tag '%s'",
2724                           filename, tpx->fileVersion, fileTag.c_str(), tpx_version, tpx_tag);
2725             }
2726         }
2727     }
2728
2729     if ((tpx->fileVersion <= tpx_incompatible_version)
2730         || ((tpx->fileVersion > tpx_version) && !TopOnlyOK) || (tpx->fileGeneration > tpx_generation)
2731         || tpx_version == 80) /*80 was used by both 5.0-dev and 4.6-dev*/
2732     {
2733         gmx_fatal(FARGS, "reading tpx file (%s) version %d with version %d program", filename,
2734                   tpx->fileVersion, tpx_version);
2735     }
2736
2737     serializer->doInt(&tpx->natoms);
2738     serializer->doInt(&tpx->ngtc);
2739
2740     if (tpx->fileVersion < 62)
2741     {
2742         serializer->doInt(&idum);
2743         serializer->doReal(&rdum);
2744     }
2745     if (tpx->fileVersion >= 79)
2746     {
2747         serializer->doInt(&tpx->fep_state);
2748     }
2749     serializer->doReal(&tpx->lambda);
2750     serializer->doBool(&tpx->bIr);
2751     serializer->doBool(&tpx->bTop);
2752     serializer->doBool(&tpx->bX);
2753     serializer->doBool(&tpx->bV);
2754     serializer->doBool(&tpx->bF);
2755     serializer->doBool(&tpx->bBox);
2756
2757     if (tpx->fileVersion >= tpxv_AddSizeField && tpx->fileGeneration >= 27)
2758     {
2759         if (!serializer->reading())
2760         {
2761             GMX_RELEASE_ASSERT(tpx->sizeOfTprBody != 0,
2762                                "Not possible to write new file with zero TPR body size");
2763         }
2764         serializer->doInt64(&tpx->sizeOfTprBody);
2765     }
2766
2767     if ((tpx->fileGeneration > tpx_generation))
2768     {
2769         /* This can only happen if TopOnlyOK=TRUE */
2770         tpx->bIr = FALSE;
2771     }
2772 }
2773
2774 #define do_test(serializer, b, p)                            \
2775     if ((serializer)->reading() && ((p) != nullptr) && !(b)) \
2776     gmx_fatal(FARGS, "No %s in input file", #p)
2777
2778 /*! \brief
2779  * Process the first part of the TPR into the state datastructure.
2780  *
2781  * Due to the structure of the legacy code, it is necessary
2782  * to split up the state reading into two parts, with the
2783  * box and legacy temperature coupling processed before the
2784  * topology datastructures.
2785  *
2786  * See the documentation for do_tpx_body for the correct order of
2787  * the operations for reading a tpr file.
2788  *
2789  * \param[in] serializer Abstract serializer used to read/write data.
2790  * \param[in] tpx The file header data.
2791  * \param[in, out] state Global state data.
2792  */
2793 static void do_tpx_state_first(gmx::ISerializer* serializer, TpxFileHeader* tpx, t_state* state)
2794 {
2795     if (serializer->reading())
2796     {
2797         state->flags = 0;
2798         init_gtc_state(state, tpx->ngtc, 0, 0);
2799     }
2800     do_test(serializer, tpx->bBox, state->box);
2801     if (tpx->bBox)
2802     {
2803         serializer->doRvecArray(state->box, DIM);
2804         if (tpx->fileVersion >= 51)
2805         {
2806             serializer->doRvecArray(state->box_rel, DIM);
2807         }
2808         else
2809         {
2810             /* We initialize box_rel after reading the inputrec */
2811             clear_mat(state->box_rel);
2812         }
2813         serializer->doRvecArray(state->boxv, DIM);
2814         if (tpx->fileVersion < 56)
2815         {
2816             matrix mdum;
2817             serializer->doRvecArray(mdum, DIM);
2818         }
2819     }
2820
2821     if (state->ngtc > 0)
2822     {
2823         real* dumv;
2824         snew(dumv, state->ngtc);
2825         if (tpx->fileVersion < 69)
2826         {
2827             serializer->doRealArray(dumv, state->ngtc);
2828         }
2829         /* These used to be the Berendsen tcoupl_lambda's */
2830         serializer->doRealArray(dumv, state->ngtc);
2831         sfree(dumv);
2832     }
2833 }
2834
2835 /*! \brief
2836  * Process global topology data.
2837  *
2838  * See the documentation for do_tpx_body for the correct order of
2839  * the operations for reading a tpr file.
2840  *
2841  * \param[in] serializer Abstract serializer  used to read/write data.
2842  * \param[in] tpx The file header data.
2843  * \param[in,out] mtop Global topology.
2844  */
2845 static void do_tpx_mtop(gmx::ISerializer* serializer, TpxFileHeader* tpx, gmx_mtop_t* mtop)
2846 {
2847     do_test(serializer, tpx->bTop, mtop);
2848     if (tpx->bTop)
2849     {
2850         if (mtop)
2851         {
2852             do_mtop(serializer, mtop, tpx->fileVersion);
2853             set_disres_npair(mtop);
2854             mtop->finalize();
2855         }
2856         else
2857         {
2858             gmx_mtop_t dum_top;
2859             do_mtop(serializer, &dum_top, tpx->fileVersion);
2860         }
2861     }
2862 }
2863 /*! \brief
2864  * Process coordinate vectors for state data.
2865  *
2866  * Main part of state gets processed here.
2867  *
2868  * See the documentation for do_tpx_body for the correct order of
2869  * the operations for reading a tpr file.
2870  *
2871  * \param[in] serializer Abstract serializer used to read/write data.
2872  * \param[in] tpx The file header data.
2873  * \param[in,out] state Global state data.
2874  * \param[in,out] x Individual coordinates for processing, deprecated.
2875  * \param[in,out] v Individual velocities for processing, deprecated.
2876  */
2877 static void do_tpx_state_second(gmx::ISerializer* serializer, TpxFileHeader* tpx, t_state* state, rvec* x, rvec* v)
2878 {
2879     if (!serializer->reading())
2880     {
2881         GMX_RELEASE_ASSERT(
2882                 x == nullptr && v == nullptr,
2883                 "Passing separate x and v pointers to do_tpx() is not supported when writing");
2884     }
2885     else
2886     {
2887         GMX_RELEASE_ASSERT(!(x == nullptr && v != nullptr),
2888                            "Passing x==NULL and v!=NULL is not supported");
2889     }
2890
2891     if (serializer->reading())
2892     {
2893         if (x == nullptr)
2894         {
2895             // v is also nullptr by the above assertion, so we may
2896             // need to make memory in state for storing the contents
2897             // of the tpx file.
2898             if (tpx->bX)
2899             {
2900                 state->flags |= (1 << estX);
2901             }
2902             if (tpx->bV)
2903             {
2904                 state->flags |= (1 << estV);
2905             }
2906             state_change_natoms(state, tpx->natoms);
2907         }
2908     }
2909
2910     if (x == nullptr)
2911     {
2912         x = state->x.rvec_array();
2913         v = state->v.rvec_array();
2914     }
2915     do_test(serializer, tpx->bX, x);
2916     if (tpx->bX)
2917     {
2918         if (serializer->reading())
2919         {
2920             state->flags |= (1 << estX);
2921         }
2922         serializer->doRvecArray(x, tpx->natoms);
2923     }
2924
2925     do_test(serializer, tpx->bV, v);
2926     if (tpx->bV)
2927     {
2928         if (serializer->reading())
2929         {
2930             state->flags |= (1 << estV);
2931         }
2932         if (!v)
2933         {
2934             std::vector<gmx::RVec> dummyVelocities(tpx->natoms);
2935             serializer->doRvecArray(as_rvec_array(dummyVelocities.data()), tpx->natoms);
2936         }
2937         else
2938         {
2939             serializer->doRvecArray(v, tpx->natoms);
2940         }
2941     }
2942
2943     // No need to run do_test when the last argument is NULL
2944     if (tpx->bF)
2945     {
2946         std::vector<gmx::RVec> dummyForces(state->natoms);
2947         serializer->doRvecArray(as_rvec_array(dummyForces.data()), tpx->natoms);
2948     }
2949 }
2950 /*! \brief
2951  * Process simulation parameters.
2952  *
2953  * See the documentation for do_tpx_body for the correct order of
2954  * the operations for reading a tpr file.
2955  *
2956  * \param[in] serializer Abstract serializer used to read/write data.
2957  * \param[in] tpx The file header data.
2958  * \param[in,out] ir Datastructure with simulation parameters.
2959  */
2960 static PbcType do_tpx_ir(gmx::ISerializer* serializer, TpxFileHeader* tpx, t_inputrec* ir)
2961 {
2962     PbcType  pbcType;
2963     gmx_bool bPeriodicMols;
2964
2965     /* Starting with tpx version 26, we have the inputrec
2966      * at the end of the file, so we can ignore it
2967      * if the file is never than the software (but still the
2968      * same generation - see comments at the top of this file.
2969      *
2970      *
2971      */
2972     pbcType       = PbcType::Unset;
2973     bPeriodicMols = FALSE;
2974
2975     do_test(serializer, tpx->bIr, ir);
2976     if (tpx->bIr)
2977     {
2978         if (tpx->fileVersion >= 53)
2979         {
2980             /* Removed the pbc info from do_inputrec, since we always want it */
2981             if (!serializer->reading())
2982             {
2983                 pbcType       = ir->pbcType;
2984                 bPeriodicMols = ir->bPeriodicMols;
2985             }
2986             serializer->doInt(reinterpret_cast<int*>(&pbcType));
2987             serializer->doBool(&bPeriodicMols);
2988         }
2989         if (tpx->fileGeneration <= tpx_generation && ir)
2990         {
2991             do_inputrec(serializer, ir, tpx->fileVersion);
2992             if (tpx->fileVersion < 53)
2993             {
2994                 pbcType       = ir->pbcType;
2995                 bPeriodicMols = ir->bPeriodicMols;
2996             }
2997         }
2998         if (serializer->reading() && ir && tpx->fileVersion >= 53)
2999         {
3000             /* We need to do this after do_inputrec, since that initializes ir */
3001             ir->pbcType       = pbcType;
3002             ir->bPeriodicMols = bPeriodicMols;
3003         }
3004     }
3005     return pbcType;
3006 }
3007
3008 /*! \brief
3009  * Correct and finalize read information.
3010  *
3011  * If \p state is nullptr, skip the parts dependent on it.
3012  *
3013  * See the documentation for do_tpx_body for the correct order of
3014  * the operations for reading a tpr file.
3015  *
3016  * \param[in] tpx The file header used to check version numbers.
3017  * \param[out] ir Input rec that needs correction.
3018  * \param[out] state State needing correction.
3019  * \param[out] mtop Topology to finalize.
3020  */
3021 static void do_tpx_finalize(TpxFileHeader* tpx, t_inputrec* ir, t_state* state, gmx_mtop_t* mtop)
3022 {
3023     if (tpx->fileVersion < 51 && state)
3024     {
3025         set_box_rel(ir, state);
3026     }
3027     if (tpx->bIr && ir)
3028     {
3029         if (state && state->ngtc == 0)
3030         {
3031             /* Reading old version without tcoupl state data: set it */
3032             init_gtc_state(state, ir->opts.ngtc, 0, ir->opts.nhchainlength);
3033         }
3034         if (tpx->bTop && mtop)
3035         {
3036             if (tpx->fileVersion < 57)
3037             {
3038                 if (!mtop->moltype[0].ilist[F_DISRES].empty())
3039                 {
3040                     ir->eDisre = edrSimple;
3041                 }
3042                 else
3043                 {
3044                     ir->eDisre = edrNone;
3045                 }
3046             }
3047         }
3048     }
3049 }
3050
3051 /*! \brief
3052  * Process TPR data for file reading/writing.
3053  *
3054  * The TPR file gets processed in in four stages due to the organization
3055  * of the data within it.
3056  *
3057  * First, state data for the box is processed in do_tpx_state_first.
3058  * This is followed by processing the topology in do_tpx_mtop.
3059  * Coordinate and velocity vectors are handled next in do_tpx_state_second.
3060  * The last file information processed is the collection of simulation parameters in do_tpx_ir.
3061  * When reading, a final processing step is undertaken at the end.
3062  *
3063  * \param[in] serializer Abstract serializer used to read/write data.
3064  * \param[in] tpx The file header data.
3065  * \param[in,out] ir Datastructures with simulation parameters.
3066  * \param[in,out] state Global state data.
3067  * \param[in,out] x Individual coordinates for processing, deprecated.
3068  * \param[in,out] v Individual velocities for processing, deprecated.
3069  * \param[in,out] mtop Global topology.
3070  */
3071 static PbcType do_tpx_body(gmx::ISerializer* serializer,
3072                            TpxFileHeader*    tpx,
3073                            t_inputrec*       ir,
3074                            t_state*          state,
3075                            rvec*             x,
3076                            rvec*             v,
3077                            gmx_mtop_t*       mtop)
3078 {
3079     if (state)
3080     {
3081         do_tpx_state_first(serializer, tpx, state);
3082     }
3083     do_tpx_mtop(serializer, tpx, mtop);
3084     if (state)
3085     {
3086         do_tpx_state_second(serializer, tpx, state, x, v);
3087     }
3088     PbcType pbcType = do_tpx_ir(serializer, tpx, ir);
3089     if (serializer->reading())
3090     {
3091         do_tpx_finalize(tpx, ir, state, mtop);
3092     }
3093     return pbcType;
3094 }
3095
3096 /*! \brief
3097  * Overload for do_tpx_body that defaults to state vectors being nullptr.
3098  *
3099  * \param[in] serializer Abstract serializer used to read/write data.
3100  * \param[in] tpx The file header data.
3101  * \param[in,out] ir Datastructures with simulation parameters.
3102  * \param[in,out] mtop Global topology.
3103  */
3104 static PbcType do_tpx_body(gmx::ISerializer* serializer, TpxFileHeader* tpx, t_inputrec* ir, gmx_mtop_t* mtop)
3105 {
3106     return do_tpx_body(serializer, tpx, ir, nullptr, nullptr, nullptr, mtop);
3107 }
3108
3109 static t_fileio* open_tpx(const char* fn, const char* mode)
3110 {
3111     return gmx_fio_open(fn, mode);
3112 }
3113
3114 static void close_tpx(t_fileio* fio)
3115 {
3116     gmx_fio_close(fio);
3117 }
3118
3119 /*! \brief
3120  * Fill information into the header only from state before writing.
3121  *
3122  * Populating the header needs to be independent from writing the information
3123  * to file to allow things like writing the raw byte stream.
3124  *
3125  * \param[in] state The current simulation state. Can't write without it.
3126  * \param[in] ir Parameter and system information.
3127  * \param[in] mtop Global topology.
3128  * \returns Fully populated header.
3129  */
3130 static TpxFileHeader populateTpxHeader(const t_state& state, const t_inputrec* ir, const gmx_mtop_t* mtop)
3131 {
3132     TpxFileHeader header;
3133     header.natoms         = state.natoms;
3134     header.ngtc           = state.ngtc;
3135     header.fep_state      = state.fep_state;
3136     header.lambda         = state.lambda[efptFEP];
3137     header.bIr            = ir != nullptr;
3138     header.bTop           = mtop != nullptr;
3139     header.bX             = (state.flags & (1 << estX)) != 0;
3140     header.bV             = (state.flags & (1 << estV)) != 0;
3141     header.bF             = false;
3142     header.bBox           = true;
3143     header.fileVersion    = tpx_version;
3144     header.fileGeneration = tpx_generation;
3145     header.isDouble       = (sizeof(real) == sizeof(double));
3146
3147     return header;
3148 }
3149
3150 /*! \brief
3151  * Process the body of a TPR file as an opaque data buffer.
3152  *
3153  * Reads/writes the information in \p buffer from/to the \p serializer
3154  * provided to the function. Does not interact with the actual
3155  * TPR datastructures but with an in memory representation of the
3156  * data, so that this data can be efficiently read or written from/to
3157  * an original source.
3158  *
3159  * \param[in] serializer The abstract serializer used for reading or writing
3160  *                       the information in \p buffer.
3161  * \param[in,out] buffer Information from TPR file as char buffer.
3162  */
3163 static void doTpxBodyBuffer(gmx::ISerializer* serializer, gmx::ArrayRef<char> buffer)
3164 {
3165     serializer->doOpaque(buffer.data(), buffer.size());
3166 }
3167
3168 /*! \brief
3169  * Populates simulation datastructures.
3170  *
3171  * Here the information from the serialization interface \p serializer
3172  * is used to first populate the datastructures containing the simulation
3173  * information. Depending on the version found in the header \p tpx,
3174  * this is done using the new reading of the data as one block from disk,
3175  * followed by complete deserialization of the information read from there.
3176  * Otherwise, the datastructures are populated as before one by one from disk.
3177  * The second version is the default for the legacy tools that read the
3178  * coordinates and velocities separate from the state.
3179  *
3180  * After reading in the data, a separate buffer is populated from them
3181  * containing only \p ir and \p mtop that can be communicated directly
3182  * to nodes needing the information to set up a simulation.
3183  *
3184  * \param[in] tpx The file header.
3185  * \param[in] serializer The Serialization interface used to read the TPR.
3186  * \param[out] ir Input rec to populate.
3187  * \param[out] state State vectors to populate.
3188  * \param[out] x Coordinates to populate if needed.
3189  * \param[out] v Velocities to populate if needed.
3190  * \param[out] mtop Global topology to populate.
3191  *
3192  * \returns Partial de-serialized TPR used for communication to nodes.
3193  */
3194 static PartialDeserializedTprFile readTpxBody(TpxFileHeader*    tpx,
3195                                               gmx::ISerializer* serializer,
3196                                               t_inputrec*       ir,
3197                                               t_state*          state,
3198                                               rvec*             x,
3199                                               rvec*             v,
3200                                               gmx_mtop_t*       mtop)
3201 {
3202     PartialDeserializedTprFile partialDeserializedTpr;
3203     if (tpx->fileVersion >= tpxv_AddSizeField && tpx->fileGeneration >= 27)
3204     {
3205         partialDeserializedTpr.body.resize(tpx->sizeOfTprBody);
3206         partialDeserializedTpr.header = *tpx;
3207         doTpxBodyBuffer(serializer, partialDeserializedTpr.body);
3208
3209         partialDeserializedTpr.pbcType =
3210                 completeTprDeserialization(&partialDeserializedTpr, ir, state, x, v, mtop);
3211     }
3212     else
3213     {
3214         partialDeserializedTpr.pbcType = do_tpx_body(serializer, tpx, ir, state, x, v, mtop);
3215     }
3216     // Update header to system info for communication to nodes.
3217     // As we only need to communicate the inputrec and mtop to other nodes,
3218     // we prepare a new char buffer with the information we have already read
3219     // in on master.
3220     partialDeserializedTpr.header = populateTpxHeader(*state, ir, mtop);
3221     // Long-term we should move to use little endian in files to avoid extra byte swapping,
3222     // but since we just used the default XDR format (which is big endian) for the TPR
3223     // header it would cause third-party libraries reading our raw data to tear their hair
3224     // if we swap the endian in the middle of the file, so we stick to big endian in the
3225     // TPR file for now - and thus we ask the serializer to swap if this host is little endian.
3226     gmx::InMemorySerializer tprBodySerializer(gmx::EndianSwapBehavior::SwapIfHostIsLittleEndian);
3227     do_tpx_body(&tprBodySerializer, &partialDeserializedTpr.header, ir, mtop);
3228     partialDeserializedTpr.body = tprBodySerializer.finishAndGetBuffer();
3229
3230     return partialDeserializedTpr;
3231 }
3232
3233 /************************************************************
3234  *
3235  *  The following routines are the exported ones
3236  *
3237  ************************************************************/
3238
3239 TpxFileHeader readTpxHeader(const char* fileName, bool canReadTopologyOnly)
3240 {
3241     t_fileio* fio;
3242
3243     fio = open_tpx(fileName, "r");
3244     gmx::FileIOXdrSerializer serializer(fio);
3245
3246     TpxFileHeader tpx;
3247     do_tpxheader(&serializer, &tpx, fileName, fio, canReadTopologyOnly);
3248     close_tpx(fio);
3249     return tpx;
3250 }
3251
3252 void write_tpx_state(const char* fn, const t_inputrec* ir, const t_state* state, const gmx_mtop_t* mtop)
3253 {
3254     /* To write a state, we first need to write the state information to a buffer before
3255      * we append the raw bytes to the file. For this, the header information needs to be
3256      * populated before we write the main body because it has some information that is
3257      * otherwise not available.
3258      */
3259
3260     t_fileio* fio;
3261
3262     TpxFileHeader tpx = populateTpxHeader(*state, ir, mtop);
3263     // Long-term we should move to use little endian in files to avoid extra byte swapping,
3264     // but since we just used the default XDR format (which is big endian) for the TPR
3265     // header it would cause third-party libraries reading our raw data to tear their hair
3266     // if we swap the endian in the middle of the file, so we stick to big endian in the
3267     // TPR file for now - and thus we ask the serializer to swap if this host is little endian.
3268     gmx::InMemorySerializer tprBodySerializer(gmx::EndianSwapBehavior::SwapIfHostIsLittleEndian);
3269
3270     do_tpx_body(&tprBodySerializer, &tpx, const_cast<t_inputrec*>(ir), const_cast<t_state*>(state),
3271                 nullptr, nullptr, const_cast<gmx_mtop_t*>(mtop));
3272
3273     std::vector<char> tprBody = tprBodySerializer.finishAndGetBuffer();
3274     tpx.sizeOfTprBody         = tprBody.size();
3275
3276     fio = open_tpx(fn, "w");
3277     gmx::FileIOXdrSerializer serializer(fio);
3278     do_tpxheader(&serializer, &tpx, fn, fio, ir == nullptr);
3279     doTpxBodyBuffer(&serializer, tprBody);
3280
3281     close_tpx(fio);
3282 }
3283
3284 PbcType completeTprDeserialization(PartialDeserializedTprFile* partialDeserializedTpr,
3285                                    t_inputrec*                 ir,
3286                                    t_state*                    state,
3287                                    rvec*                       x,
3288                                    rvec*                       v,
3289                                    gmx_mtop_t*                 mtop)
3290 {
3291     // Long-term we should move to use little endian in files to avoid extra byte swapping,
3292     // but since we just used the default XDR format (which is big endian) for the TPR
3293     // header it would cause third-party libraries reading our raw data to tear their hair
3294     // if we swap the endian in the middle of the file, so we stick to big endian in the
3295     // TPR file for now - and thus we ask the serializer to swap if this host is little endian.
3296     gmx::InMemoryDeserializer tprBodyDeserializer(partialDeserializedTpr->body,
3297                                                   partialDeserializedTpr->header.isDouble,
3298                                                   gmx::EndianSwapBehavior::SwapIfHostIsLittleEndian);
3299     return do_tpx_body(&tprBodyDeserializer, &partialDeserializedTpr->header, ir, state, x, v, mtop);
3300 }
3301
3302 PbcType completeTprDeserialization(PartialDeserializedTprFile* partialDeserializedTpr,
3303                                    t_inputrec*                 ir,
3304                                    gmx_mtop_t*                 mtop)
3305 {
3306     return completeTprDeserialization(partialDeserializedTpr, ir, nullptr, nullptr, nullptr, mtop);
3307 }
3308
3309 PartialDeserializedTprFile read_tpx_state(const char* fn, t_inputrec* ir, t_state* state, gmx_mtop_t* mtop)
3310 {
3311     t_fileio* fio;
3312     fio = open_tpx(fn, "r");
3313     gmx::FileIOXdrSerializer   serializer(fio);
3314     PartialDeserializedTprFile partialDeserializedTpr;
3315     do_tpxheader(&serializer, &partialDeserializedTpr.header, fn, fio, ir == nullptr);
3316     partialDeserializedTpr =
3317             readTpxBody(&partialDeserializedTpr.header, &serializer, ir, state, nullptr, nullptr, mtop);
3318     close_tpx(fio);
3319     return partialDeserializedTpr;
3320 }
3321
3322 PbcType read_tpx(const char* fn, t_inputrec* ir, matrix box, int* natoms, rvec* x, rvec* v, gmx_mtop_t* mtop)
3323 {
3324     t_fileio* fio;
3325     t_state   state;
3326
3327     TpxFileHeader tpx;
3328     fio = open_tpx(fn, "r");
3329     gmx::FileIOXdrSerializer serializer(fio);
3330     do_tpxheader(&serializer, &tpx, fn, fio, ir == nullptr);
3331     PartialDeserializedTprFile partialDeserializedTpr =
3332             readTpxBody(&tpx, &serializer, ir, &state, x, v, mtop);
3333     close_tpx(fio);
3334     if (mtop != nullptr && natoms != nullptr)
3335     {
3336         *natoms = mtop->natoms;
3337     }
3338     if (box)
3339     {
3340         copy_mat(state.box, box);
3341     }
3342     return partialDeserializedTpr.pbcType;
3343 }
3344
3345 PbcType read_tpx_top(const char* fn, t_inputrec* ir, matrix box, int* natoms, rvec* x, rvec* v, t_topology* top)
3346 {
3347     gmx_mtop_t mtop;
3348     PbcType    pbcType;
3349
3350     pbcType = read_tpx(fn, ir, box, natoms, x, v, &mtop);
3351
3352     *top = gmx_mtop_t_to_t_topology(&mtop, true);
3353
3354     return pbcType;
3355 }
3356
3357 gmx_bool fn2bTPX(const char* file)
3358 {
3359     return (efTPR == fn2ftp(file));
3360 }
3361
3362 void pr_tpxheader(FILE* fp, int indent, const char* title, const TpxFileHeader* sh)
3363 {
3364     if (available(fp, sh, indent, title))
3365     {
3366         indent = pr_title(fp, indent, title);
3367         pr_indent(fp, indent);
3368         fprintf(fp, "bIr    = %spresent\n", sh->bIr ? "" : "not ");
3369         pr_indent(fp, indent);
3370         fprintf(fp, "bBox   = %spresent\n", sh->bBox ? "" : "not ");
3371         pr_indent(fp, indent);
3372         fprintf(fp, "bTop   = %spresent\n", sh->bTop ? "" : "not ");
3373         pr_indent(fp, indent);
3374         fprintf(fp, "bX     = %spresent\n", sh->bX ? "" : "not ");
3375         pr_indent(fp, indent);
3376         fprintf(fp, "bV     = %spresent\n", sh->bV ? "" : "not ");
3377         pr_indent(fp, indent);
3378         fprintf(fp, "bF     = %spresent\n", sh->bF ? "" : "not ");
3379
3380         pr_indent(fp, indent);
3381         fprintf(fp, "natoms = %d\n", sh->natoms);
3382         pr_indent(fp, indent);
3383         fprintf(fp, "lambda = %e\n", sh->lambda);
3384         pr_indent(fp, indent);
3385         fprintf(fp, "buffer size = %" PRId64 "\n", sh->sizeOfTprBody);
3386     }
3387 }