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,2014, 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 #ifndef GMX_FILEIO_XDRF_H
  38 #define GMX_FILEIO_XDRF_H
  39
  40 #include <stdio.h>
  41
  42 #include "gromacs/utility/basedefinitions.h"
  43 #include "gromacs/utility/real.h"
  44
  45 #ifdef __PGI    /*Portland group compiler*/
  46 #define int64_t long long
  47 #endif
  48
  49 #include "config.h"
  50
  51 #ifdef GMX_INTERNAL_XDR
  52 #include "gmx_system_xdr.h"
  53 #else
  54 #include <rpc/rpc.h>
  55 #include <rpc/xdr.h>
  56 #endif
  57
  58 #ifdef __cplusplus
  59 extern "C" {
  60 #endif
  61
  62 struct t_fileio;
  63
  64 /* Read or write reduced precision *float* coordinates */
  65 int xdr3dfcoord(XDR *xdrs, float *fp, int *size, float *precision);
  66
  67
  68 /* Read or write a *real* value (stored as float) */
  69 int xdr_real(XDR *xdrs, real *r);
  70
  71
  72 /* Read or write reduced precision *real* coordinates */
  73 int xdr3drcoord(XDR *xdrs, real *fp, int *size, real *precision);
  74
  75
  76 int xdr_int64(XDR *xdrs, gmx_int64_t *i);
  77 /* Read or write a gmx_int64_t value.
  78  * When warn!=NULL a warning will be written to stderr
  79  * when a value does not fit,
  80  * the first line is:
  81  * "WARNING during %s:", where warn is printed in %s.
  82  */
  83
  84 int xdr_xtc_seek_time(real time, FILE *fp, XDR *xdrs, int natoms, gmx_bool bSeekForwardOnly);
  85
  86
  87 int xdr_xtc_seek_frame(int frame, FILE *fp, XDR *xdrs, int natoms);
  88
  89
  90 float xdr_xtc_get_last_frame_time(FILE *fp, XDR *xdrs, int natoms, gmx_bool * bOK);
  91
  92
  93 int xdr_xtc_get_last_frame_number(FILE *fp, XDR *xdrs, int natoms, gmx_bool * bOK);
  94
  95
  96 /* Defined in gmxfio.c.
  97  * TODO: It would be nice to decouple this header from t_fileio completely,
  98  * and not need the XDR struct in gmxfio.h, but that would require some
  99  * extra code that is not warranted for this single function.
 100  * Can be reconsidered if the file I/O gets refactored in the future.
 101  */
 102 XDR *gmx_fio_getxdr(struct t_fileio *fio);
 103 /* Return the file pointer itself */
 104
 105 #ifdef __cplusplus
 106 }
 107 #endif
 108
 109 #endif