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,2019, 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     char        ai[32], aj[32];
  64     double      e_diss;
  65     const char *fn     = "edissoc.dat";
  66     t_2morse   *t2m    = nullptr;
  67     int         maxn2m = 0, n2m = 0;
  68     int         nread;
  69
  70     /* Open the file with dissociation energies */
  71     gmx::FilePtr fp = gmx::openLibraryFile(fn);
  72     do
  73     {
  74         /* Try and read two atom names and an energy term from it */
  75         nread = fscanf(fp.get(), "%s%s%lf", ai, aj, &e_diss);
  76         if (nread == 3)
  77         {
  78             /* If we got three terms, it probably was OK, no further checking */
  79             if (n2m >= maxn2m)
  80             {
  81                 /* Increase memory for 16 at once, some mallocs are stupid */
  82                 maxn2m += 16;
  83                 srenew(t2m, maxn2m);
  84             }
  85             /* Copy the values */
  86             t2m[n2m].ai     = gmx_strdup(ai);
  87             t2m[n2m].aj     = gmx_strdup(aj);
  88             t2m[n2m].e_diss = e_diss;
  89             /* Increment counter */
  90             n2m++;
  91         }
  92         /* If we did not read three items, quit reading */
  93     }
  94     while (nread == 3);
  95
  96     /* Set the return values */
  97     *n2morse = n2m;
  98
  99     return t2m;
 100 }
 101
 102 static int nequal(const char *a1, const char *a2)
 103 {
 104     int i;
 105
 106     /* Count the number of (case insensitive) characters that are equal in
 107      * two strings. If they are equally long their respective null characters are
 108      * counted also.
 109      */
 110     for (i = 0; (a1[i] != '\0') && (a2[i] != '\0'); i++)
 111     {
 112         if (toupper(a1[i]) != toupper(a2[i]))
 113         {
 114             break;
 115         }
 116     }
 117     if ((a1[i] == '\0') && (a2[i] == '\0'))
 118     {
 119         i++;
 120     }
 121
 122     return i;
 123 }
 124
 125 static real search_e_diss(int n2m, t_2morse t2m[], const char *ai, const char *aj)
 126 {
 127     int  i;
 128     int  ibest = -1;
 129     int  nii, njj, nbstii = 0, nbstjj = 0;
 130     real ediss = 400;
 131
 132     /* Do a best match search for dissociation energies */
 133     for (i = 0; (i < n2m); i++)
 134     {
 135         /* Check for a perfect match */
 136         if (((gmx_strcasecmp(t2m[i].ai, ai) == 0) && (gmx_strcasecmp(t2m[i].aj, aj) == 0)) ||
 137             ((gmx_strcasecmp(t2m[i].aj, ai) == 0) && (gmx_strcasecmp(t2m[i].ai, aj) == 0)))
 138         {
 139             ibest = i;
 140             break;
 141         }
 142         else
 143         {
 144             /* Otherwise count the number of equal characters in the strings ai and aj
 145              * and the ones from the file
 146              */
 147             nii = nequal(t2m[i].ai, ai);
 148             njj = nequal(t2m[i].aj, aj);
 149             if (((nii >  nbstii) && (njj >= nbstjj)) ||
 150                 ((nii >= nbstii) && (njj >  nbstjj)))
 151             {
 152                 if ((nii > 0) && (njj > 0))
 153                 {
 154                     ibest  = i;
 155                     nbstii = nii;
 156                     nbstjj = njj;
 157                 }
 158             }
 159             else
 160             {
 161                 /* Swap ai and aj (at least in counting the number of equal chars) */
 162                 nii = nequal(t2m[i].ai, aj);
 163                 njj = nequal(t2m[i].aj, ai);
 164                 if (((nii >  nbstii) && (njj >= nbstjj)) ||
 165                     ((nii >= nbstii) && (njj >  nbstjj)))
 166                 {
 167                     if ((nii > 0) && (njj > 0))
 168                     {
 169                         ibest  = i;
 170                         nbstii = nii;
 171                         nbstjj = njj;
 172                     }
 173                 }
 174             }
 175         }
 176     }
 177     /* Return the dissocation energy corresponding to the best match, if we have
 178      * found one.
 179      */
 180     if (ibest == -1)
 181     {
 182         return ediss;
 183     }
 184     else
 185     {
 186         return t2m[ibest].e_diss;
 187     }
 188 }
 189
 190 void convert_harmonics(gmx::ArrayRef<MoleculeInformation> mols, PreprocessingAtomTypes *atype)
 191 {
 192     int       n2m;
 193     t_2morse *t2m;
 194
 195     /* First get the data */
 196     t2m = read_dissociation_energies(&n2m);
 197     if (n2m <= 0)
 198     {
 199         fprintf(stderr, "No dissocation energies read\n");
 200         return;
 201     }
 202
 203     /* For all the molecule types */
 204     int i = 0;
 205     for (auto &mol : mols)
 206     {
 207         /* Check how many morse and harmonic BONDSs there are, increase size of
 208          * morse with the number of harmonics
 209          */
 210         for (int bb = 0; (bb < F_NRE); bb++)
 211         {
 212             if ((interaction_function[bb].flags & IF_BTYPE) && (bb != F_MORSE))
 213             {
 214                 int nrharm  = mol.interactions[bb].size();
 215
 216                 /* Now loop over the harmonics, trying to convert them */
 217                 for (auto harmonic = mol.interactions[bb].interactionTypes.begin();
 218                      harmonic != mol.interactions[bb].interactionTypes.end(); )
 219                 {
 220                     int  ni   = harmonic->ai();
 221                     int  nj   = harmonic->aj();
 222                     real edis =
 223                         search_e_diss(n2m, t2m,
 224                                       atype->atomNameFromAtomType(mol.atoms.atom[ni].type),
 225                                       atype->atomNameFromAtomType(mol.atoms.atom[nj].type));
 226                     if (edis != 0)
 227                     {
 228                         real              b0             = harmonic->c0();
 229                         real              kb             = harmonic->c1();
 230                         real              beta           = std::sqrt(kb/(2*edis));
 231                         std::vector<int>  atoms          = {ni, nj};
 232                         std::vector<real> forceParam     = {b0, edis, beta};
 233                         mol.interactions[F_MORSE].interactionTypes.emplace_back(
 234                                 InteractionOfType(atoms, forceParam));
 235                         harmonic = mol.interactions[bb].interactionTypes.erase(harmonic);
 236                     }
 237                     else
 238                     {
 239                         ++harmonic;
 240                     }
 241                 }
 242
 243                 int newHarmonics = mol.interactions[bb].size();
 244                 fprintf(stderr, "Converted %d out of %d %s to morse bonds for mol %d\n",
 245                         nrharm-newHarmonics, nrharm, interaction_function[bb].name, i);
 246             }
 247         }
 248         i++;
 249     }
 250     sfree(t2m);
 251 }