include/tpxio.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  *                        VERSION 3.2.0
  10  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  11  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  12  * Copyright (c) 2001-2004, The GROMACS development team,
  13  * check out http://www.gromacs.org for more information.
  14
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * If you want to redistribute modifications, please consider that
  21  * scientific software is very special. Version control is crucial -
  22  * bugs must be traceable. We will be happy to consider code for
  23  * inclusion in the official distribution, but derived work must not
  24  * be called official GROMACS. Details are found in the README & COPYING
  25  * files - if they are missing, get the official version at www.gromacs.org.
  26  *
  27  * To help us fund GROMACS development, we humbly ask that you cite
  28  * the papers on the package - you can find them in the top README file.
  29  *
  30  * For more info, check our website at http://www.gromacs.org
  31  *
  32  * And Hey:
  33  * Gromacs Runs On Most of All Computer Systems
  34  */
  35
  36 #ifndef _tpxio_h
  37 #define _tpxio_h
  38
  39
  40   /**************************************************************
  41    *
  42    * The routines in the corresponding c-file tpxio.c
  43    * are based on the lower level routines in gmxfio.c
  44    * The integer file pointer returned from open_tpx
  45    * can also be used with the routines in gmxfio.h
  46    *
  47    **************************************************************/
  48 #include "visibility.h"
  49 #include "typedefs.h"
  50 #include "gmxfio.h"
  51
  52 #ifdef __cplusplus
  53 extern "C" {
  54 #endif
  55
  56 typedef struct
  57 {
  58   int   bIr;            /* Non zero if input_rec is present             */
  59   int   bBox;           /* Non zero if a box is present                 */
  60   int   bTop;           /* Non zero if a topology is present            */
  61   int   bX;             /* Non zero if coordinates are present          */
  62   int   bV;             /* Non zero if velocities are present           */
  63   int   bF;             /* Non zero if forces are present               */
  64
  65   int   natoms;         /* The total number of atoms                    */
  66   int   ngtc;           /* The number of temperature coupling groups    */
  67   real  lambda;         /* Current value of lambda                      */
  68   int   fep_state;      /* Current value of the alchemical state --
  69                          * not yet printed out.  */
  70   /*a better decision will eventually (5.0 or later) need to be made
  71     on how to treat the alchemical state of the system, which can now
  72     vary through a simulation, and cannot be completely described
  73     though a single lambda variable, or even a single state
  74     index. Eventually, should probably be a vector. MRS*/
  75 } t_tpxheader;
  76
  77 /*
  78  * These routines handle reading and writing of preprocessed
  79  * topology files in any of the following formats:
  80  * TPR : topology in XDR format, portable accross platforms
  81  * TPB : binary topology, not portable accross platforms
  82  * TPA : ascii topology (possibbly huge)
  83  * TRR : trajectory in XDR format (non compressed)
  84  * TRJ : trajectory in binary format
  85  *
  86  * Files are written in the precision with which the source are compiled,
  87  * but double and single precision can be read by either.
  88  */
  89
  90 GMX_LIBGMX_EXPORT
  91 t_fileio *open_tpx(const char *fn, const char *mode);
  92 /* Return an file pointer corresponding to the file you have just opened */
  93
  94 GMX_LIBGMX_EXPORT
  95 void close_tpx(t_fileio *fio);
  96 /*  Close the file corresponding to fio */
  97
  98 GMX_LIBGMX_EXPORT
  99 void read_tpxheader(const char *fn, t_tpxheader *tpx, gmx_bool TopOnlyOK,
 100                            int *version, int *generation);
 101 /* Read the header from a tpx file and then close it again.
 102  * By setting TopOnlyOK to true, it is possible to read future
 103  * versions too (we skip the changed inputrec), provided we havent
 104  * changed the topology description. If it is possible to read
 105  * the inputrec it will still be done even if TopOnlyOK is TRUE.
 106  *
 107  * The version and generation if the topology (see top of tpxio.c)
 108  * are returned in the two last arguments.
 109  */
 110
 111 GMX_LIBGMX_EXPORT
 112 void write_tpx_state(const char *fn,
 113                             t_inputrec *ir,t_state *state,gmx_mtop_t *mtop);
 114 /* Write a file, and close it again.
 115  * If fn == NULL, an efTPA file will be written to stdout (which
 116  * will not be closed afterwards)
 117  */
 118
 119 GMX_LIBGMX_EXPORT
 120 void read_tpx_state(const char *fn,
 121                            t_inputrec *ir,t_state *state,rvec *f,
 122                            gmx_mtop_t *mtop);
 123 GMX_LIBGMX_EXPORT
 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 GMX_LIBGMX_EXPORT
 135 int read_tpx_top(const char *fn,
 136                         t_inputrec *ir, matrix box,int *natoms,
 137                         rvec *x,rvec *v,rvec *f,t_topology *top);
 138 /* As read_tpx, but for the old t_topology struct */
 139
 140 GMX_LIBGMX_EXPORT
 141 gmx_bool fn2bTPX(const char *file);
 142 /* return if *file is one of the TPX file types */
 143
 144 GMX_LIBGMX_EXPORT
 145 gmx_bool read_tps_conf(const char *infile,char *title,t_topology *top,
 146                           int *ePBC, rvec **x,rvec **v,matrix box,gmx_bool bMass);
 147 /* Read title, top.atoms, x, v (if not NULL) and box from an STX file,
 148  * memory for atoms, x and v will be allocated.
 149  * Return TRUE if a complete topology was read.
 150  * If infile is a TPX file read the whole top,
 151  * else if bMass=TRUE, read the masses into top.atoms from the mass database.
 152  */
 153
 154 void tpx_make_chain_identifiers(t_atoms *atoms,t_block *mols);
 155
 156 #ifdef __cplusplus
 157 }
 158 #endif
 159
 160 #endif