2 * This file is part of the GROMACS molecular simulation package.
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,2021, 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.
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.
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.
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.
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.
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.
40 /* This file is completely threadsafe - keep it that way! */
42 #include "gromacs/fileio/tpxio.h"
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"
84 #define TPX_TAG_RELEASE "release"
86 /*! \brief Tag string for the file format written to run input files
87 * written by this version of the code.
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.
96 static const char* tpx_tag = TPX_TAG_RELEASE;
98 /*! \brief Enum of values that describe the contents of a tpr file
99 * whose format matches a version number
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.
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_RemovedConstantAcceleration, /**< Removed support for constant acceleration NEMD. */
138 tpxv_Count /**< the total number of tpxv versions */
141 /*! \brief Version number of the file format written to run input
142 * files by this version of the code.
144 * The tpx_version increases whenever the file format in the main
145 * development branch changes, due to an extension of the tpxv enum above.
146 * Backward compatibility for reading old run input files is maintained
147 * by checking this version number against that of the file and then using
148 * the correct code path.
150 * When developing a feature branch that needs to change the run input
151 * file format, change tpx_tag instead. */
152 static const int tpx_version = tpxv_Count - 1;
156 * Enum keeping track of incompatible changes for older TPR versions.
158 * The enum should be updated with a new field when editing the TOPOLOGY
159 * or HEADER of the tpx format. In particular, updating ftupd or
160 * changing the fields of TprHeaderVersion often trigger such needs.
162 * This way we can maintain forward compatibility too for all analysis tools
163 * and/or external programs that only need to know the atom/residue names,
164 * charges, and bond connectivity.
166 * It first appeared in tpx version 26, when I also moved the inputrecord
167 * to the end of the tpx file, so we can just skip it if we only
170 * In particular, it must be increased when adding new elements to
171 * ftupd, so that old code can read new .tpr files.
173 enum class TpxGeneration : int
175 Initial = 26, //! First version is 26
176 AddSizeField, //! TPR header modified for writing as a block.
177 AddVSite1, //! ftupd changed to include VSite1 type.
178 Count //! Number of entries.
181 //! Value of Current TPR generation.
182 static const int tpx_generation = static_cast<int>(TpxGeneration::Count) - 1;
184 /* This number should be the most recent backwards incompatible version
185 * I.e., if this number is 9, we cannot read tpx version 9 with this code.
187 static const int tpx_incompatible_version = 57; // GMX4.0 has version 58
190 /* Struct used to maintain tpx compatibility when function types are added */
193 int fvnr; /* file version number in which the function type first appeared */
194 int ftype; /* function type */
198 * TODO The following three lines make little sense, please clarify if
199 * you've had to work out how ftupd works.
201 * The entries should be ordered in:
202 * 1. ascending function type number
203 * 2. ascending file version number
205 * Because we support reading of old .tpr file versions (even when
206 * mdrun can no longer run the simulation), we need to be able to read
207 * obsolete t_interaction_function types. Any data read from such
208 * fields is discarded. Their names have _NOLONGERUSED appended to
209 * them to make things clear.
211 * When adding to or making breaking changes to reading this struct,
212 * update TpxGeneration.
214 static const t_ftupd ftupd[] = {
215 { 70, F_RESTRBONDS },
216 { tpxv_RestrictedBendingAndCombinedAngleTorsionPotentials, F_RESTRANGLES },
217 { 76, F_LINEAR_ANGLES },
218 { tpxv_RestrictedBendingAndCombinedAngleTorsionPotentials, F_RESTRDIHS },
219 { tpxv_RestrictedBendingAndCombinedAngleTorsionPotentials, F_CBTDIHS },
221 { 60, F_GB12_NOLONGERUSED },
222 { 61, F_GB13_NOLONGERUSED },
223 { 61, F_GB14_NOLONGERUSED },
224 { 72, F_GBPOL_NOLONGERUSED },
225 { 72, F_NPSOLVATION_NOLONGERUSED },
227 { 76, F_ANHARM_POL },
229 { tpxv_VSite1, F_VSITE1 },
230 { tpxv_VSite2FD, F_VSITE2FD },
231 { tpxv_GenericInternalParameters, F_DENSITYFITTING },
232 { 69, F_VTEMP_NOLONGERUSED },
243 { 79, F_DVDL_RESTRAINT },
244 { 79, F_DVDL_TEMPERATURE },
246 #define NFTUPD asize(ftupd)
248 /* Needed for backward compatibility */
251 /**************************************************************
253 * Now the higer level routines that do io of the structures and arrays
255 **************************************************************/
256 static void do_pullgrp_tpx_pre95(gmx::ISerializer* serializer, t_pull_group* pgrp, t_pull_coord* pcrd)
260 int numAtoms = pgrp->ind.size();
261 serializer->doInt(&numAtoms);
262 pgrp->ind.resize(numAtoms);
263 serializer->doIntArray(pgrp->ind.data(), numAtoms);
264 int numWeights = pgrp->weight.size();
265 serializer->doInt(&numWeights);
266 pgrp->weight.resize(numWeights);
267 serializer->doRealArray(pgrp->weight.data(), numWeights);
268 serializer->doInt(&pgrp->pbcatom);
269 serializer->doRvec(&pcrd->vec.as_vec());
270 clear_rvec(pcrd->origin);
271 serializer->doRvec(&tmp);
273 serializer->doReal(&pcrd->rate);
274 serializer->doReal(&pcrd->k);
275 serializer->doReal(&pcrd->kB);
278 static void do_pull_group(gmx::ISerializer* serializer, t_pull_group* pgrp)
280 int numAtoms = pgrp->ind.size();
281 serializer->doInt(&numAtoms);
282 pgrp->ind.resize(numAtoms);
283 serializer->doIntArray(pgrp->ind.data(), numAtoms);
284 int numWeights = pgrp->weight.size();
285 serializer->doInt(&numWeights);
286 pgrp->weight.resize(numWeights);
287 serializer->doRealArray(pgrp->weight.data(), numWeights);
288 serializer->doInt(&pgrp->pbcatom);
291 static void do_pull_coord(gmx::ISerializer* serializer,
298 if (file_version >= tpxv_PullCoordNGroup)
300 serializer->doInt(&pcrd->eType);
301 if (file_version >= tpxv_PullExternalPotential)
303 if (pcrd->eType == epullEXTERNAL)
306 if (serializer->reading())
308 serializer->doString(&buf);
309 pcrd->externalPotentialProvider = gmx_strdup(buf.c_str());
313 buf = pcrd->externalPotentialProvider;
314 serializer->doString(&buf);
319 pcrd->externalPotentialProvider.clear();
324 if (serializer->reading())
326 pcrd->externalPotentialProvider.clear();
329 /* Note that we try to support adding new geometries without
330 * changing the tpx version. This requires checks when printing the
331 * geometry string and a check and fatal_error in init_pull.
333 serializer->doInt(&pcrd->eGeom);
334 serializer->doInt(&pcrd->ngroup);
335 if (pcrd->ngroup <= c_pullCoordNgroupMax)
337 serializer->doIntArray(pcrd->group.data(), pcrd->ngroup);
341 /* More groups in file than supported, this must be a new geometry
342 * that is not supported by our current code. Since we will not
343 * use the groups for this coord (checks in the pull and WHAM code
344 * ensure this), we can ignore the groups and set ngroup=0.
347 snew(dum, pcrd->ngroup);
348 serializer->doIntArray(dum, pcrd->ngroup);
353 serializer->doIvec(&pcrd->dim.as_vec());
358 serializer->doInt(&pcrd->group[0]);
359 serializer->doInt(&pcrd->group[1]);
360 if (file_version >= tpxv_PullCoordTypeGeom)
362 pcrd->ngroup = (pcrd->eGeom == epullgDIRRELATIVE ? 4 : 2);
363 serializer->doInt(&pcrd->eType);
364 serializer->doInt(&pcrd->eGeom);
365 if (pcrd->ngroup == 4)
367 serializer->doInt(&pcrd->group[2]);
368 serializer->doInt(&pcrd->group[3]);
370 serializer->doIvec(&pcrd->dim.as_vec());
374 pcrd->eType = ePullOld;
375 pcrd->eGeom = eGeomOld;
376 copy_ivec(dimOld, pcrd->dim);
379 serializer->doRvec(&pcrd->origin.as_vec());
380 serializer->doRvec(&pcrd->vec.as_vec());
381 if (file_version >= tpxv_PullCoordTypeGeom)
383 serializer->doBool(&pcrd->bStart);
387 /* This parameter is only printed, but not actually used by mdrun */
388 pcrd->bStart = FALSE;
390 serializer->doReal(&pcrd->init);
391 serializer->doReal(&pcrd->rate);
392 serializer->doReal(&pcrd->k);
393 serializer->doReal(&pcrd->kB);
396 static void do_expandedvals(gmx::ISerializer* serializer, t_expanded* expand, t_lambda* fepvals, int file_version)
398 int n_lambda = fepvals->n_lambda;
400 /* reset the lambda calculation window */
401 fepvals->lambda_start_n = 0;
402 fepvals->lambda_stop_n = n_lambda;
403 if (file_version >= 79)
407 if (serializer->reading())
409 snew(expand->init_lambda_weights, n_lambda);
411 serializer->doRealArray(expand->init_lambda_weights, n_lambda);
412 serializer->doBool(&expand->bInit_weights);
415 serializer->doInt(&expand->nstexpanded);
416 serializer->doInt(&expand->elmcmove);
417 serializer->doInt(&expand->elamstats);
418 serializer->doInt(&expand->lmc_repeats);
419 serializer->doInt(&expand->gibbsdeltalam);
420 serializer->doInt(&expand->lmc_forced_nstart);
421 serializer->doInt(&expand->lmc_seed);
422 serializer->doReal(&expand->mc_temp);
423 serializer->doBool(&expand->bSymmetrizedTMatrix);
424 serializer->doInt(&expand->nstTij);
425 serializer->doInt(&expand->minvarmin);
426 serializer->doInt(&expand->c_range);
427 serializer->doReal(&expand->wl_scale);
428 serializer->doReal(&expand->wl_ratio);
429 serializer->doReal(&expand->init_wl_delta);
430 serializer->doBool(&expand->bWLoneovert);
431 serializer->doInt(&expand->elmceq);
432 serializer->doInt(&expand->equil_steps);
433 serializer->doInt(&expand->equil_samples);
434 serializer->doInt(&expand->equil_n_at_lam);
435 serializer->doReal(&expand->equil_wl_delta);
436 serializer->doReal(&expand->equil_ratio);
440 static void do_simtempvals(gmx::ISerializer* serializer, t_simtemp* simtemp, int n_lambda, int file_version)
442 if (file_version >= 79)
444 serializer->doInt(&simtemp->eSimTempScale);
445 serializer->doReal(&simtemp->simtemp_high);
446 serializer->doReal(&simtemp->simtemp_low);
449 if (serializer->reading())
451 snew(simtemp->temperatures, n_lambda);
453 serializer->doRealArray(simtemp->temperatures, n_lambda);
458 static void do_imd(gmx::ISerializer* serializer, t_IMD* imd)
460 serializer->doInt(&imd->nat);
461 if (serializer->reading())
463 snew(imd->ind, imd->nat);
465 serializer->doIntArray(imd->ind, imd->nat);
468 static void do_fepvals(gmx::ISerializer* serializer, t_lambda* fepvals, int file_version)
470 /* i is defined in the ndo_double macro; use g to iterate. */
474 /* free energy values */
476 if (file_version >= 79)
478 serializer->doInt(&fepvals->init_fep_state);
479 serializer->doDouble(&fepvals->init_lambda);
480 serializer->doDouble(&fepvals->delta_lambda);
482 else if (file_version >= 59)
484 serializer->doDouble(&fepvals->init_lambda);
485 serializer->doDouble(&fepvals->delta_lambda);
489 serializer->doReal(&rdum);
490 fepvals->init_lambda = rdum;
491 serializer->doReal(&rdum);
492 fepvals->delta_lambda = rdum;
494 if (file_version >= 79)
496 serializer->doInt(&fepvals->n_lambda);
497 if (serializer->reading())
499 snew(fepvals->all_lambda, efptNR);
501 for (g = 0; g < efptNR; g++)
503 if (fepvals->n_lambda > 0)
505 if (serializer->reading())
507 snew(fepvals->all_lambda[g], fepvals->n_lambda);
509 serializer->doDoubleArray(fepvals->all_lambda[g], fepvals->n_lambda);
510 serializer->doBoolArray(fepvals->separate_dvdl, efptNR);
512 else if (fepvals->init_lambda >= 0)
514 fepvals->separate_dvdl[efptFEP] = TRUE;
518 else if (file_version >= 64)
520 serializer->doInt(&fepvals->n_lambda);
521 if (serializer->reading())
525 snew(fepvals->all_lambda, efptNR);
526 /* still allocate the all_lambda array's contents. */
527 for (g = 0; g < efptNR; g++)
529 if (fepvals->n_lambda > 0)
531 snew(fepvals->all_lambda[g], fepvals->n_lambda);
535 serializer->doDoubleArray(fepvals->all_lambda[efptFEP], fepvals->n_lambda);
536 if (fepvals->init_lambda >= 0)
540 fepvals->separate_dvdl[efptFEP] = TRUE;
542 if (serializer->reading())
544 /* copy the contents of the efptFEP lambda component to all
545 the other components */
546 for (g = 0; g < efptNR; g++)
548 for (h = 0; h < fepvals->n_lambda; h++)
552 fepvals->all_lambda[g][h] = fepvals->all_lambda[efptFEP][h];
561 fepvals->n_lambda = 0;
562 fepvals->all_lambda = nullptr;
563 if (fepvals->init_lambda >= 0)
565 fepvals->separate_dvdl[efptFEP] = TRUE;
568 serializer->doReal(&fepvals->sc_alpha);
569 serializer->doInt(&fepvals->sc_power);
570 if (file_version >= 79)
572 serializer->doReal(&fepvals->sc_r_power);
576 fepvals->sc_r_power = 6.0;
578 if (fepvals->sc_r_power != 6.0)
580 gmx_fatal(FARGS, "sc-r-power=48 is no longer supported");
582 serializer->doReal(&fepvals->sc_sigma);
583 if (serializer->reading())
585 if (file_version >= 71)
587 fepvals->sc_sigma_min = fepvals->sc_sigma;
591 fepvals->sc_sigma_min = 0;
594 if (file_version >= 79)
596 serializer->doBool(&fepvals->bScCoul);
600 fepvals->bScCoul = TRUE;
602 if (file_version >= 64)
604 serializer->doInt(&fepvals->nstdhdl);
608 fepvals->nstdhdl = 1;
611 if (file_version >= 73)
613 serializer->doInt(&fepvals->separate_dhdl_file);
614 serializer->doInt(&fepvals->dhdl_derivatives);
618 fepvals->separate_dhdl_file = esepdhdlfileYES;
619 fepvals->dhdl_derivatives = edhdlderivativesYES;
621 if (file_version >= 71)
623 serializer->doInt(&fepvals->dh_hist_size);
624 serializer->doDouble(&fepvals->dh_hist_spacing);
628 fepvals->dh_hist_size = 0;
629 fepvals->dh_hist_spacing = 0.1;
631 if (file_version >= 79)
633 serializer->doInt(&fepvals->edHdLPrintEnergy);
637 fepvals->edHdLPrintEnergy = edHdLPrintEnergyNO;
640 /* handle lambda_neighbors */
641 if ((file_version >= 83 && file_version < 90) || file_version >= 92)
643 serializer->doInt(&fepvals->lambda_neighbors);
644 if ((fepvals->lambda_neighbors >= 0) && (fepvals->init_fep_state >= 0)
645 && (fepvals->init_lambda < 0))
647 fepvals->lambda_start_n = (fepvals->init_fep_state - fepvals->lambda_neighbors);
648 fepvals->lambda_stop_n = (fepvals->init_fep_state + fepvals->lambda_neighbors + 1);
649 if (fepvals->lambda_start_n < 0)
651 fepvals->lambda_start_n = 0;
653 if (fepvals->lambda_stop_n >= fepvals->n_lambda)
655 fepvals->lambda_stop_n = fepvals->n_lambda;
660 fepvals->lambda_start_n = 0;
661 fepvals->lambda_stop_n = fepvals->n_lambda;
666 fepvals->lambda_start_n = 0;
667 fepvals->lambda_stop_n = fepvals->n_lambda;
671 static void do_awhBias(gmx::ISerializer* serializer, gmx::AwhBiasParams* awhBiasParams, int gmx_unused file_version)
673 serializer->doInt(&awhBiasParams->eTarget);
674 serializer->doDouble(&awhBiasParams->targetBetaScaling);
675 serializer->doDouble(&awhBiasParams->targetCutoff);
676 serializer->doInt(&awhBiasParams->eGrowth);
677 serializer->doInt(&awhBiasParams->bUserData);
678 serializer->doDouble(&awhBiasParams->errorInitial);
679 serializer->doInt(&awhBiasParams->ndim);
680 serializer->doInt(&awhBiasParams->shareGroup);
681 serializer->doBool(&awhBiasParams->equilibrateHistogram);
683 if (serializer->reading())
685 snew(awhBiasParams->dimParams, awhBiasParams->ndim);
688 for (int d = 0; d < awhBiasParams->ndim; d++)
690 gmx::AwhDimParams* dimParams = &awhBiasParams->dimParams[d];
692 serializer->doInt(&dimParams->eCoordProvider);
693 serializer->doInt(&dimParams->coordIndex);
694 serializer->doDouble(&dimParams->origin);
695 serializer->doDouble(&dimParams->end);
696 serializer->doDouble(&dimParams->period);
697 serializer->doDouble(&dimParams->forceConstant);
698 serializer->doDouble(&dimParams->diffusion);
699 serializer->doDouble(&dimParams->coordValueInit);
700 serializer->doDouble(&dimParams->coverDiameter);
704 static void do_awh(gmx::ISerializer* serializer, gmx::AwhParams* awhParams, int gmx_unused file_version)
706 serializer->doInt(&awhParams->numBias);
707 serializer->doInt(&awhParams->nstOut);
708 serializer->doInt64(&awhParams->seed);
709 serializer->doInt(&awhParams->nstSampleCoord);
710 serializer->doInt(&awhParams->numSamplesUpdateFreeEnergy);
711 serializer->doInt(&awhParams->ePotential);
712 serializer->doBool(&awhParams->shareBiasMultisim);
714 if (awhParams->numBias > 0)
716 if (serializer->reading())
718 snew(awhParams->awhBiasParams, awhParams->numBias);
721 for (int k = 0; k < awhParams->numBias; k++)
723 do_awhBias(serializer, &awhParams->awhBiasParams[k], file_version);
728 static void do_pull(gmx::ISerializer* serializer, pull_params_t* pull, int file_version, int ePullOld)
734 if (file_version >= 95)
736 serializer->doInt(&pull->ngroup);
738 serializer->doInt(&pull->ncoord);
739 if (file_version < 95)
741 pull->ngroup = pull->ncoord + 1;
743 if (file_version < tpxv_PullCoordTypeGeom)
747 serializer->doInt(&eGeomOld);
748 serializer->doIvec(&dimOld);
749 /* The inner cylinder radius, now removed */
750 serializer->doReal(&dum);
752 serializer->doReal(&pull->cylinder_r);
753 serializer->doReal(&pull->constr_tol);
754 if (file_version >= 95)
756 serializer->doBool(&pull->bPrintCOM);
757 /* With file_version < 95 this value is set below */
759 if (file_version >= tpxv_ReplacePullPrintCOM12)
761 serializer->doBool(&pull->bPrintRefValue);
762 serializer->doBool(&pull->bPrintComp);
764 else if (file_version >= tpxv_PullCoordTypeGeom)
767 serializer->doInt(&idum); /* used to be bPrintCOM2 */
768 serializer->doBool(&pull->bPrintRefValue);
769 serializer->doBool(&pull->bPrintComp);
773 pull->bPrintRefValue = FALSE;
774 pull->bPrintComp = TRUE;
776 serializer->doInt(&pull->nstxout);
777 serializer->doInt(&pull->nstfout);
778 if (file_version >= tpxv_PullPrevStepCOMAsReference)
780 serializer->doBool(&pull->bSetPbcRefToPrevStepCOM);
784 pull->bSetPbcRefToPrevStepCOM = FALSE;
786 pull->group.resize(pull->ngroup);
787 pull->coord.resize(pull->ncoord);
788 if (file_version < 95)
790 /* epullgPOS for position pulling, before epullgDIRPBC was removed */
791 if (eGeomOld == epullgDIRPBC)
793 gmx_fatal(FARGS, "pull-geometry=position is no longer supported");
795 if (eGeomOld > epullgDIRPBC)
800 for (g = 0; g < pull->ngroup; g++)
802 /* We read and ignore a pull coordinate for group 0 */
803 do_pullgrp_tpx_pre95(serializer, &pull->group[g], &pull->coord[std::max(g - 1, 0)]);
806 pull->coord[g - 1].group[0] = 0;
807 pull->coord[g - 1].group[1] = g;
811 pull->bPrintCOM = (!pull->group[0].ind.empty());
815 for (g = 0; g < pull->ngroup; g++)
817 do_pull_group(serializer, &pull->group[g]);
819 for (g = 0; g < pull->ncoord; g++)
821 do_pull_coord(serializer, &pull->coord[g], file_version, ePullOld, eGeomOld, dimOld);
824 if (file_version >= tpxv_PullAverage)
828 v = pull->bXOutAverage;
829 serializer->doBool(&v);
830 pull->bXOutAverage = v;
831 v = pull->bFOutAverage;
832 serializer->doBool(&v);
833 pull->bFOutAverage = v;
838 static void do_rotgrp(gmx::ISerializer* serializer, t_rotgrp* rotg)
840 serializer->doInt(&rotg->eType);
841 serializer->doInt(&rotg->bMassW);
842 serializer->doInt(&rotg->nat);
843 if (serializer->reading())
845 snew(rotg->ind, rotg->nat);
847 serializer->doIntArray(rotg->ind, rotg->nat);
848 if (serializer->reading())
850 snew(rotg->x_ref, rotg->nat);
852 serializer->doRvecArray(rotg->x_ref, rotg->nat);
853 serializer->doRvec(&rotg->inputVec);
854 serializer->doRvec(&rotg->pivot);
855 serializer->doReal(&rotg->rate);
856 serializer->doReal(&rotg->k);
857 serializer->doReal(&rotg->slab_dist);
858 serializer->doReal(&rotg->min_gaussian);
859 serializer->doReal(&rotg->eps);
860 serializer->doInt(&rotg->eFittype);
861 serializer->doInt(&rotg->PotAngle_nstep);
862 serializer->doReal(&rotg->PotAngle_step);
865 static void do_rot(gmx::ISerializer* serializer, t_rot* rot)
869 serializer->doInt(&rot->ngrp);
870 serializer->doInt(&rot->nstrout);
871 serializer->doInt(&rot->nstsout);
872 if (serializer->reading())
874 snew(rot->grp, rot->ngrp);
876 for (g = 0; g < rot->ngrp; g++)
878 do_rotgrp(serializer, &rot->grp[g]);
883 static void do_swapgroup(gmx::ISerializer* serializer, t_swapGroup* g)
886 /* Name of the group or molecule */
888 if (serializer->reading())
890 serializer->doString(&buf);
891 g->molname = gmx_strdup(buf.c_str());
896 serializer->doString(&buf);
899 /* Number of atoms in the group */
900 serializer->doInt(&g->nat);
902 /* The group's atom indices */
903 if (serializer->reading())
905 snew(g->ind, g->nat);
907 serializer->doIntArray(g->ind, g->nat);
909 /* Requested counts for compartments A and B */
910 serializer->doIntArray(g->nmolReq, eCompNR);
913 static void do_swapcoords_tpx(gmx::ISerializer* serializer, t_swapcoords* swap, int file_version)
915 /* Enums for better readability of the code */
928 if (file_version >= tpxv_CompElPolyatomicIonsAndMultipleIonTypes)
930 /* The total number of swap groups is the sum of the fixed groups
931 * (split0, split1, solvent), and the user-defined groups (2+ types of ions)
933 serializer->doInt(&swap->ngrp);
934 if (serializer->reading())
936 snew(swap->grp, swap->ngrp);
938 for (int ig = 0; ig < swap->ngrp; ig++)
940 do_swapgroup(serializer, &swap->grp[ig]);
942 serializer->doBool(&swap->massw_split[eChannel0]);
943 serializer->doBool(&swap->massw_split[eChannel1]);
944 serializer->doInt(&swap->nstswap);
945 serializer->doInt(&swap->nAverage);
946 serializer->doReal(&swap->threshold);
947 serializer->doReal(&swap->cyl0r);
948 serializer->doReal(&swap->cyl0u);
949 serializer->doReal(&swap->cyl0l);
950 serializer->doReal(&swap->cyl1r);
951 serializer->doReal(&swap->cyl1u);
952 serializer->doReal(&swap->cyl1l);
956 /*** Support reading older CompEl .tpr files ***/
958 /* In the original CompEl .tpr files, we always have 5 groups: */
960 snew(swap->grp, swap->ngrp);
962 swap->grp[eGrpSplit0].molname = gmx_strdup("split0"); // group 0: split0
963 swap->grp[eGrpSplit1].molname = gmx_strdup("split1"); // group 1: split1
964 swap->grp[eGrpSolvent].molname = gmx_strdup("solvent"); // group 2: solvent
965 swap->grp[3].molname = gmx_strdup("anions"); // group 3: anions
966 swap->grp[4].molname = gmx_strdup("cations"); // group 4: cations
968 serializer->doInt(&swap->grp[3].nat);
969 serializer->doInt(&swap->grp[eGrpSolvent].nat);
970 serializer->doInt(&swap->grp[eGrpSplit0].nat);
971 serializer->doBool(&swap->massw_split[eChannel0]);
972 serializer->doInt(&swap->grp[eGrpSplit1].nat);
973 serializer->doBool(&swap->massw_split[eChannel1]);
974 serializer->doInt(&swap->nstswap);
975 serializer->doInt(&swap->nAverage);
976 serializer->doReal(&swap->threshold);
977 serializer->doReal(&swap->cyl0r);
978 serializer->doReal(&swap->cyl0u);
979 serializer->doReal(&swap->cyl0l);
980 serializer->doReal(&swap->cyl1r);
981 serializer->doReal(&swap->cyl1u);
982 serializer->doReal(&swap->cyl1l);
984 // The order[] array keeps compatibility with older .tpr files
985 // by reading in the groups in the classic order
987 const int order[4] = { 3, eGrpSolvent, eGrpSplit0, eGrpSplit1 };
989 for (int ig = 0; ig < 4; ig++)
992 snew(swap->grp[g].ind, swap->grp[g].nat);
993 serializer->doIntArray(swap->grp[g].ind, swap->grp[g].nat);
997 for (int j = eCompA; j <= eCompB; j++)
999 serializer->doInt(&swap->grp[3].nmolReq[j]); // group 3 = anions
1000 serializer->doInt(&swap->grp[4].nmolReq[j]); // group 4 = cations
1002 } /* End support reading older CompEl .tpr files */
1004 if (file_version >= tpxv_CompElWithSwapLayerOffset)
1006 serializer->doReal(&swap->bulkOffset[eCompA]);
1007 serializer->doReal(&swap->bulkOffset[eCompB]);
1011 static void do_legacy_efield(gmx::ISerializer* serializer, gmx::KeyValueTreeObjectBuilder* root)
1013 const char* const dimName[] = { "x", "y", "z" };
1015 auto appliedForcesObj = root->addObject("applied-forces");
1016 auto efieldObj = appliedForcesObj.addObject("electric-field");
1017 // The content of the tpr file for this feature has
1018 // been the same since gromacs 4.0 that was used for
1020 for (int j = 0; j < DIM; ++j)
1023 serializer->doInt(&n);
1024 serializer->doInt(&nt);
1025 std::vector<real> aa(n + 1), phi(nt + 1), at(nt + 1), phit(nt + 1);
1026 serializer->doRealArray(aa.data(), n);
1027 serializer->doRealArray(phi.data(), n);
1028 serializer->doRealArray(at.data(), nt);
1029 serializer->doRealArray(phit.data(), nt);
1032 if (n > 1 || nt > 1)
1035 "Can not handle tpr files with more than one electric field term per "
1038 auto dimObj = efieldObj.addObject(dimName[j]);
1039 dimObj.addValue<real>("E0", aa[0]);
1040 dimObj.addValue<real>("omega", at[0]);
1041 dimObj.addValue<real>("t0", phi[0]);
1042 dimObj.addValue<real>("sigma", phit[0]);
1048 static void do_inputrec(gmx::ISerializer* serializer, t_inputrec* ir, int file_version)
1050 int i, j, k, idum = 0;
1052 gmx_bool bdum = false;
1054 if (file_version != tpx_version)
1056 /* Give a warning about features that are not accessible */
1057 fprintf(stderr, "Note: file tpx version %d, software tpx version %d\n", file_version, tpx_version);
1060 if (file_version == 0)
1065 gmx::KeyValueTreeBuilder paramsBuilder;
1066 gmx::KeyValueTreeObjectBuilder paramsObj = paramsBuilder.rootObject();
1068 /* Basic inputrec stuff */
1069 serializer->doInt(&ir->eI);
1070 if (file_version >= 62)
1072 serializer->doInt64(&ir->nsteps);
1076 serializer->doInt(&idum);
1080 if (file_version >= 62)
1082 serializer->doInt64(&ir->init_step);
1086 serializer->doInt(&idum);
1087 ir->init_step = idum;
1090 serializer->doInt(&ir->simulation_part);
1092 if (file_version >= tpxv_MTS)
1094 serializer->doBool(&ir->useMts);
1095 int numLevels = ir->mtsLevels.size();
1098 serializer->doInt(&numLevels);
1100 ir->mtsLevels.resize(numLevels);
1101 for (auto& mtsLevel : ir->mtsLevels)
1103 int forceGroups = mtsLevel.forceGroups.to_ulong();
1104 serializer->doInt(&forceGroups);
1105 mtsLevel.forceGroups = std::bitset<static_cast<int>(gmx::MtsForceGroups::Count)>(forceGroups);
1106 serializer->doInt(&mtsLevel.stepFactor);
1112 ir->mtsLevels.clear();
1115 if (file_version >= 67)
1117 serializer->doInt(&ir->nstcalcenergy);
1121 ir->nstcalcenergy = 1;
1123 if (file_version >= 81)
1125 serializer->doInt(&ir->cutoff_scheme);
1126 if (file_version < 94)
1128 ir->cutoff_scheme = 1 - ir->cutoff_scheme;
1133 ir->cutoff_scheme = ecutsGROUP;
1135 serializer->doInt(&idum); /* used to be ns_type; not used anymore */
1136 serializer->doInt(&ir->nstlist);
1137 serializer->doInt(&idum); /* used to be ndelta; not used anymore */
1139 serializer->doReal(&ir->rtpi);
1141 serializer->doInt(&ir->nstcomm);
1142 serializer->doInt(&ir->comm_mode);
1144 /* ignore nstcheckpoint */
1145 if (file_version < tpxv_RemoveObsoleteParameters1)
1147 serializer->doInt(&idum);
1150 serializer->doInt(&ir->nstcgsteep);
1152 serializer->doInt(&ir->nbfgscorr);
1154 serializer->doInt(&ir->nstlog);
1155 serializer->doInt(&ir->nstxout);
1156 serializer->doInt(&ir->nstvout);
1157 serializer->doInt(&ir->nstfout);
1158 serializer->doInt(&ir->nstenergy);
1159 serializer->doInt(&ir->nstxout_compressed);
1160 if (file_version >= 59)
1162 serializer->doDouble(&ir->init_t);
1163 serializer->doDouble(&ir->delta_t);
1167 serializer->doReal(&rdum);
1169 serializer->doReal(&rdum);
1172 serializer->doReal(&ir->x_compression_precision);
1173 if (file_version >= 81)
1175 serializer->doReal(&ir->verletbuf_tol);
1179 ir->verletbuf_tol = 0;
1181 serializer->doReal(&ir->rlist);
1182 if (file_version >= 67 && file_version < tpxv_RemoveTwinRange)
1184 if (serializer->reading())
1186 // Reading such a file version could invoke the twin-range
1187 // scheme, about which mdrun should give a fatal error.
1188 real dummy_rlistlong = -1;
1189 serializer->doReal(&dummy_rlistlong);
1191 ir->useTwinRange = (ir->rlist > 0 && (dummy_rlistlong == 0 || dummy_rlistlong > ir->rlist));
1192 // When true, this forces mdrun to issue an error (regardless of
1193 // ir->cutoff_scheme).
1195 // Otherwise, grompp used to set rlistlong actively. Users
1196 // were probably also confused and set rlistlong == rlist.
1197 // However, in all remaining cases, it is safe to let
1198 // mdrun proceed normally.
1203 // No need to read or write anything
1204 ir->useTwinRange = false;
1206 if (file_version >= 82 && file_version != 90)
1208 // Multiple time-stepping is no longer enabled, but the old
1209 // support required the twin-range scheme, for which mdrun
1210 // already emits a fatal error.
1211 int dummy_nstcalclr = -1;
1212 serializer->doInt(&dummy_nstcalclr);
1214 serializer->doInt(&ir->coulombtype);
1215 if (file_version >= 81)
1217 serializer->doInt(&ir->coulomb_modifier);
1221 ir->coulomb_modifier = (ir->cutoff_scheme == ecutsVERLET ? eintmodPOTSHIFT : eintmodNONE);
1223 serializer->doReal(&ir->rcoulomb_switch);
1224 serializer->doReal(&ir->rcoulomb);
1225 serializer->doInt(&ir->vdwtype);
1226 if (file_version >= 81)
1228 serializer->doInt(&ir->vdw_modifier);
1232 ir->vdw_modifier = (ir->cutoff_scheme == ecutsVERLET ? eintmodPOTSHIFT : eintmodNONE);
1234 serializer->doReal(&ir->rvdw_switch);
1235 serializer->doReal(&ir->rvdw);
1236 serializer->doInt(&ir->eDispCorr);
1237 serializer->doReal(&ir->epsilon_r);
1238 serializer->doReal(&ir->epsilon_rf);
1239 serializer->doReal(&ir->tabext);
1241 // This permits reading a .tpr file that used implicit solvent,
1242 // and later permitting mdrun to refuse to run it.
1243 if (serializer->reading())
1245 if (file_version < tpxv_RemoveImplicitSolvation)
1247 serializer->doInt(&idum);
1248 serializer->doInt(&idum);
1249 serializer->doReal(&rdum);
1250 serializer->doReal(&rdum);
1251 serializer->doInt(&idum);
1252 ir->implicit_solvent = (idum > 0);
1256 ir->implicit_solvent = false;
1258 if (file_version < tpxv_RemoveImplicitSolvation)
1260 serializer->doReal(&rdum);
1261 serializer->doReal(&rdum);
1262 serializer->doReal(&rdum);
1263 serializer->doReal(&rdum);
1264 if (file_version >= 60)
1266 serializer->doReal(&rdum);
1267 serializer->doInt(&idum);
1269 serializer->doReal(&rdum);
1273 if (file_version >= 81)
1275 serializer->doReal(&ir->fourier_spacing);
1279 ir->fourier_spacing = 0.0;
1281 serializer->doInt(&ir->nkx);
1282 serializer->doInt(&ir->nky);
1283 serializer->doInt(&ir->nkz);
1284 serializer->doInt(&ir->pme_order);
1285 serializer->doReal(&ir->ewald_rtol);
1287 if (file_version >= 93)
1289 serializer->doReal(&ir->ewald_rtol_lj);
1293 ir->ewald_rtol_lj = ir->ewald_rtol;
1295 serializer->doInt(&ir->ewald_geometry);
1296 serializer->doReal(&ir->epsilon_surface);
1298 /* ignore bOptFFT */
1299 if (file_version < tpxv_RemoveObsoleteParameters1)
1301 serializer->doBool(&bdum);
1304 if (file_version >= 93)
1306 serializer->doInt(&ir->ljpme_combination_rule);
1308 serializer->doBool(&ir->bContinuation);
1309 serializer->doInt(&ir->etc);
1310 /* before version 18, ir->etc was a gmx_bool (ir->btc),
1311 * but the values 0 and 1 still mean no and
1312 * berendsen temperature coupling, respectively.
1314 if (file_version >= 79)
1316 serializer->doBool(&ir->bPrintNHChains);
1318 if (file_version >= 71)
1320 serializer->doInt(&ir->nsttcouple);
1324 ir->nsttcouple = ir->nstcalcenergy;
1326 serializer->doInt(&ir->epc);
1327 serializer->doInt(&ir->epct);
1328 if (file_version >= 71)
1330 serializer->doInt(&ir->nstpcouple);
1334 ir->nstpcouple = ir->nstcalcenergy;
1336 serializer->doReal(&ir->tau_p);
1337 serializer->doRvec(&ir->ref_p[XX]);
1338 serializer->doRvec(&ir->ref_p[YY]);
1339 serializer->doRvec(&ir->ref_p[ZZ]);
1340 serializer->doRvec(&ir->compress[XX]);
1341 serializer->doRvec(&ir->compress[YY]);
1342 serializer->doRvec(&ir->compress[ZZ]);
1343 serializer->doInt(&ir->refcoord_scaling);
1344 serializer->doRvec(&ir->posres_com);
1345 serializer->doRvec(&ir->posres_comB);
1347 if (file_version < 79)
1349 serializer->doInt(&ir->andersen_seed);
1353 ir->andersen_seed = 0;
1356 serializer->doReal(&ir->shake_tol);
1358 serializer->doInt(&ir->efep);
1359 do_fepvals(serializer, ir->fepvals, file_version);
1361 if (file_version >= 79)
1363 serializer->doBool(&ir->bSimTemp);
1366 ir->bSimTemp = TRUE;
1371 ir->bSimTemp = FALSE;
1375 do_simtempvals(serializer, ir->simtempvals, ir->fepvals->n_lambda, file_version);
1378 if (file_version >= 79)
1380 serializer->doBool(&ir->bExpanded);
1384 do_expandedvals(serializer, ir->expandedvals, ir->fepvals, file_version);
1387 serializer->doInt(&ir->eDisre);
1388 serializer->doInt(&ir->eDisreWeighting);
1389 serializer->doBool(&ir->bDisreMixed);
1390 serializer->doReal(&ir->dr_fc);
1391 serializer->doReal(&ir->dr_tau);
1392 serializer->doInt(&ir->nstdisreout);
1393 serializer->doReal(&ir->orires_fc);
1394 serializer->doReal(&ir->orires_tau);
1395 serializer->doInt(&ir->nstorireout);
1397 /* ignore dihre_fc */
1398 if (file_version < 79)
1400 serializer->doReal(&rdum);
1403 serializer->doReal(&ir->em_stepsize);
1404 serializer->doReal(&ir->em_tol);
1405 serializer->doBool(&ir->bShakeSOR);
1406 serializer->doInt(&ir->niter);
1407 serializer->doReal(&ir->fc_stepsize);
1408 serializer->doInt(&ir->eConstrAlg);
1409 serializer->doInt(&ir->nProjOrder);
1410 serializer->doReal(&ir->LincsWarnAngle);
1411 serializer->doInt(&ir->nLincsIter);
1412 serializer->doReal(&ir->bd_fric);
1413 if (file_version >= tpxv_Use64BitRandomSeed)
1415 serializer->doInt64(&ir->ld_seed);
1419 serializer->doInt(&idum);
1423 for (i = 0; i < DIM; i++)
1425 serializer->doRvec(&ir->deform[i]);
1427 serializer->doReal(&ir->cos_accel);
1429 serializer->doInt(&ir->userint1);
1430 serializer->doInt(&ir->userint2);
1431 serializer->doInt(&ir->userint3);
1432 serializer->doInt(&ir->userint4);
1433 serializer->doReal(&ir->userreal1);
1434 serializer->doReal(&ir->userreal2);
1435 serializer->doReal(&ir->userreal3);
1436 serializer->doReal(&ir->userreal4);
1438 /* AdResS is removed, but we need to be able to read old files,
1439 and let mdrun refuse to run them */
1440 if (file_version >= 77 && file_version < tpxv_RemoveAdress)
1442 serializer->doBool(&ir->bAdress);
1445 int idum, numThermoForceGroups, numEnergyGroups;
1448 serializer->doInt(&idum);
1449 serializer->doReal(&rdum);
1450 serializer->doReal(&rdum);
1451 serializer->doReal(&rdum);
1452 serializer->doInt(&idum);
1453 serializer->doInt(&idum);
1454 serializer->doRvec(&rvecdum);
1455 serializer->doInt(&numThermoForceGroups);
1456 serializer->doReal(&rdum);
1457 serializer->doInt(&numEnergyGroups);
1458 serializer->doInt(&idum);
1460 if (numThermoForceGroups > 0)
1462 std::vector<int> idumn(numThermoForceGroups);
1463 serializer->doIntArray(idumn.data(), idumn.size());
1465 if (numEnergyGroups > 0)
1467 std::vector<int> idumn(numEnergyGroups);
1468 serializer->doIntArray(idumn.data(), idumn.size());
1474 ir->bAdress = FALSE;
1481 if (file_version >= tpxv_PullCoordTypeGeom)
1483 serializer->doBool(&ir->bPull);
1487 serializer->doInt(&ePullOld);
1488 ir->bPull = (ePullOld > 0);
1489 /* We removed the first ePull=ePullNo for the enum */
1494 if (serializer->reading())
1496 ir->pull = std::make_unique<pull_params_t>();
1498 do_pull(serializer, ir->pull.get(), file_version, ePullOld);
1502 if (file_version >= tpxv_AcceleratedWeightHistogram)
1504 serializer->doBool(&ir->bDoAwh);
1508 if (serializer->reading())
1510 snew(ir->awhParams, 1);
1512 do_awh(serializer, ir->awhParams, file_version);
1520 /* Enforced rotation */
1521 if (file_version >= 74)
1523 serializer->doBool(&ir->bRot);
1526 if (serializer->reading())
1530 do_rot(serializer, ir->rot);
1538 /* Interactive molecular dynamics */
1539 if (file_version >= tpxv_InteractiveMolecularDynamics)
1541 serializer->doBool(&ir->bIMD);
1544 if (serializer->reading())
1548 do_imd(serializer, ir->imd);
1553 /* We don't support IMD sessions for old .tpr files */
1558 serializer->doInt(&ir->opts.ngtc);
1559 if (file_version >= 69)
1561 serializer->doInt(&ir->opts.nhchainlength);
1565 ir->opts.nhchainlength = 1;
1567 int removedOptsNgacc = 0;
1568 if (serializer->reading() && file_version < tpxv_RemovedConstantAcceleration)
1570 serializer->doInt(&removedOptsNgacc);
1572 serializer->doInt(&ir->opts.ngfrz);
1573 serializer->doInt(&ir->opts.ngener);
1575 if (serializer->reading())
1577 snew(ir->opts.nrdf, ir->opts.ngtc);
1578 snew(ir->opts.ref_t, ir->opts.ngtc);
1579 snew(ir->opts.annealing, ir->opts.ngtc);
1580 snew(ir->opts.anneal_npoints, ir->opts.ngtc);
1581 snew(ir->opts.anneal_time, ir->opts.ngtc);
1582 snew(ir->opts.anneal_temp, ir->opts.ngtc);
1583 snew(ir->opts.tau_t, ir->opts.ngtc);
1584 snew(ir->opts.nFreeze, ir->opts.ngfrz);
1585 snew(ir->opts.egp_flags, ir->opts.ngener * ir->opts.ngener);
1587 if (ir->opts.ngtc > 0)
1589 serializer->doRealArray(ir->opts.nrdf, ir->opts.ngtc);
1590 serializer->doRealArray(ir->opts.ref_t, ir->opts.ngtc);
1591 serializer->doRealArray(ir->opts.tau_t, ir->opts.ngtc);
1593 if (ir->opts.ngfrz > 0)
1595 serializer->doIvecArray(ir->opts.nFreeze, ir->opts.ngfrz);
1597 if (serializer->reading() && file_version < tpxv_RemovedConstantAcceleration && removedOptsNgacc > 0)
1599 std::vector<gmx::RVec> dummy;
1600 dummy.resize(removedOptsNgacc);
1601 serializer->doRvecArray(reinterpret_cast<rvec*>(dummy.data()), removedOptsNgacc);
1602 ir->useConstantAcceleration = std::any_of(dummy.begin(), dummy.end(), [](const gmx::RVec& vec) {
1603 return vec[XX] != 0.0 || vec[YY] != 0.0 || vec[ZZ] != 0.0;
1608 ir->useConstantAcceleration = false;
1610 serializer->doIntArray(ir->opts.egp_flags, ir->opts.ngener * ir->opts.ngener);
1612 /* First read the lists with annealing and npoints for each group */
1613 serializer->doIntArray(ir->opts.annealing, ir->opts.ngtc);
1614 serializer->doIntArray(ir->opts.anneal_npoints, ir->opts.ngtc);
1615 for (j = 0; j < (ir->opts.ngtc); j++)
1617 k = ir->opts.anneal_npoints[j];
1618 if (serializer->reading())
1620 snew(ir->opts.anneal_time[j], k);
1621 snew(ir->opts.anneal_temp[j], k);
1623 serializer->doRealArray(ir->opts.anneal_time[j], k);
1624 serializer->doRealArray(ir->opts.anneal_temp[j], k);
1628 serializer->doInt(&ir->nwall);
1629 serializer->doInt(&ir->wall_type);
1630 serializer->doReal(&ir->wall_r_linpot);
1631 serializer->doInt(&ir->wall_atomtype[0]);
1632 serializer->doInt(&ir->wall_atomtype[1]);
1633 serializer->doReal(&ir->wall_density[0]);
1634 serializer->doReal(&ir->wall_density[1]);
1635 serializer->doReal(&ir->wall_ewald_zfac);
1638 /* Cosine stuff for electric fields */
1639 if (file_version < tpxv_GenericParamsForElectricField)
1641 do_legacy_efield(serializer, ¶msObj);
1645 if (file_version >= tpxv_ComputationalElectrophysiology)
1647 serializer->doInt(&ir->eSwapCoords);
1648 if (ir->eSwapCoords != eswapNO)
1650 if (serializer->reading())
1654 do_swapcoords_tpx(serializer, ir->swap, file_version);
1658 /* QMMM reading - despite defunct we require reading for backwards
1659 * compability and correct serialization
1662 serializer->doBool(&ir->bQMMM);
1664 serializer->doInt(&qmmmScheme);
1665 real unusedScalefactor;
1666 serializer->doReal(&unusedScalefactor);
1668 // this is still used in Mimic
1669 serializer->doInt(&ir->opts.ngQM);
1670 if (ir->opts.ngQM > 0 && ir->bQMMM)
1672 /* We leave in dummy i/o for removed parameters to avoid
1673 * changing the tpr format.
1675 std::vector<int> dummyIntVec(4 * ir->opts.ngQM, 0);
1676 serializer->doIntArray(dummyIntVec.data(), dummyIntVec.size());
1677 dummyIntVec.clear();
1679 // std::vector<bool> has no data()
1680 std::vector<char> dummyBoolVec(ir->opts.ngQM * sizeof(bool) / sizeof(char));
1681 serializer->doBoolArray(reinterpret_cast<bool*>(dummyBoolVec.data()), dummyBoolVec.size());
1682 dummyBoolVec.clear();
1684 dummyIntVec.resize(2 * ir->opts.ngQM, 0);
1685 serializer->doIntArray(dummyIntVec.data(), dummyIntVec.size());
1686 dummyIntVec.clear();
1688 std::vector<real> dummyRealVec(2 * ir->opts.ngQM, 0);
1689 serializer->doRealArray(dummyRealVec.data(), dummyRealVec.size());
1690 dummyRealVec.clear();
1692 dummyIntVec.resize(3 * ir->opts.ngQM, 0);
1693 serializer->doIntArray(dummyIntVec.data(), dummyIntVec.size());
1694 dummyIntVec.clear();
1696 /* end of QMMM stuff */
1699 if (file_version >= tpxv_GenericParamsForElectricField)
1701 if (serializer->reading())
1703 paramsObj.mergeObject(gmx::deserializeKeyValueTree(serializer));
1707 GMX_RELEASE_ASSERT(ir->params != nullptr,
1708 "Parameters should be present when writing inputrec");
1709 gmx::serializeKeyValueTree(*ir->params, serializer);
1712 if (serializer->reading())
1714 ir->params = new gmx::KeyValueTreeObject(paramsBuilder.build());
1715 // Initialize internal parameters to an empty kvt for all tpr versions
1716 ir->internalParameters = std::make_unique<gmx::KeyValueTreeObject>();
1719 if (file_version >= tpxv_GenericInternalParameters)
1721 if (serializer->reading())
1723 ir->internalParameters =
1724 std::make_unique<gmx::KeyValueTreeObject>(gmx::deserializeKeyValueTree(serializer));
1728 GMX_RELEASE_ASSERT(ir->internalParameters != nullptr,
1729 "Parameters should be present when writing inputrec");
1730 gmx::serializeKeyValueTree(*ir->internalParameters, serializer);
1736 static void do_harm(gmx::ISerializer* serializer, t_iparams* iparams)
1738 serializer->doReal(&iparams->harmonic.rA);
1739 serializer->doReal(&iparams->harmonic.krA);
1740 serializer->doReal(&iparams->harmonic.rB);
1741 serializer->doReal(&iparams->harmonic.krB);
1744 static void do_iparams(gmx::ISerializer* serializer, t_functype ftype, t_iparams* iparams, int file_version)
1757 do_harm(serializer, iparams);
1758 if ((ftype == F_ANGRES || ftype == F_ANGRESZ) && serializer->reading())
1760 /* Correct incorrect storage of parameters */
1761 iparams->pdihs.phiB = iparams->pdihs.phiA;
1762 iparams->pdihs.cpB = iparams->pdihs.cpA;
1766 serializer->doReal(&iparams->harmonic.rA);
1767 serializer->doReal(&iparams->harmonic.krA);
1769 case F_LINEAR_ANGLES:
1770 serializer->doReal(&iparams->linangle.klinA);
1771 serializer->doReal(&iparams->linangle.aA);
1772 serializer->doReal(&iparams->linangle.klinB);
1773 serializer->doReal(&iparams->linangle.aB);
1776 serializer->doReal(&iparams->fene.bm);
1777 serializer->doReal(&iparams->fene.kb);
1781 serializer->doReal(&iparams->restraint.lowA);
1782 serializer->doReal(&iparams->restraint.up1A);
1783 serializer->doReal(&iparams->restraint.up2A);
1784 serializer->doReal(&iparams->restraint.kA);
1785 serializer->doReal(&iparams->restraint.lowB);
1786 serializer->doReal(&iparams->restraint.up1B);
1787 serializer->doReal(&iparams->restraint.up2B);
1788 serializer->doReal(&iparams->restraint.kB);
1794 serializer->doReal(&iparams->tab.kA);
1795 serializer->doInt(&iparams->tab.table);
1796 serializer->doReal(&iparams->tab.kB);
1798 case F_CROSS_BOND_BONDS:
1799 serializer->doReal(&iparams->cross_bb.r1e);
1800 serializer->doReal(&iparams->cross_bb.r2e);
1801 serializer->doReal(&iparams->cross_bb.krr);
1803 case F_CROSS_BOND_ANGLES:
1804 serializer->doReal(&iparams->cross_ba.r1e);
1805 serializer->doReal(&iparams->cross_ba.r2e);
1806 serializer->doReal(&iparams->cross_ba.r3e);
1807 serializer->doReal(&iparams->cross_ba.krt);
1809 case F_UREY_BRADLEY:
1810 serializer->doReal(&iparams->u_b.thetaA);
1811 serializer->doReal(&iparams->u_b.kthetaA);
1812 serializer->doReal(&iparams->u_b.r13A);
1813 serializer->doReal(&iparams->u_b.kUBA);
1814 if (file_version >= 79)
1816 serializer->doReal(&iparams->u_b.thetaB);
1817 serializer->doReal(&iparams->u_b.kthetaB);
1818 serializer->doReal(&iparams->u_b.r13B);
1819 serializer->doReal(&iparams->u_b.kUBB);
1823 iparams->u_b.thetaB = iparams->u_b.thetaA;
1824 iparams->u_b.kthetaB = iparams->u_b.kthetaA;
1825 iparams->u_b.r13B = iparams->u_b.r13A;
1826 iparams->u_b.kUBB = iparams->u_b.kUBA;
1829 case F_QUARTIC_ANGLES:
1830 serializer->doReal(&iparams->qangle.theta);
1831 serializer->doRealArray(iparams->qangle.c, 5);
1834 serializer->doReal(&iparams->bham.a);
1835 serializer->doReal(&iparams->bham.b);
1836 serializer->doReal(&iparams->bham.c);
1839 serializer->doReal(&iparams->morse.b0A);
1840 serializer->doReal(&iparams->morse.cbA);
1841 serializer->doReal(&iparams->morse.betaA);
1842 if (file_version >= 79)
1844 serializer->doReal(&iparams->morse.b0B);
1845 serializer->doReal(&iparams->morse.cbB);
1846 serializer->doReal(&iparams->morse.betaB);
1850 iparams->morse.b0B = iparams->morse.b0A;
1851 iparams->morse.cbB = iparams->morse.cbA;
1852 iparams->morse.betaB = iparams->morse.betaA;
1856 serializer->doReal(&iparams->cubic.b0);
1857 serializer->doReal(&iparams->cubic.kb);
1858 serializer->doReal(&iparams->cubic.kcub);
1860 case F_CONNBONDS: break;
1861 case F_POLARIZATION: serializer->doReal(&iparams->polarize.alpha); break;
1863 serializer->doReal(&iparams->anharm_polarize.alpha);
1864 serializer->doReal(&iparams->anharm_polarize.drcut);
1865 serializer->doReal(&iparams->anharm_polarize.khyp);
1868 serializer->doReal(&iparams->wpol.al_x);
1869 serializer->doReal(&iparams->wpol.al_y);
1870 serializer->doReal(&iparams->wpol.al_z);
1871 serializer->doReal(&iparams->wpol.rOH);
1872 serializer->doReal(&iparams->wpol.rHH);
1873 serializer->doReal(&iparams->wpol.rOD);
1876 serializer->doReal(&iparams->thole.a);
1877 serializer->doReal(&iparams->thole.alpha1);
1878 serializer->doReal(&iparams->thole.alpha2);
1879 serializer->doReal(&iparams->thole.rfac);
1882 serializer->doReal(&iparams->lj.c6);
1883 serializer->doReal(&iparams->lj.c12);
1886 serializer->doReal(&iparams->lj14.c6A);
1887 serializer->doReal(&iparams->lj14.c12A);
1888 serializer->doReal(&iparams->lj14.c6B);
1889 serializer->doReal(&iparams->lj14.c12B);
1892 serializer->doReal(&iparams->ljc14.fqq);
1893 serializer->doReal(&iparams->ljc14.qi);
1894 serializer->doReal(&iparams->ljc14.qj);
1895 serializer->doReal(&iparams->ljc14.c6);
1896 serializer->doReal(&iparams->ljc14.c12);
1898 case F_LJC_PAIRS_NB:
1899 serializer->doReal(&iparams->ljcnb.qi);
1900 serializer->doReal(&iparams->ljcnb.qj);
1901 serializer->doReal(&iparams->ljcnb.c6);
1902 serializer->doReal(&iparams->ljcnb.c12);
1908 serializer->doReal(&iparams->pdihs.phiA);
1909 serializer->doReal(&iparams->pdihs.cpA);
1910 serializer->doReal(&iparams->pdihs.phiB);
1911 serializer->doReal(&iparams->pdihs.cpB);
1912 serializer->doInt(&iparams->pdihs.mult);
1915 serializer->doReal(&iparams->pdihs.phiA);
1916 serializer->doReal(&iparams->pdihs.cpA);
1919 serializer->doInt(&iparams->disres.label);
1920 serializer->doInt(&iparams->disres.type);
1921 serializer->doReal(&iparams->disres.low);
1922 serializer->doReal(&iparams->disres.up1);
1923 serializer->doReal(&iparams->disres.up2);
1924 serializer->doReal(&iparams->disres.kfac);
1927 serializer->doInt(&iparams->orires.ex);
1928 serializer->doInt(&iparams->orires.label);
1929 serializer->doInt(&iparams->orires.power);
1930 serializer->doReal(&iparams->orires.c);
1931 serializer->doReal(&iparams->orires.obs);
1932 serializer->doReal(&iparams->orires.kfac);
1935 if (file_version < 82)
1937 serializer->doInt(&idum);
1938 serializer->doInt(&idum);
1940 serializer->doReal(&iparams->dihres.phiA);
1941 serializer->doReal(&iparams->dihres.dphiA);
1942 serializer->doReal(&iparams->dihres.kfacA);
1943 if (file_version >= 82)
1945 serializer->doReal(&iparams->dihres.phiB);
1946 serializer->doReal(&iparams->dihres.dphiB);
1947 serializer->doReal(&iparams->dihres.kfacB);
1951 iparams->dihres.phiB = iparams->dihres.phiA;
1952 iparams->dihres.dphiB = iparams->dihres.dphiA;
1953 iparams->dihres.kfacB = iparams->dihres.kfacA;
1957 serializer->doRvec(&iparams->posres.pos0A);
1958 serializer->doRvec(&iparams->posres.fcA);
1959 serializer->doRvec(&iparams->posres.pos0B);
1960 serializer->doRvec(&iparams->posres.fcB);
1963 serializer->doInt(&iparams->fbposres.geom);
1964 serializer->doRvec(&iparams->fbposres.pos0);
1965 serializer->doReal(&iparams->fbposres.r);
1966 serializer->doReal(&iparams->fbposres.k);
1968 case F_CBTDIHS: serializer->doRealArray(iparams->cbtdihs.cbtcA, NR_CBTDIHS); break;
1970 // Fall-through intended
1972 /* Fourier dihedrals are internally represented
1973 * as Ryckaert-Bellemans since those are faster to compute.
1975 serializer->doRealArray(iparams->rbdihs.rbcA, NR_RBDIHS);
1976 serializer->doRealArray(iparams->rbdihs.rbcB, NR_RBDIHS);
1980 serializer->doReal(&iparams->constr.dA);
1981 serializer->doReal(&iparams->constr.dB);
1984 serializer->doReal(&iparams->settle.doh);
1985 serializer->doReal(&iparams->settle.dhh);
1987 case F_VSITE1: break; // VSite1 has 0 parameters
1989 case F_VSITE2FD: serializer->doReal(&iparams->vsite.a); break;
1993 serializer->doReal(&iparams->vsite.a);
1994 serializer->doReal(&iparams->vsite.b);
1999 serializer->doReal(&iparams->vsite.a);
2000 serializer->doReal(&iparams->vsite.b);
2001 serializer->doReal(&iparams->vsite.c);
2004 serializer->doInt(&iparams->vsiten.n);
2005 serializer->doReal(&iparams->vsiten.a);
2007 case F_GB12_NOLONGERUSED:
2008 case F_GB13_NOLONGERUSED:
2009 case F_GB14_NOLONGERUSED:
2010 // Implicit solvent parameters can still be read, but never used
2011 if (serializer->reading())
2013 if (file_version < 68)
2015 serializer->doReal(&rdum);
2016 serializer->doReal(&rdum);
2017 serializer->doReal(&rdum);
2018 serializer->doReal(&rdum);
2020 if (file_version < tpxv_RemoveImplicitSolvation)
2022 serializer->doReal(&rdum);
2023 serializer->doReal(&rdum);
2024 serializer->doReal(&rdum);
2025 serializer->doReal(&rdum);
2026 serializer->doReal(&rdum);
2031 serializer->doInt(&iparams->cmap.cmapA);
2032 serializer->doInt(&iparams->cmap.cmapB);
2036 "unknown function type %d (%s) in %s line %d",
2038 interaction_function[ftype].name,
2044 static void do_ilist(gmx::ISerializer* serializer, InteractionList* ilist)
2046 int nr = ilist->size();
2047 serializer->doInt(&nr);
2048 if (serializer->reading())
2050 ilist->iatoms.resize(nr);
2052 serializer->doIntArray(ilist->iatoms.data(), ilist->size());
2055 static void do_ffparams(gmx::ISerializer* serializer, gmx_ffparams_t* ffparams, int file_version)
2057 serializer->doInt(&ffparams->atnr);
2058 int numTypes = ffparams->numTypes();
2059 serializer->doInt(&numTypes);
2060 if (serializer->reading())
2062 ffparams->functype.resize(numTypes);
2063 ffparams->iparams.resize(numTypes);
2065 /* Read/write all the function types */
2066 serializer->doIntArray(ffparams->functype.data(), ffparams->functype.size());
2068 if (file_version >= 66)
2070 serializer->doDouble(&ffparams->reppow);
2074 ffparams->reppow = 12.0;
2077 serializer->doReal(&ffparams->fudgeQQ);
2079 /* Check whether all these function types are supported by the code.
2080 * In practice the code is backwards compatible, which means that the
2081 * numbering may have to be altered from old numbering to new numbering
2083 for (int i = 0; i < ffparams->numTypes(); i++)
2085 if (serializer->reading())
2087 /* Loop over file versions */
2088 for (int k = 0; k < NFTUPD; k++)
2090 /* Compare the read file_version to the update table */
2091 if ((file_version < ftupd[k].fvnr) && (ffparams->functype[i] >= ftupd[k].ftype))
2093 ffparams->functype[i] += 1;
2098 do_iparams(serializer, ffparams->functype[i], &ffparams->iparams[i], file_version);
2102 static void add_settle_atoms(InteractionList* ilist)
2106 /* Settle used to only store the first atom: add the other two */
2107 ilist->iatoms.resize(2 * ilist->size());
2108 for (i = ilist->size() / 4 - 1; i >= 0; i--)
2110 ilist->iatoms[4 * i + 0] = ilist->iatoms[2 * i + 0];
2111 ilist->iatoms[4 * i + 1] = ilist->iatoms[2 * i + 1];
2112 ilist->iatoms[4 * i + 2] = ilist->iatoms[2 * i + 1] + 1;
2113 ilist->iatoms[4 * i + 3] = ilist->iatoms[2 * i + 1] + 2;
2117 static void do_ilists(gmx::ISerializer* serializer, InteractionLists* ilists, int file_version)
2119 GMX_RELEASE_ASSERT(ilists, "Need a valid ilists object");
2120 GMX_RELEASE_ASSERT(ilists->size() == F_NRE,
2121 "The code needs to be in sync with InteractionLists");
2123 for (int j = 0; j < F_NRE; j++)
2125 InteractionList& ilist = (*ilists)[j];
2126 gmx_bool bClear = FALSE;
2127 if (serializer->reading())
2129 for (int k = 0; k < NFTUPD; k++)
2131 if ((file_version < ftupd[k].fvnr) && (j == ftupd[k].ftype))
2139 ilist.iatoms.clear();
2143 do_ilist(serializer, &ilist);
2144 if (file_version < 78 && j == F_SETTLE && !ilist.empty())
2146 add_settle_atoms(&ilist);
2152 static void do_block(gmx::ISerializer* serializer, t_block* block)
2154 serializer->doInt(&block->nr);
2155 if (serializer->reading())
2157 if ((block->nalloc_index > 0) && (nullptr != block->index))
2159 sfree(block->index);
2161 block->nalloc_index = block->nr + 1;
2162 snew(block->index, block->nalloc_index);
2164 serializer->doIntArray(block->index, block->nr + 1);
2167 static void doListOfLists(gmx::ISerializer* serializer, gmx::ListOfLists<int>* listOfLists)
2169 int numLists = listOfLists->ssize();
2170 serializer->doInt(&numLists);
2171 int numElements = listOfLists->elementsView().ssize();
2172 serializer->doInt(&numElements);
2173 if (serializer->reading())
2175 std::vector<int> listRanges(numLists + 1);
2176 serializer->doIntArray(listRanges.data(), numLists + 1);
2177 std::vector<int> elements(numElements);
2178 serializer->doIntArray(elements.data(), numElements);
2179 *listOfLists = gmx::ListOfLists<int>(std::move(listRanges), std::move(elements));
2183 serializer->doIntArray(const_cast<int*>(listOfLists->listRangesView().data()), numLists + 1);
2184 serializer->doIntArray(const_cast<int*>(listOfLists->elementsView().data()), numElements);
2188 /* This is a primitive routine to make it possible to translate atomic numbers
2189 * to element names when reading TPR files, without making the Gromacs library
2190 * directory a dependency on mdrun (which is the case if we need elements.dat).
2192 static const char* atomicnumber_to_element(int atomicnumber)
2196 /* This does not have to be complete, so we only include elements likely
2197 * to occur in PDB files.
2199 switch (atomicnumber)
2201 case 1: p = "H"; break;
2202 case 5: p = "B"; break;
2203 case 6: p = "C"; break;
2204 case 7: p = "N"; break;
2205 case 8: p = "O"; break;
2206 case 9: p = "F"; break;
2207 case 11: p = "Na"; break;
2208 case 12: p = "Mg"; break;
2209 case 15: p = "P"; break;
2210 case 16: p = "S"; break;
2211 case 17: p = "Cl"; break;
2212 case 18: p = "Ar"; break;
2213 case 19: p = "K"; break;
2214 case 20: p = "Ca"; break;
2215 case 25: p = "Mn"; break;
2216 case 26: p = "Fe"; break;
2217 case 28: p = "Ni"; break;
2218 case 29: p = "Cu"; break;
2219 case 30: p = "Zn"; break;
2220 case 35: p = "Br"; break;
2221 case 47: p = "Ag"; break;
2222 default: p = ""; break;
2228 static void do_atom(gmx::ISerializer* serializer, t_atom* atom)
2230 serializer->doReal(&atom->m);
2231 serializer->doReal(&atom->q);
2232 serializer->doReal(&atom->mB);
2233 serializer->doReal(&atom->qB);
2234 serializer->doUShort(&atom->type);
2235 serializer->doUShort(&atom->typeB);
2236 serializer->doInt(&atom->ptype);
2237 serializer->doInt(&atom->resind);
2238 serializer->doInt(&atom->atomnumber);
2239 if (serializer->reading())
2241 /* Set element string from atomic number if present.
2242 * This routine returns an empty string if the name is not found.
2244 std::strncpy(atom->elem, atomicnumber_to_element(atom->atomnumber), 4);
2245 /* avoid warnings about potentially unterminated string */
2246 atom->elem[3] = '\0';
2250 static void do_grps(gmx::ISerializer* serializer, gmx::ArrayRef<AtomGroupIndices> grps)
2252 for (auto& group : grps)
2254 int size = group.size();
2255 serializer->doInt(&size);
2256 if (serializer->reading())
2260 serializer->doIntArray(group.data(), size);
2264 static void do_symstr(gmx::ISerializer* serializer, char*** nm, t_symtab* symtab)
2268 if (serializer->reading())
2270 serializer->doInt(&ls);
2271 *nm = get_symtab_handle(symtab, ls);
2275 ls = lookup_symtab(symtab, *nm);
2276 serializer->doInt(&ls);
2280 static void do_strstr(gmx::ISerializer* serializer, int nstr, char*** nm, t_symtab* symtab)
2284 for (j = 0; (j < nstr); j++)
2286 do_symstr(serializer, &(nm[j]), symtab);
2290 static void do_resinfo(gmx::ISerializer* serializer, int n, t_resinfo* ri, t_symtab* symtab, int file_version)
2294 for (j = 0; (j < n); j++)
2296 do_symstr(serializer, &(ri[j].name), symtab);
2297 if (file_version >= 63)
2299 serializer->doInt(&ri[j].nr);
2300 serializer->doUChar(&ri[j].ic);
2310 static void do_atoms(gmx::ISerializer* serializer, t_atoms* atoms, t_symtab* symtab, int file_version)
2314 serializer->doInt(&atoms->nr);
2315 serializer->doInt(&atoms->nres);
2316 if (serializer->reading())
2318 /* Since we have always written all t_atom properties in the tpr file
2319 * (at least for all backward compatible versions), we don't store
2320 * but simple set the booleans here.
2322 atoms->haveMass = TRUE;
2323 atoms->haveCharge = TRUE;
2324 atoms->haveType = TRUE;
2325 atoms->haveBState = TRUE;
2326 atoms->havePdbInfo = FALSE;
2328 snew(atoms->atom, atoms->nr);
2329 snew(atoms->atomname, atoms->nr);
2330 snew(atoms->atomtype, atoms->nr);
2331 snew(atoms->atomtypeB, atoms->nr);
2332 snew(atoms->resinfo, atoms->nres);
2333 atoms->pdbinfo = nullptr;
2337 GMX_RELEASE_ASSERT(atoms->haveMass && atoms->haveCharge && atoms->haveType && atoms->haveBState,
2338 "Mass, charge, atomtype and B-state parameters should be present in "
2339 "t_atoms when writing a tpr file");
2341 for (i = 0; (i < atoms->nr); i++)
2343 do_atom(serializer, &atoms->atom[i]);
2345 do_strstr(serializer, atoms->nr, atoms->atomname, symtab);
2346 do_strstr(serializer, atoms->nr, atoms->atomtype, symtab);
2347 do_strstr(serializer, atoms->nr, atoms->atomtypeB, symtab);
2349 do_resinfo(serializer, atoms->nres, atoms->resinfo, symtab, file_version);
2352 static void do_groups(gmx::ISerializer* serializer, SimulationGroups* groups, t_symtab* symtab)
2354 do_grps(serializer, groups->groups);
2355 int numberOfGroupNames = groups->groupNames.size();
2356 serializer->doInt(&numberOfGroupNames);
2357 if (serializer->reading())
2359 groups->groupNames.resize(numberOfGroupNames);
2361 do_strstr(serializer, numberOfGroupNames, groups->groupNames.data(), symtab);
2362 for (auto group : gmx::keysOf(groups->groupNumbers))
2364 int numberOfGroupNumbers = groups->numberOfGroupNumbers(group);
2365 serializer->doInt(&numberOfGroupNumbers);
2366 if (numberOfGroupNumbers != 0)
2368 if (serializer->reading())
2370 groups->groupNumbers[group].resize(numberOfGroupNumbers);
2372 serializer->doUCharArray(groups->groupNumbers[group].data(), numberOfGroupNumbers);
2377 static void do_atomtypes(gmx::ISerializer* serializer, t_atomtypes* atomtypes, int file_version)
2381 serializer->doInt(&atomtypes->nr);
2383 if (serializer->reading())
2385 snew(atomtypes->atomnumber, j);
2387 if (serializer->reading() && file_version < tpxv_RemoveImplicitSolvation)
2389 std::vector<real> dummy(atomtypes->nr, 0);
2390 serializer->doRealArray(dummy.data(), dummy.size());
2391 serializer->doRealArray(dummy.data(), dummy.size());
2392 serializer->doRealArray(dummy.data(), dummy.size());
2394 serializer->doIntArray(atomtypes->atomnumber, j);
2396 if (serializer->reading() && file_version >= 60 && file_version < tpxv_RemoveImplicitSolvation)
2398 std::vector<real> dummy(atomtypes->nr, 0);
2399 serializer->doRealArray(dummy.data(), dummy.size());
2400 serializer->doRealArray(dummy.data(), dummy.size());
2404 static void do_symtab(gmx::ISerializer* serializer, t_symtab* symtab)
2409 serializer->doInt(&symtab->nr);
2411 if (serializer->reading())
2413 snew(symtab->symbuf, 1);
2414 symbuf = symtab->symbuf;
2415 symbuf->bufsize = nr;
2416 snew(symbuf->buf, nr);
2417 for (i = 0; (i < nr); i++)
2420 serializer->doString(&buf);
2421 symbuf->buf[i] = gmx_strdup(buf.c_str());
2426 symbuf = symtab->symbuf;
2427 while (symbuf != nullptr)
2429 for (i = 0; (i < symbuf->bufsize) && (i < nr); i++)
2431 std::string buf = symbuf->buf[i];
2432 serializer->doString(&buf);
2435 symbuf = symbuf->next;
2439 gmx_fatal(FARGS, "nr of symtab strings left: %d", nr);
2444 static void do_cmap(gmx::ISerializer* serializer, gmx_cmap_t* cmap_grid)
2447 int ngrid = cmap_grid->cmapdata.size();
2448 serializer->doInt(&ngrid);
2449 serializer->doInt(&cmap_grid->grid_spacing);
2451 int gs = cmap_grid->grid_spacing;
2452 int nelem = gs * gs;
2454 if (serializer->reading())
2456 cmap_grid->cmapdata.resize(ngrid);
2458 for (int i = 0; i < ngrid; i++)
2460 cmap_grid->cmapdata[i].cmap.resize(4 * nelem);
2464 for (int i = 0; i < ngrid; i++)
2466 for (int j = 0; j < nelem; j++)
2468 serializer->doReal(&cmap_grid->cmapdata[i].cmap[j * 4]);
2469 serializer->doReal(&cmap_grid->cmapdata[i].cmap[j * 4 + 1]);
2470 serializer->doReal(&cmap_grid->cmapdata[i].cmap[j * 4 + 2]);
2471 serializer->doReal(&cmap_grid->cmapdata[i].cmap[j * 4 + 3]);
2477 static void do_moltype(gmx::ISerializer* serializer, gmx_moltype_t* molt, t_symtab* symtab, int file_version)
2479 do_symstr(serializer, &(molt->name), symtab);
2481 do_atoms(serializer, &molt->atoms, symtab, file_version);
2483 do_ilists(serializer, &molt->ilist, file_version);
2485 /* TODO: Remove the obsolete charge group index from the file */
2487 cgs.nr = molt->atoms.nr;
2488 cgs.nalloc_index = cgs.nr + 1;
2489 snew(cgs.index, cgs.nalloc_index);
2490 for (int i = 0; i < cgs.nr + 1; i++)
2494 do_block(serializer, &cgs);
2497 /* This used to be in the atoms struct */
2498 doListOfLists(serializer, &molt->excls);
2501 static void do_molblock(gmx::ISerializer* serializer, gmx_molblock_t* molb, int numAtomsPerMolecule)
2503 serializer->doInt(&molb->type);
2504 serializer->doInt(&molb->nmol);
2505 /* To maintain forward topology reading compatibility, we store #atoms.
2506 * TODO: Change this to conditional reading of a dummy int when we
2507 * increase tpx_generation.
2509 serializer->doInt(&numAtomsPerMolecule);
2510 /* Position restraint coordinates */
2511 int numPosres_xA = molb->posres_xA.size();
2512 serializer->doInt(&numPosres_xA);
2513 if (numPosres_xA > 0)
2515 if (serializer->reading())
2517 molb->posres_xA.resize(numPosres_xA);
2519 serializer->doRvecArray(as_rvec_array(molb->posres_xA.data()), numPosres_xA);
2521 int numPosres_xB = molb->posres_xB.size();
2522 serializer->doInt(&numPosres_xB);
2523 if (numPosres_xB > 0)
2525 if (serializer->reading())
2527 molb->posres_xB.resize(numPosres_xB);
2529 serializer->doRvecArray(as_rvec_array(molb->posres_xB.data()), numPosres_xB);
2533 static void set_disres_npair(gmx_mtop_t* mtop)
2535 gmx_mtop_ilistloop_t iloop;
2538 gmx::ArrayRef<t_iparams> ip = mtop->ffparams.iparams;
2540 iloop = gmx_mtop_ilistloop_init(mtop);
2541 while (const InteractionLists* ilist = gmx_mtop_ilistloop_next(iloop, &nmol))
2543 const InteractionList& il = (*ilist)[F_DISRES];
2547 gmx::ArrayRef<const int> a = il.iatoms;
2549 for (int i = 0; i < il.size(); i += 3)
2552 if (i + 3 == il.size() || ip[a[i]].disres.label != ip[a[i + 3]].disres.label)
2554 ip[a[i]].disres.npair = npair;
2562 static void do_mtop(gmx::ISerializer* serializer, gmx_mtop_t* mtop, int file_version)
2564 do_symtab(serializer, &(mtop->symtab));
2566 do_symstr(serializer, &(mtop->name), &(mtop->symtab));
2568 do_ffparams(serializer, &mtop->ffparams, file_version);
2570 int nmoltype = mtop->moltype.size();
2571 serializer->doInt(&nmoltype);
2572 if (serializer->reading())
2574 mtop->moltype.resize(nmoltype);
2576 for (gmx_moltype_t& moltype : mtop->moltype)
2578 do_moltype(serializer, &moltype, &mtop->symtab, file_version);
2581 int nmolblock = mtop->molblock.size();
2582 serializer->doInt(&nmolblock);
2583 if (serializer->reading())
2585 mtop->molblock.resize(nmolblock);
2587 for (gmx_molblock_t& molblock : mtop->molblock)
2589 int numAtomsPerMolecule = (serializer->reading() ? 0 : mtop->moltype[molblock.type].atoms.nr);
2590 do_molblock(serializer, &molblock, numAtomsPerMolecule);
2592 serializer->doInt(&mtop->natoms);
2594 if (file_version >= tpxv_IntermolecularBondeds)
2596 serializer->doBool(&mtop->bIntermolecularInteractions);
2597 if (mtop->bIntermolecularInteractions)
2599 if (serializer->reading())
2601 mtop->intermolecular_ilist = std::make_unique<InteractionLists>();
2603 do_ilists(serializer, mtop->intermolecular_ilist.get(), file_version);
2608 mtop->bIntermolecularInteractions = FALSE;
2611 do_atomtypes(serializer, &(mtop->atomtypes), file_version);
2613 if (file_version >= 65)
2615 do_cmap(serializer, &mtop->ffparams.cmap_grid);
2619 mtop->ffparams.cmap_grid.grid_spacing = 0;
2620 mtop->ffparams.cmap_grid.cmapdata.clear();
2623 do_groups(serializer, &mtop->groups, &(mtop->symtab));
2624 if (file_version < tpxv_RemovedConstantAcceleration)
2626 mtop->groups.groups[SimulationAtomGroupType::AccelerationUnused].clear();
2627 mtop->groups.groupNumbers[SimulationAtomGroupType::AccelerationUnused].clear();
2630 mtop->haveMoleculeIndices = true;
2632 if (file_version >= tpxv_StoreNonBondedInteractionExclusionGroup)
2634 std::int64_t intermolecularExclusionGroupSize = gmx::ssize(mtop->intermolecularExclusionGroup);
2635 serializer->doInt64(&intermolecularExclusionGroupSize);
2636 GMX_RELEASE_ASSERT(intermolecularExclusionGroupSize >= 0,
2637 "Number of atoms with excluded intermolecular non-bonded interactions "
2639 mtop->intermolecularExclusionGroup.resize(intermolecularExclusionGroupSize); // no effect when writing
2640 serializer->doIntArray(mtop->intermolecularExclusionGroup.data(),
2641 mtop->intermolecularExclusionGroup.size());
2644 if (serializer->reading())
2646 close_symtab(&(mtop->symtab));
2651 * Read the first part of the TPR file to find general system information.
2653 * If \p TopOnlyOK is true then we can read even future versions
2654 * of tpx files, provided the \p fileGeneration hasn't changed.
2655 * If it is false, we need the \p ir too, and bail out
2656 * if the file is newer than the program.
2658 * The version and generation of the topology (see top of this file)
2659 * are returned in the two last arguments, if those arguments are non-nullptr.
2661 * If possible, we will read the \p ir even when \p TopOnlyOK is true.
2663 * \param[in,out] serializer The serializer used to handle header processing.
2664 * \param[in,out] tpx File header datastructure.
2665 * \param[in] filename The name of the file being read/written
2666 * \param[in,out] fio File handle.
2667 * \param[in] TopOnlyOK If not reading \p ir is fine or not.
2669 static void do_tpxheader(gmx::FileIOXdrSerializer* serializer,
2671 const char* filename,
2679 /* XDR binary topology file */
2680 precision = sizeof(real);
2682 std::string fileTag;
2683 if (serializer->reading())
2685 serializer->doString(&buf);
2686 if (std::strncmp(buf.c_str(), "VERSION", 7) != 0)
2690 "Can not read file %s,\n"
2691 " this file is from a GROMACS version which is older than 2.0\n"
2692 " Make a new one with grompp or use a gro or pdb file, if possible",
2695 // We need to know the precision used to write the TPR file, to match it
2696 // to the precision of the currently running binary. If the precisions match
2697 // there is no problem, but mismatching precision needs to be accounted for
2698 // by reading into temporary variables of the correct precision instead
2699 // of the desired target datastructures.
2700 serializer->doInt(&precision);
2701 tpx->isDouble = (precision == sizeof(double));
2702 if ((precision != sizeof(float)) && !tpx->isDouble)
2705 "Unknown precision in file %s: real is %d bytes "
2706 "instead of %zu or %zu",
2712 gmx_fio_setprecision(fio, tpx->isDouble);
2714 "Reading file %s, %s (%s precision)\n",
2717 tpx->isDouble ? "double" : "single");
2721 buf = gmx::formatString("VERSION %s", gmx_version());
2722 serializer->doString(&buf);
2723 gmx_fio_setprecision(fio, tpx->isDouble);
2724 serializer->doInt(&precision);
2725 fileTag = gmx::formatString("%s", tpx_tag);
2728 /* Check versions! */
2729 serializer->doInt(&tpx->fileVersion);
2731 /* This is for backward compatibility with development versions 77-79
2732 * where the tag was, mistakenly, placed before the generation,
2733 * which would cause a segv instead of a proper error message
2734 * when reading the topology only from tpx with <77 code.
2736 if (tpx->fileVersion >= 77 && tpx->fileVersion <= 79)
2738 serializer->doString(&fileTag);
2741 serializer->doInt(&tpx->fileGeneration);
2743 if (tpx->fileVersion >= 81)
2745 serializer->doString(&fileTag);
2747 if (serializer->reading())
2749 if (tpx->fileVersion < 77)
2751 /* Versions before 77 don't have the tag, set it to release */
2752 fileTag = gmx::formatString("%s", TPX_TAG_RELEASE);
2755 if (fileTag != tpx_tag)
2757 fprintf(stderr, "Note: file tpx tag '%s', software tpx tag '%s'\n", fileTag.c_str(), tpx_tag);
2759 /* We only support reading tpx files with the same tag as the code
2760 * or tpx files with the release tag and with lower version number.
2762 if (fileTag != TPX_TAG_RELEASE && tpx->fileVersion < tpx_version)
2765 "tpx tag/version mismatch: reading tpx file (%s) version %d, tag '%s' "
2766 "with program for tpx version %d, tag '%s'",
2776 if ((tpx->fileVersion <= tpx_incompatible_version)
2777 || ((tpx->fileVersion > tpx_version) && !TopOnlyOK) || (tpx->fileGeneration > tpx_generation)
2778 || tpx_version == 80) /*80 was used by both 5.0-dev and 4.6-dev*/
2781 "reading tpx file (%s) version %d with version %d program",
2787 serializer->doInt(&tpx->natoms);
2788 serializer->doInt(&tpx->ngtc);
2790 if (tpx->fileVersion < 62)
2792 serializer->doInt(&idum);
2793 serializer->doReal(&rdum);
2795 if (tpx->fileVersion >= 79)
2797 serializer->doInt(&tpx->fep_state);
2799 serializer->doReal(&tpx->lambda);
2800 serializer->doBool(&tpx->bIr);
2801 serializer->doBool(&tpx->bTop);
2802 serializer->doBool(&tpx->bX);
2803 serializer->doBool(&tpx->bV);
2804 serializer->doBool(&tpx->bF);
2805 serializer->doBool(&tpx->bBox);
2807 if (tpx->fileVersion >= tpxv_AddSizeField && tpx->fileGeneration >= 27)
2809 if (!serializer->reading())
2811 GMX_RELEASE_ASSERT(tpx->sizeOfTprBody != 0,
2812 "Not possible to write new file with zero TPR body size");
2814 serializer->doInt64(&tpx->sizeOfTprBody);
2817 if ((tpx->fileGeneration > tpx_generation))
2819 /* This can only happen if TopOnlyOK=TRUE */
2824 #define do_test(serializer, b, p) \
2825 if ((serializer)->reading() && ((p) != nullptr) && !(b)) \
2826 gmx_fatal(FARGS, "No %s in input file", #p)
2829 * Process the first part of the TPR into the state datastructure.
2831 * Due to the structure of the legacy code, it is necessary
2832 * to split up the state reading into two parts, with the
2833 * box and legacy temperature coupling processed before the
2834 * topology datastructures.
2836 * See the documentation for do_tpx_body for the correct order of
2837 * the operations for reading a tpr file.
2839 * \param[in] serializer Abstract serializer used to read/write data.
2840 * \param[in] tpx The file header data.
2841 * \param[in, out] state Global state data.
2843 static void do_tpx_state_first(gmx::ISerializer* serializer, TpxFileHeader* tpx, t_state* state)
2845 if (serializer->reading())
2848 init_gtc_state(state, tpx->ngtc, 0, 0);
2850 do_test(serializer, tpx->bBox, state->box);
2853 serializer->doRvecArray(state->box, DIM);
2854 if (tpx->fileVersion >= 51)
2856 serializer->doRvecArray(state->box_rel, DIM);
2860 /* We initialize box_rel after reading the inputrec */
2861 clear_mat(state->box_rel);
2863 serializer->doRvecArray(state->boxv, DIM);
2864 if (tpx->fileVersion < 56)
2867 serializer->doRvecArray(mdum, DIM);
2871 if (state->ngtc > 0)
2874 snew(dumv, state->ngtc);
2875 if (tpx->fileVersion < 69)
2877 serializer->doRealArray(dumv, state->ngtc);
2879 /* These used to be the Berendsen tcoupl_lambda's */
2880 serializer->doRealArray(dumv, state->ngtc);
2886 * Process global topology data.
2888 * See the documentation for do_tpx_body for the correct order of
2889 * the operations for reading a tpr file.
2891 * \param[in] serializer Abstract serializer used to read/write data.
2892 * \param[in] tpx The file header data.
2893 * \param[in,out] mtop Global topology.
2895 static void do_tpx_mtop(gmx::ISerializer* serializer, TpxFileHeader* tpx, gmx_mtop_t* mtop)
2897 do_test(serializer, tpx->bTop, mtop);
2902 do_mtop(serializer, mtop, tpx->fileVersion);
2903 set_disres_npair(mtop);
2909 do_mtop(serializer, &dum_top, tpx->fileVersion);
2914 * Process coordinate vectors for state data.
2916 * Main part of state gets processed here.
2918 * See the documentation for do_tpx_body for the correct order of
2919 * the operations for reading a tpr file.
2921 * \param[in] serializer Abstract serializer used to read/write data.
2922 * \param[in] tpx The file header data.
2923 * \param[in,out] state Global state data.
2924 * \param[in,out] x Individual coordinates for processing, deprecated.
2925 * \param[in,out] v Individual velocities for processing, deprecated.
2927 static void do_tpx_state_second(gmx::ISerializer* serializer, TpxFileHeader* tpx, t_state* state, rvec* x, rvec* v)
2929 if (!serializer->reading())
2932 x == nullptr && v == nullptr,
2933 "Passing separate x and v pointers to do_tpx() is not supported when writing");
2937 GMX_RELEASE_ASSERT(!(x == nullptr && v != nullptr),
2938 "Passing x==NULL and v!=NULL is not supported");
2941 if (serializer->reading())
2945 // v is also nullptr by the above assertion, so we may
2946 // need to make memory in state for storing the contents
2950 state->flags |= (1 << estX);
2954 state->flags |= (1 << estV);
2956 state_change_natoms(state, tpx->natoms);
2962 x = state->x.rvec_array();
2963 v = state->v.rvec_array();
2965 do_test(serializer, tpx->bX, x);
2968 if (serializer->reading())
2970 state->flags |= (1 << estX);
2972 serializer->doRvecArray(x, tpx->natoms);
2975 do_test(serializer, tpx->bV, v);
2978 if (serializer->reading())
2980 state->flags |= (1 << estV);
2984 std::vector<gmx::RVec> dummyVelocities(tpx->natoms);
2985 serializer->doRvecArray(as_rvec_array(dummyVelocities.data()), tpx->natoms);
2989 serializer->doRvecArray(v, tpx->natoms);
2993 // No need to run do_test when the last argument is NULL
2996 std::vector<gmx::RVec> dummyForces(state->natoms);
2997 serializer->doRvecArray(as_rvec_array(dummyForces.data()), tpx->natoms);
3001 * Process simulation parameters.
3003 * See the documentation for do_tpx_body for the correct order of
3004 * the operations for reading a tpr file.
3006 * \param[in] serializer Abstract serializer used to read/write data.
3007 * \param[in] tpx The file header data.
3008 * \param[in,out] ir Datastructure with simulation parameters.
3010 static PbcType do_tpx_ir(gmx::ISerializer* serializer, TpxFileHeader* tpx, t_inputrec* ir)
3013 gmx_bool bPeriodicMols;
3015 /* Starting with tpx version 26, we have the inputrec
3016 * at the end of the file, so we can ignore it
3017 * if the file is never than the software (but still the
3018 * same generation - see comments at the top of this file.
3022 pbcType = PbcType::Unset;
3023 bPeriodicMols = FALSE;
3025 do_test(serializer, tpx->bIr, ir);
3028 if (tpx->fileVersion >= 53)
3030 /* Removed the pbc info from do_inputrec, since we always want it */
3031 if (!serializer->reading())
3033 pbcType = ir->pbcType;
3034 bPeriodicMols = ir->bPeriodicMols;
3036 serializer->doInt(reinterpret_cast<int*>(&pbcType));
3037 serializer->doBool(&bPeriodicMols);
3039 if (tpx->fileGeneration <= tpx_generation && ir)
3041 do_inputrec(serializer, ir, tpx->fileVersion);
3042 if (tpx->fileVersion < 53)
3044 pbcType = ir->pbcType;
3045 bPeriodicMols = ir->bPeriodicMols;
3048 if (serializer->reading() && ir && tpx->fileVersion >= 53)
3050 /* We need to do this after do_inputrec, since that initializes ir */
3051 ir->pbcType = pbcType;
3052 ir->bPeriodicMols = bPeriodicMols;
3059 * Correct and finalize read information.
3061 * If \p state is nullptr, skip the parts dependent on it.
3063 * See the documentation for do_tpx_body for the correct order of
3064 * the operations for reading a tpr file.
3066 * \param[in] tpx The file header used to check version numbers.
3067 * \param[out] ir Input rec that needs correction.
3068 * \param[out] state State needing correction.
3069 * \param[out] mtop Topology to finalize.
3071 static void do_tpx_finalize(TpxFileHeader* tpx, t_inputrec* ir, t_state* state, gmx_mtop_t* mtop)
3073 if (tpx->fileVersion < 51 && state)
3075 set_box_rel(ir, state);
3079 if (state && state->ngtc == 0)
3081 /* Reading old version without tcoupl state data: set it */
3082 init_gtc_state(state, ir->opts.ngtc, 0, ir->opts.nhchainlength);
3084 if (tpx->bTop && mtop)
3086 if (tpx->fileVersion < 57)
3088 if (!mtop->moltype[0].ilist[F_DISRES].empty())
3090 ir->eDisre = edrSimple;
3094 ir->eDisre = edrNone;
3102 * Process TPR data for file reading/writing.
3104 * The TPR file gets processed in in four stages due to the organization
3105 * of the data within it.
3107 * First, state data for the box is processed in do_tpx_state_first.
3108 * This is followed by processing the topology in do_tpx_mtop.
3109 * Coordinate and velocity vectors are handled next in do_tpx_state_second.
3110 * The last file information processed is the collection of simulation parameters in do_tpx_ir.
3111 * When reading, a final processing step is undertaken at the end.
3113 * \param[in] serializer Abstract serializer used to read/write data.
3114 * \param[in] tpx The file header data.
3115 * \param[in,out] ir Datastructures with simulation parameters.
3116 * \param[in,out] state Global state data.
3117 * \param[in,out] x Individual coordinates for processing, deprecated.
3118 * \param[in,out] v Individual velocities for processing, deprecated.
3119 * \param[in,out] mtop Global topology.
3121 static PbcType do_tpx_body(gmx::ISerializer* serializer,
3131 do_tpx_state_first(serializer, tpx, state);
3133 do_tpx_mtop(serializer, tpx, mtop);
3136 do_tpx_state_second(serializer, tpx, state, x, v);
3138 PbcType pbcType = do_tpx_ir(serializer, tpx, ir);
3139 if (serializer->reading())
3141 do_tpx_finalize(tpx, ir, state, mtop);
3147 * Overload for do_tpx_body that defaults to state vectors being nullptr.
3149 * \param[in] serializer Abstract serializer used to read/write data.
3150 * \param[in] tpx The file header data.
3151 * \param[in,out] ir Datastructures with simulation parameters.
3152 * \param[in,out] mtop Global topology.
3154 static PbcType do_tpx_body(gmx::ISerializer* serializer, TpxFileHeader* tpx, t_inputrec* ir, gmx_mtop_t* mtop)
3156 return do_tpx_body(serializer, tpx, ir, nullptr, nullptr, nullptr, mtop);
3159 static t_fileio* open_tpx(const char* fn, const char* mode)
3161 return gmx_fio_open(fn, mode);
3164 static void close_tpx(t_fileio* fio)
3170 * Fill information into the header only from state before writing.
3172 * Populating the header needs to be independent from writing the information
3173 * to file to allow things like writing the raw byte stream.
3175 * \param[in] state The current simulation state. Can't write without it.
3176 * \param[in] ir Parameter and system information.
3177 * \param[in] mtop Global topology.
3178 * \returns Fully populated header.
3180 static TpxFileHeader populateTpxHeader(const t_state& state, const t_inputrec* ir, const gmx_mtop_t* mtop)
3182 TpxFileHeader header;
3183 header.natoms = state.natoms;
3184 header.ngtc = state.ngtc;
3185 header.fep_state = state.fep_state;
3186 header.lambda = state.lambda[efptFEP];
3187 header.bIr = ir != nullptr;
3188 header.bTop = mtop != nullptr;
3189 header.bX = (state.flags & (1 << estX)) != 0;
3190 header.bV = (state.flags & (1 << estV)) != 0;
3193 header.fileVersion = tpx_version;
3194 header.fileGeneration = tpx_generation;
3195 header.isDouble = (sizeof(real) == sizeof(double));
3201 * Process the body of a TPR file as an opaque data buffer.
3203 * Reads/writes the information in \p buffer from/to the \p serializer
3204 * provided to the function. Does not interact with the actual
3205 * TPR datastructures but with an in memory representation of the
3206 * data, so that this data can be efficiently read or written from/to
3207 * an original source.
3209 * \param[in] serializer The abstract serializer used for reading or writing
3210 * the information in \p buffer.
3211 * \param[in,out] buffer Information from TPR file as char buffer.
3213 static void doTpxBodyBuffer(gmx::ISerializer* serializer, gmx::ArrayRef<char> buffer)
3215 serializer->doOpaque(buffer.data(), buffer.size());
3219 * Populates simulation datastructures.
3221 * Here the information from the serialization interface \p serializer
3222 * is used to first populate the datastructures containing the simulation
3223 * information. Depending on the version found in the header \p tpx,
3224 * this is done using the new reading of the data as one block from disk,
3225 * followed by complete deserialization of the information read from there.
3226 * Otherwise, the datastructures are populated as before one by one from disk.
3227 * The second version is the default for the legacy tools that read the
3228 * coordinates and velocities separate from the state.
3230 * After reading in the data, a separate buffer is populated from them
3231 * containing only \p ir and \p mtop that can be communicated directly
3232 * to nodes needing the information to set up a simulation.
3234 * \param[in] tpx The file header.
3235 * \param[in] serializer The Serialization interface used to read the TPR.
3236 * \param[out] ir Input rec to populate.
3237 * \param[out] state State vectors to populate.
3238 * \param[out] x Coordinates to populate if needed.
3239 * \param[out] v Velocities to populate if needed.
3240 * \param[out] mtop Global topology to populate.
3242 * \returns Partial de-serialized TPR used for communication to nodes.
3244 static PartialDeserializedTprFile readTpxBody(TpxFileHeader* tpx,
3245 gmx::ISerializer* serializer,
3252 PartialDeserializedTprFile partialDeserializedTpr;
3253 if (tpx->fileVersion >= tpxv_AddSizeField && tpx->fileGeneration >= 27)
3255 partialDeserializedTpr.body.resize(tpx->sizeOfTprBody);
3256 partialDeserializedTpr.header = *tpx;
3257 doTpxBodyBuffer(serializer, partialDeserializedTpr.body);
3259 partialDeserializedTpr.pbcType =
3260 completeTprDeserialization(&partialDeserializedTpr, ir, state, x, v, mtop);
3264 partialDeserializedTpr.pbcType = do_tpx_body(serializer, tpx, ir, state, x, v, mtop);
3266 // Update header to system info for communication to nodes.
3267 // As we only need to communicate the inputrec and mtop to other nodes,
3268 // we prepare a new char buffer with the information we have already read
3270 partialDeserializedTpr.header = populateTpxHeader(*state, ir, mtop);
3271 // Long-term we should move to use little endian in files to avoid extra byte swapping,
3272 // but since we just used the default XDR format (which is big endian) for the TPR
3273 // header it would cause third-party libraries reading our raw data to tear their hair
3274 // if we swap the endian in the middle of the file, so we stick to big endian in the
3275 // TPR file for now - and thus we ask the serializer to swap if this host is little endian.
3276 gmx::InMemorySerializer tprBodySerializer(gmx::EndianSwapBehavior::SwapIfHostIsLittleEndian);
3277 do_tpx_body(&tprBodySerializer, &partialDeserializedTpr.header, ir, mtop);
3278 partialDeserializedTpr.body = tprBodySerializer.finishAndGetBuffer();
3280 return partialDeserializedTpr;
3283 /************************************************************
3285 * The following routines are the exported ones
3287 ************************************************************/
3289 TpxFileHeader readTpxHeader(const char* fileName, bool canReadTopologyOnly)
3293 fio = open_tpx(fileName, "r");
3294 gmx::FileIOXdrSerializer serializer(fio);
3297 do_tpxheader(&serializer, &tpx, fileName, fio, canReadTopologyOnly);
3302 void write_tpx_state(const char* fn, const t_inputrec* ir, const t_state* state, const gmx_mtop_t* mtop)
3304 /* To write a state, we first need to write the state information to a buffer before
3305 * we append the raw bytes to the file. For this, the header information needs to be
3306 * populated before we write the main body because it has some information that is
3307 * otherwise not available.
3312 TpxFileHeader tpx = populateTpxHeader(*state, ir, mtop);
3313 // Long-term we should move to use little endian in files to avoid extra byte swapping,
3314 // but since we just used the default XDR format (which is big endian) for the TPR
3315 // header it would cause third-party libraries reading our raw data to tear their hair
3316 // if we swap the endian in the middle of the file, so we stick to big endian in the
3317 // TPR file for now - and thus we ask the serializer to swap if this host is little endian.
3318 gmx::InMemorySerializer tprBodySerializer(gmx::EndianSwapBehavior::SwapIfHostIsLittleEndian);
3320 do_tpx_body(&tprBodySerializer,
3322 const_cast<t_inputrec*>(ir),
3323 const_cast<t_state*>(state),
3326 const_cast<gmx_mtop_t*>(mtop));
3328 std::vector<char> tprBody = tprBodySerializer.finishAndGetBuffer();
3329 tpx.sizeOfTprBody = tprBody.size();
3331 fio = open_tpx(fn, "w");
3332 gmx::FileIOXdrSerializer serializer(fio);
3333 do_tpxheader(&serializer, &tpx, fn, fio, ir == nullptr);
3334 doTpxBodyBuffer(&serializer, tprBody);
3339 PbcType completeTprDeserialization(PartialDeserializedTprFile* partialDeserializedTpr,
3346 // Long-term we should move to use little endian in files to avoid extra byte swapping,
3347 // but since we just used the default XDR format (which is big endian) for the TPR
3348 // header it would cause third-party libraries reading our raw data to tear their hair
3349 // if we swap the endian in the middle of the file, so we stick to big endian in the
3350 // TPR file for now - and thus we ask the serializer to swap if this host is little endian.
3351 gmx::InMemoryDeserializer tprBodyDeserializer(partialDeserializedTpr->body,
3352 partialDeserializedTpr->header.isDouble,
3353 gmx::EndianSwapBehavior::SwapIfHostIsLittleEndian);
3354 return do_tpx_body(&tprBodyDeserializer, &partialDeserializedTpr->header, ir, state, x, v, mtop);
3357 PbcType completeTprDeserialization(PartialDeserializedTprFile* partialDeserializedTpr,
3361 return completeTprDeserialization(partialDeserializedTpr, ir, nullptr, nullptr, nullptr, mtop);
3364 PartialDeserializedTprFile read_tpx_state(const char* fn, t_inputrec* ir, t_state* state, gmx_mtop_t* mtop)
3367 fio = open_tpx(fn, "r");
3368 gmx::FileIOXdrSerializer serializer(fio);
3369 PartialDeserializedTprFile partialDeserializedTpr;
3370 do_tpxheader(&serializer, &partialDeserializedTpr.header, fn, fio, ir == nullptr);
3371 partialDeserializedTpr =
3372 readTpxBody(&partialDeserializedTpr.header, &serializer, ir, state, nullptr, nullptr, mtop);
3374 return partialDeserializedTpr;
3377 PbcType read_tpx(const char* fn, t_inputrec* ir, matrix box, int* natoms, rvec* x, rvec* v, gmx_mtop_t* mtop)
3383 fio = open_tpx(fn, "r");
3384 gmx::FileIOXdrSerializer serializer(fio);
3385 do_tpxheader(&serializer, &tpx, fn, fio, ir == nullptr);
3386 PartialDeserializedTprFile partialDeserializedTpr =
3387 readTpxBody(&tpx, &serializer, ir, &state, x, v, mtop);
3389 if (mtop != nullptr && natoms != nullptr)
3391 *natoms = mtop->natoms;
3395 copy_mat(state.box, box);
3397 return partialDeserializedTpr.pbcType;
3400 PbcType read_tpx_top(const char* fn, t_inputrec* ir, matrix box, int* natoms, rvec* x, rvec* v, t_topology* top)
3405 pbcType = read_tpx(fn, ir, box, natoms, x, v, &mtop);
3407 *top = gmx_mtop_t_to_t_topology(&mtop, true);
3412 gmx_bool fn2bTPX(const char* file)
3414 return (efTPR == fn2ftp(file));
3417 void pr_tpxheader(FILE* fp, int indent, const char* title, const TpxFileHeader* sh)
3419 if (available(fp, sh, indent, title))
3421 indent = pr_title(fp, indent, title);
3422 pr_indent(fp, indent);
3423 fprintf(fp, "bIr = %spresent\n", sh->bIr ? "" : "not ");
3424 pr_indent(fp, indent);
3425 fprintf(fp, "bBox = %spresent\n", sh->bBox ? "" : "not ");
3426 pr_indent(fp, indent);
3427 fprintf(fp, "bTop = %spresent\n", sh->bTop ? "" : "not ");
3428 pr_indent(fp, indent);
3429 fprintf(fp, "bX = %spresent\n", sh->bX ? "" : "not ");
3430 pr_indent(fp, indent);
3431 fprintf(fp, "bV = %spresent\n", sh->bV ? "" : "not ");
3432 pr_indent(fp, indent);
3433 fprintf(fp, "bF = %spresent\n", sh->bF ? "" : "not ");
3435 pr_indent(fp, indent);
3436 fprintf(fp, "natoms = %d\n", sh->natoms);
3437 pr_indent(fp, indent);
3438 fprintf(fp, "lambda = %e\n", sh->lambda);
3439 pr_indent(fp, indent);
3440 fprintf(fp, "buffer size = %" PRId64 "\n", sh->sizeOfTprBody);