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, 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
  38 #ifndef GMX_FILEIO_TPXIO_H
  39 #define GMX_FILEIO_TPXIO_H
  40
  41
  42 /**************************************************************
  43  *
  44  * The routines in the corresponding c-file tpxio.c
  45  * are based on the lower level routines in gmxfio.c
  46  * The integer file pointer returned from open_tpx
  47  * can also be used with the routines in gmxfio.h
  48  *
  49  **************************************************************/
  50 #include "../legacyheaders/types/inputrec.h"
  51 #include "../legacyheaders/types/state.h"
  52 #include "../legacyheaders/types/topology.h"
  53 #include "gmxfio.h"
  54
  55 #ifdef __cplusplus
  56 extern "C" {
  57 #endif
  58
  59 struct t_atoms;
  60 struct t_block;
  61
  62 typedef struct
  63 {
  64     int   bIr;       /* Non zero if input_rec is present                */
  65     int   bBox;      /* Non zero if a box is present                    */
  66     int   bTop;      /* Non zero if a topology is present               */
  67     int   bX;        /* Non zero if coordinates are present             */
  68     int   bV;        /* Non zero if velocities are present              */
  69     int   bF;        /* Non zero if forces are present          */
  70
  71     int   natoms;    /* The total number of atoms                       */
  72     int   ngtc;      /* The number of temperature coupling groups    */
  73     real  lambda;    /* Current value of lambda                 */
  74     int   fep_state; /* Current value of the alchemical state --
  75                       * not yet printed out.  */
  76     /*a better decision will eventually (5.0 or later) need to be made
  77        on how to treat the alchemical state of the system, which can now
  78        vary through a simulation, and cannot be completely described
  79        though a single lambda variable, or even a single state
  80        index. Eventually, should probably be a vector. MRS*/
  81 } t_tpxheader;
  82
  83 /*
  84  * These routines handle reading and writing of preprocessed
  85  * topology files in any of the following formats:
  86  * TPR : topology in XDR format, portable accross platforms
  87  * TPB : binary topology, not portable accross platforms
  88  * TPA : ascii topology (possibbly huge)
  89  * TRR : trajectory in XDR format (non compressed)
  90  * TRJ : trajectory in binary format
  91  *
  92  * Files are written in the precision with which the source are compiled,
  93  * but double and single precision can be read by either.
  94  */
  95
  96 t_fileio *open_tpx(const char *fn, const char *mode);
  97 /* Return an file pointer corresponding to the file you have just opened */
  98
  99 void close_tpx(t_fileio *fio);
 100 /*  Close the file corresponding to fio */
 101
 102 void read_tpxheader(const char *fn, t_tpxheader *tpx, gmx_bool TopOnlyOK,
 103                     int *version, int *generation);
 104 /* Read the header from a tpx file and then close it again.
 105  * By setting TopOnlyOK to true, it is possible to read future
 106  * versions too (we skip the changed inputrec), provided we havent
 107  * changed the topology description. If it is possible to read
 108  * the inputrec it will still be done even if TopOnlyOK is TRUE.
 109  *
 110  * The version and generation if the topology (see top of tpxio.c)
 111  * are returned in the two last arguments.
 112  */
 113
 114 void write_tpx_state(const char *fn,
 115                      t_inputrec *ir, t_state *state, gmx_mtop_t *mtop);
 116 /* Write a file, and close it again.
 117  * If fn == NULL, an efTPA file will be written to stdout (which
 118  * will not be closed afterwards)
 119  */
 120
 121 void read_tpx_state(const char *fn,
 122                     t_inputrec *ir, t_state *state, rvec *f,
 123                     gmx_mtop_t *mtop);
 124 int read_tpx(const char *fn,
 125              t_inputrec *ir, matrix box, int *natoms,
 126              rvec *x, rvec *v, rvec *f, gmx_mtop_t *mtop);
 127 /* Read a file, and close it again.
 128  * If fn == NULL, an efTPA file will be read from stdin (which
 129  * will not be closed afterwards)
 130  * When step, t or lambda are NULL they will not be stored.
 131  * Returns ir->ePBC, if it could be read from the file.
 132  */
 133
 134 int read_tpx_top(const char *fn,
 135                  t_inputrec *ir, matrix box, int *natoms,
 136                  rvec *x, rvec *v, rvec *f, t_topology *top);
 137 /* As read_tpx, but for the old t_topology struct */
 138
 139 gmx_bool fn2bTPX(const char *file);
 140 /* return if *file is one of the TPX file types */
 141
 142 gmx_bool read_tps_conf(const char *infile, char *title, t_topology *top,
 143                        int *ePBC, rvec **x, rvec **v, matrix box, gmx_bool bMass);
 144 /* Read title, top.atoms, x, v (if not NULL) and box from an STX file,
 145  * memory for atoms, x and v will be allocated.
 146  * Return TRUE if a complete topology was read.
 147  * If infile is a TPX file read the whole top,
 148  * else if bMass=TRUE, read the masses into top.atoms from the mass database.
 149  */
 150
 151 void tpx_make_chain_identifiers(struct t_atoms *atoms, struct t_block *mols);
 152
 153 #ifdef __cplusplus
 154 }
 155 #endif
 156
 157 #endif