src/gromacs/fileio/trnio.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_TRNIO_H
  39 #define GMX_FILEIO_TRNIO_H
  40
  41 /**************************************************************
  42  *
  43  * These routines handle trr (trajectory) I/O, they read and
  44  * write trr files. The routines should be able to read single
  45  * and double precision files without the user noting it.
  46  * The files are backward compatible, therefore the header holds
  47  * some unused variables.
  48  *
  49  * The routines in the corresponding c-file trnio.c
  50  * are based on the lower level routines in gmxfio.c
  51  * The integer file pointer returned from open_trn
  52  * can also be used with the routines in gmxfio.h
  53  *
  54  **************************************************************/
  55
  56 #include "gmxfio.h"
  57
  58 #ifdef __cplusplus
  59 extern "C" {
  60 #endif
  61
  62 typedef struct           /* This struct describes the order and the     */
  63                          /* sizes of the structs in a trjfile, sizes are given in bytes.        */
  64 {
  65     gmx_bool  bDouble;   /* Double precision?                            */
  66     int       ir_size;   /* Backward compatibility                      */
  67     int       e_size;    /* Backward compatibility                      */
  68     int       box_size;  /* Non zero if a box is present                        */
  69     int       vir_size;  /* Backward compatibility                      */
  70     int       pres_size; /* Backward compatibility                      */
  71     int       top_size;  /* Backward compatibility                      */
  72     int       sym_size;  /* Backward compatibility                      */
  73     int       x_size;    /* Non zero if coordinates are present         */
  74     int       v_size;    /* Non zero if velocities are present          */
  75     int       f_size;    /* Non zero if forces are present              */
  76
  77     int       natoms;    /* The total number of atoms                   */
  78     int       step;      /* Current step number                         */
  79     int       nre;       /* Backward compatibility                      */
  80     real      t;         /* Current time                                        */
  81     real      lambda;    /* Current value of lambda                     */
  82     int       fep_state; /* Current value of alchemical state */
  83 } t_trnheader;
  84
  85 t_fileio *open_trn(const char *fn, const char *mode);
  86 /* Open a trr / trr file */
  87
  88 void close_trn(t_fileio *fio);
  89 /* Close it */
  90
  91 gmx_bool fread_trnheader(t_fileio *fio, t_trnheader *trn, gmx_bool *bOK);
  92 /* Read the header of a trn file. Return FALSE if there is no frame.
  93  * bOK will be FALSE when the header is incomplete.
  94  */
  95
  96 void read_trnheader(const char *fn, t_trnheader *header);
  97 /* Read the header of a trn file from fn, and close the file afterwards.
  98  */
  99
 100 void pr_trnheader(FILE *fp, int indent, char *title, t_trnheader *sh);
 101 /* Print the header of a trn file to fp */
 102
 103 gmx_bool is_trn(FILE *fp);
 104 /* Return true when the file is a trn file. File will be rewound
 105  * afterwards.
 106  */
 107
 108 void fwrite_trn(t_fileio *fio, int step, real t, real lambda,
 109                 rvec *box, int natoms, rvec *x, rvec *v, rvec *f);
 110 /* Write a trn frame to file fp, box, x, v, f may be NULL */
 111
 112 gmx_bool fread_htrn(t_fileio *fio, t_trnheader *sh,
 113                     rvec *box, rvec *x, rvec *v, rvec *f);
 114 /* Extern read a frame except the header (that should be pre-read,
 115  * using routine read_trnheader, see above) from a trn file.
 116  * Return FALSE on error
 117  */
 118
 119 gmx_bool fread_trn(t_fileio *fio, int *step, real *t, real *lambda,
 120                    rvec *box, int *natoms, rvec *x, rvec *v, rvec *f);
 121 /* Read a trn frame, including the header from fp. box, x, v, f may
 122  * be NULL, in which case the data will be skipped over.
 123  * return FALSE on error
 124  */
 125
 126 void write_trn(const char *fn, int step, real t, real lambda,
 127                rvec *box, int natoms, rvec *x, rvec *v, rvec *f);
 128 /* Write a single trn frame to file fn, which is closed afterwards */
 129
 130 void read_trn(const char *fn, int *step, real *t, real *lambda,
 131               rvec *box, int *natoms, rvec *x, rvec *v, rvec *f);
 132 /* Read a single trn frame from file fn, which is closed afterwards
 133  */
 134
 135 #ifdef __cplusplus
 136 }
 137 #endif
 138
 139
 140 #endif