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