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