src/gromacs/mdlib/forcerec.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,2016,2017, 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 "forcerec.h"
  40
  41 #include "config.h"
  42
  43 #include <assert.h>
  44 #include <stdlib.h>
  45 #include <string.h>
  46
  47 #include <cmath>
  48
  49 #include <algorithm>
  50
  51 #include "gromacs/commandline/filenm.h"
  52 #include "gromacs/domdec/domdec.h"
  53 #include "gromacs/domdec/domdec_struct.h"
  54 #include "gromacs/ewald/ewald.h"
  55 #include "gromacs/ewald/ewald-utils.h"
  56 #include "gromacs/fileio/filetypes.h"
  57 #include "gromacs/gmxlib/network.h"
  58 #include "gromacs/gmxlib/nonbonded/nonbonded.h"
  59 #include "gromacs/gpu_utils/gpu_utils.h"
  60 #include "gromacs/hardware/hw_info.h"
  61 #include "gromacs/listed-forces/manage-threading.h"
  62 #include "gromacs/listed-forces/pairs.h"
  63 #include "gromacs/math/functions.h"
  64 #include "gromacs/math/units.h"
  65 #include "gromacs/math/utilities.h"
  66 #include "gromacs/math/vec.h"
  67 #include "gromacs/mdlib/force.h"
  68 #include "gromacs/mdlib/forcerec-threading.h"
  69 #include "gromacs/mdlib/gmx_omp_nthreads.h"
  70 #include "gromacs/mdlib/md_support.h"
  71 #include "gromacs/mdlib/nb_verlet.h"
  72 #include "gromacs/mdlib/nbnxn_atomdata.h"
  73 #include "gromacs/mdlib/nbnxn_gpu_data_mgmt.h"
  74 #include "gromacs/mdlib/nbnxn_search.h"
  75 #include "gromacs/mdlib/nbnxn_simd.h"
  76 #include "gromacs/mdlib/nbnxn_tuning.h"
  77 #include "gromacs/mdlib/nbnxn_util.h"
  78 #include "gromacs/mdlib/ns.h"
  79 #include "gromacs/mdlib/qmmm.h"
  80 #include "gromacs/mdlib/sim_util.h"
  81 #include "gromacs/mdtypes/commrec.h"
  82 #include "gromacs/mdtypes/fcdata.h"
  83 #include "gromacs/mdtypes/group.h"
  84 #include "gromacs/mdtypes/iforceprovider.h"
  85 #include "gromacs/mdtypes/inputrec.h"
  86 #include "gromacs/mdtypes/md_enums.h"
  87 #include "gromacs/pbcutil/ishift.h"
  88 #include "gromacs/pbcutil/pbc.h"
  89 #include "gromacs/simd/simd.h"
  90 #include "gromacs/tables/forcetable.h"
  91 #include "gromacs/topology/mtop_util.h"
  92 #include "gromacs/trajectory/trajectoryframe.h"
  93 #include "gromacs/utility/cstringutil.h"
  94 #include "gromacs/utility/exceptions.h"
  95 #include "gromacs/utility/fatalerror.h"
  96 #include "gromacs/utility/gmxassert.h"
  97 #include "gromacs/utility/logger.h"
  98 #include "gromacs/utility/pleasecite.h"
  99 #include "gromacs/utility/smalloc.h"
 100 #include "gromacs/utility/strconvert.h"
 101
 102 #include "nbnxn_gpu_jit_support.h"
 103
 104 const char *egrp_nm[egNR+1] = {
 105     "Coul-SR", "LJ-SR", "Buck-SR",
 106     "Coul-14", "LJ-14", nullptr
 107 };
 108
 109 t_forcerec *mk_forcerec(void)
 110 {
 111     t_forcerec *fr;
 112
 113     snew(fr, 1);
 114
 115     return fr;
 116 }
 117
 118 #ifdef DEBUG
 119 static void pr_nbfp(FILE *fp, real *nbfp, gmx_bool bBHAM, int atnr)
 120 {
 121     int i, j;
 122
 123     for (i = 0; (i < atnr); i++)
 124     {
 125         for (j = 0; (j < atnr); j++)
 126         {
 127             fprintf(fp, "%2d - %2d", i, j);
 128             if (bBHAM)
 129             {
 130                 fprintf(fp, "  a=%10g, b=%10g, c=%10g\n", BHAMA(nbfp, atnr, i, j),
 131                         BHAMB(nbfp, atnr, i, j), BHAMC(nbfp, atnr, i, j)/6.0);
 132             }
 133             else
 134             {
 135                 fprintf(fp, "  c6=%10g, c12=%10g\n", C6(nbfp, atnr, i, j)/6.0,
 136                         C12(nbfp, atnr, i, j)/12.0);
 137             }
 138         }
 139     }
 140 }
 141 #endif
 142
 143 static real *mk_nbfp(const gmx_ffparams_t *idef, gmx_bool bBHAM)
 144 {
 145     real *nbfp;
 146     int   i, j, k, atnr;
 147
 148     atnr = idef->atnr;
 149     if (bBHAM)
 150     {
 151         snew(nbfp, 3*atnr*atnr);
 152         for (i = k = 0; (i < atnr); i++)
 153         {
 154             for (j = 0; (j < atnr); j++, k++)
 155             {
 156                 BHAMA(nbfp, atnr, i, j) = idef->iparams[k].bham.a;
 157                 BHAMB(nbfp, atnr, i, j) = idef->iparams[k].bham.b;
 158                 /* nbfp now includes the 6.0 derivative prefactor */
 159                 BHAMC(nbfp, atnr, i, j) = idef->iparams[k].bham.c*6.0;
 160             }
 161         }
 162     }
 163     else
 164     {
 165         snew(nbfp, 2*atnr*atnr);
 166         for (i = k = 0; (i < atnr); i++)
 167         {
 168             for (j = 0; (j < atnr); j++, k++)
 169             {
 170                 /* nbfp now includes the 6.0/12.0 derivative prefactors */
 171                 C6(nbfp, atnr, i, j)   = idef->iparams[k].lj.c6*6.0;
 172                 C12(nbfp, atnr, i, j)  = idef->iparams[k].lj.c12*12.0;
 173             }
 174         }
 175     }
 176
 177     return nbfp;
 178 }
 179
 180 static real *make_ljpme_c6grid(const gmx_ffparams_t *idef, t_forcerec *fr)
 181 {
 182     int        i, j, k, atnr;
 183     real       c6, c6i, c6j, c12i, c12j, epsi, epsj, sigmai, sigmaj;
 184     real      *grid;
 185
 186     /* For LJ-PME simulations, we correct the energies with the reciprocal space
 187      * inside of the cut-off. To do this the non-bonded kernels needs to have
 188      * access to the C6-values used on the reciprocal grid in pme.c
 189      */
 190
 191     atnr = idef->atnr;
 192     snew(grid, 2*atnr*atnr);
 193     for (i = k = 0; (i < atnr); i++)
 194     {
 195         for (j = 0; (j < atnr); j++, k++)
 196         {
 197             c6i  = idef->iparams[i*(atnr+1)].lj.c6;
 198             c12i = idef->iparams[i*(atnr+1)].lj.c12;
 199             c6j  = idef->iparams[j*(atnr+1)].lj.c6;
 200             c12j = idef->iparams[j*(atnr+1)].lj.c12;
 201             c6   = std::sqrt(c6i * c6j);
 202             if (fr->ljpme_combination_rule == eljpmeLB
 203                 && !gmx_numzero(c6) && !gmx_numzero(c12i) && !gmx_numzero(c12j))
 204             {
 205                 sigmai = gmx::sixthroot(c12i / c6i);
 206                 sigmaj = gmx::sixthroot(c12j / c6j);
 207                 epsi   = c6i * c6i / c12i;
 208                 epsj   = c6j * c6j / c12j;
 209                 c6     = std::sqrt(epsi * epsj) * gmx::power6(0.5*(sigmai+sigmaj));
 210             }
 211             /* Store the elements at the same relative positions as C6 in nbfp in order
 212              * to simplify access in the kernels
 213              */
 214             grid[2*(atnr*i+j)] = c6*6.0;
 215         }
 216     }
 217     return grid;
 218 }
 219
 220 static real *mk_nbfp_combination_rule(const gmx_ffparams_t *idef, int comb_rule)
 221 {
 222     real      *nbfp;
 223     int        i, j, atnr;
 224     real       c6i, c6j, c12i, c12j, epsi, epsj, sigmai, sigmaj;
 225     real       c6, c12;
 226
 227     atnr = idef->atnr;
 228     snew(nbfp, 2*atnr*atnr);
 229     for (i = 0; i < atnr; ++i)
 230     {
 231         for (j = 0; j < atnr; ++j)
 232         {
 233             c6i  = idef->iparams[i*(atnr+1)].lj.c6;
 234             c12i = idef->iparams[i*(atnr+1)].lj.c12;
 235             c6j  = idef->iparams[j*(atnr+1)].lj.c6;
 236             c12j = idef->iparams[j*(atnr+1)].lj.c12;
 237             c6   = std::sqrt(c6i  * c6j);
 238             c12  = std::sqrt(c12i * c12j);
 239             if (comb_rule == eCOMB_ARITHMETIC
 240                 && !gmx_numzero(c6) && !gmx_numzero(c12))
 241             {
 242                 sigmai = gmx::sixthroot(c12i / c6i);
 243                 sigmaj = gmx::sixthroot(c12j / c6j);
 244                 epsi   = c6i * c6i / c12i;
 245                 epsj   = c6j * c6j / c12j;
 246                 c6     = std::sqrt(epsi * epsj) * gmx::power6(0.5*(sigmai+sigmaj));
 247                 c12    = std::sqrt(epsi * epsj) * gmx::power12(0.5*(sigmai+sigmaj));
 248             }
 249             C6(nbfp, atnr, i, j)   = c6*6.0;
 250             C12(nbfp, atnr, i, j)  = c12*12.0;
 251         }
 252     }
 253     return nbfp;
 254 }
 255
 256 /* This routine sets fr->solvent_opt to the most common solvent in the
 257  * system, e.g. esolSPC or esolTIP4P. It will also mark each charge group in
 258  * the fr->solvent_type array with the correct type (or esolNO).
 259  *
 260  * Charge groups that fulfill the conditions but are not identical to the
 261  * most common one will be marked as esolNO in the solvent_type array.
 262  *
 263  * TIP3p is identical to SPC for these purposes, so we call it
 264  * SPC in the arrays (Apologies to Bill Jorgensen ;-)
 265  *
 266  * NOTE: QM particle should not
 267  * become an optimized solvent. Not even if there is only one charge
 268  * group in the Qm
 269  */
 270
 271 typedef struct
 272 {
 273     int    model;
 274     int    count;
 275     int    vdwtype[4];
 276     real   charge[4];
 277 } solvent_parameters_t;
 278
 279 static void
 280 check_solvent_cg(const gmx_moltype_t    *molt,
 281                  int                     cg0,
 282                  int                     nmol,
 283                  const unsigned char    *qm_grpnr,
 284                  const t_grps           *qm_grps,
 285                  t_forcerec   *          fr,
 286                  int                    *n_solvent_parameters,
 287                  solvent_parameters_t  **solvent_parameters_p,
 288                  int                     cginfo,
 289                  int                    *cg_sp)
 290 {
 291     t_atom               *atom;
 292     int                   j, k;
 293     int                   j0, j1, nj;
 294     gmx_bool              perturbed;
 295     gmx_bool              has_vdw[4];
 296     gmx_bool              match;
 297     real                  tmp_charge[4]  = { 0.0 }; /* init to zero to make gcc4.8 happy */
 298     int                   tmp_vdwtype[4] = { 0 };   /* init to zero to make gcc4.8 happy */
 299     int                   tjA;
 300     gmx_bool              qm;
 301     solvent_parameters_t *solvent_parameters;
 302
 303     /* We use a list with parameters for each solvent type.
 304      * Every time we discover a new molecule that fulfills the basic
 305      * conditions for a solvent we compare with the previous entries
 306      * in these lists. If the parameters are the same we just increment
 307      * the counter for that type, and otherwise we create a new type
 308      * based on the current molecule.
 309      *
 310      * Once we've finished going through all molecules we check which
 311      * solvent is most common, and mark all those molecules while we
 312      * clear the flag on all others.
 313      */
 314
 315     solvent_parameters = *solvent_parameters_p;
 316
 317     /* Mark the cg first as non optimized */
 318     *cg_sp = -1;
 319
 320     /* Check if this cg has no exclusions with atoms in other charge groups
 321      * and all atoms inside the charge group excluded.
 322      * We only have 3 or 4 atom solvent loops.
 323      */
 324     if (GET_CGINFO_EXCL_INTER(cginfo) ||
 325         !GET_CGINFO_EXCL_INTRA(cginfo))
 326     {
 327         return;
 328     }
 329
 330     /* Get the indices of the first atom in this charge group */
 331     j0     = molt->cgs.index[cg0];
 332     j1     = molt->cgs.index[cg0+1];
 333
 334     /* Number of atoms in our molecule */
 335     nj     = j1 - j0;
 336
 337     if (debug)
 338     {
 339         fprintf(debug,
 340                 "Moltype '%s': there are %d atoms in this charge group\n",
 341                 *molt->name, nj);
 342     }
 343
 344     /* Check if it could be an SPC (3 atoms) or TIP4p (4) water,
 345      * otherwise skip it.
 346      */
 347     if (nj < 3 || nj > 4)
 348     {
 349         return;
 350     }
 351
 352     /* Check if we are doing QM on this group */
 353     qm = FALSE;
 354     if (qm_grpnr != nullptr)
 355     {
 356         for (j = j0; j < j1 && !qm; j++)
 357         {
 358             qm = (qm_grpnr[j] < qm_grps->nr - 1);
 359         }
 360     }
 361     /* Cannot use solvent optimization with QM */
 362     if (qm)
 363     {
 364         return;
 365     }
 366
 367     atom = molt->atoms.atom;
 368
 369     /* Still looks like a solvent, time to check parameters */
 370
 371     /* If it is perturbed (free energy) we can't use the solvent loops,
 372      * so then we just skip to the next molecule.
 373      */
 374     perturbed = FALSE;
 375
 376     for (j = j0; j < j1 && !perturbed; j++)
 377     {
 378         perturbed = PERTURBED(atom[j]);
 379     }
 380
 381     if (perturbed)
 382     {
 383         return;
 384     }
 385
 386     /* Now it's only a question if the VdW and charge parameters
 387      * are OK. Before doing the check we compare and see if they are
 388      * identical to a possible previous solvent type.
 389      * First we assign the current types and charges.
 390      */
 391     for (j = 0; j < nj; j++)
 392     {
 393         tmp_vdwtype[j] = atom[j0+j].type;
 394         tmp_charge[j]  = atom[j0+j].q;
 395     }
 396
 397     /* Does it match any previous solvent type? */
 398     for (k = 0; k < *n_solvent_parameters; k++)
 399     {
 400         match = TRUE;
 401
 402
 403         /* We can only match SPC with 3 atoms and TIP4p with 4 atoms */
 404         if ( (solvent_parameters[k].model == esolSPC   && nj != 3)  ||
 405              (solvent_parameters[k].model == esolTIP4P && nj != 4) )
 406         {
 407             match = FALSE;
 408         }
 409
 410         /* Check that types & charges match for all atoms in molecule */
 411         for (j = 0; j < nj && match == TRUE; j++)
 412         {
 413             if (tmp_vdwtype[j] != solvent_parameters[k].vdwtype[j])
 414             {
 415                 match = FALSE;
 416             }
 417             if (tmp_charge[j] != solvent_parameters[k].charge[j])
 418             {
 419                 match = FALSE;
 420             }
 421         }
 422         if (match == TRUE)
 423         {
 424             /* Congratulations! We have a matched solvent.
 425              * Flag it with this type for later processing.
 426              */
 427             *cg_sp = k;
 428             solvent_parameters[k].count += nmol;
 429
 430             /* We are done with this charge group */
 431             return;
 432         }
 433     }
 434
 435     /* If we get here, we have a tentative new solvent type.
 436      * Before we add it we must check that it fulfills the requirements
 437      * of the solvent optimized loops. First determine which atoms have
 438      * VdW interactions.
 439      */
 440     for (j = 0; j < nj; j++)
 441     {
 442         has_vdw[j] = FALSE;
 443         tjA        = tmp_vdwtype[j];
 444
 445         /* Go through all other tpes and see if any have non-zero
 446          * VdW parameters when combined with this one.
 447          */
 448         for (k = 0; k < fr->ntype && (has_vdw[j] == FALSE); k++)
 449         {
 450             /* We already checked that the atoms weren't perturbed,
 451              * so we only need to check state A now.
 452              */
 453             if (fr->bBHAM)
 454             {
 455                 has_vdw[j] = (has_vdw[j] ||
 456                               (BHAMA(fr->nbfp, fr->ntype, tjA, k) != 0.0) ||
 457                               (BHAMB(fr->nbfp, fr->ntype, tjA, k) != 0.0) ||
 458                               (BHAMC(fr->nbfp, fr->ntype, tjA, k) != 0.0));
 459             }
 460             else
 461             {
 462                 /* Standard LJ */
 463                 has_vdw[j] = (has_vdw[j] ||
 464                               (C6(fr->nbfp, fr->ntype, tjA, k)  != 0.0) ||
 465                               (C12(fr->nbfp, fr->ntype, tjA, k) != 0.0));
 466             }
 467         }
 468     }
 469
 470     /* Now we know all we need to make the final check and assignment. */
 471     if (nj == 3)
 472     {
 473         /* So, is it an SPC?
 474          * For this we require thatn all atoms have charge,
 475          * the charges on atom 2 & 3 should be the same, and only
 476          * atom 1 might have VdW.
 477          */
 478         if (has_vdw[1] == FALSE &&
 479             has_vdw[2] == FALSE &&
 480             tmp_charge[0]  != 0 &&
 481             tmp_charge[1]  != 0 &&
 482             tmp_charge[2]  == tmp_charge[1])
 483         {
 484             srenew(solvent_parameters, *n_solvent_parameters+1);
 485             solvent_parameters[*n_solvent_parameters].model = esolSPC;
 486             solvent_parameters[*n_solvent_parameters].count = nmol;
 487             for (k = 0; k < 3; k++)
 488             {
 489                 solvent_parameters[*n_solvent_parameters].vdwtype[k] = tmp_vdwtype[k];
 490                 solvent_parameters[*n_solvent_parameters].charge[k]  = tmp_charge[k];
 491             }
 492
 493             *cg_sp = *n_solvent_parameters;
 494             (*n_solvent_parameters)++;
 495         }
 496     }
 497     else if (nj == 4)
 498     {
 499         /* Or could it be a TIP4P?
 500          * For this we require thatn atoms 2,3,4 have charge, but not atom 1.
 501          * Only atom 1 mght have VdW.
 502          */
 503         if (has_vdw[1] == FALSE &&
 504             has_vdw[2] == FALSE &&
 505             has_vdw[3] == FALSE &&
 506             tmp_charge[0]  == 0 &&
 507             tmp_charge[1]  != 0 &&
 508             tmp_charge[2]  == tmp_charge[1] &&
 509             tmp_charge[3]  != 0)
 510         {
 511             srenew(solvent_parameters, *n_solvent_parameters+1);
 512             solvent_parameters[*n_solvent_parameters].model = esolTIP4P;
 513             solvent_parameters[*n_solvent_parameters].count = nmol;
 514             for (k = 0; k < 4; k++)
 515             {
 516                 solvent_parameters[*n_solvent_parameters].vdwtype[k] = tmp_vdwtype[k];
 517                 solvent_parameters[*n_solvent_parameters].charge[k]  = tmp_charge[k];
 518             }
 519
 520             *cg_sp = *n_solvent_parameters;
 521             (*n_solvent_parameters)++;
 522         }
 523     }
 524
 525     *solvent_parameters_p = solvent_parameters;
 526 }
 527
 528 static void
 529 check_solvent(FILE  *                fp,
 530               const gmx_mtop_t  *    mtop,
 531               t_forcerec  *          fr,
 532               cginfo_mb_t           *cginfo_mb)
 533 {
 534     const t_block     *   cgs;
 535     const gmx_moltype_t  *molt;
 536     int                   mb, mol, cg_mol, at_offset, am, cgm, i, nmol_ch, nmol;
 537     int                   n_solvent_parameters;
 538     solvent_parameters_t *solvent_parameters;
 539     int                 **cg_sp;
 540     int                   bestsp, bestsol;
 541
 542     if (debug)
 543     {
 544         fprintf(debug, "Going to determine what solvent types we have.\n");
 545     }
 546
 547     n_solvent_parameters = 0;
 548     solvent_parameters   = nullptr;
 549     /* Allocate temporary array for solvent type */
 550     snew(cg_sp, mtop->nmolblock);
 551
 552     at_offset = 0;
 553     for (mb = 0; mb < mtop->nmolblock; mb++)
 554     {
 555         molt = &mtop->moltype[mtop->molblock[mb].type];
 556         cgs  = &molt->cgs;
 557         /* Here we have to loop over all individual molecules
 558          * because we need to check for QMMM particles.
 559          */
 560         snew(cg_sp[mb], cginfo_mb[mb].cg_mod);
 561         nmol_ch = cginfo_mb[mb].cg_mod/cgs->nr;
 562         nmol    = mtop->molblock[mb].nmol/nmol_ch;
 563         for (mol = 0; mol < nmol_ch; mol++)
 564         {
 565             cgm = mol*cgs->nr;
 566             am  = mol*cgs->index[cgs->nr];
 567             for (cg_mol = 0; cg_mol < cgs->nr; cg_mol++)
 568             {
 569                 check_solvent_cg(molt, cg_mol, nmol,
 570                                  mtop->groups.grpnr[egcQMMM] ?
 571                                  mtop->groups.grpnr[egcQMMM]+at_offset+am : nullptr,
 572                                  &mtop->groups.grps[egcQMMM],
 573                                  fr,
 574                                  &n_solvent_parameters, &solvent_parameters,
 575                                  cginfo_mb[mb].cginfo[cgm+cg_mol],
 576                                  &cg_sp[mb][cgm+cg_mol]);
 577             }
 578         }
 579         at_offset += cgs->index[cgs->nr];
 580     }
 581
 582     /* Puh! We finished going through all charge groups.
 583      * Now find the most common solvent model.
 584      */
 585
 586     /* Most common solvent this far */
 587     bestsp = -2;
 588     for (i = 0; i < n_solvent_parameters; i++)
 589     {
 590         if (bestsp == -2 ||
 591             solvent_parameters[i].count > solvent_parameters[bestsp].count)
 592         {
 593             bestsp = i;
 594         }
 595     }
 596
 597     if (bestsp >= 0)
 598     {
 599         bestsol = solvent_parameters[bestsp].model;
 600     }
 601     else
 602     {
 603         bestsol = esolNO;
 604     }
 605
 606     fr->nWatMol = 0;
 607     for (mb = 0; mb < mtop->nmolblock; mb++)
 608     {
 609         cgs  = &mtop->moltype[mtop->molblock[mb].type].cgs;
 610         nmol = (mtop->molblock[mb].nmol*cgs->nr)/cginfo_mb[mb].cg_mod;
 611         for (i = 0; i < cginfo_mb[mb].cg_mod; i++)
 612         {
 613             if (cg_sp[mb][i] == bestsp)
 614             {
 615                 SET_CGINFO_SOLOPT(cginfo_mb[mb].cginfo[i], bestsol);
 616                 fr->nWatMol += nmol;
 617             }
 618             else
 619             {
 620                 SET_CGINFO_SOLOPT(cginfo_mb[mb].cginfo[i], esolNO);
 621             }
 622         }
 623         sfree(cg_sp[mb]);
 624     }
 625     sfree(cg_sp);
 626
 627     if (bestsol != esolNO && fp != nullptr)
 628     {
 629         fprintf(fp, "\nEnabling %s-like water optimization for %d molecules.\n\n",
 630                 esol_names[bestsol],
 631                 solvent_parameters[bestsp].count);
 632     }
 633
 634     sfree(solvent_parameters);
 635     fr->solvent_opt = bestsol;
 636 }
 637
 638 enum {
 639     acNONE = 0, acCONSTRAINT, acSETTLE
 640 };
 641
 642 static cginfo_mb_t *init_cginfo_mb(FILE *fplog, const gmx_mtop_t *mtop,
 643                                    t_forcerec *fr, gmx_bool bNoSolvOpt,
 644                                    gmx_bool *bFEP_NonBonded,
 645                                    gmx_bool *bExcl_IntraCGAll_InterCGNone)
 646 {
 647     const t_block        *cgs;
 648     const t_blocka       *excl;
 649     const gmx_moltype_t  *molt;
 650     const gmx_molblock_t *molb;
 651     cginfo_mb_t          *cginfo_mb;
 652     gmx_bool             *type_VDW;
 653     int                  *cginfo;
 654     int                   cg_offset, a_offset;
 655     int                   mb, m, cg, a0, a1, gid, ai, j, aj, excl_nalloc;
 656     int                  *a_con;
 657     int                   ftype;
 658     int                   ia;
 659     gmx_bool              bId, *bExcl, bExclIntraAll, bExclInter, bHaveVDW, bHaveQ, bHavePerturbedAtoms;
 660
 661     snew(cginfo_mb, mtop->nmolblock);
 662
 663     snew(type_VDW, fr->ntype);
 664     for (ai = 0; ai < fr->ntype; ai++)
 665     {
 666         type_VDW[ai] = FALSE;
 667         for (j = 0; j < fr->ntype; j++)
 668         {
 669             type_VDW[ai] = type_VDW[ai] ||
 670                 fr->bBHAM ||
 671                 C6(fr->nbfp, fr->ntype, ai, j) != 0 ||
 672                 C12(fr->nbfp, fr->ntype, ai, j) != 0;
 673         }
 674     }
 675
 676     *bFEP_NonBonded               = FALSE;
 677     *bExcl_IntraCGAll_InterCGNone = TRUE;
 678
 679     excl_nalloc = 10;
 680     snew(bExcl, excl_nalloc);
 681     cg_offset = 0;
 682     a_offset  = 0;
 683     for (mb = 0; mb < mtop->nmolblock; mb++)
 684     {
 685         molb = &mtop->molblock[mb];
 686         molt = &mtop->moltype[molb->type];
 687         cgs  = &molt->cgs;
 688         excl = &molt->excls;
 689
 690         /* Check if the cginfo is identical for all molecules in this block.
 691          * If so, we only need an array of the size of one molecule.
 692          * Otherwise we make an array of #mol times #cgs per molecule.
 693          */
 694         bId = TRUE;
 695         for (m = 0; m < molb->nmol; m++)
 696         {
 697             int am = m*cgs->index[cgs->nr];
 698             for (cg = 0; cg < cgs->nr; cg++)
 699             {
 700                 a0 = cgs->index[cg];
 701                 a1 = cgs->index[cg+1];
 702                 if (ggrpnr(&mtop->groups, egcENER, a_offset+am+a0) !=
 703                     ggrpnr(&mtop->groups, egcENER, a_offset   +a0))
 704                 {
 705                     bId = FALSE;
 706                 }
 707                 if (mtop->groups.grpnr[egcQMMM] != nullptr)
 708                 {
 709                     for (ai = a0; ai < a1; ai++)
 710                     {
 711                         if (mtop->groups.grpnr[egcQMMM][a_offset+am+ai] !=
 712                             mtop->groups.grpnr[egcQMMM][a_offset   +ai])
 713                         {
 714                             bId = FALSE;
 715                         }
 716                     }
 717                 }
 718             }
 719         }
 720
 721         cginfo_mb[mb].cg_start = cg_offset;
 722         cginfo_mb[mb].cg_end   = cg_offset + molb->nmol*cgs->nr;
 723         cginfo_mb[mb].cg_mod   = (bId ? 1 : molb->nmol)*cgs->nr;
 724         snew(cginfo_mb[mb].cginfo, cginfo_mb[mb].cg_mod);
 725         cginfo = cginfo_mb[mb].cginfo;
 726
 727         /* Set constraints flags for constrained atoms */
 728         snew(a_con, molt->atoms.nr);
 729         for (ftype = 0; ftype < F_NRE; ftype++)
 730         {
 731             if (interaction_function[ftype].flags & IF_CONSTRAINT)
 732             {
 733                 int nral;
 734
 735                 nral = NRAL(ftype);
 736                 for (ia = 0; ia < molt->ilist[ftype].nr; ia += 1+nral)
 737                 {
 738                     int a;
 739
 740                     for (a = 0; a < nral; a++)
 741                     {
 742                         a_con[molt->ilist[ftype].iatoms[ia+1+a]] =
 743                             (ftype == F_SETTLE ? acSETTLE : acCONSTRAINT);
 744                     }
 745                 }
 746             }
 747         }
 748
 749         for (m = 0; m < (bId ? 1 : molb->nmol); m++)
 750         {
 751             int cgm = m*cgs->nr;
 752             int am  = m*cgs->index[cgs->nr];
 753             for (cg = 0; cg < cgs->nr; cg++)
 754             {
 755                 a0 = cgs->index[cg];
 756                 a1 = cgs->index[cg+1];
 757
 758                 /* Store the energy group in cginfo */
 759                 gid = ggrpnr(&mtop->groups, egcENER, a_offset+am+a0);
 760                 SET_CGINFO_GID(cginfo[cgm+cg], gid);
 761
 762                 /* Check the intra/inter charge group exclusions */
 763                 if (a1-a0 > excl_nalloc)
 764                 {
 765                     excl_nalloc = a1 - a0;
 766                     srenew(bExcl, excl_nalloc);
 767                 }
 768                 /* bExclIntraAll: all intra cg interactions excluded
 769                  * bExclInter:    any inter cg interactions excluded
 770                  */
 771                 bExclIntraAll       = TRUE;
 772                 bExclInter          = FALSE;
 773                 bHaveVDW            = FALSE;
 774                 bHaveQ              = FALSE;
 775                 bHavePerturbedAtoms = FALSE;
 776                 for (ai = a0; ai < a1; ai++)
 777                 {
 778                     /* Check VDW and electrostatic interactions */
 779                     bHaveVDW = bHaveVDW || (type_VDW[molt->atoms.atom[ai].type] ||
 780                                             type_VDW[molt->atoms.atom[ai].typeB]);
 781                     bHaveQ  = bHaveQ    || (molt->atoms.atom[ai].q != 0 ||
 782                                             molt->atoms.atom[ai].qB != 0);
 783
 784                     bHavePerturbedAtoms = bHavePerturbedAtoms || (PERTURBED(molt->atoms.atom[ai]) != 0);
 785
 786                     /* Clear the exclusion list for atom ai */
 787                     for (aj = a0; aj < a1; aj++)
 788                     {
 789                         bExcl[aj-a0] = FALSE;
 790                     }
 791                     /* Loop over all the exclusions of atom ai */
 792                     for (j = excl->index[ai]; j < excl->index[ai+1]; j++)
 793                     {
 794                         aj = excl->a[j];
 795                         if (aj < a0 || aj >= a1)
 796                         {
 797                             bExclInter = TRUE;
 798                         }
 799                         else
 800                         {
 801                             bExcl[aj-a0] = TRUE;
 802                         }
 803                     }
 804                     /* Check if ai excludes a0 to a1 */
 805                     for (aj = a0; aj < a1; aj++)
 806                     {
 807                         if (!bExcl[aj-a0])
 808                         {
 809                             bExclIntraAll = FALSE;
 810                         }
 811                     }
 812
 813                     switch (a_con[ai])
 814                     {
 815                         case acCONSTRAINT:
 816                             SET_CGINFO_CONSTR(cginfo[cgm+cg]);
 817                             break;
 818                         case acSETTLE:
 819                             SET_CGINFO_SETTLE(cginfo[cgm+cg]);
 820                             break;
 821                         default:
 822                             break;
 823                     }
 824                 }
 825                 if (bExclIntraAll)
 826                 {
 827                     SET_CGINFO_EXCL_INTRA(cginfo[cgm+cg]);
 828                 }
 829                 if (bExclInter)
 830                 {
 831                     SET_CGINFO_EXCL_INTER(cginfo[cgm+cg]);
 832                 }
 833                 if (a1 - a0 > MAX_CHARGEGROUP_SIZE)
 834                 {
 835                     /* The size in cginfo is currently only read with DD */
 836                     gmx_fatal(FARGS, "A charge group has size %d which is larger than the limit of %d atoms", a1-a0, MAX_CHARGEGROUP_SIZE);
 837                 }
 838                 if (bHaveVDW)
 839                 {
 840                     SET_CGINFO_HAS_VDW(cginfo[cgm+cg]);
 841                 }
 842                 if (bHaveQ)
 843                 {
 844                     SET_CGINFO_HAS_Q(cginfo[cgm+cg]);
 845                 }
 846                 if (bHavePerturbedAtoms && fr->efep != efepNO)
 847                 {
 848                     SET_CGINFO_FEP(cginfo[cgm+cg]);
 849                     *bFEP_NonBonded = TRUE;
 850                 }
 851                 /* Store the charge group size */
 852                 SET_CGINFO_NATOMS(cginfo[cgm+cg], a1-a0);
 853
 854                 if (!bExclIntraAll || bExclInter)
 855                 {
 856                     *bExcl_IntraCGAll_InterCGNone = FALSE;
 857                 }
 858             }
 859         }
 860
 861         sfree(a_con);
 862
 863         cg_offset += molb->nmol*cgs->nr;
 864         a_offset  += molb->nmol*cgs->index[cgs->nr];
 865     }
 866     sfree(bExcl);
 867
 868     /* the solvent optimizer is called after the QM is initialized,
 869      * because we don't want to have the QM subsystemto become an
 870      * optimized solvent
 871      */
 872
 873     check_solvent(fplog, mtop, fr, cginfo_mb);
 874
 875     if (getenv("GMX_NO_SOLV_OPT"))
 876     {
 877         if (fplog)
 878         {
 879             fprintf(fplog, "Found environment variable GMX_NO_SOLV_OPT.\n"
 880                     "Disabling all solvent optimization\n");
 881         }
 882         fr->solvent_opt = esolNO;
 883     }
 884     if (bNoSolvOpt)
 885     {
 886         fr->solvent_opt = esolNO;
 887     }
 888     if (!fr->solvent_opt)
 889     {
 890         for (mb = 0; mb < mtop->nmolblock; mb++)
 891         {
 892             for (cg = 0; cg < cginfo_mb[mb].cg_mod; cg++)
 893             {
 894                 SET_CGINFO_SOLOPT(cginfo_mb[mb].cginfo[cg], esolNO);
 895             }
 896         }
 897     }
 898
 899     return cginfo_mb;
 900 }
 901
 902 static int *cginfo_expand(int nmb, cginfo_mb_t *cgi_mb)
 903 {
 904     int  ncg, mb, cg;
 905     int *cginfo;
 906
 907     ncg = cgi_mb[nmb-1].cg_end;
 908     snew(cginfo, ncg);
 909     mb = 0;
 910     for (cg = 0; cg < ncg; cg++)
 911     {
 912         while (cg >= cgi_mb[mb].cg_end)
 913         {
 914             mb++;
 915         }
 916         cginfo[cg] =
 917             cgi_mb[mb].cginfo[(cg - cgi_mb[mb].cg_start) % cgi_mb[mb].cg_mod];
 918     }
 919
 920     return cginfo;
 921 }
 922
 923 /* Sets the sum of charges (squared) and C6 in the system in fr.
 924  * Returns whether the system has a net charge.
 925  */
 926 static bool set_chargesum(FILE *log, t_forcerec *fr, const gmx_mtop_t *mtop)
 927 {
 928     /*This now calculates sum for q and c6*/
 929     double         qsum, q2sum, q, c6sum, c6;
 930     int            mb, nmol, i;
 931     const t_atoms *atoms;
 932
 933     qsum   = 0;
 934     q2sum  = 0;
 935     c6sum  = 0;
 936     for (mb = 0; mb < mtop->nmolblock; mb++)
 937     {
 938         nmol  = mtop->molblock[mb].nmol;
 939         atoms = &mtop->moltype[mtop->molblock[mb].type].atoms;
 940         for (i = 0; i < atoms->nr; i++)
 941         {
 942             q       = atoms->atom[i].q;
 943             qsum   += nmol*q;
 944             q2sum  += nmol*q*q;
 945             c6      = mtop->ffparams.iparams[atoms->atom[i].type*(mtop->ffparams.atnr+1)].lj.c6;
 946             c6sum  += nmol*c6;
 947         }
 948     }
 949     fr->qsum[0]   = qsum;
 950     fr->q2sum[0]  = q2sum;
 951     fr->c6sum[0]  = c6sum;
 952
 953     if (fr->efep != efepNO)
 954     {
 955         qsum   = 0;
 956         q2sum  = 0;
 957         c6sum  = 0;
 958         for (mb = 0; mb < mtop->nmolblock; mb++)
 959         {
 960             nmol  = mtop->molblock[mb].nmol;
 961             atoms = &mtop->moltype[mtop->molblock[mb].type].atoms;
 962             for (i = 0; i < atoms->nr; i++)
 963             {
 964                 q       = atoms->atom[i].qB;
 965                 qsum   += nmol*q;
 966                 q2sum  += nmol*q*q;
 967                 c6      = mtop->ffparams.iparams[atoms->atom[i].typeB*(mtop->ffparams.atnr+1)].lj.c6;
 968                 c6sum  += nmol*c6;
 969             }
 970             fr->qsum[1]   = qsum;
 971             fr->q2sum[1]  = q2sum;
 972             fr->c6sum[1]  = c6sum;
 973         }
 974     }
 975     else
 976     {
 977         fr->qsum[1]   = fr->qsum[0];
 978         fr->q2sum[1]  = fr->q2sum[0];
 979         fr->c6sum[1]  = fr->c6sum[0];
 980     }
 981     if (log)
 982     {
 983         if (fr->efep == efepNO)
 984         {
 985             fprintf(log, "System total charge: %.3f\n", fr->qsum[0]);
 986         }
 987         else
 988         {
 989             fprintf(log, "System total charge, top. A: %.3f top. B: %.3f\n",
 990                     fr->qsum[0], fr->qsum[1]);
 991         }
 992     }
 993
 994     /* A cut-off of 1e-4 is used to catch rounding errors due to ascii input */
 995     return (std::abs(fr->qsum[0]) > 1e-4 ||
 996             std::abs(fr->qsum[1]) > 1e-4);
 997 }
 998
 999 void update_forcerec(t_forcerec *fr, matrix box)
1000 {
1001     if (fr->ic->eeltype == eelGRF)
1002     {
1003         calc_rffac(nullptr, fr->ic->eeltype, fr->ic->epsilon_r, fr->ic->epsilon_rf,
1004                    fr->ic->rcoulomb, fr->temp, fr->zsquare, box,
1005                    &fr->ic->k_rf, &fr->ic->c_rf);
1006     }
1007 }
1008
1009 void set_avcsixtwelve(FILE *fplog, t_forcerec *fr, const gmx_mtop_t *mtop)
1010 {
1011     const t_atoms  *atoms, *atoms_tpi;
1012     const t_blocka *excl;
1013     int             mb, nmol, nmolc, i, j, tpi, tpj, j1, j2, k, nexcl, q;
1014     gmx_int64_t     npair, npair_ij, tmpi, tmpj;
1015     double          csix, ctwelve;
1016     int             ntp, *typecount;
1017     gmx_bool        bBHAM;
1018     real           *nbfp;
1019     real           *nbfp_comb = nullptr;
1020
1021     ntp   = fr->ntype;
1022     bBHAM = fr->bBHAM;
1023     nbfp  = fr->nbfp;
1024
1025     /* For LJ-PME, we want to correct for the difference between the
1026      * actual C6 values and the C6 values used by the LJ-PME based on
1027      * combination rules. */
1028
1029     if (EVDW_PME(fr->ic->vdwtype))
1030     {
1031         nbfp_comb = mk_nbfp_combination_rule(&mtop->ffparams,
1032                                              (fr->ljpme_combination_rule == eljpmeLB) ? eCOMB_ARITHMETIC : eCOMB_GEOMETRIC);
1033         for (tpi = 0; tpi < ntp; ++tpi)
1034         {
1035             for (tpj = 0; tpj < ntp; ++tpj)
1036             {
1037                 C6(nbfp_comb, ntp, tpi, tpj) =
1038                     C6(nbfp, ntp, tpi, tpj) - C6(nbfp_comb, ntp, tpi, tpj);
1039                 C12(nbfp_comb, ntp, tpi, tpj) = C12(nbfp, ntp, tpi, tpj);
1040             }
1041         }
1042         nbfp = nbfp_comb;
1043     }
1044     for (q = 0; q < (fr->efep == efepNO ? 1 : 2); q++)
1045     {
1046         csix    = 0;
1047         ctwelve = 0;
1048         npair   = 0;
1049         nexcl   = 0;
1050         if (!fr->n_tpi)
1051         {
1052             /* Count the types so we avoid natoms^2 operations */
1053             snew(typecount, ntp);
1054             gmx_mtop_count_atomtypes(mtop, q, typecount);
1055
1056             for (tpi = 0; tpi < ntp; tpi++)
1057             {
1058                 for (tpj = tpi; tpj < ntp; tpj++)
1059                 {
1060                     tmpi = typecount[tpi];
1061                     tmpj = typecount[tpj];
1062                     if (tpi != tpj)
1063                     {
1064                         npair_ij = tmpi*tmpj;
1065                     }
1066                     else
1067                     {
1068                         npair_ij = tmpi*(tmpi - 1)/2;
1069                     }
1070                     if (bBHAM)
1071                     {
1072                         /* nbfp now includes the 6.0 derivative prefactor */
1073                         csix    += npair_ij*BHAMC(nbfp, ntp, tpi, tpj)/6.0;
1074                     }
1075                     else
1076                     {
1077                         /* nbfp now includes the 6.0/12.0 derivative prefactors */
1078                         csix    += npair_ij*   C6(nbfp, ntp, tpi, tpj)/6.0;
1079                         ctwelve += npair_ij*  C12(nbfp, ntp, tpi, tpj)/12.0;
1080                     }
1081                     npair += npair_ij;
1082                 }
1083             }
1084             sfree(typecount);
1085             /* Subtract the excluded pairs.
1086              * The main reason for substracting exclusions is that in some cases
1087              * some combinations might never occur and the parameters could have
1088              * any value. These unused values should not influence the dispersion
1089              * correction.
1090              */
1091             for (mb = 0; mb < mtop->nmolblock; mb++)
1092             {
1093                 nmol  = mtop->molblock[mb].nmol;
1094                 atoms = &mtop->moltype[mtop->molblock[mb].type].atoms;
1095                 excl  = &mtop->moltype[mtop->molblock[mb].type].excls;
1096                 for (i = 0; (i < atoms->nr); i++)
1097                 {
1098                     if (q == 0)
1099                     {
1100                         tpi = atoms->atom[i].type;
1101                     }
1102                     else
1103                     {
1104                         tpi = atoms->atom[i].typeB;
1105                     }
1106                     j1  = excl->index[i];
1107                     j2  = excl->index[i+1];
1108                     for (j = j1; j < j2; j++)
1109                     {
1110                         k = excl->a[j];
1111                         if (k > i)
1112                         {
1113                             if (q == 0)
1114                             {
1115                                 tpj = atoms->atom[k].type;
1116                             }
1117                             else
1118                             {
1119                                 tpj = atoms->atom[k].typeB;
1120                             }
1121                             if (bBHAM)
1122                             {
1123                                 /* nbfp now includes the 6.0 derivative prefactor */
1124                                 csix -= nmol*BHAMC(nbfp, ntp, tpi, tpj)/6.0;
1125                             }
1126                             else
1127                             {
1128                                 /* nbfp now includes the 6.0/12.0 derivative prefactors */
1129                                 csix    -= nmol*C6 (nbfp, ntp, tpi, tpj)/6.0;
1130                                 ctwelve -= nmol*C12(nbfp, ntp, tpi, tpj)/12.0;
1131                             }
1132                             nexcl += nmol;
1133                         }
1134                     }
1135                 }
1136             }
1137         }
1138         else
1139         {
1140             /* Only correct for the interaction of the test particle
1141              * with the rest of the system.
1142              */
1143             atoms_tpi =
1144                 &mtop->moltype[mtop->molblock[mtop->nmolblock-1].type].atoms;
1145
1146             npair = 0;
1147             for (mb = 0; mb < mtop->nmolblock; mb++)
1148             {
1149                 nmol  = mtop->molblock[mb].nmol;
1150                 atoms = &mtop->moltype[mtop->molblock[mb].type].atoms;
1151                 for (j = 0; j < atoms->nr; j++)
1152                 {
1153                     nmolc = nmol;
1154                     /* Remove the interaction of the test charge group
1155                      * with itself.
1156                      */
1157                     if (mb == mtop->nmolblock-1)
1158                     {
1159                         nmolc--;
1160
1161                         if (mb == 0 && nmol == 1)
1162                         {
1163                             gmx_fatal(FARGS, "Old format tpr with TPI, please generate a new tpr file");
1164                         }
1165                     }
1166                     if (q == 0)
1167                     {
1168                         tpj = atoms->atom[j].type;
1169                     }
1170                     else
1171                     {
1172                         tpj = atoms->atom[j].typeB;
1173                     }
1174                     for (i = 0; i < fr->n_tpi; i++)
1175                     {
1176                         if (q == 0)
1177                         {
1178                             tpi = atoms_tpi->atom[i].type;
1179                         }
1180                         else
1181                         {
1182                             tpi = atoms_tpi->atom[i].typeB;
1183                         }
1184                         if (bBHAM)
1185                         {
1186                             /* nbfp now includes the 6.0 derivative prefactor */
1187                             csix    += nmolc*BHAMC(nbfp, ntp, tpi, tpj)/6.0;
1188                         }
1189                         else
1190                         {
1191                             /* nbfp now includes the 6.0/12.0 derivative prefactors */
1192                             csix    += nmolc*C6 (nbfp, ntp, tpi, tpj)/6.0;
1193                             ctwelve += nmolc*C12(nbfp, ntp, tpi, tpj)/12.0;
1194                         }
1195                         npair += nmolc;
1196                     }
1197                 }
1198             }
1199         }
1200         if (npair - nexcl <= 0 && fplog)
1201         {
1202             fprintf(fplog, "\nWARNING: There are no atom pairs for dispersion correction\n\n");
1203             csix     = 0;
1204             ctwelve  = 0;
1205         }
1206         else
1207         {
1208             csix    /= npair - nexcl;
1209             ctwelve /= npair - nexcl;
1210         }
1211         if (debug)
1212         {
1213             fprintf(debug, "Counted %d exclusions\n", nexcl);
1214             fprintf(debug, "Average C6 parameter is: %10g\n", (double)csix);
1215             fprintf(debug, "Average C12 parameter is: %10g\n", (double)ctwelve);
1216         }
1217         fr->avcsix[q]    = csix;
1218         fr->avctwelve[q] = ctwelve;
1219     }
1220
1221     if (EVDW_PME(fr->ic->vdwtype))
1222     {
1223         sfree(nbfp_comb);
1224     }
1225
1226     if (fplog != nullptr)
1227     {
1228         if (fr->eDispCorr == edispcAllEner ||
1229             fr->eDispCorr == edispcAllEnerPres)
1230         {
1231             fprintf(fplog, "Long Range LJ corr.: <C6> %10.4e, <C12> %10.4e\n",
1232                     fr->avcsix[0], fr->avctwelve[0]);
1233         }
1234         else
1235         {
1236             fprintf(fplog, "Long Range LJ corr.: <C6> %10.4e\n", fr->avcsix[0]);
1237         }
1238     }
1239 }
1240
1241
1242 static real calcBuckinghamBMax(FILE *fplog, const gmx_mtop_t *mtop)
1243 {
1244     const t_atoms *at1, *at2;
1245     int            mt1, mt2, i, j, tpi, tpj, ntypes;
1246     real           b, bmin;
1247
1248     if (fplog)
1249     {
1250         fprintf(fplog, "Determining largest Buckingham b parameter for table\n");
1251     }
1252     ntypes = mtop->ffparams.atnr;
1253
1254     bmin            = -1;
1255     real bham_b_max = 0;
1256     for (mt1 = 0; mt1 < mtop->nmoltype; mt1++)
1257     {
1258         at1 = &mtop->moltype[mt1].atoms;
1259         for (i = 0; (i < at1->nr); i++)
1260         {
1261             tpi = at1->atom[i].type;
1262             if (tpi >= ntypes)
1263             {
1264                 gmx_fatal(FARGS, "Atomtype[%d] = %d, maximum = %d", i, tpi, ntypes);
1265             }
1266
1267             for (mt2 = mt1; mt2 < mtop->nmoltype; mt2++)
1268             {
1269                 at2 = &mtop->moltype[mt2].atoms;
1270                 for (j = 0; (j < at2->nr); j++)
1271                 {
1272                     tpj = at2->atom[j].type;
1273                     if (tpj >= ntypes)
1274                     {
1275                         gmx_fatal(FARGS, "Atomtype[%d] = %d, maximum = %d", j, tpj, ntypes);
1276                     }
1277                     b = mtop->ffparams.iparams[tpi*ntypes + tpj].bham.b;
1278                     if (b > bham_b_max)
1279                     {
1280                         bham_b_max = b;
1281                     }
1282                     if ((b < bmin) || (bmin == -1))
1283                     {
1284                         bmin = b;
1285                     }
1286                 }
1287             }
1288         }
1289     }
1290     if (fplog)
1291     {
1292         fprintf(fplog, "Buckingham b parameters, min: %g, max: %g\n",
1293                 bmin, bham_b_max);
1294     }
1295
1296     return bham_b_max;
1297 }
1298
1299 static void make_nbf_tables(FILE *fp,
1300                             const interaction_const_t *ic, real rtab,
1301                             const char *tabfn, char *eg1, char *eg2,
1302                             t_nblists *nbl)
1303 {
1304     char buf[STRLEN];
1305     int  i, j;
1306
1307     if (tabfn == nullptr)
1308     {
1309         if (debug)
1310         {
1311             fprintf(debug, "No table file name passed, can not read table, can not do non-bonded interactions\n");
1312         }
1313         return;
1314     }
1315
1316     sprintf(buf, "%s", tabfn);
1317     if (eg1 && eg2)
1318     {
1319         /* Append the two energy group names */
1320         sprintf(buf + strlen(tabfn) - strlen(ftp2ext(efXVG)) - 1, "_%s_%s.%s",
1321                 eg1, eg2, ftp2ext(efXVG));
1322     }
1323     nbl->table_elec_vdw = make_tables(fp, ic, buf, rtab, 0);
1324     /* Copy the contents of the table to separate coulomb and LJ tables too,
1325      * to improve cache performance.
1326      */
1327     /* For performance reasons we want
1328      * the table data to be aligned to 16-byte. The pointers could be freed
1329      * but currently aren't.
1330      */
1331     snew(nbl->table_elec, 1);
1332     nbl->table_elec->interaction   = GMX_TABLE_INTERACTION_ELEC;
1333     nbl->table_elec->format        = nbl->table_elec_vdw->format;
1334     nbl->table_elec->r             = nbl->table_elec_vdw->r;
1335     nbl->table_elec->n             = nbl->table_elec_vdw->n;
1336     nbl->table_elec->scale         = nbl->table_elec_vdw->scale;
1337     nbl->table_elec->formatsize    = nbl->table_elec_vdw->formatsize;
1338     nbl->table_elec->ninteractions = 1;
1339     nbl->table_elec->stride        = nbl->table_elec->formatsize * nbl->table_elec->ninteractions;
1340     snew_aligned(nbl->table_elec->data, nbl->table_elec->stride*(nbl->table_elec->n+1), 32);
1341
1342     snew(nbl->table_vdw, 1);
1343     nbl->table_vdw->interaction   = GMX_TABLE_INTERACTION_VDWREP_VDWDISP;
1344     nbl->table_vdw->format        = nbl->table_elec_vdw->format;
1345     nbl->table_vdw->r             = nbl->table_elec_vdw->r;
1346     nbl->table_vdw->n             = nbl->table_elec_vdw->n;
1347     nbl->table_vdw->scale         = nbl->table_elec_vdw->scale;
1348     nbl->table_vdw->formatsize    = nbl->table_elec_vdw->formatsize;
1349     nbl->table_vdw->ninteractions = 2;
1350     nbl->table_vdw->stride        = nbl->table_vdw->formatsize * nbl->table_vdw->ninteractions;
1351     snew_aligned(nbl->table_vdw->data, nbl->table_vdw->stride*(nbl->table_vdw->n+1), 32);
1352
1353     for (i = 0; i <= nbl->table_elec_vdw->n; i++)
1354     {
1355         for (j = 0; j < 4; j++)
1356         {
1357             nbl->table_elec->data[4*i+j] = nbl->table_elec_vdw->data[12*i+j];
1358         }
1359         for (j = 0; j < 8; j++)
1360         {
1361             nbl->table_vdw->data[8*i+j] = nbl->table_elec_vdw->data[12*i+4+j];
1362         }
1363     }
1364 }
1365
1366 /*!\brief If there's bonded interactions of type \c ftype1 or \c
1367  * ftype2 present in the topology, build an array of the number of
1368  * interactions present for each bonded interaction index found in the
1369  * topology.
1370  *
1371  * \c ftype1 or \c ftype2 may be set to -1 to disable seeking for a
1372  * valid type with that parameter.
1373  *
1374  * \c count will be reallocated as necessary to fit the largest bonded
1375  * interaction index found, and its current size will be returned in
1376  * \c ncount. It will contain zero for every bonded interaction index
1377  * for which no interactions are present in the topology.
1378  */
1379 static void count_tables(int ftype1, int ftype2, const gmx_mtop_t *mtop,
1380                          int *ncount, int **count)
1381 {
1382     const gmx_moltype_t *molt;
1383     const t_ilist       *il;
1384     int                  mt, ftype, stride, i, j, tabnr;
1385
1386     // Loop over all moleculetypes
1387     for (mt = 0; mt < mtop->nmoltype; mt++)
1388     {
1389         molt = &mtop->moltype[mt];
1390         // Loop over all interaction types
1391         for (ftype = 0; ftype < F_NRE; ftype++)
1392         {
1393             // If the current interaction type is one of the types whose tables we're trying to count...
1394             if (ftype == ftype1 || ftype == ftype2)
1395             {
1396                 il     = &molt->ilist[ftype];
1397                 stride = 1 + NRAL(ftype);
1398                 // ... and there are actually some interactions for this type
1399                 for (i = 0; i < il->nr; i += stride)
1400                 {
1401                     // Find out which table index the user wanted
1402                     tabnr = mtop->ffparams.iparams[il->iatoms[i]].tab.table;
1403                     if (tabnr < 0)
1404                     {
1405                         gmx_fatal(FARGS, "A bonded table number is smaller than 0: %d\n", tabnr);
1406                     }
1407                     // Make room for this index in the data structure
1408                     if (tabnr >= *ncount)
1409                     {
1410                         srenew(*count, tabnr+1);
1411                         for (j = *ncount; j < tabnr+1; j++)
1412                         {
1413                             (*count)[j] = 0;
1414                         }
1415                         *ncount = tabnr+1;
1416                     }
1417                     // Record that this table index is used and must have a valid file
1418                     (*count)[tabnr]++;
1419                 }
1420             }
1421         }
1422     }
1423 }
1424
1425 /*!\brief If there's bonded interactions of flavour \c tabext and type
1426  * \c ftype1 or \c ftype2 present in the topology, seek them in the
1427  * list of filenames passed to mdrun, and make bonded tables from
1428  * those files.
1429  *
1430  * \c ftype1 or \c ftype2 may be set to -1 to disable seeking for a
1431  * valid type with that parameter.
1432  *
1433  * A fatal error occurs if no matching filename is found.
1434  */
1435 static bondedtable_t *make_bonded_tables(FILE *fplog,
1436                                          int ftype1, int ftype2,
1437                                          const gmx_mtop_t *mtop,
1438                                          const t_filenm *tabbfnm,
1439                                          const char *tabext)
1440 {
1441     int            ncount, *count;
1442     bondedtable_t *tab;
1443
1444     tab = nullptr;
1445
1446     ncount = 0;
1447     count  = nullptr;
1448     count_tables(ftype1, ftype2, mtop, &ncount, &count);
1449
1450     // Are there any relevant tabulated bond interactions?
1451     if (ncount > 0)
1452     {
1453         snew(tab, ncount);
1454         for (int i = 0; i < ncount; i++)
1455         {
1456             // Do any interactions exist that requires this table?
1457             if (count[i] > 0)
1458             {
1459                 // This pattern enforces the current requirement that
1460                 // table filenames end in a characteristic sequence
1461                 // before the file type extension, and avoids table 13
1462                 // being recognized and used for table 1.
1463                 std::string patternToFind = gmx::formatString("_%s%d.%s", tabext, i, ftp2ext(efXVG));
1464                 bool        madeTable     = false;
1465                 for (int j = 0; j < tabbfnm->nfiles && !madeTable; ++j)
1466                 {
1467                     std::string filename(tabbfnm->fns[j]);
1468                     if (gmx::endsWith(filename, patternToFind))
1469                     {
1470                         // Finally read the table from the file found
1471                         tab[i]    = make_bonded_table(fplog, tabbfnm->fns[j], NRAL(ftype1)-2);
1472                         madeTable = true;
1473                     }
1474                 }
1475                 if (!madeTable)
1476                 {
1477                     bool isPlural = (ftype2 != -1);
1478                     gmx_fatal(FARGS, "Tabulated interaction of type '%s%s%s' with index %d cannot be used because no table file whose name matched '%s' was passed via the gmx mdrun -tableb command-line option.",
1479                               interaction_function[ftype1].longname,
1480                               isPlural ? "' or '" : "",
1481                               isPlural ? interaction_function[ftype2].longname : "",
1482                               i,
1483                               patternToFind.c_str());
1484                 }
1485             }
1486         }
1487         sfree(count);
1488     }
1489
1490     return tab;
1491 }
1492
1493 void forcerec_set_ranges(t_forcerec *fr,
1494                          int ncg_home, int ncg_force,
1495                          int natoms_force,
1496                          int natoms_force_constr, int natoms_f_novirsum)
1497 {
1498     fr->cg0 = 0;
1499     fr->hcg = ncg_home;
1500
1501     /* fr->ncg_force is unused in the standard code,
1502      * but it can be useful for modified code dealing with charge groups.
1503      */
1504     fr->ncg_force           = ncg_force;
1505     fr->natoms_force        = natoms_force;
1506     fr->natoms_force_constr = natoms_force_constr;
1507
1508     if (fr->natoms_force_constr > fr->nalloc_force)
1509     {
1510         fr->nalloc_force = over_alloc_dd(fr->natoms_force_constr);
1511     }
1512
1513     if (fr->haveDirectVirialContributions)
1514     {
1515         fr->forceBufferForDirectVirialContributions->resize(natoms_f_novirsum);
1516     }
1517 }
1518
1519 static real cutoff_inf(real cutoff)
1520 {
1521     if (cutoff == 0)
1522     {
1523         cutoff = GMX_CUTOFF_INF;
1524     }
1525
1526     return cutoff;
1527 }
1528
1529 gmx_bool can_use_allvsall(const t_inputrec *ir, gmx_bool bPrintNote, t_commrec *cr, FILE *fp)
1530 {
1531     gmx_bool bAllvsAll;
1532
1533     bAllvsAll =
1534         (
1535             ir->rlist == 0            &&
1536             ir->rcoulomb == 0         &&
1537             ir->rvdw == 0             &&
1538             ir->ePBC == epbcNONE      &&
1539             ir->vdwtype == evdwCUT    &&
1540             ir->coulombtype == eelCUT &&
1541             ir->efep == efepNO        &&
1542             (ir->implicit_solvent == eisNO ||
1543              (ir->implicit_solvent == eisGBSA && (ir->gb_algorithm == egbSTILL ||
1544                                                   ir->gb_algorithm == egbHCT   ||
1545                                                   ir->gb_algorithm == egbOBC))) &&
1546             getenv("GMX_NO_ALLVSALL") == nullptr
1547         );
1548
1549     if (bAllvsAll && ir->opts.ngener > 1)
1550     {
1551         const char *note = "NOTE: Can not use all-vs-all force loops, because there are multiple energy monitor groups; you might get significantly higher performance when using only a single energy monitor group.\n";
1552
1553         if (bPrintNote)
1554         {
1555             if (fp != nullptr)
1556             {
1557                 fprintf(fp, "\n%s\n", note);
1558             }
1559         }
1560         bAllvsAll = FALSE;
1561     }
1562
1563     if (bAllvsAll && fp && MASTER(cr))
1564     {
1565         fprintf(fp, "\nUsing SIMD all-vs-all kernels.\n\n");
1566     }
1567
1568     return bAllvsAll;
1569 }
1570
1571
1572 gmx_bool nbnxn_simd_supported(const gmx::MDLogger &mdlog,
1573                               const t_inputrec    *ir)
1574 {
1575     if (ir->vdwtype == evdwPME && ir->ljpme_combination_rule == eljpmeLB)
1576     {
1577         /* LJ PME with LB combination rule does 7 mesh operations.
1578          * This so slow that we don't compile SIMD non-bonded kernels
1579          * for that. */
1580         GMX_LOG(mdlog.warning).asParagraph().appendText("LJ-PME with Lorentz-Berthelot is not supported with SIMD kernels, falling back to plain C kernels");
1581         return FALSE;
1582     }
1583
1584     return TRUE;
1585 }
1586
1587
1588 static void pick_nbnxn_kernel_cpu(const t_inputrec gmx_unused    *ir,
1589                                   int                            *kernel_type,
1590                                   int                            *ewald_excl,
1591                                   const gmx_hw_info_t gmx_unused &hardwareInfo)
1592 {
1593     *kernel_type = nbnxnk4x4_PlainC;
1594     *ewald_excl  = ewaldexclTable;
1595
1596 #if GMX_SIMD
1597     {
1598 #ifdef GMX_NBNXN_SIMD_4XN
1599         *kernel_type = nbnxnk4xN_SIMD_4xN;
1600 #endif
1601 #ifdef GMX_NBNXN_SIMD_2XNN
1602         *kernel_type = nbnxnk4xN_SIMD_2xNN;
1603 #endif
1604
1605 #if defined GMX_NBNXN_SIMD_2XNN && defined GMX_NBNXN_SIMD_4XN
1606         /* We need to choose if we want 2x(N+N) or 4xN kernels.
1607          * This is based on the SIMD acceleration choice and CPU information
1608          * detected at runtime.
1609          *
1610          * 4xN calculates more (zero) interactions, but has less pair-search
1611          * work and much better kernel instruction scheduling.
1612          *
1613          * Up till now we have only seen that on Intel Sandy/Ivy Bridge,
1614          * which doesn't have FMA, both the analytical and tabulated Ewald
1615          * kernels have similar pair rates for 4x8 and 2x(4+4), so we choose
1616          * 2x(4+4) because it results in significantly fewer pairs.
1617          * For RF, the raw pair rate of the 4x8 kernel is higher than 2x(4+4),
1618          * 10% with HT, 50% without HT. As we currently don't detect the actual
1619          * use of HT, use 4x8 to avoid a potential performance hit.
1620          * On Intel Haswell 4x8 is always faster.
1621          */
1622         *kernel_type = nbnxnk4xN_SIMD_4xN;
1623
1624 #if !GMX_SIMD_HAVE_FMA
1625         if (EEL_PME_EWALD(ir->coulombtype) ||
1626             EVDW_PME(ir->vdwtype))
1627         {
1628             /* We have Ewald kernels without FMA (Intel Sandy/Ivy Bridge).
1629              * There are enough instructions to make 2x(4+4) efficient.
1630              */
1631             *kernel_type = nbnxnk4xN_SIMD_2xNN;
1632         }
1633 #endif
1634         if (hardwareInfo.haveAmdZenCpu)
1635         {
1636             /* One 256-bit FMA per cycle makes 2xNN faster */
1637             *kernel_type = nbnxnk4xN_SIMD_2xNN;
1638         }
1639 #endif  /* GMX_NBNXN_SIMD_2XNN && GMX_NBNXN_SIMD_4XN */
1640
1641
1642         if (getenv("GMX_NBNXN_SIMD_4XN") != nullptr)
1643         {
1644 #ifdef GMX_NBNXN_SIMD_4XN
1645             *kernel_type = nbnxnk4xN_SIMD_4xN;
1646 #else
1647             gmx_fatal(FARGS, "SIMD 4xN kernels requested, but GROMACS has been compiled without support for these kernels");
1648 #endif
1649         }
1650         if (getenv("GMX_NBNXN_SIMD_2XNN") != nullptr)
1651         {
1652 #ifdef GMX_NBNXN_SIMD_2XNN
1653             *kernel_type = nbnxnk4xN_SIMD_2xNN;
1654 #else
1655             gmx_fatal(FARGS, "SIMD 2x(N+N) kernels requested, but GROMACS has been compiled without support for these kernels");
1656 #endif
1657         }
1658
1659         /* Analytical Ewald exclusion correction is only an option in
1660          * the SIMD kernel.
1661          * Since table lookup's don't parallelize with SIMD, analytical
1662          * will probably always be faster for a SIMD width of 8 or more.
1663          * With FMA analytical is sometimes faster for a width if 4 as well.
1664          * On BlueGene/Q, this is faster regardless of precision.
1665          * In single precision, this is faster on Bulldozer.
1666          * On Skylake table is faster in single and double. TODO: Test 5xxx series.
1667          */
1668 #if ((GMX_SIMD_REAL_WIDTH >= 8 || (GMX_SIMD_REAL_WIDTH >= 4 && GMX_SIMD_HAVE_FMA && !GMX_DOUBLE)) \
1669         && !GMX_SIMD_X86_AVX_512) || GMX_SIMD_IBM_QPX
1670         /* On AMD Zen, tabulated Ewald kernels are faster on all 4 combinations
1671          * of single or double precision and 128 or 256-bit AVX2.
1672          */
1673         if (!hardwareInfo.haveAmdZenCpu)
1674         {
1675             *ewald_excl = ewaldexclAnalytical;
1676         }
1677 #endif
1678         if (getenv("GMX_NBNXN_EWALD_TABLE") != nullptr)
1679         {
1680             *ewald_excl = ewaldexclTable;
1681         }
1682         if (getenv("GMX_NBNXN_EWALD_ANALYTICAL") != nullptr)
1683         {
1684             *ewald_excl = ewaldexclAnalytical;
1685         }
1686
1687     }
1688 #endif // GMX_SIMD
1689 }
1690
1691
1692 const char *lookup_nbnxn_kernel_name(int kernel_type)
1693 {
1694     const char *returnvalue = nullptr;
1695     switch (kernel_type)
1696     {
1697         case nbnxnkNotSet:
1698             returnvalue = "not set";
1699             break;
1700         case nbnxnk4x4_PlainC:
1701             returnvalue = "plain C";
1702             break;
1703         case nbnxnk4xN_SIMD_4xN:
1704         case nbnxnk4xN_SIMD_2xNN:
1705 #if GMX_SIMD
1706             returnvalue = "SIMD";
1707 #else  // GMX_SIMD
1708             returnvalue = "not available";
1709 #endif // GMX_SIMD
1710             break;
1711         case nbnxnk8x8x8_GPU: returnvalue    = "GPU"; break;
1712         case nbnxnk8x8x8_PlainC: returnvalue = "plain C"; break;
1713
1714         case nbnxnkNR:
1715         default:
1716             gmx_fatal(FARGS, "Illegal kernel type selected");
1717             returnvalue = nullptr;
1718             break;
1719     }
1720     return returnvalue;
1721 };
1722
1723 static void pick_nbnxn_kernel(const gmx::MDLogger &mdlog,
1724                               gmx_bool             use_simd_kernels,
1725                               const gmx_hw_info_t &hardwareInfo,
1726                               gmx_bool             bUseGPU,
1727                               EmulateGpuNonbonded  emulateGpu,
1728                               const t_inputrec    *ir,
1729                               int                 *kernel_type,
1730                               int                 *ewald_excl,
1731                               gmx_bool             bDoNonbonded)
1732 {
1733     assert(kernel_type);
1734
1735     *kernel_type = nbnxnkNotSet;
1736     *ewald_excl  = ewaldexclTable;
1737
1738     if (emulateGpu == EmulateGpuNonbonded::Yes)
1739     {
1740         *kernel_type = nbnxnk8x8x8_PlainC;
1741
1742         if (bDoNonbonded)
1743         {
1744             GMX_LOG(mdlog.warning).asParagraph().appendText("Emulating a GPU run on the CPU (slow)");
1745         }
1746     }
1747     else if (bUseGPU)
1748     {
1749         *kernel_type = nbnxnk8x8x8_GPU;
1750     }
1751
1752     if (*kernel_type == nbnxnkNotSet)
1753     {
1754         if (use_simd_kernels &&
1755             nbnxn_simd_supported(mdlog, ir))
1756         {
1757             pick_nbnxn_kernel_cpu(ir, kernel_type, ewald_excl, hardwareInfo);
1758         }
1759         else
1760         {
1761             *kernel_type = nbnxnk4x4_PlainC;
1762         }
1763     }
1764
1765     if (bDoNonbonded)
1766     {
1767         GMX_LOG(mdlog.info).asParagraph().appendTextFormatted(
1768                 "Using %s %dx%d nonbonded short-range kernels",
1769                 lookup_nbnxn_kernel_name(*kernel_type),
1770                 nbnxn_kernel_to_cluster_i_size(*kernel_type),
1771                 nbnxn_kernel_to_cluster_j_size(*kernel_type));
1772
1773         if (nbnxnk4x4_PlainC == *kernel_type ||
1774             nbnxnk8x8x8_PlainC == *kernel_type)
1775         {
1776             GMX_LOG(mdlog.warning).asParagraph().appendTextFormatted(
1777                     "WARNING: Using the slow %s kernels. This should\n"
1778                     "not happen during routine usage on supported platforms.",
1779                     lookup_nbnxn_kernel_name(*kernel_type));
1780         }
1781     }
1782 }
1783
1784 /*! \brief Print Coulomb Ewald citations and set ewald coefficients */
1785 static void initCoulombEwaldParameters(FILE *fp, const t_inputrec *ir,
1786                                        bool systemHasNetCharge,
1787                                        interaction_const_t *ic)
1788 {
1789     if (!EEL_PME_EWALD(ir->coulombtype))
1790     {
1791         return;
1792     }
1793
1794     if (fp)
1795     {
1796         fprintf(fp, "Will do PME sum in reciprocal space for electrostatic interactions.\n");
1797
1798         if (ir->coulombtype == eelP3M_AD)
1799         {
1800             please_cite(fp, "Hockney1988");
1801             please_cite(fp, "Ballenegger2012");
1802         }
1803         else
1804         {
1805             please_cite(fp, "Essmann95a");
1806         }
1807
1808         if (ir->ewald_geometry == eewg3DC)
1809         {
1810             if (fp)
1811             {
1812                 fprintf(fp, "Using the Ewald3DC correction for systems with a slab geometry%s.\n",
1813                         systemHasNetCharge ? " and net charge" : "");
1814             }
1815             please_cite(fp, "In-Chul99a");
1816             if (systemHasNetCharge)
1817             {
1818                 please_cite(fp, "Ballenegger2009");
1819             }
1820         }
1821     }
1822
1823     ic->ewaldcoeff_q = calc_ewaldcoeff_q(ir->rcoulomb, ir->ewald_rtol);
1824     if (fp)
1825     {
1826         fprintf(fp, "Using a Gaussian width (1/beta) of %g nm for Ewald\n",
1827                 1/ic->ewaldcoeff_q);
1828     }
1829
1830     if (ic->coulomb_modifier == eintmodPOTSHIFT)
1831     {
1832         GMX_RELEASE_ASSERT(ic->rcoulomb != 0, "Cutoff radius cannot be zero");
1833         ic->sh_ewald = std::erfc(ic->ewaldcoeff_q*ic->rcoulomb) / ic->rcoulomb;
1834     }
1835     else
1836     {
1837         ic->sh_ewald = 0;
1838     }
1839 }
1840
1841 /*! \brief Print Van der Waals Ewald citations and set ewald coefficients */
1842 static void initVdwEwaldParameters(FILE *fp, const t_inputrec *ir,
1843                                    interaction_const_t *ic)
1844 {
1845     if (!EVDW_PME(ir->vdwtype))
1846     {
1847         return;
1848     }
1849
1850     if (fp)
1851     {
1852         fprintf(fp, "Will do PME sum in reciprocal space for LJ dispersion interactions.\n");
1853         please_cite(fp, "Essmann95a");
1854     }
1855     ic->ewaldcoeff_lj = calc_ewaldcoeff_lj(ir->rvdw, ir->ewald_rtol_lj);
1856     if (fp)
1857     {
1858         fprintf(fp, "Using a Gaussian width (1/beta) of %g nm for LJ Ewald\n",
1859                 1/ic->ewaldcoeff_lj);
1860     }
1861
1862     if (ic->vdw_modifier == eintmodPOTSHIFT)
1863     {
1864         real crc2       = gmx::square(ic->ewaldcoeff_lj*ic->rvdw);
1865         ic->sh_lj_ewald = (std::exp(-crc2)*(1 + crc2 + 0.5*crc2*crc2) - 1)/gmx::power6(ic->rvdw);
1866     }
1867     else
1868     {
1869         ic->sh_lj_ewald = 0;
1870     }
1871 }
1872
1873 gmx_bool uses_simple_tables(int                 cutoff_scheme,
1874                             nonbonded_verlet_t *nbv,
1875                             int                 group)
1876 {
1877     gmx_bool bUsesSimpleTables = TRUE;
1878     int      grp_index;
1879
1880     switch (cutoff_scheme)
1881     {
1882         case ecutsGROUP:
1883             bUsesSimpleTables = TRUE;
1884             break;
1885         case ecutsVERLET:
1886             assert(NULL != nbv && NULL != nbv->grp);
1887             grp_index         = (group < 0) ? 0 : (nbv->ngrp - 1);
1888             bUsesSimpleTables = nbnxn_kernel_pairlist_simple(nbv->grp[grp_index].kernel_type);
1889             break;
1890         default:
1891             gmx_incons("unimplemented");
1892     }
1893     return bUsesSimpleTables;
1894 }
1895
1896 static void init_ewald_f_table(interaction_const_t *ic,
1897                                real                 rtab)
1898 {
1899     real maxr;
1900
1901     /* Get the Ewald table spacing based on Coulomb and/or LJ
1902      * Ewald coefficients and rtol.
1903      */
1904     ic->tabq_scale = ewald_spline3_table_scale(ic);
1905
1906     if (ic->cutoff_scheme == ecutsVERLET)
1907     {
1908         maxr = ic->rcoulomb;
1909     }
1910     else
1911     {
1912         maxr = std::max(ic->rcoulomb, rtab);
1913     }
1914     ic->tabq_size  = static_cast<int>(maxr*ic->tabq_scale) + 2;
1915
1916     sfree_aligned(ic->tabq_coul_FDV0);
1917     sfree_aligned(ic->tabq_coul_F);
1918     sfree_aligned(ic->tabq_coul_V);
1919
1920     sfree_aligned(ic->tabq_vdw_FDV0);
1921     sfree_aligned(ic->tabq_vdw_F);
1922     sfree_aligned(ic->tabq_vdw_V);
1923
1924     if (EEL_PME_EWALD(ic->eeltype))
1925     {
1926         /* Create the original table data in FDV0 */
1927         snew_aligned(ic->tabq_coul_FDV0, ic->tabq_size*4, 32);
1928         snew_aligned(ic->tabq_coul_F, ic->tabq_size, 32);
1929         snew_aligned(ic->tabq_coul_V, ic->tabq_size, 32);
1930         table_spline3_fill_ewald_lr(ic->tabq_coul_F, ic->tabq_coul_V, ic->tabq_coul_FDV0,
1931                                     ic->tabq_size, 1/ic->tabq_scale, ic->ewaldcoeff_q, v_q_ewald_lr);
1932     }
1933
1934     if (EVDW_PME(ic->vdwtype))
1935     {
1936         snew_aligned(ic->tabq_vdw_FDV0, ic->tabq_size*4, 32);
1937         snew_aligned(ic->tabq_vdw_F, ic->tabq_size, 32);
1938         snew_aligned(ic->tabq_vdw_V, ic->tabq_size, 32);
1939         table_spline3_fill_ewald_lr(ic->tabq_vdw_F, ic->tabq_vdw_V, ic->tabq_vdw_FDV0,
1940                                     ic->tabq_size, 1/ic->tabq_scale, ic->ewaldcoeff_lj, v_lj_ewald_lr);
1941     }
1942 }
1943
1944 void init_interaction_const_tables(FILE                *fp,
1945                                    interaction_const_t *ic,
1946                                    real                 rtab)
1947 {
1948     if (EEL_PME_EWALD(ic->eeltype) || EVDW_PME(ic->vdwtype))
1949     {
1950         init_ewald_f_table(ic, rtab);
1951
1952         if (fp != nullptr)
1953         {
1954             fprintf(fp, "Initialized non-bonded Ewald correction tables, spacing: %.2e size: %d\n\n",
1955                     1/ic->tabq_scale, ic->tabq_size);
1956         }
1957     }
1958 }
1959
1960 static void clear_force_switch_constants(shift_consts_t *sc)
1961 {
1962     sc->c2   = 0;
1963     sc->c3   = 0;
1964     sc->cpot = 0;
1965 }
1966
1967 static void force_switch_constants(real p,
1968                                    real rsw, real rc,
1969                                    shift_consts_t *sc)
1970 {
1971     /* Here we determine the coefficient for shifting the force to zero
1972      * between distance rsw and the cut-off rc.
1973      * For a potential of r^-p, we have force p*r^-(p+1).
1974      * But to save flops we absorb p in the coefficient.
1975      * Thus we get:
1976      * force/p   = r^-(p+1) + c2*r^2 + c3*r^3
1977      * potential = r^-p + c2/3*r^3 + c3/4*r^4 + cpot
1978      */
1979     sc->c2   =  ((p + 1)*rsw - (p + 4)*rc)/(pow(rc, p + 2)*gmx::square(rc - rsw));
1980     sc->c3   = -((p + 1)*rsw - (p + 3)*rc)/(pow(rc, p + 2)*gmx::power3(rc - rsw));
1981     sc->cpot = -pow(rc, -p) + p*sc->c2/3*gmx::power3(rc - rsw) + p*sc->c3/4*gmx::power4(rc - rsw);
1982 }
1983
1984 static void potential_switch_constants(real rsw, real rc,
1985                                        switch_consts_t *sc)
1986 {
1987     /* The switch function is 1 at rsw and 0 at rc.
1988      * The derivative and second derivate are zero at both ends.
1989      * rsw        = max(r - r_switch, 0)
1990      * sw         = 1 + c3*rsw^3 + c4*rsw^4 + c5*rsw^5
1991      * dsw        = 3*c3*rsw^2 + 4*c4*rsw^3 + 5*c5*rsw^4
1992      * force      = force*dsw - potential*sw
1993      * potential *= sw
1994      */
1995     sc->c3 = -10/gmx::power3(rc - rsw);
1996     sc->c4 =  15/gmx::power4(rc - rsw);
1997     sc->c5 =  -6/gmx::power5(rc - rsw);
1998 }
1999
2000 /*! \brief Construct interaction constants
2001  *
2002  * This data is used (particularly) by search and force code for
2003  * short-range interactions. Many of these are constant for the whole
2004  * simulation; some are constant only after PME tuning completes.
2005  */
2006 static void
2007 init_interaction_const(FILE                       *fp,
2008                        interaction_const_t       **interaction_const,
2009                        const t_inputrec           *ir,
2010                        const gmx_mtop_t           *mtop,
2011                        bool                        systemHasNetCharge)
2012 {
2013     interaction_const_t *ic;
2014
2015     snew(ic, 1);
2016
2017     ic->cutoff_scheme   = ir->cutoff_scheme;
2018
2019     /* Just allocate something so we can free it */
2020     snew_aligned(ic->tabq_coul_FDV0, 16, 32);
2021     snew_aligned(ic->tabq_coul_F, 16, 32);
2022     snew_aligned(ic->tabq_coul_V, 16, 32);
2023
2024     /* Lennard-Jones */
2025     ic->vdwtype         = ir->vdwtype;
2026     ic->vdw_modifier    = ir->vdw_modifier;
2027     ic->reppow          = mtop->ffparams.reppow;
2028     ic->rvdw            = cutoff_inf(ir->rvdw);
2029     ic->rvdw_switch     = ir->rvdw_switch;
2030     ic->ljpme_comb_rule = ir->ljpme_combination_rule;
2031     ic->useBuckingham   = (mtop->ffparams.functype[0] == F_BHAM);
2032     if (ic->useBuckingham)
2033     {
2034         ic->buckinghamBMax = calcBuckinghamBMax(fp, mtop);
2035     }
2036
2037     initVdwEwaldParameters(fp, ir, ic);
2038
2039     clear_force_switch_constants(&ic->dispersion_shift);
2040     clear_force_switch_constants(&ic->repulsion_shift);
2041
2042     switch (ic->vdw_modifier)
2043     {
2044         case eintmodPOTSHIFT:
2045             /* Only shift the potential, don't touch the force */
2046             ic->dispersion_shift.cpot = -1.0/gmx::power6(ic->rvdw);
2047             ic->repulsion_shift.cpot  = -1.0/gmx::power12(ic->rvdw);
2048             break;
2049         case eintmodFORCESWITCH:
2050             /* Switch the force, switch and shift the potential */
2051             force_switch_constants(6.0, ic->rvdw_switch, ic->rvdw,
2052                                    &ic->dispersion_shift);
2053             force_switch_constants(12.0, ic->rvdw_switch, ic->rvdw,
2054                                    &ic->repulsion_shift);
2055             break;
2056         case eintmodPOTSWITCH:
2057             /* Switch the potential and force */
2058             potential_switch_constants(ic->rvdw_switch, ic->rvdw,
2059                                        &ic->vdw_switch);
2060             break;
2061         case eintmodNONE:
2062         case eintmodEXACTCUTOFF:
2063             /* Nothing to do here */
2064             break;
2065         default:
2066             gmx_incons("unimplemented potential modifier");
2067     }
2068
2069     ic->sh_invrc6 = -ic->dispersion_shift.cpot;
2070
2071     /* Electrostatics */
2072     ic->eeltype          = ir->coulombtype;
2073     ic->coulomb_modifier = ir->coulomb_modifier;
2074     ic->rcoulomb         = cutoff_inf(ir->rcoulomb);
2075     ic->rcoulomb_switch  = ir->rcoulomb_switch;
2076     ic->epsilon_r        = ir->epsilon_r;
2077
2078     /* Set the Coulomb energy conversion factor */
2079     if (ic->epsilon_r != 0)
2080     {
2081         ic->epsfac = ONE_4PI_EPS0/ic->epsilon_r;
2082     }
2083     else
2084     {
2085         /* eps = 0 is infinite dieletric: no Coulomb interactions */
2086         ic->epsfac = 0;
2087     }
2088
2089     /* Reaction-field */
2090     if (EEL_RF(ic->eeltype))
2091     {
2092         ic->epsilon_rf = ir->epsilon_rf;
2093         /* Generalized reaction field parameters are updated every step */
2094         if (ic->eeltype != eelGRF)
2095         {
2096             calc_rffac(fp, ic->eeltype, ic->epsilon_r, ic->epsilon_rf,
2097                        ic->rcoulomb, 0, 0, NULL,
2098                        &ic->k_rf, &ic->c_rf);
2099         }
2100
2101         if (ir->cutoff_scheme == ecutsGROUP && ic->eeltype == eelRF_ZERO)
2102         {
2103             /* grompp should have done this, but this scheme is obsolete */
2104             ic->coulomb_modifier = eintmodEXACTCUTOFF;
2105         }
2106     }
2107     else
2108     {
2109         /* For plain cut-off we might use the reaction-field kernels */
2110         ic->epsilon_rf = ic->epsilon_r;
2111         ic->k_rf       = 0;
2112         if (ir->coulomb_modifier == eintmodPOTSHIFT)
2113         {
2114             ic->c_rf   = 1/ic->rcoulomb;
2115         }
2116         else
2117         {
2118             ic->c_rf   = 0;
2119         }
2120     }
2121
2122     initCoulombEwaldParameters(fp, ir, systemHasNetCharge, ic);
2123
2124     if (fp != nullptr)
2125     {
2126         real dispersion_shift;
2127
2128         dispersion_shift = ic->dispersion_shift.cpot;
2129         if (EVDW_PME(ic->vdwtype))
2130         {
2131             dispersion_shift -= ic->sh_lj_ewald;
2132         }
2133         fprintf(fp, "Potential shift: LJ r^-12: %.3e r^-6: %.3e",
2134                 ic->repulsion_shift.cpot, dispersion_shift);
2135
2136         if (ic->eeltype == eelCUT)
2137         {
2138             fprintf(fp, ", Coulomb %.e", -ic->c_rf);
2139         }
2140         else if (EEL_PME(ic->eeltype))
2141         {
2142             fprintf(fp, ", Ewald %.3e", -ic->sh_ewald);
2143         }
2144         fprintf(fp, "\n");
2145     }
2146
2147     *interaction_const = ic;
2148 }
2149
2150 static void init_nb_verlet(const gmx::MDLogger     &mdlog,
2151                            nonbonded_verlet_t     **nb_verlet,
2152                            gmx_bool                 bFEP_NonBonded,
2153                            const t_inputrec        *ir,
2154                            const t_forcerec        *fr,
2155                            const t_commrec         *cr,
2156                            const gmx_hw_info_t     &hardwareInfo,
2157                            const gmx_device_info_t *deviceInfo,
2158                            const gmx_mtop_t        *mtop,
2159                            matrix                   box)
2160 {
2161     nonbonded_verlet_t *nbv;
2162     char               *env;
2163
2164     nbnxn_alloc_t      *nb_alloc;
2165     nbnxn_free_t       *nb_free;
2166
2167     nbv = new nonbonded_verlet_t();
2168
2169     nbv->emulateGpu = ((getenv("GMX_EMULATE_GPU") != nullptr) ? EmulateGpuNonbonded::Yes : EmulateGpuNonbonded::No);
2170     nbv->bUseGPU    = deviceInfo != nullptr;
2171
2172     GMX_RELEASE_ASSERT(!(nbv->emulateGpu == EmulateGpuNonbonded::Yes && nbv->bUseGPU), "When GPU emulation is active, there cannot be a GPU assignment");
2173
2174     nbv->nbs             = nullptr;
2175     nbv->min_ci_balanced = 0;
2176
2177     nbv->ngrp = (DOMAINDECOMP(cr) ? 2 : 1);
2178     for (int i = 0; i < nbv->ngrp; i++)
2179     {
2180         nbv->grp[i].nbl_lists.nnbl = 0;
2181         nbv->grp[i].kernel_type    = nbnxnkNotSet;
2182
2183         if (i == 0) /* local */
2184         {
2185             pick_nbnxn_kernel(mdlog, fr->use_simd_kernels, hardwareInfo,
2186                               nbv->bUseGPU, nbv->emulateGpu, ir,
2187                               &nbv->grp[i].kernel_type,
2188                               &nbv->grp[i].ewald_excl,
2189                               fr->bNonbonded);
2190         }
2191         else /* non-local */
2192         {
2193             /* Use the same kernel for local and non-local interactions */
2194             nbv->grp[i].kernel_type = nbv->grp[0].kernel_type;
2195             nbv->grp[i].ewald_excl  = nbv->grp[0].ewald_excl;
2196         }
2197     }
2198
2199     nbv->listParams = std::unique_ptr<NbnxnListParameters>(new NbnxnListParameters(ir->rlist));
2200     setupDynamicPairlistPruning(mdlog, ir, mtop, box, nbv->grp[0].kernel_type, fr->ic,
2201                                 nbv->listParams.get());
2202
2203     nbnxn_init_search(&nbv->nbs,
2204                       DOMAINDECOMP(cr) ? &cr->dd->nc : nullptr,
2205                       DOMAINDECOMP(cr) ? domdec_zones(cr->dd) : nullptr,
2206                       bFEP_NonBonded,
2207                       gmx_omp_nthreads_get(emntPairsearch));
2208
2209     gpu_set_host_malloc_and_free(nbv->grp[0].kernel_type == nbnxnk8x8x8_GPU,
2210                                  &nb_alloc, &nb_free);
2211
2212     for (int i = 0; i < nbv->ngrp; i++)
2213     {
2214         nbnxn_init_pairlist_set(&nbv->grp[i].nbl_lists,
2215                                 nbnxn_kernel_pairlist_simple(nbv->grp[i].kernel_type),
2216                                 /* 8x8x8 "non-simple" lists are ATM always combined */
2217                                 !nbnxn_kernel_pairlist_simple(nbv->grp[i].kernel_type),
2218                                 nb_alloc, nb_free);
2219     }
2220
2221     int      enbnxninitcombrule;
2222     if (fr->ic->vdwtype == evdwCUT &&
2223         (fr->ic->vdw_modifier == eintmodNONE ||
2224          fr->ic->vdw_modifier == eintmodPOTSHIFT) &&
2225         getenv("GMX_NO_LJ_COMB_RULE") == nullptr)
2226     {
2227         /* Plain LJ cut-off: we can optimize with combination rules */
2228         enbnxninitcombrule = enbnxninitcombruleDETECT;
2229     }
2230     else if (fr->ic->vdwtype == evdwPME)
2231     {
2232         /* LJ-PME: we need to use a combination rule for the grid */
2233         if (fr->ljpme_combination_rule == eljpmeGEOM)
2234         {
2235             enbnxninitcombrule = enbnxninitcombruleGEOM;
2236         }
2237         else
2238         {
2239             enbnxninitcombrule = enbnxninitcombruleLB;
2240         }
2241     }
2242     else
2243     {
2244         /* We use a full combination matrix: no rule required */
2245         enbnxninitcombrule = enbnxninitcombruleNONE;
2246     }
2247
2248     snew(nbv->nbat, 1);
2249     bool bSimpleList = nbnxn_kernel_pairlist_simple(nbv->grp[0].kernel_type);
2250     nbnxn_atomdata_init(mdlog,
2251                         nbv->nbat,
2252                         nbv->grp[0].kernel_type,
2253                         enbnxninitcombrule,
2254                         fr->ntype, fr->nbfp,
2255                         ir->opts.ngener,
2256                         bSimpleList ? gmx_omp_nthreads_get(emntNonbonded) : 1,
2257                         nb_alloc, nb_free);
2258
2259     if (nbv->bUseGPU)
2260     {
2261         /* init the NxN GPU data; the last argument tells whether we'll have
2262          * both local and non-local NB calculation on GPU */
2263         nbnxn_gpu_init(&nbv->gpu_nbv,
2264                        deviceInfo,
2265                        fr->ic,
2266                        nbv->listParams.get(),
2267                        nbv->nbat,
2268                        cr->nodeid,
2269                        (nbv->ngrp > 1));
2270
2271         /* With tMPI + GPUs some ranks may be sharing GPU(s) and therefore
2272          * also sharing texture references. To keep the code simple, we don't
2273          * treat texture references as shared resources, but this means that
2274          * the coulomb_tab and nbfp texture refs will get updated by multiple threads.
2275          * Hence, to ensure that the non-bonded kernels don't start before all
2276          * texture binding operations are finished, we need to wait for all ranks
2277          * to arrive here before continuing.
2278          *
2279          * Note that we could omit this barrier if GPUs are not shared (or
2280          * texture objects are used), but as this is initialization code, there
2281          * is no point in complicating things.
2282          */
2283 #if GMX_THREAD_MPI
2284         if (PAR(cr))
2285         {
2286             gmx_barrier(cr);
2287         }
2288 #endif  /* GMX_THREAD_MPI */
2289
2290         if ((env = getenv("GMX_NB_MIN_CI")) != nullptr)
2291         {
2292             char *end;
2293
2294             nbv->min_ci_balanced = strtol(env, &end, 10);
2295             if (!end || (*end != 0) || nbv->min_ci_balanced < 0)
2296             {
2297                 gmx_fatal(FARGS, "Invalid value passed in GMX_NB_MIN_CI=%s, non-negative integer required", env);
2298             }
2299
2300             if (debug)
2301             {
2302                 fprintf(debug, "Neighbor-list balancing parameter: %d (passed as env. var.)\n",
2303                         nbv->min_ci_balanced);
2304             }
2305         }
2306         else
2307         {
2308             nbv->min_ci_balanced = nbnxn_gpu_min_ci_balanced(nbv->gpu_nbv);
2309             if (debug)
2310             {
2311                 fprintf(debug, "Neighbor-list balancing parameter: %d (auto-adjusted to the number of GPU multi-processors)\n",
2312                         nbv->min_ci_balanced);
2313             }
2314         }
2315
2316     }
2317
2318     *nb_verlet = nbv;
2319 }
2320
2321 gmx_bool usingGpu(nonbonded_verlet_t *nbv)
2322 {
2323     return nbv != nullptr && nbv->bUseGPU;
2324 }
2325
2326 void init_forcerec(FILE                    *fp,
2327                    const gmx::MDLogger     &mdlog,
2328                    t_forcerec              *fr,
2329                    t_fcdata                *fcd,
2330                    const t_inputrec        *ir,
2331                    const gmx_mtop_t        *mtop,
2332                    const t_commrec         *cr,
2333                    matrix                   box,
2334                    const char              *tabfn,
2335                    const char              *tabpfn,
2336                    const t_filenm          *tabbfnm,
2337                    const gmx_hw_info_t     &hardwareInfo,
2338                    const gmx_device_info_t *deviceInfo,
2339                    gmx_bool                 bNoSolvOpt,
2340                    real                     print_force)
2341 {
2342     int            i, m, negp_pp, negptable, egi, egj;
2343     real           rtab;
2344     char          *env;
2345     double         dbl;
2346     const t_block *cgs;
2347     gmx_bool       bGenericKernelOnly;
2348     gmx_bool       needGroupSchemeTables, bSomeNormalNbListsAreInUse;
2349     gmx_bool       bFEP_NonBonded;
2350     int           *nm_ind, egp_flags;
2351
2352     /* By default we turn SIMD kernels on, but it might be turned off further down... */
2353     fr->use_simd_kernels = TRUE;
2354
2355     fr->bDomDec = DOMAINDECOMP(cr);
2356
2357     if (check_box(ir->ePBC, box))
2358     {
2359         gmx_fatal(FARGS, check_box(ir->ePBC, box));
2360     }
2361
2362     /* Test particle insertion ? */
2363     if (EI_TPI(ir->eI))
2364     {
2365         /* Set to the size of the molecule to be inserted (the last one) */
2366         /* Because of old style topologies, we have to use the last cg
2367          * instead of the last molecule type.
2368          */
2369         cgs       = &mtop->moltype[mtop->molblock[mtop->nmolblock-1].type].cgs;
2370         fr->n_tpi = cgs->index[cgs->nr] - cgs->index[cgs->nr-1];
2371         if (fr->n_tpi != mtop->mols.index[mtop->mols.nr] - mtop->mols.index[mtop->mols.nr-1])
2372         {
2373             gmx_fatal(FARGS, "The molecule to insert can not consist of multiple charge groups.\nMake it a single charge group.");
2374         }
2375     }
2376     else
2377     {
2378         fr->n_tpi = 0;
2379     }
2380
2381     if (ir->coulombtype == eelRF_NEC_UNSUPPORTED)
2382     {
2383         gmx_fatal(FARGS, "%s electrostatics is no longer supported",
2384                   eel_names[ir->coulombtype]);
2385     }
2386
2387     if (ir->bAdress)
2388     {
2389         gmx_fatal(FARGS, "AdResS simulations are no longer supported");
2390     }
2391     if (ir->useTwinRange)
2392     {
2393         gmx_fatal(FARGS, "Twin-range simulations are no longer supported");
2394     }
2395     /* Copy the user determined parameters */
2396     fr->userint1  = ir->userint1;
2397     fr->userint2  = ir->userint2;
2398     fr->userint3  = ir->userint3;
2399     fr->userint4  = ir->userint4;
2400     fr->userreal1 = ir->userreal1;
2401     fr->userreal2 = ir->userreal2;
2402     fr->userreal3 = ir->userreal3;
2403     fr->userreal4 = ir->userreal4;
2404
2405     /* Shell stuff */
2406     fr->fc_stepsize = ir->fc_stepsize;
2407
2408     /* Free energy */
2409     fr->efep        = ir->efep;
2410     fr->sc_alphavdw = ir->fepvals->sc_alpha;
2411     if (ir->fepvals->bScCoul)
2412     {
2413         fr->sc_alphacoul  = ir->fepvals->sc_alpha;
2414         fr->sc_sigma6_min = gmx::power6(ir->fepvals->sc_sigma_min);
2415     }
2416     else
2417     {
2418         fr->sc_alphacoul  = 0;
2419         fr->sc_sigma6_min = 0; /* only needed when bScCoul is on */
2420     }
2421     fr->sc_power      = ir->fepvals->sc_power;
2422     fr->sc_r_power    = ir->fepvals->sc_r_power;
2423     fr->sc_sigma6_def = gmx::power6(ir->fepvals->sc_sigma);
2424
2425     env = getenv("GMX_SCSIGMA_MIN");
2426     if (env != nullptr)
2427     {
2428         dbl = 0;
2429         sscanf(env, "%20lf", &dbl);
2430         fr->sc_sigma6_min = gmx::power6(dbl);
2431         if (fp)
2432         {
2433             fprintf(fp, "Setting the minimum soft core sigma to %g nm\n", dbl);
2434         }
2435     }
2436
2437     fr->bNonbonded = TRUE;
2438     if (getenv("GMX_NO_NONBONDED") != nullptr)
2439     {
2440         /* turn off non-bonded calculations */
2441         fr->bNonbonded = FALSE;
2442         GMX_LOG(mdlog.warning).asParagraph().appendText(
2443                 "Found environment variable GMX_NO_NONBONDED.\n"
2444                 "Disabling nonbonded calculations.");
2445     }
2446
2447     bGenericKernelOnly = FALSE;
2448
2449     /* We now check in the NS code whether a particular combination of interactions
2450      * can be used with water optimization, and disable it if that is not the case.
2451      */
2452
2453     if (getenv("GMX_NB_GENERIC") != nullptr)
2454     {
2455         if (fp != nullptr)
2456         {
2457             fprintf(fp,
2458                     "Found environment variable GMX_NB_GENERIC.\n"
2459                     "Disabling all interaction-specific nonbonded kernels, will only\n"
2460                     "use the slow generic ones in src/gmxlib/nonbonded/nb_generic.c\n\n");
2461         }
2462         bGenericKernelOnly = TRUE;
2463     }
2464
2465     if (bGenericKernelOnly == TRUE)
2466     {
2467         bNoSolvOpt         = TRUE;
2468     }
2469
2470     if ( (getenv("GMX_DISABLE_SIMD_KERNELS") != nullptr) || (getenv("GMX_NOOPTIMIZEDKERNELS") != nullptr) )
2471     {
2472         fr->use_simd_kernels = FALSE;
2473         if (fp != nullptr)
2474         {
2475             fprintf(fp,
2476                     "\nFound environment variable GMX_DISABLE_SIMD_KERNELS.\n"
2477                     "Disabling the usage of any SIMD-specific non-bonded & bonded kernel routines\n"
2478                     "(e.g. SSE2/SSE4.1/AVX).\n\n");
2479         }
2480     }
2481
2482     fr->bBHAM = (mtop->ffparams.functype[0] == F_BHAM);
2483
2484     /* Check if we can/should do all-vs-all kernels */
2485     fr->bAllvsAll       = can_use_allvsall(ir, FALSE, nullptr, nullptr);
2486     fr->AllvsAll_work   = nullptr;
2487     fr->AllvsAll_workgb = nullptr;
2488
2489     /* All-vs-all kernels have not been implemented in 4.6 and later.
2490      * See Redmine #1249. */
2491     if (fr->bAllvsAll)
2492     {
2493         fr->bAllvsAll            = FALSE;
2494         if (fp != nullptr)
2495         {
2496             fprintf(fp,
2497                     "\nYour simulation settings would have triggered the efficient all-vs-all\n"
2498                     "kernels in GROMACS 4.5, but these have not been implemented in GROMACS\n"
2499                     "4.6 and 5.x. If performance is important, please use GROMACS 4.5.7\n"
2500                     "or try cutoff-scheme = Verlet.\n\n");
2501         }
2502     }
2503
2504     /* Neighbour searching stuff */
2505     fr->cutoff_scheme = ir->cutoff_scheme;
2506     fr->bGrid         = (ir->ns_type == ensGRID);
2507     fr->ePBC          = ir->ePBC;
2508
2509     if (fr->cutoff_scheme == ecutsGROUP)
2510     {
2511         const char *note = "NOTE: This file uses the deprecated 'group' cutoff_scheme. This will be\n"
2512             "removed in a future release when 'verlet' supports all interaction forms.\n";
2513
2514         if (MASTER(cr))
2515         {
2516             fprintf(stderr, "\n%s\n", note);
2517         }
2518         if (fp != nullptr)
2519         {
2520             fprintf(fp, "\n%s\n", note);
2521         }
2522
2523         if (GMX_TARGET_BGQ)
2524         {
2525             GMX_LOG(mdlog.warning).asParagraph()
2526                 .appendText("There is no SIMD implementation of the group scheme kernels on "
2527                             "BlueGene/Q. You will observe better performance from using the "
2528                             "Verlet cut-off scheme.");
2529         }
2530     }
2531
2532     /* Determine if we will do PBC for distances in bonded interactions */
2533     if (fr->ePBC == epbcNONE)
2534     {
2535         fr->bMolPBC = FALSE;
2536     }
2537     else
2538     {
2539         if (!DOMAINDECOMP(cr))
2540         {
2541             gmx_bool bSHAKE;
2542
2543             bSHAKE = (ir->eConstrAlg == econtSHAKE &&
2544                       (gmx_mtop_ftype_count(mtop, F_CONSTR) > 0 ||
2545                        gmx_mtop_ftype_count(mtop, F_CONSTRNC) > 0));
2546
2547             /* The group cut-off scheme and SHAKE assume charge groups
2548              * are whole, but not using molpbc is faster in most cases.
2549              * With intermolecular interactions we need PBC for calculating
2550              * distances between atoms in different molecules.
2551              */
2552             if ((fr->cutoff_scheme == ecutsGROUP || bSHAKE) &&
2553                 !mtop->bIntermolecularInteractions)
2554             {
2555                 fr->bMolPBC = ir->bPeriodicMols;
2556
2557                 if (bSHAKE && fr->bMolPBC)
2558                 {
2559                     gmx_fatal(FARGS, "SHAKE is not supported with periodic molecules");
2560                 }
2561             }
2562             else
2563             {
2564                 /* Not making molecules whole is faster in most cases,
2565                  * but With orientation restraints we need whole molecules.
2566                  */
2567                 fr->bMolPBC = (fcd->orires.nr == 0);
2568
2569                 if (getenv("GMX_USE_GRAPH") != nullptr)
2570                 {
2571                     fr->bMolPBC = FALSE;
2572                     if (fp)
2573                     {
2574                         GMX_LOG(mdlog.warning).asParagraph().appendText("GMX_USE_GRAPH is set, using the graph for bonded interactions");
2575                     }
2576
2577                     if (mtop->bIntermolecularInteractions)
2578                     {
2579                         GMX_LOG(mdlog.warning).asParagraph().appendText("WARNING: Molecules linked by intermolecular interactions have to reside in the same periodic image, otherwise artifacts will occur!");
2580                     }
2581                 }
2582
2583                 GMX_RELEASE_ASSERT(fr->bMolPBC || !mtop->bIntermolecularInteractions, "We need to use PBC within molecules with inter-molecular interactions");
2584
2585                 if (bSHAKE && fr->bMolPBC)
2586                 {
2587                     gmx_fatal(FARGS, "SHAKE is not properly supported with intermolecular interactions. For short simulations where linked molecules remain in the same periodic image, the environment variable GMX_USE_GRAPH can be used to override this check.\n");
2588                 }
2589             }
2590         }
2591         else
2592         {
2593             fr->bMolPBC = dd_bonded_molpbc(cr->dd, fr->ePBC);
2594         }
2595     }
2596     fr->bGB = (ir->implicit_solvent == eisGBSA);
2597
2598     fr->rc_scaling = ir->refcoord_scaling;
2599     copy_rvec(ir->posres_com, fr->posres_com);
2600     copy_rvec(ir->posres_comB, fr->posres_comB);
2601     fr->rlist                    = cutoff_inf(ir->rlist);
2602     fr->ljpme_combination_rule   = ir->ljpme_combination_rule;
2603
2604     /* This now calculates sum for q and c6*/
2605     bool systemHasNetCharge = set_chargesum(fp, fr, mtop);
2606
2607     /* fr->ic is used both by verlet and group kernels (to some extent) now */
2608     init_interaction_const(fp, &fr->ic, ir, mtop, systemHasNetCharge);
2609     init_interaction_const_tables(fp, fr->ic, ir->rlist + ir->tabext);
2610
2611     const interaction_const_t *ic = fr->ic;
2612
2613     /* TODO: Replace this Ewald table or move it into interaction_const_t */
2614     if (ir->coulombtype == eelEWALD)
2615     {
2616         init_ewald_tab(&(fr->ewald_table), ir, fp);
2617     }
2618
2619     /* Electrostatics: Translate from interaction-setting-in-mdp-file to kernel interaction format */
2620     switch (ic->eeltype)
2621     {
2622         case eelCUT:
2623             fr->nbkernel_elec_interaction = (fr->bGB) ? GMX_NBKERNEL_ELEC_GENERALIZEDBORN : GMX_NBKERNEL_ELEC_COULOMB;
2624             break;
2625
2626         case eelRF:
2627         case eelGRF:
2628             fr->nbkernel_elec_interaction = GMX_NBKERNEL_ELEC_REACTIONFIELD;
2629             break;
2630
2631         case eelRF_ZERO:
2632             fr->nbkernel_elec_interaction = GMX_NBKERNEL_ELEC_REACTIONFIELD;
2633             GMX_RELEASE_ASSERT(ic->coulomb_modifier == eintmodEXACTCUTOFF, "With the group scheme RF-zero needs the exact cut-off modifier");
2634             break;
2635
2636         case eelSWITCH:
2637         case eelSHIFT:
2638         case eelUSER:
2639         case eelENCADSHIFT:
2640         case eelPMESWITCH:
2641         case eelPMEUSER:
2642         case eelPMEUSERSWITCH:
2643             fr->nbkernel_elec_interaction = GMX_NBKERNEL_ELEC_CUBICSPLINETABLE;
2644             break;
2645
2646         case eelPME:
2647         case eelP3M_AD:
2648         case eelEWALD:
2649             fr->nbkernel_elec_interaction = GMX_NBKERNEL_ELEC_EWALD;
2650             break;
2651
2652         default:
2653             gmx_fatal(FARGS, "Unsupported electrostatic interaction: %s", eel_names[ic->eeltype]);
2654             break;
2655     }
2656
2657     /* Vdw: Translate from mdp settings to kernel format */
2658     switch (ic->vdwtype)
2659     {
2660         case evdwCUT:
2661             if (fr->bBHAM)
2662             {
2663                 fr->nbkernel_vdw_interaction = GMX_NBKERNEL_VDW_BUCKINGHAM;
2664             }
2665             else
2666             {
2667                 fr->nbkernel_vdw_interaction = GMX_NBKERNEL_VDW_LENNARDJONES;
2668             }
2669             break;
2670         case evdwPME:
2671             fr->nbkernel_vdw_interaction = GMX_NBKERNEL_VDW_LJEWALD;
2672             break;
2673
2674         case evdwSWITCH:
2675         case evdwSHIFT:
2676         case evdwUSER:
2677         case evdwENCADSHIFT:
2678             fr->nbkernel_vdw_interaction = GMX_NBKERNEL_VDW_CUBICSPLINETABLE;
2679             break;
2680
2681         default:
2682             gmx_fatal(FARGS, "Unsupported vdw interaction: %s", evdw_names[ic->vdwtype]);
2683             break;
2684     }
2685
2686     if (ir->cutoff_scheme == ecutsGROUP)
2687     {
2688         fr->bvdwtab    = ((ic->vdwtype != evdwCUT || !gmx_within_tol(ic->reppow, 12.0, 10*GMX_DOUBLE_EPS))
2689                           && !EVDW_PME(ic->vdwtype));
2690         /* We have special kernels for standard Ewald and PME, but the pme-switch ones are tabulated above */
2691         fr->bcoultab   = !(ic->eeltype == eelCUT ||
2692                            ic->eeltype == eelEWALD ||
2693                            ic->eeltype == eelPME ||
2694                            ic->eeltype == eelP3M_AD ||
2695                            ic->eeltype == eelRF ||
2696                            ic->eeltype == eelRF_ZERO);
2697
2698         /* If the user absolutely wants different switch/shift settings for coul/vdw, it is likely
2699          * going to be faster to tabulate the interaction than calling the generic kernel.
2700          * However, if generic kernels have been requested we keep things analytically.
2701          */
2702         if (fr->nbkernel_elec_modifier == eintmodPOTSWITCH &&
2703             fr->nbkernel_vdw_modifier == eintmodPOTSWITCH &&
2704             bGenericKernelOnly == FALSE)
2705         {
2706             if ((ic->rcoulomb_switch != ic->rvdw_switch) || (ic->rcoulomb != ic->rvdw))
2707             {
2708                 fr->bcoultab = TRUE;
2709                 /* Once we tabulate electrostatics, we can use the switch function for LJ,
2710                  * which would otherwise need two tables.
2711                  */
2712             }
2713         }
2714         else if ((fr->nbkernel_elec_modifier == eintmodPOTSHIFT && fr->nbkernel_vdw_modifier == eintmodPOTSHIFT) ||
2715                  ((fr->nbkernel_elec_interaction == GMX_NBKERNEL_ELEC_REACTIONFIELD &&
2716                    fr->nbkernel_elec_modifier == eintmodEXACTCUTOFF &&
2717                    (fr->nbkernel_vdw_modifier == eintmodPOTSWITCH || fr->nbkernel_vdw_modifier == eintmodPOTSHIFT))))
2718         {
2719             if ((ic->rcoulomb != ic->rvdw) && (bGenericKernelOnly == FALSE))
2720             {
2721                 fr->bcoultab = TRUE;
2722             }
2723         }
2724
2725         if (fr->nbkernel_elec_modifier == eintmodFORCESWITCH)
2726         {
2727             fr->bcoultab = TRUE;
2728         }
2729         if (fr->nbkernel_vdw_modifier == eintmodFORCESWITCH)
2730         {
2731             fr->bvdwtab = TRUE;
2732         }
2733
2734         if (getenv("GMX_REQUIRE_TABLES"))
2735         {
2736             fr->bvdwtab  = TRUE;
2737             fr->bcoultab = TRUE;
2738         }
2739
2740         if (fp)
2741         {
2742             fprintf(fp, "Table routines are used for coulomb: %s\n",
2743                     gmx::boolToString(fr->bcoultab));
2744             fprintf(fp, "Table routines are used for vdw:     %s\n",
2745                     gmx::boolToString(fr->bvdwtab));
2746         }
2747
2748         if (fr->bvdwtab == TRUE)
2749         {
2750             fr->nbkernel_vdw_interaction = GMX_NBKERNEL_VDW_CUBICSPLINETABLE;
2751             fr->nbkernel_vdw_modifier    = eintmodNONE;
2752         }
2753         if (fr->bcoultab == TRUE)
2754         {
2755             fr->nbkernel_elec_interaction = GMX_NBKERNEL_ELEC_CUBICSPLINETABLE;
2756             fr->nbkernel_elec_modifier    = eintmodNONE;
2757         }
2758     }
2759
2760     if (ir->cutoff_scheme == ecutsVERLET)
2761     {
2762         if (!gmx_within_tol(ic->reppow, 12.0, 10*GMX_DOUBLE_EPS))
2763         {
2764             gmx_fatal(FARGS, "Cut-off scheme %S only supports LJ repulsion power 12", ecutscheme_names[ir->cutoff_scheme]);
2765         }
2766         /* Older tpr files can contain Coulomb user tables with the Verlet cutoff-scheme,
2767          * while mdrun does not (and never did) support this.
2768          */
2769         if (EEL_USER(fr->ic->eeltype))
2770         {
2771             gmx_fatal(FARGS, "Combination of %s and cutoff scheme %s is not supported",
2772                       eel_names[ir->coulombtype], ecutscheme_names[ir->cutoff_scheme]);
2773         }
2774
2775         fr->bvdwtab  = FALSE;
2776         fr->bcoultab = FALSE;
2777     }
2778
2779     /* 1-4 interaction electrostatics */
2780     fr->fudgeQQ = mtop->ffparams.fudgeQQ;
2781
2782     /* Parameters for generalized RF */
2783     fr->zsquare = 0.0;
2784     fr->temp    = 0.0;
2785
2786     if (ic->eeltype == eelGRF)
2787     {
2788         init_generalized_rf(fp, mtop, ir, fr);
2789     }
2790
2791     fr->haveDirectVirialContributions =
2792         (EEL_FULL(ic->eeltype) || EVDW_PME(ic->vdwtype) ||
2793          fr->forceProviders->hasForceProvider() ||
2794          gmx_mtop_ftype_count(mtop, F_POSRES) > 0 ||
2795          gmx_mtop_ftype_count(mtop, F_FBPOSRES) > 0 ||
2796          ir->bPull ||
2797          ir->bRot ||
2798          ir->bIMD);
2799
2800     if (fr->haveDirectVirialContributions)
2801     {
2802         fr->forceBufferForDirectVirialContributions = new std::vector<gmx::RVec>;
2803     }
2804
2805     if (fr->cutoff_scheme == ecutsGROUP &&
2806         ncg_mtop(mtop) > fr->cg_nalloc && !DOMAINDECOMP(cr))
2807     {
2808         /* Count the total number of charge groups */
2809         fr->cg_nalloc = ncg_mtop(mtop);
2810         srenew(fr->cg_cm, fr->cg_nalloc);
2811     }
2812     if (fr->shift_vec == nullptr)
2813     {
2814         snew(fr->shift_vec, SHIFTS);
2815     }
2816
2817     if (fr->fshift == nullptr)
2818     {
2819         snew(fr->fshift, SHIFTS);
2820     }
2821
2822     if (fr->nbfp == nullptr)
2823     {
2824         fr->ntype = mtop->ffparams.atnr;
2825         fr->nbfp  = mk_nbfp(&mtop->ffparams, fr->bBHAM);
2826         if (EVDW_PME(ic->vdwtype))
2827         {
2828             fr->ljpme_c6grid  = make_ljpme_c6grid(&mtop->ffparams, fr);
2829         }
2830     }
2831
2832     /* Copy the energy group exclusions */
2833     fr->egp_flags = ir->opts.egp_flags;
2834
2835     /* Van der Waals stuff */
2836     if ((ic->vdwtype != evdwCUT) && (ic->vdwtype != evdwUSER) && !fr->bBHAM)
2837     {
2838         if (ic->rvdw_switch >= ic->rvdw)
2839         {
2840             gmx_fatal(FARGS, "rvdw_switch (%f) must be < rvdw (%f)",
2841                       ic->rvdw_switch, ic->rvdw);
2842         }
2843         if (fp)
2844         {
2845             fprintf(fp, "Using %s Lennard-Jones, switch between %g and %g nm\n",
2846                     (ic->eeltype == eelSWITCH) ? "switched" : "shifted",
2847                     ic->rvdw_switch, ic->rvdw);
2848         }
2849     }
2850
2851     if (fr->bBHAM && EVDW_PME(ic->vdwtype))
2852     {
2853         gmx_fatal(FARGS, "LJ PME not supported with Buckingham");
2854     }
2855
2856     if (fr->bBHAM && (ic->vdwtype == evdwSHIFT || ic->vdwtype == evdwSWITCH))
2857     {
2858         gmx_fatal(FARGS, "Switch/shift interaction not supported with Buckingham");
2859     }
2860
2861     if (fr->bBHAM && fr->cutoff_scheme == ecutsVERLET)
2862     {
2863         gmx_fatal(FARGS, "Verlet cutoff-scheme is not supported with Buckingham");
2864     }
2865
2866     if (fp && fr->cutoff_scheme == ecutsGROUP)
2867     {
2868         fprintf(fp, "Cut-off's:   NS: %g   Coulomb: %g   %s: %g\n",
2869                 fr->rlist, ic->rcoulomb, fr->bBHAM ? "BHAM" : "LJ", ic->rvdw);
2870     }
2871
2872     fr->eDispCorr = ir->eDispCorr;
2873     fr->numAtomsForDispersionCorrection = mtop->natoms;
2874     if (ir->eDispCorr != edispcNO)
2875     {
2876         set_avcsixtwelve(fp, fr, mtop);
2877     }
2878
2879     fr->gb_epsilon_solvent = ir->gb_epsilon_solvent;
2880
2881     /* Copy the GBSA data (radius, volume and surftens for each
2882      * atomtype) from the topology atomtype section to forcerec.
2883      */
2884     snew(fr->atype_radius, fr->ntype);
2885     snew(fr->atype_vol, fr->ntype);
2886     snew(fr->atype_surftens, fr->ntype);
2887     snew(fr->atype_gb_radius, fr->ntype);
2888     snew(fr->atype_S_hct, fr->ntype);
2889
2890     if (mtop->atomtypes.nr > 0)
2891     {
2892         for (i = 0; i < fr->ntype; i++)
2893         {
2894             fr->atype_radius[i] = mtop->atomtypes.radius[i];
2895         }
2896         for (i = 0; i < fr->ntype; i++)
2897         {
2898             fr->atype_vol[i] = mtop->atomtypes.vol[i];
2899         }
2900         for (i = 0; i < fr->ntype; i++)
2901         {
2902             fr->atype_surftens[i] = mtop->atomtypes.surftens[i];
2903         }
2904         for (i = 0; i < fr->ntype; i++)
2905         {
2906             fr->atype_gb_radius[i] = mtop->atomtypes.gb_radius[i];
2907         }
2908         for (i = 0; i < fr->ntype; i++)
2909         {
2910             fr->atype_S_hct[i] = mtop->atomtypes.S_hct[i];
2911         }
2912     }
2913
2914     /* Generate the GB table if needed */
2915     if (fr->bGB)
2916     {
2917 #if GMX_DOUBLE
2918         fr->gbtabscale = 2000;
2919 #else
2920         fr->gbtabscale = 500;
2921 #endif
2922
2923         fr->gbtabr = 100;
2924         fr->gbtab  = make_gb_table(fr);
2925
2926         init_gb(&fr->born, fr, ir, mtop, ir->gb_algorithm);
2927
2928         /* Copy local gb data (for dd, this is done in dd_partition_system) */
2929         if (!DOMAINDECOMP(cr))
2930         {
2931             make_local_gb(cr, fr->born, ir->gb_algorithm);
2932         }
2933     }
2934
2935     /* Construct tables for the group scheme. A little unnecessary to
2936      * make both vdw and coul tables sometimes, but what the
2937      * heck. Note that both cutoff schemes construct Ewald tables in
2938      * init_interaction_const_tables. */
2939     needGroupSchemeTables = (ir->cutoff_scheme == ecutsGROUP &&
2940                              (fr->bcoultab || fr->bvdwtab));
2941
2942     negp_pp   = ir->opts.ngener - ir->nwall;
2943     negptable = 0;
2944     if (!needGroupSchemeTables)
2945     {
2946         bSomeNormalNbListsAreInUse = TRUE;
2947         fr->nnblists               = 1;
2948     }
2949     else
2950     {
2951         bSomeNormalNbListsAreInUse = FALSE;
2952         for (egi = 0; egi < negp_pp; egi++)
2953         {
2954             for (egj = egi; egj < negp_pp; egj++)
2955             {
2956                 egp_flags = ir->opts.egp_flags[GID(egi, egj, ir->opts.ngener)];
2957                 if (!(egp_flags & EGP_EXCL))
2958                 {
2959                     if (egp_flags & EGP_TABLE)
2960                     {
2961                         negptable++;
2962                     }
2963                     else
2964                     {
2965                         bSomeNormalNbListsAreInUse = TRUE;
2966                     }
2967                 }
2968             }
2969         }
2970         if (bSomeNormalNbListsAreInUse)
2971         {
2972             fr->nnblists = negptable + 1;
2973         }
2974         else
2975         {
2976             fr->nnblists = negptable;
2977         }
2978         if (fr->nnblists > 1)
2979         {
2980             snew(fr->gid2nblists, ir->opts.ngener*ir->opts.ngener);
2981         }
2982     }
2983
2984     snew(fr->nblists, fr->nnblists);
2985
2986     /* This code automatically gives table length tabext without cut-off's,
2987      * in that case grompp should already have checked that we do not need
2988      * normal tables and we only generate tables for 1-4 interactions.
2989      */
2990     rtab = ir->rlist + ir->tabext;
2991
2992     if (needGroupSchemeTables)
2993     {
2994         /* make tables for ordinary interactions */
2995         if (bSomeNormalNbListsAreInUse)
2996         {
2997             make_nbf_tables(fp, ic, rtab, tabfn, nullptr, nullptr, &fr->nblists[0]);
2998             m = 1;
2999         }
3000         else
3001         {
3002             m = 0;
3003         }
3004         if (negptable > 0)
3005         {
3006             /* Read the special tables for certain energy group pairs */
3007             nm_ind = mtop->groups.grps[egcENER].nm_ind;
3008             for (egi = 0; egi < negp_pp; egi++)
3009             {
3010                 for (egj = egi; egj < negp_pp; egj++)
3011                 {
3012                     egp_flags = ir->opts.egp_flags[GID(egi, egj, ir->opts.ngener)];
3013                     if ((egp_flags & EGP_TABLE) && !(egp_flags & EGP_EXCL))
3014                     {
3015                         if (fr->nnblists > 1)
3016                         {
3017                             fr->gid2nblists[GID(egi, egj, ir->opts.ngener)] = m;
3018                         }
3019                         /* Read the table file with the two energy groups names appended */
3020                         make_nbf_tables(fp, ic, rtab, tabfn,
3021                                         *mtop->groups.grpname[nm_ind[egi]],
3022                                         *mtop->groups.grpname[nm_ind[egj]],
3023                                         &fr->nblists[m]);
3024                         m++;
3025                     }
3026                     else if (fr->nnblists > 1)
3027                     {
3028                         fr->gid2nblists[GID(egi, egj, ir->opts.ngener)] = 0;
3029                     }
3030                 }
3031             }
3032         }
3033     }
3034
3035     /* Tables might not be used for the potential modifier
3036      * interactions per se, but we still need them to evaluate
3037      * switch/shift dispersion corrections in this case. */
3038     if (fr->eDispCorr != edispcNO)
3039     {
3040         fr->dispersionCorrectionTable = makeDispersionCorrectionTable(fp, ic, rtab, tabfn);
3041     }
3042
3043     /* We want to use unmodified tables for 1-4 coulombic
3044      * interactions, so we must in general have an extra set of
3045      * tables. */
3046     if (gmx_mtop_ftype_count(mtop, F_LJ14) > 0 ||
3047         gmx_mtop_ftype_count(mtop, F_LJC14_Q) > 0 ||
3048         gmx_mtop_ftype_count(mtop, F_LJC_PAIRS_NB) > 0)
3049     {
3050         fr->pairsTable = make_tables(fp, ic, tabpfn, rtab,
3051                                      GMX_MAKETABLES_14ONLY);
3052     }
3053
3054     /* Wall stuff */
3055     fr->nwall = ir->nwall;
3056     if (ir->nwall && ir->wall_type == ewtTABLE)
3057     {
3058         make_wall_tables(fp, ir, tabfn, &mtop->groups, fr);
3059     }
3060
3061     if (fcd && tabbfnm)
3062     {
3063         // Need to catch std::bad_alloc
3064         // TODO Don't need to catch this here, when merging with master branch
3065         try
3066         {
3067             fcd->bondtab  = make_bonded_tables(fp,
3068                                                F_TABBONDS, F_TABBONDSNC,
3069                                                mtop, tabbfnm, "b");
3070             fcd->angletab = make_bonded_tables(fp,
3071                                                F_TABANGLES, -1,
3072                                                mtop, tabbfnm, "a");
3073             fcd->dihtab   = make_bonded_tables(fp,
3074                                                F_TABDIHS, -1,
3075                                                mtop, tabbfnm, "d");
3076         }
3077         GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
3078     }
3079     else
3080     {
3081         if (debug)
3082         {
3083             fprintf(debug, "No fcdata or table file name passed, can not read table, can not do bonded interactions\n");
3084         }
3085     }
3086
3087     /* QM/MM initialization if requested
3088      */
3089     if (ir->bQMMM)
3090     {
3091         fprintf(stderr, "QM/MM calculation requested.\n");
3092     }
3093
3094     fr->bQMMM      = ir->bQMMM;
3095     fr->qr         = mk_QMMMrec();
3096
3097     /* Set all the static charge group info */
3098     fr->cginfo_mb = init_cginfo_mb(fp, mtop, fr, bNoSolvOpt,
3099                                    &bFEP_NonBonded,
3100                                    &fr->bExcl_IntraCGAll_InterCGNone);
3101     if (DOMAINDECOMP(cr))
3102     {
3103         fr->cginfo = nullptr;
3104     }
3105     else
3106     {
3107         fr->cginfo = cginfo_expand(mtop->nmolblock, fr->cginfo_mb);
3108     }
3109
3110     if (!DOMAINDECOMP(cr))
3111     {
3112         forcerec_set_ranges(fr, ncg_mtop(mtop), ncg_mtop(mtop),
3113                             mtop->natoms, mtop->natoms, mtop->natoms);
3114     }
3115
3116     fr->print_force = print_force;
3117
3118
3119     /* coarse load balancing vars */
3120     fr->t_fnbf    = 0.;
3121     fr->t_wait    = 0.;
3122     fr->timesteps = 0;
3123
3124     /* Initialize neighbor search */
3125     snew(fr->ns, 1);
3126     init_ns(fp, cr, fr->ns, fr, mtop);
3127
3128     if (thisRankHasDuty(cr, DUTY_PP))
3129     {
3130         gmx_nonbonded_setup(fr, bGenericKernelOnly);
3131     }
3132
3133     /* Initialize the thread working data for bonded interactions */
3134     init_bonded_threading(fp, mtop->groups.grps[egcENER].nr,
3135                           &fr->bonded_threading);
3136
3137     fr->nthread_ewc = gmx_omp_nthreads_get(emntBonded);
3138     snew(fr->ewc_t, fr->nthread_ewc);
3139
3140     if (fr->cutoff_scheme == ecutsVERLET)
3141     {
3142         // We checked the cut-offs in grompp, but double-check here.
3143         // We have PME+LJcutoff kernels for rcoulomb>rvdw.
3144         if (EEL_PME_EWALD(ir->coulombtype) && ir->vdwtype == eelCUT)
3145         {
3146             GMX_RELEASE_ASSERT(ir->rcoulomb >= ir->rvdw, "With Verlet lists and PME we should have rcoulomb>=rvdw");
3147         }
3148         else
3149         {
3150             GMX_RELEASE_ASSERT(ir->rcoulomb == ir->rvdw, "With Verlet lists and no PME rcoulomb and rvdw should be identical");
3151         }
3152
3153         init_nb_verlet(mdlog, &fr->nbv, bFEP_NonBonded, ir, fr,
3154                        cr, hardwareInfo, deviceInfo,
3155                        mtop, box);
3156     }
3157
3158     if (fp != nullptr)
3159     {
3160         /* Here we switch from using mdlog, which prints the newline before
3161          * the paragraph, to our old fprintf logging, which prints the newline
3162          * after the paragraph, so we should add a newline here.
3163          */
3164         fprintf(fp, "\n");
3165     }
3166
3167     if (ir->eDispCorr != edispcNO)
3168     {
3169         calc_enervirdiff(fp, ir->eDispCorr, fr);
3170     }
3171 }
3172
3173 /* Frees GPU memory and sets a tMPI node barrier.
3174  *
3175  * Note that this function needs to be called even if GPUs are not used
3176  * in this run because the PME ranks have no knowledge of whether GPUs
3177  * are used or not, but all ranks need to enter the barrier below.
3178  * \todo Remove physical node barrier from this function after making sure
3179  * that it's not needed anymore (with a shared GPU run).
3180  */
3181 void free_gpu_resources(const t_forcerec        *fr,
3182                         const t_commrec         *cr)
3183 {
3184     bool isPPrankUsingGPU = fr && fr->nbv && fr->nbv->bUseGPU;
3185
3186     /* stop the GPU profiler (only CUDA) */
3187     stopGpuProfiler();
3188
3189     if (isPPrankUsingGPU)
3190     {
3191         /* free nbnxn data in GPU memory */
3192         nbnxn_gpu_free(fr->nbv->gpu_nbv);
3193     }
3194
3195     /* With tMPI we need to wait for all ranks to finish deallocation before
3196      * destroying the CUDA context in free_gpu() as some tMPI ranks may be sharing
3197      * GPU and context.
3198      *
3199      * This is not a concern in OpenCL where we use one context per rank which
3200      * is freed in nbnxn_gpu_free().
3201      *
3202      * Note: it is safe to not call the barrier on the ranks which do not use GPU,
3203      * but it is easier and more futureproof to call it on the whole node.
3204      */
3205     if (GMX_THREAD_MPI && (PAR(cr) || MULTISIM(cr)))
3206     {
3207         gmx_barrier_physical_node(cr);
3208     }
3209 }