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