src/gromacs/gmxpreprocess/hizzie.cpp

   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 /* This file is completely threadsafe - keep it that way! */
  38 #include "gmxpre.h"
  39
  40 #include <stdio.h>
  41 #include <string.h>
  42
  43 #include <cmath>
  44
  45 #include "gromacs/fileio/pdbio.h"
  46 #include "gromacs/gmxpreprocess/pdb2top.h"
  47 #include "gromacs/gmxpreprocess/toputil.h"
  48 #include "gromacs/legacyheaders/macros.h"
  49 #include "gromacs/legacyheaders/typedefs.h"
  50 #include "gromacs/math/units.h"
  51 #include "gromacs/math/vec.h"
  52 #include "gromacs/topology/block.h"
  53 #include "gromacs/utility/cstringutil.h"
  54 #include "gromacs/utility/fatalerror.h"
  55 #include "gromacs/utility/smalloc.h"
  56
  57 static int in_strings(char *key, int nstr, const char **str)
  58 {
  59     int j;
  60
  61     for (j = 0; (j < nstr); j++)
  62     {
  63         if (strcmp(str[j], key) == 0)
  64         {
  65             return j;
  66         }
  67     }
  68
  69     return -1;
  70 }
  71
  72 static gmx_bool hbond(rvec x[], int i, int j, real distance)
  73 {
  74     real   tol = distance*distance;
  75     rvec   tmp;
  76
  77     rvec_sub(x[i], x[j], tmp);
  78
  79     return (iprod(tmp, tmp) < tol);
  80 }
  81
  82 static void chk_allhb(t_atoms *pdba, rvec x[], t_blocka *hb,
  83                       gmx_bool donor[], gmx_bool accept[], real dist)
  84 {
  85     int i, j, k, ii, natom;
  86
  87     natom = pdba->nr;
  88     snew(hb->index, natom+1);
  89     snew(hb->a, 6*natom);
  90     hb->nr  = natom;
  91     hb->nra = 6*natom;
  92
  93     k               = ii = 0;
  94     hb->index[ii++] = 0;
  95     for (i = 0; (i < natom); i++)
  96     {
  97         if (donor[i])
  98         {
  99             for (j = i+1; (j < natom); j++)
 100             {
 101                 if ((accept[j]) && (hbond(x, i, j, dist)))
 102                 {
 103                     hb->a[k++] = j;
 104                 }
 105             }
 106         }
 107         else if (accept[i])
 108         {
 109             for (j = i+1; (j < natom); j++)
 110             {
 111                 if ((donor[j]) && (hbond(x, i, j, dist)))
 112                 {
 113                     hb->a[k++] = j;
 114                 }
 115             }
 116         }
 117         hb->index[ii++] = k;
 118     }
 119     hb->nra = k;
 120 }
 121
 122 static void pr_hbonds(FILE *fp, t_blocka *hb, t_atoms *pdba)
 123 {
 124     int i, j, k, j0, j1;
 125
 126     fprintf(fp, "Dumping all hydrogen bonds!\n");
 127     for (i = 0; (i < hb->nr); i++)
 128     {
 129         j0 = hb->index[i];
 130         j1 = hb->index[i+1];
 131         for (j = j0; (j < j1); j++)
 132         {
 133             k = hb->a[j];
 134             fprintf(fp, "%5s%4d%5s - %5s%4d%5s\n",
 135                     *pdba->resinfo[pdba->atom[i].resind].name,
 136                     pdba->resinfo[pdba->atom[i].resind].nr, *pdba->atomname[i],
 137                     *pdba->resinfo[pdba->atom[k].resind].name,
 138                     pdba->resinfo[pdba->atom[k].resind].nr, *pdba->atomname[k]);
 139         }
 140     }
 141 }
 142
 143 static gmx_bool chk_hbonds(int i, t_atoms *pdba, rvec x[],
 144                            gmx_bool ad[], gmx_bool hbond[], rvec xh,
 145                            real angle, real dist)
 146 {
 147     gmx_bool bHB;
 148     int      j, aj, ri, natom;
 149     real     d2, dist2, a;
 150     rvec     nh, oh;
 151
 152     natom = pdba->nr;
 153     bHB   = FALSE;
 154     ri    = pdba->atom[i].resind;
 155     dist2 = sqr(dist);
 156     for (j = 0; (j < natom); j++)
 157     {
 158         /* Check whether the other atom is a donor/acceptor and not i */
 159         if ((ad[j]) && (j != i))
 160         {
 161             /* Check whether the other atom is on the same ring as well */
 162             if ((pdba->atom[j].resind != ri) ||
 163                 ((strcmp(*pdba->atomname[j], "ND1") != 0) &&
 164                  (strcmp(*pdba->atomname[j], "NE2") != 0)))
 165             {
 166                 aj  = j;
 167                 d2  = distance2(x[i], x[j]);
 168                 rvec_sub(x[i], xh, nh);
 169                 rvec_sub(x[aj], xh, oh);
 170                 a  = RAD2DEG * acos(cos_angle(nh, oh));
 171                 if ((d2 < dist2) && (a > angle))
 172                 {
 173                     if (debug)
 174                     {
 175                         fprintf(debug,
 176                                 "HBOND between %s%d-%s and %s%d-%s is %g nm, %g deg\n",
 177                                 *pdba->resinfo[pdba->atom[i].resind].name,
 178                                 pdba->resinfo[pdba->atom[i].resind].nr, *pdba->atomname[i],
 179                                 *pdba->resinfo[pdba->atom[aj].resind].name,
 180                                 pdba->resinfo[pdba->atom[aj].resind].nr, *pdba->atomname[aj],
 181                                 std::sqrt(d2), a);
 182                     }
 183                     hbond[i] = TRUE;
 184                     bHB      = TRUE;
 185                 }
 186             }
 187         }
 188     }
 189     return bHB;
 190 }
 191
 192 static void calc_ringh(rvec xattach, rvec xb, rvec xc, rvec xh)
 193 {
 194     rvec tab, tac;
 195     real n;
 196
 197     /* Add a proton on a ring to atom attach at distance 0.1 nm */
 198     rvec_sub(xattach, xb, tab);
 199     rvec_sub(xattach, xc, tac);
 200     rvec_add(tab, tac, xh);
 201     n = 0.1/norm(xh);
 202     svmul(n, xh, xh);
 203     rvec_inc(xh, xattach);
 204 }
 205
 206 void set_histp(t_atoms *pdba, rvec *x, real angle, real dist)
 207 {
 208     static const char *prot_acc[] = {
 209         "O", "OD1", "OD2", "OE1", "OE2", "OG", "OG1", "OH", "OW"
 210     };
 211 #define NPA asize(prot_acc)
 212     static const char *prot_don[] = {
 213         "N", "NH1", "NH2", "NE", "ND1", "ND2", "NE2", "NZ", "OG", "OG1", "OH", "NE1", "OW"
 214     };
 215 #define NPD asize(prot_don)
 216
 217     gmx_bool *donor, *acceptor;
 218     gmx_bool *hbond;
 219     gmx_bool  bHDd, bHEd;
 220     rvec      xh1, xh2;
 221     int       natom;
 222     int       i, j, nd, na, hisind, type = -1;
 223     int       nd1, ne2, cg, cd2, ce1;
 224     t_blocka *hb;
 225     char     *atomnm;
 226
 227     natom = pdba->nr;
 228
 229     i = 0;
 230     while (i < natom &&
 231            gmx_strcasecmp(*pdba->resinfo[pdba->atom[i].resind].name, "HIS") != 0)
 232     {
 233         i++;
 234     }
 235     if (natom == i)
 236     {
 237         return;
 238     }
 239
 240     /* A histidine residue exists that requires automated assignment, so
 241      * doing the analysis of donors and acceptors is worthwhile. */
 242     fprintf(stderr,
 243             "Analysing hydrogen-bonding network for automated assignment of histidine\n"
 244             " protonation.");
 245
 246     snew(donor, natom);
 247     snew(acceptor, natom);
 248     snew(hbond, natom);
 249     snew(hb, 1);
 250
 251     nd = na = 0;
 252     for (j = 0; (j < natom); j++)
 253     {
 254         if (in_strings(*pdba->atomname[j], NPA, prot_acc) != -1)
 255         {
 256             acceptor[j] = TRUE;
 257             na++;
 258         }
 259         if (in_strings(*pdba->atomname[j], NPD, prot_don) != -1)
 260         {
 261             donor[j] = TRUE;
 262             nd++;
 263         }
 264     }
 265     fprintf(stderr, " %d donors and %d acceptors were found.\n", nd, na);
 266     chk_allhb(pdba, x, hb, donor, acceptor, dist);
 267     if (debug)
 268     {
 269         pr_hbonds(debug, hb, pdba);
 270     }
 271     fprintf(stderr, "There are %d hydrogen bonds\n", hb->nra);
 272
 273     /* Now do the HIS stuff */
 274     hisind = -1;
 275     while (i < natom)
 276     {
 277         if (gmx_strcasecmp(*pdba->resinfo[pdba->atom[i].resind].name, "HIS") != 0)
 278         {
 279             i++;
 280         }
 281         else
 282         {
 283             if (pdba->atom[i].resind != hisind)
 284             {
 285                 hisind = pdba->atom[i].resind;
 286
 287                 /* Find the  atoms in the ring */
 288                 nd1 = ne2 = cg = cd2 = ce1 = -1;
 289                 while (i < natom && pdba->atom[i].resind == hisind)
 290                 {
 291                     atomnm = *pdba->atomname[i];
 292                     if (strcmp(atomnm, "CD2") == 0)
 293                     {
 294                         cd2 = i;
 295                     }
 296                     else if (strcmp(atomnm, "CG") == 0)
 297                     {
 298                         cg  = i;
 299                     }
 300                     else if (strcmp(atomnm, "CE1") == 0)
 301                     {
 302                         ce1 = i;
 303                     }
 304                     else if (strcmp(atomnm, "ND1") == 0)
 305                     {
 306                         nd1 = i;
 307                     }
 308                     else if (strcmp(atomnm, "NE2") == 0)
 309                     {
 310                         ne2 = i;
 311                     }
 312
 313                     i++;
 314                 }
 315
 316                 if (!((cg == -1 ) || (cd2 == -1) || (ce1 == -1) ||
 317                       (nd1 == -1) || (ne2 == -1)))
 318                 {
 319                     calc_ringh(x[nd1], x[cg], x[ce1], xh1);
 320                     calc_ringh(x[ne2], x[ce1], x[cd2], xh2);
 321
 322                     bHDd = chk_hbonds(nd1, pdba, x, acceptor, hbond, xh1, angle, dist);
 323                     chk_hbonds(nd1, pdba, x, donor, hbond, xh1, angle, dist);
 324                     bHEd = chk_hbonds(ne2, pdba, x, acceptor, hbond, xh2, angle, dist);
 325                     chk_hbonds(ne2, pdba, x, donor, hbond, xh2, angle, dist);
 326
 327                     if (bHDd)
 328                     {
 329                         if (bHEd)
 330                         {
 331                             type = ehisH;
 332                         }
 333                         else
 334                         {
 335                             type = ehisA;
 336                         }
 337                     }
 338                     else
 339                     {
 340                         type = ehisB;
 341                     }
 342                     fprintf(stderr, "Will use %s for residue %d\n",
 343                             hh[type], pdba->resinfo[hisind].nr);
 344                 }
 345                 else
 346                 {
 347                     gmx_fatal(FARGS, "Incomplete ring in HIS%d",
 348                               pdba->resinfo[hisind].nr);
 349                 }
 350
 351                 snew(pdba->resinfo[hisind].rtp, 1);
 352                 *pdba->resinfo[hisind].rtp = gmx_strdup(hh[type]);
 353             }
 354         }
 355     }
 356     done_blocka(hb);
 357     sfree(hb);
 358     sfree(donor);
 359     sfree(acceptor);
 360     sfree(hbond);
 361 }