src/gromacs/fileio/xdrf.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, 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_XDRF_H
  39 #define GMX_FILEIO_XDRF_H
  40
  41
  42 #include <stdio.h>
  43 #include "../legacyheaders/typedefs.h"
  44
  45 #ifdef __PGI    /*Portland group compiler*/
  46 #define int64_t long long
  47 #endif
  48
  49 #include "../utility/gmx_header_config.h"
  50 #ifdef GMX_INTERNAL_XDR
  51 #include "gmx_system_xdr.h"
  52 #else
  53 #include <rpc/rpc.h>
  54 #include <rpc/xdr.h>
  55 #endif
  56
  57 #ifdef __cplusplus
  58 extern "C" {
  59 #endif
  60
  61
  62 /* THESE 3 FUNCTIONS (xdropen, xdrclose and xdr_get_fp) ARE NOW OBSOLETE
  63    AND ONLY PROVIDED FOR BACKWARD COMPATIBILITY OF 3D PARTY TOOLS.
  64    THEY SHOULD NOT BE USED ANYWHERE IN GROMACS ITSELF.
  65    int xdropen(XDR *xdrs, const char *filename, const char *type);
  66    int xdrclose(XDR *xdrs);
  67  */
  68
  69 /* the xdr data types; note that there is no data type 'real' because
  70    here we deal with the types as they are actually written to disk.  */
  71 typedef enum
  72 {
  73     xdr_datatype_int,
  74     xdr_datatype_float,
  75     xdr_datatype_double,
  76     xdr_datatype_large_int,
  77     xdr_datatype_char,
  78     xdr_datatype_string
  79 } xdr_datatype;
  80
  81 /* names corresponding to the xdr_datatype enum */
  82 extern const char *xdr_datatype_names[];
  83
  84 /* Read or write reduced precision *float* coordinates */
  85 int xdr3dfcoord(XDR *xdrs, float *fp, int *size, float *precision);
  86
  87
  88 /* Read or write a *real* value (stored as float) */
  89 int xdr_real(XDR *xdrs, real *r);
  90
  91
  92 /* Read or write reduced precision *real* coordinates */
  93 int xdr3drcoord(XDR *xdrs, real *fp, int *size, real *precision);
  94
  95
  96 int xdr_gmx_large_int(XDR *xdrs, gmx_large_int_t *i);
  97 /* Read or write a gmx_large_int_t value.
  98  * 32bit code reading a 64bit gmx_large_int_t value from xdrs could
  99  * lead to values out of int range.
 100  * When warn!=NULL a warning will be written to stderr
 101  * when a value does not fit,
 102  * the first line is:
 103  * "WARNING during %s:", where warn is printed in %s.
 104  */
 105
 106 int xdr_xtc_seek_time(real time, FILE *fp, XDR *xdrs, int natoms, gmx_bool bSeekForwardOnly);
 107
 108
 109 int xdr_xtc_seek_frame(int frame, FILE *fp, XDR *xdrs, int natoms);
 110
 111
 112 float xdr_xtc_get_last_frame_time(FILE *fp, XDR *xdrs, int natoms, gmx_bool * bOK);
 113
 114
 115 int xdr_xtc_get_last_frame_number(FILE *fp, XDR *xdrs, int natoms, gmx_bool * bOK);
 116
 117 #ifdef __cplusplus
 118 }
 119 #endif
 120
 121 #endif