src/gromacs/fileio/tpxio.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015,2016,2017 by the GROMACS development team.
   7  * Copyright (c) 2018,2019,2020,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.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 #ifndef GMX_FILEIO_TPXIO_H
  39 #define GMX_FILEIO_TPXIO_H
  40
  41 #include <cstdio>
  42
  43 #include <vector>
  44
  45 #include "gromacs/math/vectypes.h"
  46 #include "gromacs/pbcutil/pbc.h"
  47 #include "gromacs/utility/basedefinitions.h"
  48 #include "gromacs/utility/real.h"
  49
  50 struct gmx_mtop_t;
  51 struct t_atoms;
  52 struct t_block;
  53 struct t_inputrec;
  54 class t_state;
  55 struct t_topology;
  56
  57 namespace gmx
  58 {
  59 template<typename>
  60 class ArrayRef;
  61 }
  62 /*! \libinternal
  63  * \brief
  64  * First part of the TPR file structure containing information about
  65  * the general aspect of the system.
  66  *
  67  * When adding to or making breaking changes to reading this struct,
  68  * update TpxGeneration.
  69  */
  70 struct TpxFileHeader
  71 {
  72     //! Non zero if input_rec is present.
  73     bool bIr = false;
  74     //! Non zero if a box is present.
  75     bool bBox = false;
  76     //! Non zero if a topology is present.
  77     bool bTop = false;
  78     //! Non zero if coordinates are present.
  79     bool bX = false;
  80     //! Non zero if velocities are present.
  81     bool bV = false;
  82     //! Non zero if forces are present (no longer supported, but retained so old .tpr can be read)
  83     bool bF = false;
  84     //! The total number of atoms.
  85     int natoms = 0;
  86     //! The number of temperature coupling groups.
  87     int ngtc = 0;
  88     //! Current value of lambda.
  89     real lambda = 0;
  90     //! Current value of the alchemical state - not yet printed out.
  91     int fep_state = 0;
  92     /*a better decision will eventually (5.0 or later) need to be made
  93        on how to treat the alchemical state of the system, which can now
  94        vary through a simulation, and cannot be completely described
  95        though a single lambda variable, or even a single state
  96        index. Eventually, should probably be a vector. MRS*/
  97     //! Size of the TPR body in chars (equal to number of bytes) during I/O.
  98     int64_t sizeOfTprBody = 0;
  99     //! File version.
 100     int fileVersion = 0;
 101     //! File generation.
 102     int fileGeneration = 0;
 103     //! If the tpr file was written in double precision.
 104     bool isDouble = false;
 105 };
 106
 107 /*! \brief
 108  * Contains the partly deserialized contents of a TPR file.
 109  *
 110  * Convenience struct that holds a fully deserialized TPR file header,
 111  * and the body of the TPR file as char buffer that can be deserialized
 112  * independently from the header.
 113  */
 114 struct PartialDeserializedTprFile
 115 {
 116     //! The file header.
 117     TpxFileHeader header;
 118     //! The file body.
 119     std::vector<char> body;
 120     //! Flag for PBC needed by legacy implementation.
 121     PbcType pbcType = PbcType::Unset;
 122 };
 123
 124 /*
 125  * These routines handle reading and writing of preprocessed
 126  * topology files in any of the following formats:
 127  * TPR : topology in XDR format, portable accross platforms
 128  *
 129  * Files are written in the precision with which the source are compiled,
 130  * but double and single precision can be read by either.
 131  */
 132
 133 /*! \brief
 134  * Read the header from a tpx file and then close it again.
 135  *
 136  * By setting \p canReadTopologyOnly to true, it is possible to read future
 137  * versions too (we skip the changed inputrec), provided we havent
 138  * changed the topology description. If it is possible to read
 139  * the inputrec it will still be done even if canReadTopologyOnly is true.
 140  *
 141  * \param[in] fileName The name of the input file.
 142  * \param[in] canReadTopologyOnly If reading the inputrec can be skipped or not.
 143  * \returns An initialized and populated TPX File header object.
 144  */
 145 TpxFileHeader readTpxHeader(const char* fileName, bool canReadTopologyOnly);
 146
 147 void write_tpx_state(const char* fn, const t_inputrec* ir, const t_state* state, const gmx_mtop_t* mtop);
 148 /* Write a file, and close it again.
 149  */
 150
 151 /*! \brief
 152  * Complete deserialization of TPR file into the individual data structures.
 153  *
 154  * If \p state is nullptr, only populates ir and mtop.
 155  *
 156  * \param[in] partialDeserializedTpr Struct with header and char buffer needed to populate system.
 157  * \param[out] ir Input rec to populate.
 158  * \param[out] state System state variables to populate.
 159  * \param[out] x Separate vector for coordinates, deprecated.
 160  * \param[out] v Separate vector for velocities, deprecated.
 161  * \param[out] mtop Global topology to populate.
 162  *
 163  * \returns PBC flag.
 164  */
 165 PbcType completeTprDeserialization(PartialDeserializedTprFile* partialDeserializedTpr,
 166                                    t_inputrec*                 ir,
 167                                    t_state*                    state,
 168                                    rvec*                       x,
 169                                    rvec*                       v,
 170                                    gmx_mtop_t*                 mtop);
 171
 172 //! Overload for final TPR deserialization when not using state vectors.
 173 PbcType completeTprDeserialization(PartialDeserializedTprFile* partialDeserializedTpr,
 174                                    t_inputrec*                 ir,
 175                                    gmx_mtop_t*                 mtop);
 176
 177 /*! \brief
 178  * Read a file to set up a simulation and close it after reading.
 179  *
 180  * Main function used to initialize simulations. Reads the input \p fn
 181  * to populate the \p state, \p ir and \p mtop needed to run a simulations.
 182  *
 183  * This function returns the partial deserialized TPR file
 184  * that can then be communicated to set up non-master nodes to run simulations.
 185  *
 186  * \param[in] fn Input file name.
 187  * \param[out] ir Input parameters to be set, or nullptr.
 188  * \param[out] state State variables for the simulation.
 189  * \param[out] mtop Global simulation topolgy.
 190  * \returns Struct with header and body in char vector.
 191  */
 192 PartialDeserializedTprFile read_tpx_state(const char* fn, t_inputrec* ir, t_state* state, gmx_mtop_t* mtop);
 193
 194 /*! \brief
 195  * Read a file and close it again.
 196  *
 197  * Reads a topology input file and populates the fields if the passed
 198  * variables are valid. It is possible to pass \p ir, \p natoms,
 199  * \p x, \p v or \p mtop as nullptr to the function. In those cases,
 200  * the variables will not be populated from the input file. Passing both
 201  * \p x and \p v as nullptr is not supported. If both \p natoms and
 202  * \p mtop are passed as valid objects to the function, the total atom
 203  * number from \p mtop will be set in \p natoms. Otherwise \p natoms
 204  * will not be changed. If \p box is valid, the box will be set from
 205  * the information read in from the file.
 206  *
 207  * \param[in] fn Input file name.
 208  * \param[out] ir Input parameters to be set, or nullptr.
 209  * \param[out] box Box matrix.
 210  * \param[out] natoms Total atom numbers to be set, or nullptr.
 211  * \param[out] x Positions to be filled from file, or nullptr.
 212  * \param[out] v Velocities to be filled from file, or nullptr.
 213  * \param[out] mtop Topology to be populated, or nullptr.
 214  * \returns ir->pbcType if it was read from the file.
 215  */
 216 PbcType read_tpx(const char* fn, t_inputrec* ir, matrix box, int* natoms, rvec* x, rvec* v, gmx_mtop_t* mtop);
 217
 218 PbcType read_tpx_top(const char* fn, t_inputrec* ir, matrix box, int* natoms, rvec* x, rvec* v, t_topology* top);
 219 /* As read_tpx, but for the old t_topology struct */
 220
 221 gmx_bool fn2bTPX(const char* file);
 222 /* return if *file is one of the TPX file types */
 223
 224 void pr_tpxheader(FILE* fp, int indent, const char* title, const TpxFileHeader* sh);
 225
 226 #endif