src/gromacs/fileio/confio.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
  38 #ifndef GMX_FILEIO_CONFIO_H
  39 #define GMX_FILEIO_CONFIO_H
  40
  41 #include <stdio.h>
  42
  43 #include "../legacyheaders/types/simple.h"
  44
  45 #include "trx.h"
  46
  47 /* For reading coordinate files it is assumed that enough memory
  48  * has been allocated beforehand.
  49  */
  50 #ifdef __cplusplus
  51 extern "C" {
  52 #endif
  53
  54 struct gmx_mtop_t;
  55 struct t_atoms;
  56
  57 int read_g96_conf(FILE *fp, const char *infile, t_trxframe *fr, char *line);
  58 /* read a Gromos96 coordinate or trajectory file,                       *
  59  * returns the number of atoms                                          *
  60  * sets what's in the frame in info                                     *
  61  * read from fp, infile is only needed for error messages               *
  62  * nwanted is the number of wanted coordinates,                         *
  63  * set this to -1 if you want to know the number of atoms in the file   *
  64  * title, atoms, x, v can all be NULL, in which case they won't be read *
  65  * line holds the previous line for trajectory reading                  */
  66
  67 void write_g96_conf(FILE *out, t_trxframe *fr, int nindex, const atom_id *index);
  68 /* write a Gromos96 coordinate file or trajectory frame *
  69  * index can be NULL                                    */
  70
  71 gmx_bool gro_next_x_or_v(FILE *status, t_trxframe *fr);
  72 int gro_first_x_or_v(FILE *status, t_trxframe *fr);
  73 /* read first/next x and/or v frame from gro file */
  74
  75 void write_hconf_indexed_p(FILE *out, const char *title, struct t_atoms *atoms,
  76                            int nx, const atom_id index[], int ndec,
  77                            rvec *x, rvec *v, matrix box);
  78
  79 void write_hconf_p(FILE *out, const char *title, struct t_atoms *atoms, int ndec,
  80                    rvec *x, rvec *v, matrix box);
  81 /* Write a Gromos file with precision ndec: number of decimal places in x,
  82  * v has one place more. */
  83
  84 void write_sto_conf_indexed(const char *outfile, const char *title,
  85                             struct t_atoms *atoms,
  86                             rvec x[], rvec *v, int ePBC, matrix box,
  87                             atom_id nindex, atom_id index[]);
  88 /* like write_sto_conf, but indexed */
  89
  90 void write_sto_conf(const char *outfile, const char *title,
  91                     struct t_atoms *atoms,
  92                     rvec x[], rvec *v, int ePBC, matrix box);
  93 /* write atoms, x, v (if .gro and not NULL) and box (if not NULL)
  94  * to an STO (.gro or .pdb) file */
  95
  96 void write_sto_conf_mtop(const char *outfile, const char *title,
  97                          struct gmx_mtop_t *mtop,
  98                          rvec x[], rvec *v, int ePBC, matrix box);
  99 /* As write_sto_conf, but uses a gmx_mtop_t struct */
 100
 101 void get_stx_coordnum (const char *infile, int *natoms);
 102 /* read the number of atoms from an STX file */
 103
 104 void read_stx_conf(const char *infile, char *title,
 105                    struct t_atoms *atoms,
 106                    rvec x[], rvec *v, int *ePBC, matrix box);
 107 /* Read atoms, x, v and box from an STX file.
 108  * If ePBC!=NULL return the type of pbc in *ePBC or -1 if unknown.
 109  */
 110
 111 #ifdef __cplusplus
 112 }
 113 #endif
 114
 115 #endif  /* GMX_FILEIO_CONFIO_H */