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,2015, 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_CONFIO_H
  38 #define GMX_FILEIO_CONFIO_H
  39
  40 #include <stdio.h>
  41
  42 #include "gromacs/legacyheaders/types/simple.h"
  43
  44 /* For reading coordinate files it is assumed that enough memory
  45  * has been allocated beforehand.
  46  */
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif
  50
  51 struct gmx_mtop_t;
  52 struct t_atoms;
  53 struct t_topology;
  54
  55 void write_sto_conf_indexed(const char *outfile, const char *title,
  56                             struct t_atoms *atoms,
  57                             rvec x[], rvec *v, int ePBC, matrix box,
  58                             atom_id nindex, atom_id index[]);
  59 /* like write_sto_conf, but indexed */
  60
  61 void write_sto_conf(const char *outfile, const char *title,
  62                     struct t_atoms *atoms,
  63                     rvec x[], rvec *v, int ePBC, matrix box);
  64 /* write atoms, x, v (if .gro and not NULL) and box (if not NULL)
  65  * to an STO (.gro or .pdb) file */
  66
  67 void write_sto_conf_mtop(const char *outfile, const char *title,
  68                          struct gmx_mtop_t *mtop,
  69                          rvec x[], rvec *v, int ePBC, matrix box);
  70 /* As write_sto_conf, but uses a gmx_mtop_t struct */
  71
  72 void get_stx_coordnum (const char *infile, int *natoms);
  73 /* read the number of atoms from an STX file */
  74
  75 void read_stx_conf(const char *infile, char *title,
  76                    struct t_atoms *atoms,
  77                    rvec x[], rvec *v, int *ePBC, matrix box);
  78 /* Read atoms, x, v and box from an STX file.
  79  * If ePBC!=NULL return the type of pbc in *ePBC or -1 if unknown.
  80  */
  81
  82 gmx_bool read_tps_conf(const char *infile, char *title, struct t_topology *top,
  83                        int *ePBC, rvec **x, rvec **v, matrix box, gmx_bool bMass);
  84 /* Read title, top.atoms, x, v (if not NULL) and box from an STX file,
  85  * memory for atoms, x and v will be allocated.
  86  * Return TRUE if a complete topology was read.
  87  * If infile is a TPX file read the whole top,
  88  * else if bMass=TRUE, read the masses into top.atoms from the mass database.
  89  */
  90
  91 #ifdef __cplusplus
  92 }
  93 #endif
  94
  95 #endif