src/gromacs/fileio/xtcio.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,2016,2018 by the GROMACS development team.
   7  * Copyright (c) 2019,2020, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38
  39 #ifndef GMX_FILEIO_XTCIO_H
  40 #define GMX_FILEIO_XTCIO_H
  41
  42 #include "gromacs/math/vectypes.h"
  43 #include "gromacs/utility/basedefinitions.h"
  44 #include "gromacs/utility/real.h"
  45
  46 struct t_fileio;
  47
  48 /* All functions return 1 if successful, 0 otherwise
  49  * bOK tells if a frame is not corrupted
  50  */
  51
  52 /* Note that XTC was implemented to use xdr_int for the step number,
  53  * which is defined by the standard to be signed and 32 bit. We didn't
  54  * design the format to be extensible, so we can't fix the fact that
  55  * after 2^31 frames, step numbers will wrap to be
  56  * negative. Fortunately, this tends not to cause serious problems,
  57  * and we've fixed it in TNG. */
  58
  59 struct t_fileio* open_xtc(const char* filename, const char* mode);
  60 /* Open a file for xdr I/O */
  61
  62 void close_xtc(struct t_fileio* fio);
  63 /* Close the file for xdr I/O */
  64
  65 int read_first_xtc(struct t_fileio* fio,
  66                    int*             natoms,
  67                    int64_t*         step,
  68                    real*            time,
  69                    matrix           box,
  70                    rvec**           x,
  71                    real*            prec,
  72                    gmx_bool*        bOK);
  73 /* Open xtc file, read xtc file first time, allocate memory for x */
  74
  75 int read_next_xtc(struct t_fileio* fio, int natoms, int64_t* step, real* time, matrix box, rvec* x, real* prec, gmx_bool* bOK);
  76 /* Read subsequent frames */
  77
  78 int write_xtc(struct t_fileio* fio, int natoms, int64_t step, real time, const rvec* box, const rvec* x, real prec);
  79 /* Write a frame to xtc file */
  80
  81 #endif