src/gromacs/fileio/tpxio.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
  38 #ifndef GMX_FILEIO_TPXIO_H
  39 #define GMX_FILEIO_TPXIO_H
  40
  41
  42 /**************************************************************
  43  *
  44  * The routines in the corresponding c-file tpxio.c
  45  * are based on the lower level routines in gmxfio.c
  46  *
  47  **************************************************************/
  48 #include "gromacs/legacyheaders/types/inputrec.h"
  49 #include "gromacs/legacyheaders/types/state.h"
  50
  51 #ifdef __cplusplus
  52 extern "C" {
  53 #endif
  54
  55 struct gmx_mtop_t;
  56 struct t_atoms;
  57 struct t_block;
  58 struct t_topology;
  59
  60 typedef struct
  61 {
  62     int   bIr;       /* Non zero if input_rec is present                */
  63     int   bBox;      /* Non zero if a box is present                    */
  64     int   bTop;      /* Non zero if a topology is present               */
  65     int   bX;        /* Non zero if coordinates are present             */
  66     int   bV;        /* Non zero if velocities are present              */
  67     int   bF;        /* Non zero if forces are present          */
  68
  69     int   natoms;    /* The total number of atoms                       */
  70     int   ngtc;      /* The number of temperature coupling groups    */
  71     real  lambda;    /* Current value of lambda                 */
  72     int   fep_state; /* Current value of the alchemical state --
  73                       * not yet printed out.  */
  74     /*a better decision will eventually (5.0 or later) need to be made
  75        on how to treat the alchemical state of the system, which can now
  76        vary through a simulation, and cannot be completely described
  77        though a single lambda variable, or even a single state
  78        index. Eventually, should probably be a vector. MRS*/
  79 } t_tpxheader;
  80
  81 /*
  82  * These routines handle reading and writing of preprocessed
  83  * topology files in any of the following formats:
  84  * TPR : topology in XDR format, portable accross platforms
  85  *
  86  * Files are written in the precision with which the source are compiled,
  87  * but double and single precision can be read by either.
  88  */
  89
  90 void read_tpxheader(const char *fn, t_tpxheader *tpx, gmx_bool TopOnlyOK,
  91                     int *version, int *generation);
  92 /* Read the header from a tpx file and then close it again.
  93  * By setting TopOnlyOK to true, it is possible to read future
  94  * versions too (we skip the changed inputrec), provided we havent
  95  * changed the topology description. If it is possible to read
  96  * the inputrec it will still be done even if TopOnlyOK is TRUE.
  97  *
  98  * The version and generation if the topology (see top of tpxio.c)
  99  * are returned in the two last arguments.
 100  */
 101
 102 void write_tpx_state(const char *fn,
 103                      t_inputrec *ir, t_state *state, struct gmx_mtop_t *mtop);
 104 /* Write a file, and close it again.
 105  */
 106
 107 void read_tpx_state(const char *fn,
 108                     t_inputrec *ir, t_state *state, rvec *f,
 109                     struct gmx_mtop_t *mtop);
 110 int read_tpx(const char *fn,
 111              t_inputrec *ir, matrix box, int *natoms,
 112              rvec *x, rvec *v, rvec *f, struct gmx_mtop_t *mtop);
 113 /* Read a file, and close it again.
 114  * When step, t or lambda are NULL they will not be stored.
 115  * Returns ir->ePBC, if it could be read from the file.
 116  */
 117
 118 int read_tpx_top(const char *fn,
 119                  t_inputrec *ir, matrix box, int *natoms,
 120                  rvec *x, rvec *v, rvec *f, struct t_topology *top);
 121 /* As read_tpx, but for the old t_topology struct */
 122
 123 gmx_bool fn2bTPX(const char *file);
 124 /* return if *file is one of the TPX file types */
 125
 126 #ifdef __cplusplus
 127 }
 128 #endif
 129
 130 #endif