include/pdbio.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 _pdbio_h
  37 #define _pdbio_h
  38 #include "visibility.h"
  39 #include "sysstuff.h"
  40 #include "typedefs.h"
  41 #include "symtab.h"
  42 #include "atomprop.h"
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 typedef struct gmx_conect_t *gmx_conect;
  49
  50 /* THE pdb format (for ATOM/HETATOM lines) */
  51 static const char *pdbformat ="%-6s%5u  %-4.4s%3.3s %c%4d%c   %8.3f%8.3f%8.3f";
  52 static const char *pdbformat4="%-6s%5u %-4.4s %3.3s %c%4d%c   %8.3f%8.3f%8.3f";
  53
  54 /* Enumerated type for pdb records. The other entries are ignored
  55  * when reading a pdb file
  56  */
  57 enum { epdbATOM,   epdbHETATM, epdbANISOU, epdbCRYST1, epdbCOMPND,
  58        epdbMODEL,  epdbENDMDL, epdbTER,    epdbHEADER, epdbTITLE, epdbREMARK,
  59        epdbCONECT, epdbNR };
  60
  61 /* Enumerated value for indexing an uij entry (anisotropic temperature factors) */
  62 enum { U11, U22, U33, U12, U13, U23 };
  63
  64 GMX_LIBGMX_EXPORT
  65 void set_pdb_wide_format(gmx_bool bSet);
  66 /* If bSet, use wider format for occupancy and bfactor */
  67
  68 void pdb_use_ter(gmx_bool bSet);
  69 /* set read_pdbatoms to read upto 'TER' or 'ENDMDL' (default, bSet=FALSE).
  70    This function is fundamentally broken as far as thread-safety is concerned.*/
  71
  72 GMX_LIBGMX_EXPORT
  73 void gmx_write_pdb_box(FILE *out,int ePBC,matrix box);
  74 /* write the box in the CRYST1 record,
  75  * with ePBC=-1 the pbc is guessed from the box
  76  * This function is fundamentally broken as far as thread-safety is concerned.
  77  */
  78
  79 GMX_LIBGMX_EXPORT
  80 void write_pdbfile_indexed(FILE *out,const char *title,t_atoms *atoms,
  81                                   rvec x[],int ePBC,matrix box,char chain,
  82                                   int model_nr,atom_id nindex,atom_id index[],
  83                                   gmx_conect conect,gmx_bool bTerSepChains);
  84 /* REALLY low level */
  85
  86 GMX_LIBGMX_EXPORT
  87 void write_pdbfile(FILE *out,const char *title,t_atoms *atoms,
  88                           rvec x[],int ePBC,matrix box,char chain,
  89                           int model_nr,gmx_conect conect,gmx_bool bTerSepChains);
  90 /* Low level pdb file writing routine.
  91  *
  92  *          ONLY FOR SPECIAL PURPOSES,
  93  *
  94  *       USE write_sto_conf WHEN YOU CAN.
  95  *
  96  * override chain-identifiers with chain when chain>0
  97  * write ENDMDL when bEndmodel is TRUE.
  98  *
  99  * If the gmx_conect structure is not NULL its content is dumped as CONECT records
 100  * which may be useful for visualization purposes.
 101  */
 102
 103 GMX_LIBGMX_EXPORT
 104 void get_pdb_atomnumber(t_atoms *atoms,gmx_atomprop_t aps);
 105 /* Routine to extract atomic numbers from the atom names */
 106
 107 int read_pdbfile(FILE *in,char *title,int *model_nr,
 108                         t_atoms *atoms,rvec x[],int *ePBC,matrix box,
 109                         gmx_bool bChange,gmx_conect conect);
 110 /* Function returns number of atoms found.
 111  * ePBC and gmx_conect structure may be NULL.
 112  */
 113
 114 void read_pdb_conf(const char *infile,char *title,
 115                           t_atoms *atoms,rvec x[],int *ePBC,matrix box,
 116                           gmx_bool bChange,gmx_conect conect);
 117 /* Read a pdb file and extract ATOM and HETATM fields.
 118  * Read a box from the CRYST1 line, return 0 box when no CRYST1 is found.
 119  * Change atom names according to protein conventions if wanted.
 120  * ePBC and gmx_conect structure may be NULL.
 121  */
 122
 123 void get_pdb_coordnum(FILE *in,int *natoms);
 124 /* Read a pdb file and count the ATOM and HETATM fields. */
 125
 126 GMX_LIBGMX_EXPORT
 127 gmx_bool is_hydrogen(const char *nm);
 128 /* Return whether atom nm is a hydrogen */
 129
 130 GMX_LIBGMX_EXPORT
 131 gmx_bool is_dummymass(const char *nm);
 132 /* Return whether atom nm is a dummy mass */
 133
 134 /* Routines to handle CONECT records if they have been read in */
 135 void gmx_conect_dump(FILE *fp,gmx_conect conect);
 136
 137 gmx_bool gmx_conect_exist(gmx_conect conect,int ai,int aj);
 138 /* Return TRUE if there is a conection between the atoms */
 139
 140 void gmx_conect_add(gmx_conect conect,int ai,int aj);
 141 /* Add a connection between ai and aj (numbered from 0 to natom-1) */
 142
 143 GMX_LIBGMX_EXPORT
 144 gmx_conect gmx_conect_generate(t_topology *top);
 145 /* Generate a conect structure from a topology */
 146
 147 gmx_conect gmx_conect_init(void);
 148 /* Initiate data structure */
 149
 150 void gmx_conect_done(gmx_conect gc);
 151 /* Free memory */
 152
 153 #ifdef __cplusplus
 154 }
 155 #endif
 156
 157 #endif  /* _pdbio_h */