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,2018,2019, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 #ifndef GMX_FILEIO_TPXIO_H
  38 #define GMX_FILEIO_TPXIO_H
  39
  40 #include <cstdio>
  41
  42 #include "gromacs/math/vectypes.h"
  43 #include "gromacs/utility/basedefinitions.h"
  44 #include "gromacs/utility/real.h"
  45
  46 struct gmx_mtop_t;
  47 struct t_atoms;
  48 struct t_block;
  49 struct t_inputrec;
  50 class t_state;
  51 struct t_topology;
  52
  53 /*! \libinternal
  54  * \brief
  55  * First part of the TPR file structure containing information about
  56  * the general aspect of the system.
  57  */
  58 struct TpxFileHeader
  59 {
  60     //! Non zero if input_rec is present.
  61     bool  bIr = false;
  62     //! Non zero if a box is present.
  63     bool  bBox = false;
  64     //! Non zero if a topology is present.
  65     bool  bTop = false;
  66     //! Non zero if coordinates are present.
  67     bool  bX = false;
  68     //! Non zero if velocities are present.
  69     bool  bV = false;
  70     //! Non zero if forces are present (no longer supported, but retained so old .tpr can be read)
  71     bool  bF = false;
  72     //! The total number of atoms.
  73     int   natoms = 0;
  74     //! The number of temperature coupling groups.
  75     int   ngtc = 0;
  76     //! Current value of lambda.
  77     real  lambda = 0;
  78     //! Current value of the alchemical state - not yet printed out.
  79     int   fep_state = 0;
  80     /*a better decision will eventually (5.0 or later) need to be made
  81        on how to treat the alchemical state of the system, which can now
  82        vary through a simulation, and cannot be completely described
  83        though a single lambda variable, or even a single state
  84        index. Eventually, should probably be a vector. MRS*/
  85     //! File version.
  86     int     fileVersion = 0;
  87     //! File generation.
  88     int     fileGeneration = 0;
  89 };
  90
  91 /*
  92  * These routines handle reading and writing of preprocessed
  93  * topology files in any of the following formats:
  94  * TPR : topology in XDR format, portable accross platforms
  95  *
  96  * Files are written in the precision with which the source are compiled,
  97  * but double and single precision can be read by either.
  98  */
  99
 100 /*! \brief
 101  * Read the header from a tpx file and then close it again.
 102  *
 103  * By setting \p canReadTopologyOnly to true, it is possible to read future
 104  * versions too (we skip the changed inputrec), provided we havent
 105  * changed the topology description. If it is possible to read
 106  * the inputrec it will still be done even if canReadTopologyOnly is true.
 107  *
 108  * \param[in] fileName The name of the input file.
 109  * \param[in] canReadTopologyOnly If reading the inputrec can be skipped or not.
 110  * \returns An initialized and populated TPX File header object.
 111  */
 112 TpxFileHeader readTpxHeader(const char *fileName, bool canReadTopologyOnly);
 113
 114 void write_tpx_state(const char *fn,
 115                      const t_inputrec *ir, const t_state *state, const gmx_mtop_t *mtop);
 116 /* Write a file, and close it again.
 117  */
 118
 119 void read_tpx_state(const char *fn,
 120                     t_inputrec *ir, t_state *state,
 121                     gmx_mtop_t *mtop);
 122
 123 /*! \brief
 124  * Read a file and close it again.
 125  *
 126  * Reads a topology input file and populates the fields if the passed
 127  * variables are valid. It is possible to pass \p ir, \p natoms,
 128  * \p x, \p v or \p mtop as nullptr to the function. In those cases,
 129  * the variables will not be populated from the input file. Passing both
 130  * \p x and \p v as nullptr is not supported. If both \p natoms and
 131  * \p mtop are passed as valid objects to the function, the total atom
 132  * number from \p mtop will be set in \p natoms. Otherwise \p natoms
 133  * will not be changed. If \p box is valid, the box will be set from
 134  * the information read in from the file.
 135  *
 136  * \param[in] fn Input file name.
 137  * \param[out] ir Input parameters to be set, or nullptr.
 138  * \param[out] box Box matrix.
 139  * \param[out] natoms Total atom numbers to be set, or nullptr.
 140  * \param[out] x Positions to be filled from file, or nullptr.
 141  * \param[out] v Velocities to be filled from file, or nullptr.
 142  * \param[out] mtop Topology to be populated, or nullptr.
 143  * \returns ir->ePBC if it was read from the file.
 144  */
 145 int read_tpx(const char *fn,
 146              t_inputrec *ir, matrix box, int *natoms,
 147              rvec *x, rvec *v, gmx_mtop_t *mtop);
 148
 149 int read_tpx_top(const char *fn,
 150                  t_inputrec *ir, matrix box, int *natoms,
 151                  rvec *x, rvec *v, t_topology *top);
 152 /* As read_tpx, but for the old t_topology struct */
 153
 154 gmx_bool fn2bTPX(const char *file);
 155 /* return if *file is one of the TPX file types */
 156
 157 void pr_tpxheader(FILE *fp, int indent, const char *title, const TpxFileHeader *sh);
 158
 159 #endif