a86854fa9746489ec630e38969ecc7995be853f5
[alexxy/gromacs.git] / include / types / trx.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  * GRoups of Organic Molecules in ACtion for Science
34  */
35
36 /* The bools indicate whether a field was read from the trajectory.
37  * Do not try to use a pointer when its bool is FALSE, as memory might
38  * not be allocated.
39  */ 
40
41 #include "atoms.h"
42 #include "../molfile_plugin.h"
43 #include "../vmdio.h"
44
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48
49 typedef struct trxframe
50 {
51   int  flags;     /* flags for read_first/next_frame  */
52   int  not_ok;    /* integrity flags (see statutil.h  */
53   bool bDouble;   /* Double precision?                */
54   int  natoms;    /* number of atoms (atoms, x, v, f) */
55   real t0;        /* time of the first frame, needed  *
56                    * for skipping frames with -dt     */
57   real tpf;       /* time of the previous frame, not  */
58                   /* the read, but real file frames   */
59   real tppf;      /* time of two frames ago           */
60                   /* tpf and tppf are needed to       */
61                   /* correct rounding errors for -e   */
62   bool bTitle;
63   const char *title; /* title of the frame            */
64   bool bStep;
65   int  step;      /* MD step number                   */
66   bool bTime;
67   real time;      /* time of the frame                */
68   bool bLambda;
69   real lambda;    /* free energy perturbation lambda  */
70   bool bAtoms;
71   t_atoms *atoms; /* atoms struct (natoms)            */
72   bool bPrec;
73   real prec;      /* precision of x, fraction of 1 nm */
74   bool bX;
75   rvec *x;        /* coordinates (natoms)             */
76   bool bV;
77   rvec *v;        /* velocities (natoms)              */
78   bool bF;
79   rvec *f;        /* forces (natoms)                  */
80   bool bBox;
81   matrix box;     /* the 3 box vectors                */
82   bool bPBC;
83   int  ePBC;      /* the type of pbc                  */
84   t_gmxvmdplugin vmdplugin;
85 } t_trxframe;
86
87 #ifdef __cplusplus
88 }
89 #endif
90