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