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