src/gromacs/gmxpreprocess/toputil.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) 2012,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 #include "gmxpre.h"
  38
  39 #include "toputil.h"
  40
  41 #include <climits>
  42 #include <cmath>
  43 #include <cstring>
  44
  45 #include <algorithm>
  46
  47 #include "gromacs/gmxpreprocess/gpp_atomtype.h"
  48 #include "gromacs/gmxpreprocess/grompp_impl.h"
  49 #include "gromacs/gmxpreprocess/notset.h"
  50 #include "gromacs/gmxpreprocess/topdirs.h"
  51 #include "gromacs/topology/block.h"
  52 #include "gromacs/topology/ifunc.h"
  53 #include "gromacs/topology/symtab.h"
  54 #include "gromacs/utility/fatalerror.h"
  55 #include "gromacs/utility/gmxassert.h"
  56 #include "gromacs/utility/smalloc.h"
  57
  58 /* UTILITIES */
  59
  60 void set_p_string(t_param *p, const char *s)
  61 {
  62     if (s)
  63     {
  64         if (strlen(s) < sizeof(p->s)-1)
  65         {
  66             strncpy(p->s, s, sizeof(p->s));
  67         }
  68         else
  69         {
  70             gmx_fatal(FARGS, "Increase MAXSLEN in the grompp code to at least %zu,"
  71                       " or shorten your definition of bonds like %s to at most %d",
  72                       strlen(s)+1, s, MAXSLEN-1);
  73         }
  74     }
  75     else
  76     {
  77         strcpy(p->s, "");
  78     }
  79 }
  80
  81 void pr_alloc (int extra, InteractionTypeParameters *pr)
  82 {
  83     int i, j;
  84
  85     /* get new space for arrays */
  86     if (extra < 0)
  87     {
  88         gmx_fatal(FARGS, "Trying to make array smaller.\n");
  89     }
  90     if (extra == 0)
  91     {
  92         return;
  93     }
  94     GMX_ASSERT(pr->nr != 0 || pr->param == nullptr, "Invalid InteractionTypeParameters object");
  95     if (pr->nr+extra > pr->maxnr)
  96     {
  97         pr->maxnr = std::max(static_cast<int>(1.2*pr->maxnr), pr->maxnr + extra);
  98         srenew(pr->param, pr->maxnr);
  99         for (i = pr->nr; (i < pr->maxnr); i++)
 100         {
 101             for (j = 0; (j < MAXATOMLIST); j++)
 102             {
 103                 pr->param[i].a[j] = 0;
 104             }
 105             for (j = 0; (j < MAXFORCEPARAM); j++)
 106             {
 107                 pr->param[i].c[j] = 0;
 108             }
 109             set_p_string(&(pr->param[i]), "");
 110         }
 111     }
 112 }
 113
 114 void init_plist(gmx::ArrayRef<InteractionTypeParameters> plist)
 115 {
 116     int i;
 117
 118     for (i = 0; (i < F_NRE); i++)
 119     {
 120         plist[i].nr    = 0;
 121         plist[i].maxnr = 0;
 122         plist[i].param = nullptr;
 123     }
 124 }
 125
 126 void done_plist(gmx::ArrayRef<InteractionTypeParameters> plist)
 127 {
 128     for (int i = 0; i < F_NRE; i++)
 129     {
 130         sfree(plist[i].param);
 131     }
 132 }
 133
 134 void cp_param(t_param *dest, t_param *src)
 135 {
 136     int j;
 137
 138     for (j = 0; (j < MAXATOMLIST); j++)
 139     {
 140         dest->a[j] = src->a[j];
 141     }
 142     for (j = 0; (j < MAXFORCEPARAM); j++)
 143     {
 144         dest->c[j] = src->c[j];
 145     }
 146     strncpy(dest->s, src->s, sizeof(dest->s));
 147 }
 148
 149 void add_param_to_list(InteractionTypeParameters *list, t_param *b)
 150 {
 151     int j;
 152
 153     /* allocate one position extra */
 154     pr_alloc (1, list);
 155
 156     /* fill the arrays */
 157     for (j = 0; (j < MAXFORCEPARAM); j++)
 158     {
 159         list->param[list->nr].c[j]   = b->c[j];
 160     }
 161     for (j = 0; (j < MAXATOMLIST); j++)
 162     {
 163         list->param[list->nr].a[j]   = b->a[j];
 164     }
 165     memset(list->param[list->nr].s, 0, sizeof(list->param[list->nr].s));
 166
 167     list->nr++;
 168 }
 169
 170 /* PRINTING STRUCTURES */
 171
 172 static void print_bt(FILE *out, Directive d, gpp_atomtype *at,
 173                      int ftype, int fsubtype, gmx::ArrayRef<const InteractionTypeParameters> plist,
 174                      bool bFullDih)
 175 {
 176     /* This dihp is a DIRTY patch because the dih-types do not use
 177      * all four atoms to determine the type.
 178      */
 179     const int                        dihp[2][2] = { { 1, 2 }, { 0, 3 } };
 180     int                              i, j, f, nral, nrfp;
 181     bool                             bDih = FALSE, bSwapParity;
 182
 183     const InteractionTypeParameters *bt = &(plist[ftype]);
 184
 185     if (!bt->nr)
 186     {
 187         return;
 188     }
 189
 190     f = 0;
 191     switch (ftype)
 192     {
 193         case F_G96ANGLES:
 194             f = 1;
 195             break;
 196         case F_G96BONDS:
 197             f = 1;
 198             break;
 199         case F_MORSE:
 200             f = 2;
 201             break;
 202         case F_CUBICBONDS:
 203             f = 3;
 204             break;
 205         case F_CONNBONDS:
 206             f = 4;
 207             break;
 208         case F_HARMONIC:
 209             f = 5;
 210             break;
 211         case F_CROSS_BOND_ANGLES:
 212             f = 2;
 213             break;
 214         case F_CROSS_BOND_BONDS:
 215             f = 3;
 216             break;
 217         case F_UREY_BRADLEY:
 218             f = 4;
 219             break;
 220         case F_PDIHS:
 221         case F_RBDIHS:
 222         case F_FOURDIHS:
 223             bDih = TRUE;
 224             break;
 225         case F_IDIHS:
 226             f    = 1;
 227             bDih = TRUE;
 228             break;
 229         case F_CONSTRNC:
 230             f = 1;
 231             break;
 232         case F_VSITE3FD:
 233             f = 1;
 234             break;
 235         case F_VSITE3FAD:
 236             f = 2;
 237             break;
 238         case F_VSITE3OUT:
 239             f = 3;
 240             break;
 241         case F_VSITE4FDN:
 242             f = 1;
 243             break;
 244         case F_CMAP:
 245             f = 1;
 246             break;
 247
 248         default:
 249             bDih = FALSE;
 250     }
 251     if (bFullDih)
 252     {
 253         bDih = FALSE;
 254     }
 255     if (fsubtype)
 256     {
 257         f = fsubtype-1;
 258     }
 259
 260     nral = NRAL(ftype);
 261     nrfp = NRFP(ftype);
 262
 263     /* header */
 264     fprintf(out, "[ %s ]\n", dir2str(d));
 265     fprintf(out, "; ");
 266     if (!bDih)
 267     {
 268         fprintf (out, "%3s  %4s", "ai", "aj");
 269         for (j = 2; (j < nral); j++)
 270         {
 271             fprintf (out, "  %3c%c", 'a', 'i'+j);
 272         }
 273     }
 274     else
 275     {
 276         for (j = 0; (j < 2); j++)
 277         {
 278             fprintf (out, "%3c%c", 'a', 'i'+dihp[f][j]);
 279         }
 280     }
 281
 282     fprintf (out, " funct");
 283     for (j = 0; (j < nrfp); j++)
 284     {
 285         fprintf (out, " %12c%1d", 'c', j);
 286     }
 287     fprintf (out, "\n");
 288
 289     /* print bondtypes */
 290     for (i = 0; (i < bt->nr); i++)
 291     {
 292         bSwapParity = (bt->param[i].c0() == NOTSET) && (bt->param[i].c1() == -1);
 293         if (!bDih)
 294         {
 295             for (j = 0; (j < nral); j++)
 296             {
 297                 fprintf (out, "%5s ", get_atomtype_name(bt->param[i].a[j], at));
 298             }
 299         }
 300         else
 301         {
 302             for (j = 0; (j < 2); j++)
 303             {
 304                 fprintf (out, "%5s ", get_atomtype_name(bt->param[i].a[dihp[f][j]], at));
 305             }
 306         }
 307         fprintf (out, "%5d ", bSwapParity ? -f-1 : f+1);
 308
 309         if (bt->param[i].s[0])
 310         {
 311             fprintf(out, "   %s", bt->param[i].s);
 312         }
 313         else
 314         {
 315             for (j = 0; (j < nrfp && (bt->param[i].c[j] != NOTSET)); j++)
 316             {
 317                 fprintf (out, "%13.6e ", bt->param[i].c[j]);
 318             }
 319         }
 320
 321         fprintf (out, "\n");
 322     }
 323     fprintf (out, "\n");
 324     fflush (out);
 325 }
 326
 327 void print_blocka(FILE *out, const char *szName,
 328                   const char *szIndex, const char *szA,
 329                   t_blocka *block)
 330 {
 331     int i, j;
 332
 333     fprintf (out, "; %s\n", szName);
 334     fprintf (out, "; %4s    %s\n", szIndex, szA);
 335     for (i = 0; (i < block->nr); i++)
 336     {
 337         for (i = 0; (i < block->nr); i++)
 338         {
 339             fprintf (out, "%6d", i+1);
 340             for (j = block->index[i]; (j < (block->index[i+1])); j++)
 341             {
 342                 fprintf (out, "%5d", block->a[j]+1);
 343             }
 344             fprintf (out, "\n");
 345         }
 346         fprintf (out, "\n");
 347     }
 348 }
 349
 350 void print_excl(FILE *out, int natoms, t_excls excls[])
 351 {
 352     int         i;
 353     bool        have_excl;
 354     int         j;
 355
 356     have_excl = FALSE;
 357     for (i = 0; i < natoms && !have_excl; i++)
 358     {
 359         have_excl = (excls[i].nr > 0);
 360     }
 361
 362     if (have_excl)
 363     {
 364         fprintf (out, "[ %s ]\n", dir2str(Directive::d_exclusions));
 365         fprintf (out, "; %4s    %s\n", "i", "excluded from i");
 366         for (i = 0; i < natoms; i++)
 367         {
 368             if (excls[i].nr > 0)
 369             {
 370                 fprintf (out, "%6d ", i+1);
 371                 for (j = 0; j < excls[i].nr; j++)
 372                 {
 373                     fprintf (out, " %5d", excls[i].e[j]+1);
 374                 }
 375                 fprintf (out, "\n");
 376             }
 377         }
 378         fprintf (out, "\n");
 379         fflush(out);
 380     }
 381 }
 382
 383 static double get_residue_charge(const t_atoms *atoms, int at)
 384 {
 385     int    ri;
 386     double q;
 387
 388     ri = atoms->atom[at].resind;
 389     q  = 0;
 390     while (at < atoms->nr && atoms->atom[at].resind == ri)
 391     {
 392         q += atoms->atom[at].q;
 393         at++;
 394     }
 395
 396     return q;
 397 }
 398
 399 void print_atoms(FILE *out, gpp_atomtype *atype, t_atoms *at, int *cgnr,
 400                  bool bRTPresname)
 401 {
 402     int         i, ri;
 403     int         tpA, tpB;
 404     const char *as;
 405     char       *tpnmA, *tpnmB;
 406     double      qres, qtot;
 407
 408     as = dir2str(Directive::d_atoms);
 409     fprintf(out, "[ %s ]\n", as);
 410     fprintf(out, "; %4s %10s %6s %7s%6s %6s %10s %10s %6s %10s %10s\n",
 411             "nr", "type", "resnr", "residue", "atom", "cgnr", "charge", "mass", "typeB", "chargeB", "massB");
 412
 413     qtot  = 0;
 414
 415     if (at->nres)
 416     {
 417         /* if the information is present... */
 418         for (i = 0; (i < at->nr); i++)
 419         {
 420             ri = at->atom[i].resind;
 421             if ((i == 0 || ri != at->atom[i-1].resind) &&
 422                 at->resinfo[ri].rtp != nullptr)
 423             {
 424                 qres = get_residue_charge(at, i);
 425                 fprintf(out, "; residue %3d %-3s rtp %-4s q ",
 426                         at->resinfo[ri].nr,
 427                         *at->resinfo[ri].name,
 428                         *at->resinfo[ri].rtp);
 429                 if (fabs(qres) < 0.001)
 430                 {
 431                     fprintf(out, " %s", "0.0");
 432                 }
 433                 else
 434                 {
 435                     fprintf(out, "%+3.1f", qres);
 436                 }
 437                 fprintf(out, "\n");
 438             }
 439             tpA = at->atom[i].type;
 440             if ((tpnmA = get_atomtype_name(tpA, atype)) == nullptr)
 441             {
 442                 gmx_fatal(FARGS, "tpA = %d, i= %d in print_atoms", tpA, i);
 443             }
 444
 445             /* This is true by construction, but static analysers don't know */
 446             GMX_ASSERT(!bRTPresname || at->resinfo[at->atom[i].resind].rtp, "-rtpres did not have residue name available");
 447             fprintf(out, "%6d %10s %6d%c %5s %6s %6d %10g %10g",
 448                     i+1, tpnmA,
 449                     at->resinfo[ri].nr,
 450                     at->resinfo[ri].ic,
 451                     bRTPresname ?
 452                     *(at->resinfo[at->atom[i].resind].rtp) :
 453                     *(at->resinfo[at->atom[i].resind].name),
 454                     *(at->atomname[i]), cgnr[i],
 455                     at->atom[i].q, at->atom[i].m);
 456             if (PERTURBED(at->atom[i]))
 457             {
 458                 tpB = at->atom[i].typeB;
 459                 if ((tpnmB = get_atomtype_name(tpB, atype)) == nullptr)
 460                 {
 461                     gmx_fatal(FARGS, "tpB = %d, i= %d in print_atoms", tpB, i);
 462                 }
 463                 fprintf(out, " %6s %10g %10g",
 464                         tpnmB, at->atom[i].qB, at->atom[i].mB);
 465             }
 466             // Accumulate the total charge to help troubleshoot issues.
 467             qtot += static_cast<double>(at->atom[i].q);
 468             // Round it to zero if it is close to zero, because
 469             // printing -9.34e-5 confuses users.
 470             if (fabs(qtot) < 0.0001)
 471             {
 472                 qtot = 0;
 473             }
 474             // Write the total charge for the last atom of the system
 475             // and/or residue, because generally that's where it is
 476             // expected to be an integer.
 477             if (i == at->nr-1 || ri != at->atom[i+1].resind)
 478             {
 479                 fprintf(out, "   ; qtot %.4g\n", qtot);
 480             }
 481             else
 482             {
 483                 fputs("\n", out);
 484             }
 485         }
 486     }
 487     fprintf(out, "\n");
 488     fflush(out);
 489 }
 490
 491 void print_bondeds(FILE *out, int natoms, Directive d,
 492                    int ftype, int fsubtype, gmx::ArrayRef<const InteractionTypeParameters> plist)
 493 {
 494     t_symtab       stab;
 495     gpp_atomtype  *atype;
 496     t_param       *param;
 497     t_atom        *a;
 498     int            i;
 499
 500     atype = init_atomtype();
 501     snew(a, 1);
 502     snew(param, 1);
 503     open_symtab(&stab);
 504     for (i = 0; (i < natoms); i++)
 505     {
 506         char buf[12];
 507         sprintf(buf, "%4d", (i+1));
 508         add_atomtype(atype, &stab, a, buf, param, 0, 0);
 509     }
 510     print_bt(out, d, atype, ftype, fsubtype, plist, TRUE);
 511
 512     done_symtab(&stab);
 513     sfree(a);
 514     sfree(param);
 515     done_atomtype(atype);
 516 }