src/gromacs/gmxpreprocess/tomorse.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,2017,2018, 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 "tomorse.h"
  41
  42 #include <cctype>
  43 #include <cmath>
  44 #include <cstdlib>
  45 #include <cstring>
  46
  47 #include "gromacs/gmxpreprocess/gpp_atomtype.h"
  48 #include "gromacs/gmxpreprocess/grompp-impl.h"
  49 #include "gromacs/gmxpreprocess/toputil.h"
  50 #include "gromacs/topology/ifunc.h"
  51 #include "gromacs/utility/cstringutil.h"
  52 #include "gromacs/utility/fatalerror.h"
  53 #include "gromacs/utility/futil.h"
  54 #include "gromacs/utility/smalloc.h"
  55
  56 typedef struct {
  57     char *ai, *aj;
  58     real  e_diss;
  59 } t_2morse;
  60
  61 static t_2morse *read_dissociation_energies(int *n2morse)
  62 {
  63     FILE       *fp;
  64     char        ai[32], aj[32];
  65     double      e_diss;
  66     const char *fn     = "edissoc.dat";
  67     t_2morse   *t2m    = nullptr;
  68     int         maxn2m = 0, n2m = 0;
  69     int         nread;
  70
  71     /* Open the file with dissociation energies */
  72     fp = libopen(fn);
  73     do
  74     {
  75         /* Try and read two atom names and an energy term from it */
  76         nread = fscanf(fp, "%s%s%lf", ai, aj, &e_diss);
  77         if (nread == 3)
  78         {
  79             /* If we got three terms, it probably was OK, no further checking */
  80             if (n2m >= maxn2m)
  81             {
  82                 /* Increase memory for 16 at once, some mallocs are stupid */
  83                 maxn2m += 16;
  84                 srenew(t2m, maxn2m);
  85             }
  86             /* Copy the values */
  87             t2m[n2m].ai     = gmx_strdup(ai);
  88             t2m[n2m].aj     = gmx_strdup(aj);
  89             t2m[n2m].e_diss = e_diss;
  90             /* Increment counter */
  91             n2m++;
  92         }
  93         /* If we did not read three items, quit reading */
  94     }
  95     while (nread == 3);
  96     gmx_ffclose(fp);
  97
  98     /* Set the return values */
  99     *n2morse = n2m;
 100
 101     return t2m;
 102 }
 103
 104 static int nequal(char *a1, char *a2)
 105 {
 106     int i;
 107
 108     /* Count the number of (case insensitive) characters that are equal in
 109      * two strings. If they are equally long their respective null characters are
 110      * counted also.
 111      */
 112     for (i = 0; (a1[i] != '\0') && (a2[i] != '\0'); i++)
 113     {
 114         if (toupper(a1[i]) != toupper(a2[i]))
 115         {
 116             break;
 117         }
 118     }
 119     if ((a1[i] == '\0') && (a2[i] == '\0'))
 120     {
 121         i++;
 122     }
 123
 124     return i;
 125 }
 126
 127 static real search_e_diss(int n2m, t_2morse t2m[], char *ai, char *aj)
 128 {
 129     int  i;
 130     int  ibest = -1;
 131     int  nii, njj, nbstii = 0, nbstjj = 0;
 132     real ediss = 400;
 133
 134     /* Do a best match search for dissociation energies */
 135     for (i = 0; (i < n2m); i++)
 136     {
 137         /* Check for a perfect match */
 138         if (((gmx_strcasecmp(t2m[i].ai, ai) == 0) && (gmx_strcasecmp(t2m[i].aj, aj) == 0)) ||
 139             ((gmx_strcasecmp(t2m[i].aj, ai) == 0) && (gmx_strcasecmp(t2m[i].ai, aj) == 0)))
 140         {
 141             ibest = i;
 142             break;
 143         }
 144         else
 145         {
 146             /* Otherwise count the number of equal characters in the strings ai and aj
 147              * and the ones from the file
 148              */
 149             nii = nequal(t2m[i].ai, ai);
 150             njj = nequal(t2m[i].aj, aj);
 151             if (((nii >  nbstii) && (njj >= nbstjj)) ||
 152                 ((nii >= nbstii) && (njj >  nbstjj)))
 153             {
 154                 if ((nii > 0) && (njj > 0))
 155                 {
 156                     ibest  = i;
 157                     nbstii = nii;
 158                     nbstjj = njj;
 159                 }
 160             }
 161             else
 162             {
 163                 /* Swap ai and aj (at least in counting the number of equal chars) */
 164                 nii = nequal(t2m[i].ai, aj);
 165                 njj = nequal(t2m[i].aj, ai);
 166                 if (((nii >  nbstii) && (njj >= nbstjj)) ||
 167                     ((nii >= nbstii) && (njj >  nbstjj)))
 168                 {
 169                     if ((nii > 0) && (njj > 0))
 170                     {
 171                         ibest  = i;
 172                         nbstii = nii;
 173                         nbstjj = njj;
 174                     }
 175                 }
 176             }
 177         }
 178     }
 179     /* Return the dissocation energy corresponding to the best match, if we have
 180      * found one.
 181      */
 182     if (ibest == -1)
 183     {
 184         return ediss;
 185     }
 186     else
 187     {
 188         return t2m[ibest].e_diss;
 189     }
 190 }
 191
 192 void convert_harmonics(int nrmols, t_molinfo mols[], gpp_atomtype_t atype)
 193 {
 194     int       n2m;
 195     t_2morse *t2m;
 196
 197     int       i, j, k, last, ni, nj;
 198     int       nrharm, nrmorse, bb;
 199     real      edis, kb, b0, beta;
 200     bool     *bRemoveHarm;
 201
 202     /* First get the data */
 203     t2m = read_dissociation_energies(&n2m);
 204     if (n2m <= 0)
 205     {
 206         fprintf(stderr, "No dissocation energies read\n");
 207         return;
 208     }
 209
 210     /* For all the molecule types */
 211     for (i = 0; (i < nrmols); i++)
 212     {
 213         /* Check how many morse and harmonic BONDSs there are, increase size of
 214          * morse with the number of harmonics
 215          */
 216         nrmorse = mols[i].plist[F_MORSE].nr;
 217
 218         for (bb = 0; (bb < F_NRE); bb++)
 219         {
 220             if ((interaction_function[bb].flags & IF_BTYPE) && (bb != F_MORSE))
 221             {
 222                 nrharm  = mols[i].plist[bb].nr;
 223                 pr_alloc(nrharm, &(mols[i].plist[F_MORSE]));
 224                 snew(bRemoveHarm, nrharm);
 225
 226                 /* Now loop over the harmonics, trying to convert them */
 227                 for (j = 0; (j < nrharm); j++)
 228                 {
 229                     ni   = mols[i].plist[bb].param[j].ai();
 230                     nj   = mols[i].plist[bb].param[j].aj();
 231                     edis =
 232                         search_e_diss(n2m, t2m,
 233                                       get_atomtype_name(mols[i].atoms.atom[ni].type, atype),
 234                                       get_atomtype_name(mols[i].atoms.atom[nj].type, atype));
 235                     if (edis != 0)
 236                     {
 237                         bRemoveHarm[j] = TRUE;
 238                         b0             = mols[i].plist[bb].param[j].c[0];
 239                         kb             = mols[i].plist[bb].param[j].c[1];
 240                         beta           = std::sqrt(kb/(2*edis));
 241                         mols[i].plist[F_MORSE].param[nrmorse].a[0] = ni;
 242                         mols[i].plist[F_MORSE].param[nrmorse].a[1] = nj;
 243                         mols[i].plist[F_MORSE].param[nrmorse].c[0] = b0;
 244                         mols[i].plist[F_MORSE].param[nrmorse].c[1] = edis;
 245                         mols[i].plist[F_MORSE].param[nrmorse].c[2] = beta;
 246                         nrmorse++;
 247                     }
 248                 }
 249                 mols[i].plist[F_MORSE].nr = nrmorse;
 250
 251                 /* Now remove the harmonics */
 252                 for (j = last = 0; (j < nrharm); j++)
 253                 {
 254                     if (!bRemoveHarm[j])
 255                     {
 256                         /* Copy it to the last position */
 257                         for (k = 0; (k < MAXATOMLIST); k++)
 258                         {
 259                             mols[i].plist[bb].param[last].a[k] =
 260                                 mols[i].plist[bb].param[j].a[k];
 261                         }
 262                         for (k = 0; (k < MAXFORCEPARAM); k++)
 263                         {
 264                             mols[i].plist[bb].param[last].c[k] =
 265                                 mols[i].plist[bb].param[j].c[k];
 266                         }
 267                         last++;
 268                     }
 269                 }
 270                 sfree(bRemoveHarm);
 271                 fprintf(stderr, "Converted %d out of %d %s to morse bonds for mol %d\n",
 272                         nrharm-last, nrharm, interaction_function[bb].name, i);
 273                 mols[i].plist[bb].nr = last;
 274             }
 275         }
 276     }
 277     sfree(t2m);
 278 }