include/confio.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  *                        VERSION 3.2.0
  10  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  11  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  12  * Copyright (c) 2001-2004, The GROMACS development team,
  13  * check out http://www.gromacs.org for more information.
  14
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * If you want to redistribute modifications, please consider that
  21  * scientific software is very special. Version control is crucial -
  22  * bugs must be traceable. We will be happy to consider code for
  23  * inclusion in the official distribution, but derived work must not
  24  * be called official GROMACS. Details are found in the README & COPYING
  25  * files - if they are missing, get the official version at www.gromacs.org.
  26  *
  27  * To help us fund GROMACS development, we humbly ask that you cite
  28  * the papers on the package - you can find them in the top README file.
  29  *
  30  * For more info, check our website at http://www.gromacs.org
  31  *
  32  * And Hey:
  33  * Gromacs Runs On Most of All Computer Systems
  34  */
  35
  36 #ifndef _confio_h
  37 #define _confio_h
  38
  39
  40 #include "typedefs.h"
  41
  42 /* For reading coordinate files it is assumed that enough memory
  43  * has been allocated beforehand.
  44  */
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 void init_t_atoms(t_atoms *atoms, int natoms, gmx_bool bPdbinfo);
  50 /* allocate memory for the arrays, set nr to natoms and nres to 0
  51  * set pdbinfo to NULL or allocate memory for it */
  52
  53 int read_g96_conf(FILE *fp,const char *infile,t_trxframe *fr);
  54 /* read a Gromos96 coordinate or trajectory file,                       *
  55  * returns the number of atoms                                          *
  56  * sets what's in the frame in info                                     *
  57  * read from fp, infile is only needed for error messages               *
  58  * nwanted is the number of wanted coordinates,                         *
  59  * set this to -1 if you want to know the number of atoms in the file   *
  60  * title, atoms, x, v can all be NULL, in which case they won't be read */
  61
  62 void write_g96_conf(FILE *out,t_trxframe *fr,int nindex,atom_id *index);
  63 /* write a Gromos96 coordinate file or trajectory frame *
  64  * index can be NULL                                    */
  65
  66 gmx_bool gro_next_x_or_v(FILE *status,t_trxframe *fr);
  67 int gro_first_x_or_v(FILE *status,t_trxframe *fr);
  68 /* read first/next x and/or v frame from gro file */
  69
  70 void write_hconf_indexed_p(FILE *out,const char *title,t_atoms *atoms,
  71                                   int nx,atom_id index[],int ndec,
  72                                   rvec *x,rvec *v,matrix box);
  73
  74 void write_hconf_p(FILE *out,const char *title,t_atoms *atoms, int ndec,
  75                           rvec *x,rvec *v,matrix box);
  76 /* Write a Gromos file with precision ndec: number of decimal places in x,
  77  * v has one place more. */
  78
  79 void write_sto_conf_indexed(const char *outfile,const char *title,
  80                             t_atoms *atoms,
  81                             rvec x[],rvec *v,int ePBC,matrix box,
  82                             atom_id nindex,atom_id index[]);
  83 /* like write_sto_conf, but indexed */
  84
  85 void write_sto_conf(const char *outfile,const char *title,
  86                            t_atoms *atoms,
  87                            rvec x[],rvec *v,int ePBC,matrix box);
  88 /* write atoms, x, v (if .gro and not NULL) and box (if not NULL)
  89  * to an STO (.gro or .pdb) file */
  90
  91 void write_sto_conf_mtop(const char *outfile,const char *title,
  92                                 gmx_mtop_t *mtop,
  93                                 rvec x[],rvec *v,int ePBC,matrix box);
  94 /* As write_sto_conf, but uses a gmx_mtop_t struct */
  95
  96 void get_stx_coordnum (const char *infile,int *natoms);
  97 /* read the number of atoms from an STX file */
  98
  99 void read_stx_conf(const char *infile,char *title,
 100                           t_atoms *atoms,
 101                           rvec x[],rvec *v,int *ePBC,matrix box);
 102 /* Read atoms, x, v and box from an STX file.
 103  * If ePBC!=NULL return the type of pbc in *ePBC or -1 if unknown.
 104  */
 105
 106 #ifdef __cplusplus
 107 }
 108 #endif
 109
 110 #endif  /* _confio_h */