c635a8ae714cfdb41d3fb574c5d8ae57fa1956f1
[alexxy/gromacs.git] / include / types / trx.h
1 /*
2  * $Id$
3  * 
4  *                This source code is part of
5  * 
6  *                 G   R   O   M   A   C   S
7  * 
8  *          GROningen MAchine for Chemical Simulations
9  * 
10  *                        VERSION 3.0
11  * 
12  * Copyright (c) 1991-2001
13  * BIOSON Research Institute, Dept. of Biophysical Chemistry
14  * University of Groningen, The Netherlands
15  * 
16  * This program is free software; you can redistribute it and/or
17  * modify it under the terms of the GNU General Public License
18  * as published by the Free Software Foundation; either version 2
19  * of the License, or (at your option) any later version.
20  * 
21  * If you want to redistribute modifications, please consider that
22  * scientific software is very special. Version control is crucial -
23  * bugs must be traceable. We will be happy to consider code for
24  * inclusion in the official distribution, but derived work must not
25  * be called official GROMACS. Details are found in the README & COPYING
26  * files - if they are missing, get the official version at www.gromacs.org.
27  * 
28  * To help us fund GROMACS development, we humbly ask that you cite
29  * the papers on the package - you can find them in the top README file.
30  * 
31  * Do check out http://www.gromacs.org , or mail us at gromacs@gromacs.org .
32  * 
33  * And Hey:
34  * Good ROcking Metal Altar for Chronical Sinners
35  */
36 #ifdef HAVE_CONFIG_H
37 #include <config.h>
38 #endif
39
40 /* The bools indicate whether a field was read from the trajectory.
41  * Do not try to use a pointer when its bool is FALSE, as memory might
42  * not be allocated.
43  */ 
44 typedef struct
45 {
46   int  flags;     /* flags for read_first/next_frame  */
47   int  not_ok;    /* integrity flags (see statutil.h  */
48   int  natoms;    /* number of atoms (atoms, x, v, f) */
49   real t0;        /* time of the first frame, needed  *
50                    * for skipping frames with -dt     */
51   real tpf;       /* time of the previous frame, not  */
52                   /* the read, but real file frames   */
53   real tppf;      /* time of two frames ago           */
54                   /* tpf and tppf are needed to       */
55                   /* correct rounding errors for -e   */
56   bool bTitle;
57   char *title;    /* title of the frame               */
58   bool bStep;
59   int  step;      /* MD step number                   */
60   bool bTime;
61   real time;      /* time of the frame                */
62   bool bLambda;
63   real lambda;    /* free energy perturbation lambda  */
64   bool bAtoms;
65   t_atoms *atoms; /* atoms struct (natoms)            */
66   bool bPrec;
67   real prec;      /* precision of x, fraction of 1 nm */
68   bool bX;
69   rvec *x;        /* coordinates (natoms)             */
70   bool bV;
71   rvec *v;        /* velocities (natoms)              */
72   bool bF;
73   rvec *f;        /* forces (natoms)                  */
74   bool bBox;
75   matrix box;     /* the 3 box vectors                */
76 } t_trxframe;
77