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, 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.
38 #ifndef GMX_FILEIO_TPXIO_H
39 #define GMX_FILEIO_TPXIO_H
45 #include "gromacs/math/vectypes.h"
46 #include "gromacs/utility/arrayref.h"
47 #include "gromacs/utility/basedefinitions.h"
48 #include "gromacs/utility/real.h"
59 * First part of the TPR file structure containing information about
60 * the general aspect of the system.
64 //! Non zero if input_rec is present.
66 //! Non zero if a box is present.
68 //! Non zero if a topology is present.
70 //! Non zero if coordinates are present.
72 //! Non zero if velocities are present.
74 //! Non zero if forces are present (no longer supported, but retained so old .tpr can be read)
76 //! The total number of atoms.
78 //! The number of temperature coupling groups.
80 //! Current value of lambda.
82 //! Current value of the alchemical state - not yet printed out.
84 /*a better decision will eventually (5.0 or later) need to be made
85 on how to treat the alchemical state of the system, which can now
86 vary through a simulation, and cannot be completely described
87 though a single lambda variable, or even a single state
88 index. Eventually, should probably be a vector. MRS*/
89 //! Size of the TPR body in chars (equal to number of bytes) during I/O.
90 int64_t sizeOfTprBody = 0;
94 int fileGeneration = 0;
95 //! If the tpr file was written in double precision.
96 bool isDouble = false;
100 * Contains the partly deserialized contents of a TPR file.
102 * Convenience struct that holds a fully deserialized TPR file header,
103 * and the body of the TPR file as char buffer that can be deserialized
104 * independently from the header.
106 struct PartialDeserializedTprFile
109 TpxFileHeader header;
111 std::vector<char> body;
112 //! Flag for PBC needed by legacy implementation.
117 * These routines handle reading and writing of preprocessed
118 * topology files in any of the following formats:
119 * TPR : topology in XDR format, portable accross platforms
121 * Files are written in the precision with which the source are compiled,
122 * but double and single precision can be read by either.
126 * Read the header from a tpx file and then close it again.
128 * By setting \p canReadTopologyOnly to true, it is possible to read future
129 * versions too (we skip the changed inputrec), provided we havent
130 * changed the topology description. If it is possible to read
131 * the inputrec it will still be done even if canReadTopologyOnly is true.
133 * \param[in] fileName The name of the input file.
134 * \param[in] canReadTopologyOnly If reading the inputrec can be skipped or not.
135 * \returns An initialized and populated TPX File header object.
137 TpxFileHeader readTpxHeader(const char* fileName, bool canReadTopologyOnly);
139 void write_tpx_state(const char* fn, const t_inputrec* ir, const t_state* state, const gmx_mtop_t* mtop);
140 /* Write a file, and close it again.
144 * Complete deserialization of TPR file into the individual data structures.
146 * If \p state is nullptr, only populates ir and mtop.
148 * \param[in] partialDeserializedTpr Struct with header and char buffer needed to populate system.
149 * \param[out] ir Input rec to populate.
150 * \param[out] state System state variables to populate.
151 * \param[out] x Separate vector for coordinates, deprecated.
152 * \param[out] v Separate vector for velocities, deprecated.
153 * \param[out] mtop Global topology to populate.
157 int completeTprDeserialization(PartialDeserializedTprFile* partialDeserializedTpr,
164 //! Overload for final TPR deserialization when not using state vectors.
165 int completeTprDeserialization(PartialDeserializedTprFile* partialDeserializedTpr,
170 * Read a file to set up a simulation and close it after reading.
172 * Main function used to initialize simulations. Reads the input \p fn
173 * to populate the \p state, \p ir and \p mtop needed to run a simulations.
175 * This function returns the partial deserialized TPR file
176 * that can then be communicated to set up non-master nodes to run simulations.
178 * \param[in] fn Input file name.
179 * \param[out] ir Input parameters to be set, or nullptr.
180 * \param[out] state State variables for the simulation.
181 * \param[out] mtop Global simulation topolgy.
182 * \returns Struct with header and body in char vector.
184 PartialDeserializedTprFile read_tpx_state(const char* fn, t_inputrec* ir, t_state* state, gmx_mtop_t* mtop);
187 * Read a file and close it again.
189 * Reads a topology input file and populates the fields if the passed
190 * variables are valid. It is possible to pass \p ir, \p natoms,
191 * \p x, \p v or \p mtop as nullptr to the function. In those cases,
192 * the variables will not be populated from the input file. Passing both
193 * \p x and \p v as nullptr is not supported. If both \p natoms and
194 * \p mtop are passed as valid objects to the function, the total atom
195 * number from \p mtop will be set in \p natoms. Otherwise \p natoms
196 * will not be changed. If \p box is valid, the box will be set from
197 * the information read in from the file.
199 * \param[in] fn Input file name.
200 * \param[out] ir Input parameters to be set, or nullptr.
201 * \param[out] box Box matrix.
202 * \param[out] natoms Total atom numbers to be set, or nullptr.
203 * \param[out] x Positions to be filled from file, or nullptr.
204 * \param[out] v Velocities to be filled from file, or nullptr.
205 * \param[out] mtop Topology to be populated, or nullptr.
206 * \returns ir->ePBC if it was read from the file.
208 int read_tpx(const char* fn, t_inputrec* ir, matrix box, int* natoms, rvec* x, rvec* v, gmx_mtop_t* mtop);
210 int read_tpx_top(const char* fn, t_inputrec* ir, matrix box, int* natoms, rvec* x, rvec* v, t_topology* top);
211 /* As read_tpx, but for the old t_topology struct */
213 gmx_bool fn2bTPX(const char* file);
214 /* return if *file is one of the TPX file types */
216 void pr_tpxheader(FILE* fp, int indent, const char* title, const TpxFileHeader* sh);