src/gromacs/fileio/g96io.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,2017 by the GROMACS development team.
   7  * Copyright (c) 2018,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 #ifndef GMX_FILEIO_G96IO_H
  39 #define GMX_FILEIO_G96IO_H
  40
  41 #include <stdio.h>
  42
  43
  44 struct t_symtab;
  45 struct t_trxframe;
  46
  47 int read_g96_conf(FILE* fp, const char* infile, char** name, struct t_trxframe* fr, struct t_symtab* symtab, char* line);
  48 /* read a Gromos96 coordinate or trajectory file,                       *
  49  * returns the number of atoms                                          *
  50  * sets what's in the frame in info                                     *
  51  * read from fp, infile is only needed for error messages               *
  52  * nwanted is the number of wanted coordinates,                         *
  53  * set this to -1 if you want to know the number of atoms in the file   *
  54  * title, atoms, x, v can all be NULL, in which case they won't be read *
  55  * line holds the previous line for trajectory reading                  *
  56  *
  57  * symtab only needs to be valid if fr->atoms is valid
  58  *
  59  * If name is not nullptr, gmx_strdup the first g96 title string into it. */
  60
  61 void write_g96_conf(FILE* out, const char* title, const t_trxframe* fr, int nindex, const int* index);
  62 /* write a Gromos96 coordinate file or trajectory frame *
  63  * index can be NULL                                    */
  64
  65 #endif