src/gromacs/mdlib/sim_util.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-2019,2020,2021, 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 "config.h"
  40
  41 #include <cmath>
  42 #include <cstdint>
  43 #include <cstdio>
  44 #include <cstring>
  45
  46 #include <array>
  47 #include <optional>
  48
  49 #include "gromacs/applied_forces/awh/awh.h"
  50 #include "gromacs/domdec/dlbtiming.h"
  51 #include "gromacs/domdec/domdec.h"
  52 #include "gromacs/domdec/domdec_struct.h"
  53 #include "gromacs/domdec/gpuhaloexchange.h"
  54 #include "gromacs/domdec/partition.h"
  55 #include "gromacs/essentialdynamics/edsam.h"
  56 #include "gromacs/ewald/pme.h"
  57 #include "gromacs/ewald/pme_pp.h"
  58 #include "gromacs/ewald/pme_pp_comm_gpu.h"
  59 #include "gromacs/gmxlib/network.h"
  60 #include "gromacs/gmxlib/nonbonded/nb_free_energy.h"
  61 #include "gromacs/gmxlib/nonbonded/nonbonded.h"
  62 #include "gromacs/gmxlib/nrnb.h"
  63 #include "gromacs/gpu_utils/gpu_utils.h"
  64 #include "gromacs/imd/imd.h"
  65 #include "gromacs/listed_forces/disre.h"
  66 #include "gromacs/listed_forces/gpubonded.h"
  67 #include "gromacs/listed_forces/listed_forces.h"
  68 #include "gromacs/listed_forces/orires.h"
  69 #include "gromacs/math/arrayrefwithpadding.h"
  70 #include "gromacs/math/functions.h"
  71 #include "gromacs/math/units.h"
  72 #include "gromacs/math/vec.h"
  73 #include "gromacs/math/vecdump.h"
  74 #include "gromacs/mdlib/calcmu.h"
  75 #include "gromacs/mdlib/calcvir.h"
  76 #include "gromacs/mdlib/constr.h"
  77 #include "gromacs/mdlib/dispersioncorrection.h"
  78 #include "gromacs/mdlib/enerdata_utils.h"
  79 #include "gromacs/mdlib/force.h"
  80 #include "gromacs/mdlib/force_flags.h"
  81 #include "gromacs/mdlib/forcerec.h"
  82 #include "gromacs/mdlib/gmx_omp_nthreads.h"
  83 #include "gromacs/mdlib/update.h"
  84 #include "gromacs/mdlib/vsite.h"
  85 #include "gromacs/mdlib/wall.h"
  86 #include "gromacs/mdlib/wholemoleculetransform.h"
  87 #include "gromacs/mdtypes/commrec.h"
  88 #include "gromacs/mdtypes/enerdata.h"
  89 #include "gromacs/mdtypes/forcebuffers.h"
  90 #include "gromacs/mdtypes/forceoutput.h"
  91 #include "gromacs/mdtypes/forcerec.h"
  92 #include "gromacs/mdtypes/iforceprovider.h"
  93 #include "gromacs/mdtypes/inputrec.h"
  94 #include "gromacs/mdtypes/md_enums.h"
  95 #include "gromacs/mdtypes/mdatom.h"
  96 #include "gromacs/mdtypes/multipletimestepping.h"
  97 #include "gromacs/mdtypes/simulation_workload.h"
  98 #include "gromacs/mdtypes/state.h"
  99 #include "gromacs/mdtypes/state_propagator_data_gpu.h"
 100 #include "gromacs/nbnxm/gpu_data_mgmt.h"
 101 #include "gromacs/nbnxm/nbnxm.h"
 102 #include "gromacs/nbnxm/nbnxm_gpu.h"
 103 #include "gromacs/pbcutil/ishift.h"
 104 #include "gromacs/pbcutil/pbc.h"
 105 #include "gromacs/pulling/pull.h"
 106 #include "gromacs/pulling/pull_rotation.h"
 107 #include "gromacs/timing/cyclecounter.h"
 108 #include "gromacs/timing/gpu_timing.h"
 109 #include "gromacs/timing/wallcycle.h"
 110 #include "gromacs/timing/wallcyclereporting.h"
 111 #include "gromacs/timing/walltime_accounting.h"
 112 #include "gromacs/topology/topology.h"
 113 #include "gromacs/utility/arrayref.h"
 114 #include "gromacs/utility/basedefinitions.h"
 115 #include "gromacs/utility/cstringutil.h"
 116 #include "gromacs/utility/exceptions.h"
 117 #include "gromacs/utility/fatalerror.h"
 118 #include "gromacs/utility/fixedcapacityvector.h"
 119 #include "gromacs/utility/gmxassert.h"
 120 #include "gromacs/utility/gmxmpi.h"
 121 #include "gromacs/utility/logger.h"
 122 #include "gromacs/utility/smalloc.h"
 123 #include "gromacs/utility/strconvert.h"
 124 #include "gromacs/utility/sysinfo.h"
 125
 126 #include "gpuforcereduction.h"
 127
 128 using gmx::ArrayRef;
 129 using gmx::AtomLocality;
 130 using gmx::DomainLifetimeWorkload;
 131 using gmx::ForceOutputs;
 132 using gmx::ForceWithShiftForces;
 133 using gmx::InteractionLocality;
 134 using gmx::RVec;
 135 using gmx::SimulationWorkload;
 136 using gmx::StepWorkload;
 137
 138 // TODO: this environment variable allows us to verify before release
 139 // that on less common architectures the total cost of polling is not larger than
 140 // a blocking wait (so polling does not introduce overhead when the static
 141 // PME-first ordering would suffice).
 142 static const bool c_disableAlternatingWait = (getenv("GMX_DISABLE_ALTERNATING_GPU_WAIT") != nullptr);
 143
 144 static void sum_forces(ArrayRef<RVec> f, ArrayRef<const RVec> forceToAdd)
 145 {
 146     GMX_ASSERT(f.size() >= forceToAdd.size(), "Accumulation buffer should be sufficiently large");
 147     const int end = forceToAdd.size();
 148
 149     int gmx_unused nt = gmx_omp_nthreads_get(ModuleMultiThread::Default);
 150 #pragma omp parallel for num_threads(nt) schedule(static)
 151     for (int i = 0; i < end; i++)
 152     {
 153         rvec_inc(f[i], forceToAdd[i]);
 154     }
 155 }
 156
 157 static void calc_virial(int                              start,
 158                         int                              homenr,
 159                         const rvec                       x[],
 160                         const gmx::ForceWithShiftForces& forceWithShiftForces,
 161                         tensor                           vir_part,
 162                         const matrix                     box,
 163                         t_nrnb*                          nrnb,
 164                         const t_forcerec*                fr,
 165                         PbcType                          pbcType)
 166 {
 167     /* The short-range virial from surrounding boxes */
 168     const rvec* fshift          = as_rvec_array(forceWithShiftForces.shiftForces().data());
 169     const rvec* shiftVecPointer = as_rvec_array(fr->shift_vec.data());
 170     calc_vir(gmx::c_numShiftVectors, shiftVecPointer, fshift, vir_part, pbcType == PbcType::Screw, box);
 171     inc_nrnb(nrnb, eNR_VIRIAL, gmx::c_numShiftVectors);
 172
 173     /* Calculate partial virial, for local atoms only, based on short range.
 174      * Total virial is computed in global_stat, called from do_md
 175      */
 176     const rvec* f = as_rvec_array(forceWithShiftForces.force().data());
 177     f_calc_vir(start, start + homenr, x, f, vir_part, box);
 178     inc_nrnb(nrnb, eNR_VIRIAL, homenr);
 179
 180     if (debug)
 181     {
 182         pr_rvecs(debug, 0, "vir_part", vir_part, DIM);
 183     }
 184 }
 185
 186 static void pull_potential_wrapper(const t_commrec*               cr,
 187                                    const t_inputrec&              ir,
 188                                    const matrix                   box,
 189                                    gmx::ArrayRef<const gmx::RVec> x,
 190                                    gmx::ForceWithVirial*          force,
 191                                    const t_mdatoms*               mdatoms,
 192                                    gmx_enerdata_t*                enerd,
 193                                    pull_t*                        pull_work,
 194                                    const real*                    lambda,
 195                                    double                         t,
 196                                    gmx_wallcycle*                 wcycle)
 197 {
 198     t_pbc pbc;
 199     real  dvdl;
 200
 201     /* Calculate the center of mass forces, this requires communication,
 202      * which is why pull_potential is called close to other communication.
 203      */
 204     wallcycle_start(wcycle, WallCycleCounter::PullPot);
 205     set_pbc(&pbc, ir.pbcType, box);
 206     dvdl = 0;
 207     enerd->term[F_COM_PULL] +=
 208             pull_potential(pull_work,
 209                            gmx::arrayRefFromArray(mdatoms->massT, mdatoms->nr),
 210                            &pbc,
 211                            cr,
 212                            t,
 213                            lambda[static_cast<int>(FreeEnergyPerturbationCouplingType::Restraint)],
 214                            x,
 215                            force,
 216                            &dvdl);
 217     enerd->dvdl_lin[FreeEnergyPerturbationCouplingType::Restraint] += dvdl;
 218     wallcycle_stop(wcycle, WallCycleCounter::PullPot);
 219 }
 220
 221 static void pme_receive_force_ener(t_forcerec*           fr,
 222                                    const t_commrec*      cr,
 223                                    gmx::ForceWithVirial* forceWithVirial,
 224                                    gmx_enerdata_t*       enerd,
 225                                    bool                  useGpuPmePpComms,
 226                                    bool                  receivePmeForceToGpu,
 227                                    gmx_wallcycle*        wcycle)
 228 {
 229     real  e_q, e_lj, dvdl_q, dvdl_lj;
 230     float cycles_ppdpme, cycles_seppme;
 231
 232     cycles_ppdpme = wallcycle_stop(wcycle, WallCycleCounter::PpDuringPme);
 233     dd_cycles_add(cr->dd, cycles_ppdpme, ddCyclPPduringPME);
 234
 235     /* In case of node-splitting, the PP nodes receive the long-range
 236      * forces, virial and energy from the PME nodes here.
 237      */
 238     wallcycle_start(wcycle, WallCycleCounter::PpPmeWaitRecvF);
 239     dvdl_q  = 0;
 240     dvdl_lj = 0;
 241     gmx_pme_receive_f(fr->pmePpCommGpu.get(),
 242                       cr,
 243                       forceWithVirial,
 244                       &e_q,
 245                       &e_lj,
 246                       &dvdl_q,
 247                       &dvdl_lj,
 248                       useGpuPmePpComms,
 249                       receivePmeForceToGpu,
 250                       &cycles_seppme);
 251     enerd->term[F_COUL_RECIP] += e_q;
 252     enerd->term[F_LJ_RECIP] += e_lj;
 253     enerd->dvdl_lin[FreeEnergyPerturbationCouplingType::Coul] += dvdl_q;
 254     enerd->dvdl_lin[FreeEnergyPerturbationCouplingType::Vdw] += dvdl_lj;
 255
 256     if (wcycle)
 257     {
 258         dd_cycles_add(cr->dd, cycles_seppme, ddCyclPME);
 259     }
 260     wallcycle_stop(wcycle, WallCycleCounter::PpPmeWaitRecvF);
 261 }
 262
 263 static void print_large_forces(FILE*                fp,
 264                                const t_mdatoms*     md,
 265                                const t_commrec*     cr,
 266                                int64_t              step,
 267                                real                 forceTolerance,
 268                                ArrayRef<const RVec> x,
 269                                ArrayRef<const RVec> f)
 270 {
 271     real       force2Tolerance = gmx::square(forceTolerance);
 272     gmx::index numNonFinite    = 0;
 273     for (int i = 0; i < md->homenr; i++)
 274     {
 275         real force2    = norm2(f[i]);
 276         bool nonFinite = !std::isfinite(force2);
 277         if (force2 >= force2Tolerance || nonFinite)
 278         {
 279             fprintf(fp,
 280                     "step %" PRId64 " atom %6d  x %8.3f %8.3f %8.3f  force %12.5e\n",
 281                     step,
 282                     ddglatnr(cr->dd, i),
 283                     x[i][XX],
 284                     x[i][YY],
 285                     x[i][ZZ],
 286                     std::sqrt(force2));
 287         }
 288         if (nonFinite)
 289         {
 290             numNonFinite++;
 291         }
 292     }
 293     if (numNonFinite > 0)
 294     {
 295         /* Note that with MPI this fatal call on one rank might interrupt
 296          * the printing on other ranks. But we can only avoid that with
 297          * an expensive MPI barrier that we would need at each step.
 298          */
 299         gmx_fatal(FARGS, "At step %" PRId64 " detected non-finite forces on %td atoms", step, numNonFinite);
 300     }
 301 }
 302
 303 //! When necessary, spreads forces on vsites and computes the virial for \p forceOutputs->forceWithShiftForces()
 304 static void postProcessForceWithShiftForces(t_nrnb*                   nrnb,
 305                                             gmx_wallcycle*            wcycle,
 306                                             const matrix              box,
 307                                             ArrayRef<const RVec>      x,
 308                                             ForceOutputs*             forceOutputs,
 309                                             tensor                    vir_force,
 310                                             const t_mdatoms&          mdatoms,
 311                                             const t_forcerec&         fr,
 312                                             gmx::VirtualSitesHandler* vsite,
 313                                             const StepWorkload&       stepWork)
 314 {
 315     ForceWithShiftForces& forceWithShiftForces = forceOutputs->forceWithShiftForces();
 316
 317     /* If we have NoVirSum forces, but we do not calculate the virial,
 318      * we later sum the forceWithShiftForces buffer together with
 319      * the noVirSum buffer and spread the combined vsite forces at once.
 320      */
 321     if (vsite && (!forceOutputs->haveForceWithVirial() || stepWork.computeVirial))
 322     {
 323         using VirialHandling = gmx::VirtualSitesHandler::VirialHandling;
 324
 325         auto                 f      = forceWithShiftForces.force();
 326         auto                 fshift = forceWithShiftForces.shiftForces();
 327         const VirialHandling virialHandling =
 328                 (stepWork.computeVirial ? VirialHandling::Pbc : VirialHandling::None);
 329         vsite->spreadForces(x, f, virialHandling, fshift, nullptr, nrnb, box, wcycle);
 330         forceWithShiftForces.haveSpreadVsiteForces() = true;
 331     }
 332
 333     if (stepWork.computeVirial)
 334     {
 335         /* Calculation of the virial must be done after vsites! */
 336         calc_virial(
 337                 0, mdatoms.homenr, as_rvec_array(x.data()), forceWithShiftForces, vir_force, box, nrnb, &fr, fr.pbcType);
 338     }
 339 }
 340
 341 //! Spread, compute virial for and sum forces, when necessary
 342 static void postProcessForces(const t_commrec*          cr,
 343                               int64_t                   step,
 344                               t_nrnb*                   nrnb,
 345                               gmx_wallcycle*            wcycle,
 346                               const matrix              box,
 347                               ArrayRef<const RVec>      x,
 348                               ForceOutputs*             forceOutputs,
 349                               tensor                    vir_force,
 350                               const t_mdatoms*          mdatoms,
 351                               const t_forcerec*         fr,
 352                               gmx::VirtualSitesHandler* vsite,
 353                               const StepWorkload&       stepWork)
 354 {
 355     // Extract the final output force buffer, which is also the buffer for forces with shift forces
 356     ArrayRef<RVec> f = forceOutputs->forceWithShiftForces().force();
 357
 358     if (forceOutputs->haveForceWithVirial())
 359     {
 360         auto& forceWithVirial = forceOutputs->forceWithVirial();
 361
 362         if (vsite)
 363         {
 364             /* Spread the mesh force on virtual sites to the other particles...
 365              * This is parallellized. MPI communication is performed
 366              * if the constructing atoms aren't local.
 367              */
 368             GMX_ASSERT(!stepWork.computeVirial || f.data() != forceWithVirial.force_.data(),
 369                        "We need separate force buffers for shift and virial forces when "
 370                        "computing the virial");
 371             GMX_ASSERT(!stepWork.computeVirial
 372                                || forceOutputs->forceWithShiftForces().haveSpreadVsiteForces(),
 373                        "We should spread the force with shift forces separately when computing "
 374                        "the virial");
 375             const gmx::VirtualSitesHandler::VirialHandling virialHandling =
 376                     (stepWork.computeVirial ? gmx::VirtualSitesHandler::VirialHandling::NonLinear
 377                                             : gmx::VirtualSitesHandler::VirialHandling::None);
 378             matrix virial = { { 0 } };
 379             vsite->spreadForces(x, forceWithVirial.force_, virialHandling, {}, virial, nrnb, box, wcycle);
 380             forceWithVirial.addVirialContribution(virial);
 381         }
 382
 383         if (stepWork.computeVirial)
 384         {
 385             /* Now add the forces, this is local */
 386             sum_forces(f, forceWithVirial.force_);
 387
 388             /* Add the direct virial contributions */
 389             GMX_ASSERT(
 390                     forceWithVirial.computeVirial_,
 391                     "forceWithVirial should request virial computation when we request the virial");
 392             m_add(vir_force, forceWithVirial.getVirial(), vir_force);
 393
 394             if (debug)
 395             {
 396                 pr_rvecs(debug, 0, "vir_force", vir_force, DIM);
 397             }
 398         }
 399     }
 400     else
 401     {
 402         GMX_ASSERT(vsite == nullptr || forceOutputs->forceWithShiftForces().haveSpreadVsiteForces(),
 403                    "We should have spread the vsite forces (earlier)");
 404     }
 405
 406     if (fr->print_force >= 0)
 407     {
 408         print_large_forces(stderr, mdatoms, cr, step, fr->print_force, x, f);
 409     }
 410 }
 411
 412 static void do_nb_verlet(t_forcerec*                fr,
 413                          const interaction_const_t* ic,
 414                          gmx_enerdata_t*            enerd,
 415                          const StepWorkload&        stepWork,
 416                          const InteractionLocality  ilocality,
 417                          const int                  clearF,
 418                          const int64_t              step,
 419                          t_nrnb*                    nrnb,
 420                          gmx_wallcycle*             wcycle)
 421 {
 422     if (!stepWork.computeNonbondedForces)
 423     {
 424         /* skip non-bonded calculation */
 425         return;
 426     }
 427
 428     nonbonded_verlet_t* nbv = fr->nbv.get();
 429
 430     /* GPU kernel launch overhead is already timed separately */
 431     if (!nbv->useGpu())
 432     {
 433         /* When dynamic pair-list  pruning is requested, we need to prune
 434          * at nstlistPrune steps.
 435          */
 436         if (nbv->isDynamicPruningStepCpu(step))
 437         {
 438             /* Prune the pair-list beyond fr->ic->rlistPrune using
 439              * the current coordinates of the atoms.
 440              */
 441             wallcycle_sub_start(wcycle, WallCycleSubCounter::NonbondedPruning);
 442             nbv->dispatchPruneKernelCpu(ilocality, fr->shift_vec);
 443             wallcycle_sub_stop(wcycle, WallCycleSubCounter::NonbondedPruning);
 444         }
 445     }
 446
 447     nbv->dispatchNonbondedKernel(
 448             ilocality,
 449             *ic,
 450             stepWork,
 451             clearF,
 452             fr->shift_vec,
 453             enerd->grpp.energyGroupPairTerms[fr->haveBuckingham ? NonBondedEnergyTerms::BuckinghamSR
 454                                                                 : NonBondedEnergyTerms::LJSR],
 455             enerd->grpp.energyGroupPairTerms[NonBondedEnergyTerms::CoulombSR],
 456             nrnb);
 457 }
 458
 459 static inline void clearRVecs(ArrayRef<RVec> v, const bool useOpenmpThreading)
 460 {
 461     int nth = gmx_omp_nthreads_get_simple_rvec_task(ModuleMultiThread::Default, v.ssize());
 462
 463     /* Note that we would like to avoid this conditional by putting it
 464      * into the omp pragma instead, but then we still take the full
 465      * omp parallel for overhead (at least with gcc5).
 466      */
 467     if (!useOpenmpThreading || nth == 1)
 468     {
 469         for (RVec& elem : v)
 470         {
 471             clear_rvec(elem);
 472         }
 473     }
 474     else
 475     {
 476 #pragma omp parallel for num_threads(nth) schedule(static)
 477         for (gmx::index i = 0; i < v.ssize(); i++)
 478         {
 479             clear_rvec(v[i]);
 480         }
 481     }
 482 }
 483
 484 /*! \brief Return an estimate of the average kinetic energy or 0 when unreliable
 485  *
 486  * \param groupOptions  Group options, containing T-coupling options
 487  */
 488 static real averageKineticEnergyEstimate(const t_grpopts& groupOptions)
 489 {
 490     real nrdfCoupled   = 0;
 491     real nrdfUncoupled = 0;
 492     real kineticEnergy = 0;
 493     for (int g = 0; g < groupOptions.ngtc; g++)
 494     {
 495         if (groupOptions.tau_t[g] >= 0)
 496         {
 497             nrdfCoupled += groupOptions.nrdf[g];
 498             kineticEnergy += groupOptions.nrdf[g] * 0.5 * groupOptions.ref_t[g] * gmx::c_boltz;
 499         }
 500         else
 501         {
 502             nrdfUncoupled += groupOptions.nrdf[g];
 503         }
 504     }
 505
 506     /* This conditional with > also catches nrdf=0 */
 507     if (nrdfCoupled > nrdfUncoupled)
 508     {
 509         return kineticEnergy * (nrdfCoupled + nrdfUncoupled) / nrdfCoupled;
 510     }
 511     else
 512     {
 513         return 0;
 514     }
 515 }
 516
 517 /*! \brief This routine checks that the potential energy is finite.
 518  *
 519  * Always checks that the potential energy is finite. If step equals
 520  * inputrec.init_step also checks that the magnitude of the potential energy
 521  * is reasonable. Terminates with a fatal error when a check fails.
 522  * Note that passing this check does not guarantee finite forces,
 523  * since those use slightly different arithmetics. But in most cases
 524  * there is just a narrow coordinate range where forces are not finite
 525  * and energies are finite.
 526  *
 527  * \param[in] step      The step number, used for checking and printing
 528  * \param[in] enerd     The energy data; the non-bonded group energies need to be added to
 529  * enerd.term[F_EPOT] before calling this routine \param[in] inputrec  The input record
 530  */
 531 static void checkPotentialEnergyValidity(int64_t step, const gmx_enerdata_t& enerd, const t_inputrec& inputrec)
 532 {
 533     /* Threshold valid for comparing absolute potential energy against
 534      * the kinetic energy. Normally one should not consider absolute
 535      * potential energy values, but with a factor of one million
 536      * we should never get false positives.
 537      */
 538     constexpr real c_thresholdFactor = 1e6;
 539
 540     bool energyIsNotFinite    = !std::isfinite(enerd.term[F_EPOT]);
 541     real averageKineticEnergy = 0;
 542     /* We only check for large potential energy at the initial step,
 543      * because that is by far the most likely step for this too occur
 544      * and because computing the average kinetic energy is not free.
 545      * Note: nstcalcenergy >> 1 often does not allow to catch large energies
 546      * before they become NaN.
 547      */
 548     if (step == inputrec.init_step && EI_DYNAMICS(inputrec.eI))
 549     {
 550         averageKineticEnergy = averageKineticEnergyEstimate(inputrec.opts);
 551     }
 552
 553     if (energyIsNotFinite
 554         || (averageKineticEnergy > 0 && enerd.term[F_EPOT] > c_thresholdFactor * averageKineticEnergy))
 555     {
 556         gmx_fatal(
 557                 FARGS,
 558                 "Step %" PRId64
 559                 ": The total potential energy is %g, which is %s. The LJ and electrostatic "
 560                 "contributions to the energy are %g and %g, respectively. A %s potential energy "
 561                 "can be caused by overlapping interactions in bonded interactions or very large%s "
 562                 "coordinate values. Usually this is caused by a badly- or non-equilibrated initial "
 563                 "configuration, incorrect interactions or parameters in the topology.",
 564                 step,
 565                 enerd.term[F_EPOT],
 566                 energyIsNotFinite ? "not finite" : "extremely high",
 567                 enerd.term[F_LJ],
 568                 enerd.term[F_COUL_SR],
 569                 energyIsNotFinite ? "non-finite" : "very high",
 570                 energyIsNotFinite ? " or Nan" : "");
 571     }
 572 }
 573
 574 /*! \brief Return true if there are special forces computed this step.
 575  *
 576  * The conditionals exactly correspond to those in computeSpecialForces().
 577  */
 578 static bool haveSpecialForces(const t_inputrec&          inputrec,
 579                               const gmx::ForceProviders& forceProviders,
 580                               const pull_t*              pull_work,
 581                               const bool                 computeForces,
 582                               const gmx_edsam*           ed)
 583 {
 584
 585     return ((computeForces && forceProviders.hasForceProvider()) || // forceProviders
 586             (inputrec.bPull && pull_have_potential(*pull_work)) ||  // pull
 587             inputrec.bRot ||                                        // enforced rotation
 588             (ed != nullptr) ||                                      // flooding
 589             (inputrec.bIMD && computeForces));                      // IMD
 590 }
 591
 592 /*! \brief Compute forces and/or energies for special algorithms
 593  *
 594  * The intention is to collect all calls to algorithms that compute
 595  * forces on local atoms only and that do not contribute to the local
 596  * virial sum (but add their virial contribution separately).
 597  * Eventually these should likely all become ForceProviders.
 598  * Within this function the intention is to have algorithms that do
 599  * global communication at the end, so global barriers within the MD loop
 600  * are as close together as possible.
 601  *
 602  * \param[in]     fplog            The log file
 603  * \param[in]     cr               The communication record
 604  * \param[in]     inputrec         The input record
 605  * \param[in]     awh              The Awh module (nullptr if none in use).
 606  * \param[in]     enforcedRotation Enforced rotation module.
 607  * \param[in]     imdSession       The IMD session
 608  * \param[in]     pull_work        The pull work structure.
 609  * \param[in]     step             The current MD step
 610  * \param[in]     t                The current time
 611  * \param[in,out] wcycle           Wallcycle accounting struct
 612  * \param[in,out] forceProviders   Pointer to a list of force providers
 613  * \param[in]     box              The unit cell
 614  * \param[in]     x                The coordinates
 615  * \param[in]     mdatoms          Per atom properties
 616  * \param[in]     lambda           Array of free-energy lambda values
 617  * \param[in]     stepWork         Step schedule flags
 618  * \param[in,out] forceWithVirialMtsLevel0  Force and virial for MTS level0 forces
 619  * \param[in,out] forceWithVirialMtsLevel1  Force and virial for MTS level1 forces, can be nullptr
 620  * \param[in,out] enerd            Energy buffer
 621  * \param[in,out] ed               Essential dynamics pointer
 622  * \param[in]     didNeighborSearch Tells if we did neighbor searching this step, used for ED sampling
 623  *
 624  * \todo Remove didNeighborSearch, which is used incorrectly.
 625  * \todo Convert all other algorithms called here to ForceProviders.
 626  */
 627 static void computeSpecialForces(FILE*                          fplog,
 628                                  const t_commrec*               cr,
 629                                  const t_inputrec&              inputrec,
 630                                  gmx::Awh*                      awh,
 631                                  gmx_enfrot*                    enforcedRotation,
 632                                  gmx::ImdSession*               imdSession,
 633                                  pull_t*                        pull_work,
 634                                  int64_t                        step,
 635                                  double                         t,
 636                                  gmx_wallcycle*                 wcycle,
 637                                  gmx::ForceProviders*           forceProviders,
 638                                  const matrix                   box,
 639                                  gmx::ArrayRef<const gmx::RVec> x,
 640                                  const t_mdatoms*               mdatoms,
 641                                  gmx::ArrayRef<const real>      lambda,
 642                                  const StepWorkload&            stepWork,
 643                                  gmx::ForceWithVirial*          forceWithVirialMtsLevel0,
 644                                  gmx::ForceWithVirial*          forceWithVirialMtsLevel1,
 645                                  gmx_enerdata_t*                enerd,
 646                                  gmx_edsam*                     ed,
 647                                  bool                           didNeighborSearch)
 648 {
 649     /* NOTE: Currently all ForceProviders only provide forces.
 650      *       When they also provide energies, remove this conditional.
 651      */
 652     if (stepWork.computeForces)
 653     {
 654         gmx::ForceProviderInput forceProviderInput(
 655                 x,
 656                 mdatoms->homenr,
 657                 gmx::arrayRefFromArray(mdatoms->chargeA, mdatoms->homenr),
 658                 gmx::arrayRefFromArray(mdatoms->massT, mdatoms->homenr),
 659                 t,
 660                 box,
 661                 *cr);
 662         gmx::ForceProviderOutput forceProviderOutput(forceWithVirialMtsLevel0, enerd);
 663
 664         /* Collect forces from modules */
 665         forceProviders->calculateForces(forceProviderInput, &forceProviderOutput);
 666     }
 667
 668     if (inputrec.bPull && pull_have_potential(*pull_work))
 669     {
 670         const int mtsLevel = forceGroupMtsLevel(inputrec.mtsLevels, gmx::MtsForceGroups::Pull);
 671         if (mtsLevel == 0 || stepWork.computeSlowForces)
 672         {
 673             auto& forceWithVirial = (mtsLevel == 0) ? forceWithVirialMtsLevel0 : forceWithVirialMtsLevel1;
 674             pull_potential_wrapper(
 675                     cr, inputrec, box, x, forceWithVirial, mdatoms, enerd, pull_work, lambda.data(), t, wcycle);
 676         }
 677     }
 678     if (awh)
 679     {
 680         const int mtsLevel = forceGroupMtsLevel(inputrec.mtsLevels, gmx::MtsForceGroups::Pull);
 681         if (mtsLevel == 0 || stepWork.computeSlowForces)
 682         {
 683             const bool needForeignEnergyDifferences = awh->needForeignEnergyDifferences(step);
 684             std::vector<double> foreignLambdaDeltaH, foreignLambdaDhDl;
 685             if (needForeignEnergyDifferences)
 686             {
 687                 enerd->foreignLambdaTerms.finalizePotentialContributions(
 688                         enerd->dvdl_lin, lambda, *inputrec.fepvals);
 689                 std::tie(foreignLambdaDeltaH, foreignLambdaDhDl) = enerd->foreignLambdaTerms.getTerms(cr);
 690             }
 691
 692             auto& forceWithVirial = (mtsLevel == 0) ? forceWithVirialMtsLevel0 : forceWithVirialMtsLevel1;
 693             enerd->term[F_COM_PULL] += awh->applyBiasForcesAndUpdateBias(
 694                     inputrec.pbcType,
 695                     gmx::arrayRefFromArray(mdatoms->massT, mdatoms->nr),
 696                     foreignLambdaDeltaH,
 697                     foreignLambdaDhDl,
 698                     box,
 699                     forceWithVirial,
 700                     t,
 701                     step,
 702                     wcycle,
 703                     fplog);
 704         }
 705     }
 706     /* Add the forces from enforced rotation potentials (if any) */
 707     if (inputrec.bRot)
 708     {
 709         wallcycle_start(wcycle, WallCycleCounter::RotAdd);
 710         enerd->term[F_COM_PULL] +=
 711                 add_rot_forces(enforcedRotation, forceWithVirialMtsLevel0->force_, cr, step, t);
 712         wallcycle_stop(wcycle, WallCycleCounter::RotAdd);
 713     }
 714
 715     if (ed)
 716     {
 717         /* Note that since init_edsam() is called after the initialization
 718          * of forcerec, edsam doesn't request the noVirSum force buffer.
 719          * Thus if no other algorithm (e.g. PME) requires it, the forces
 720          * here will contribute to the virial.
 721          */
 722         do_flood(cr, inputrec, x, forceWithVirialMtsLevel0->force_, ed, box, step, didNeighborSearch);
 723     }
 724
 725     /* Add forces from interactive molecular dynamics (IMD), if any */
 726     if (inputrec.bIMD && stepWork.computeForces)
 727     {
 728         imdSession->applyForces(forceWithVirialMtsLevel0->force_);
 729     }
 730 }
 731
 732 /*! \brief Launch the prepare_step and spread stages of PME GPU.
 733  *
 734  * \param[in]  pmedata              The PME structure
 735  * \param[in]  box                  The box matrix
 736  * \param[in]  stepWork             Step schedule flags
 737  * \param[in]  xReadyOnDevice       Event synchronizer indicating that the coordinates are ready in the device memory.
 738  * \param[in]  lambdaQ              The Coulomb lambda of the current state.
 739  * \param[in]  wcycle               The wallcycle structure
 740  */
 741 static inline void launchPmeGpuSpread(gmx_pme_t*            pmedata,
 742                                       const matrix          box,
 743                                       const StepWorkload&   stepWork,
 744                                       GpuEventSynchronizer* xReadyOnDevice,
 745                                       const real            lambdaQ,
 746                                       gmx_wallcycle*        wcycle)
 747 {
 748     pme_gpu_prepare_computation(pmedata, box, wcycle, stepWork);
 749     pme_gpu_launch_spread(pmedata, xReadyOnDevice, wcycle, lambdaQ);
 750 }
 751
 752 /*! \brief Launch the FFT and gather stages of PME GPU
 753  *
 754  * This function only implements setting the output forces (no accumulation).
 755  *
 756  * \param[in]  pmedata        The PME structure
 757  * \param[in]  lambdaQ        The Coulomb lambda of the current system state.
 758  * \param[in]  wcycle         The wallcycle structure
 759  * \param[in]  stepWork       Step schedule flags
 760  */
 761 static void launchPmeGpuFftAndGather(gmx_pme_t*               pmedata,
 762                                      const real               lambdaQ,
 763                                      gmx_wallcycle*           wcycle,
 764                                      const gmx::StepWorkload& stepWork)
 765 {
 766     pme_gpu_launch_complex_transforms(pmedata, wcycle, stepWork);
 767     pme_gpu_launch_gather(pmedata, wcycle, lambdaQ);
 768 }
 769
 770 /*! \brief
 771  *  Polling wait for either of the PME or nonbonded GPU tasks.
 772  *
 773  * Instead of a static order in waiting for GPU tasks, this function
 774  * polls checking which of the two tasks completes first, and does the
 775  * associated force buffer reduction overlapped with the other task.
 776  * By doing that, unlike static scheduling order, it can always overlap
 777  * one of the reductions, regardless of the GPU task completion order.
 778  *
 779  * \param[in]     nbv              Nonbonded verlet structure
 780  * \param[in,out] pmedata          PME module data
 781  * \param[in,out] forceOutputsNonbonded  Force outputs for the non-bonded forces and shift forces
 782  * \param[in,out] forceOutputsPme  Force outputs for the PME forces and virial
 783  * \param[in,out] enerd            Energy data structure results are reduced into
 784  * \param[in]     lambdaQ          The Coulomb lambda of the current system state.
 785  * \param[in]     stepWork         Step schedule flags
 786  * \param[in]     wcycle           The wallcycle structure
 787  */
 788 static void alternatePmeNbGpuWaitReduce(nonbonded_verlet_t* nbv,
 789                                         gmx_pme_t*          pmedata,
 790                                         gmx::ForceOutputs*  forceOutputsNonbonded,
 791                                         gmx::ForceOutputs*  forceOutputsPme,
 792                                         gmx_enerdata_t*     enerd,
 793                                         const real          lambdaQ,
 794                                         const StepWorkload& stepWork,
 795                                         gmx_wallcycle*      wcycle)
 796 {
 797     bool isPmeGpuDone = false;
 798     bool isNbGpuDone  = false;
 799
 800     gmx::ArrayRef<const gmx::RVec> pmeGpuForces;
 801
 802     while (!isPmeGpuDone || !isNbGpuDone)
 803     {
 804         if (!isPmeGpuDone)
 805         {
 806             GpuTaskCompletion completionType =
 807                     (isNbGpuDone) ? GpuTaskCompletion::Wait : GpuTaskCompletion::Check;
 808             isPmeGpuDone = pme_gpu_try_finish_task(
 809                     pmedata, stepWork, wcycle, &forceOutputsPme->forceWithVirial(), enerd, lambdaQ, completionType);
 810         }
 811
 812         if (!isNbGpuDone)
 813         {
 814             auto&             forceBuffersNonbonded = forceOutputsNonbonded->forceWithShiftForces();
 815             GpuTaskCompletion completionType =
 816                     (isPmeGpuDone) ? GpuTaskCompletion::Wait : GpuTaskCompletion::Check;
 817             isNbGpuDone = Nbnxm::gpu_try_finish_task(
 818                     nbv->gpu_nbv,
 819                     stepWork,
 820                     AtomLocality::Local,
 821                     enerd->grpp.energyGroupPairTerms[NonBondedEnergyTerms::LJSR].data(),
 822                     enerd->grpp.energyGroupPairTerms[NonBondedEnergyTerms::CoulombSR].data(),
 823                     forceBuffersNonbonded.shiftForces(),
 824                     completionType,
 825                     wcycle);
 826
 827             if (isNbGpuDone)
 828             {
 829                 nbv->atomdata_add_nbat_f_to_f(AtomLocality::Local, forceBuffersNonbonded.force());
 830             }
 831         }
 832     }
 833 }
 834
 835 /*! \brief Set up the different force buffers; also does clearing.
 836  *
 837  * \param[in] forceHelperBuffers        Helper force buffers
 838  * \param[in] force                     force array
 839  * \param[in] domainWork                Domain lifetime workload flags
 840  * \param[in] stepWork                  Step schedule flags
 841  * \param[in] havePpDomainDecomposition Whether we have a PP domain decomposition
 842  * \param[out] wcycle                   wallcycle recording structure
 843  *
 844  * \returns                             Cleared force output structure
 845  */
 846 static ForceOutputs setupForceOutputs(ForceHelperBuffers*                 forceHelperBuffers,
 847                                       gmx::ArrayRefWithPadding<gmx::RVec> force,
 848                                       const DomainLifetimeWorkload&       domainWork,
 849                                       const StepWorkload&                 stepWork,
 850                                       const bool                          havePpDomainDecomposition,
 851                                       gmx_wallcycle*                      wcycle)
 852 {
 853     wallcycle_sub_start(wcycle, WallCycleSubCounter::ClearForceBuffer);
 854
 855     /* NOTE: We assume fr->shiftForces is all zeros here */
 856     gmx::ForceWithShiftForces forceWithShiftForces(
 857             force, stepWork.computeVirial, forceHelperBuffers->shiftForces());
 858
 859     if (stepWork.computeForces
 860         && (domainWork.haveCpuLocalForceWork || !stepWork.useGpuFBufferOps
 861             || (havePpDomainDecomposition && !stepWork.useGpuFHalo)))
 862     {
 863         /* Clear the short- and long-range forces */
 864         clearRVecs(forceWithShiftForces.force(), true);
 865
 866         /* Clear the shift forces */
 867         clearRVecs(forceWithShiftForces.shiftForces(), false);
 868     }
 869
 870     /* If we need to compute the virial, we might need a separate
 871      * force buffer for algorithms for which the virial is calculated
 872      * directly, such as PME. Otherwise, forceWithVirial uses the
 873      * the same force (f in legacy calls) buffer as other algorithms.
 874      */
 875     const bool useSeparateForceWithVirialBuffer =
 876             (stepWork.computeForces
 877              && (stepWork.computeVirial && forceHelperBuffers->haveDirectVirialContributions()));
 878     /* forceWithVirial uses the local atom range only */
 879     gmx::ForceWithVirial forceWithVirial(
 880             useSeparateForceWithVirialBuffer ? forceHelperBuffers->forceBufferForDirectVirialContributions()
 881                                              : force.unpaddedArrayRef(),
 882             stepWork.computeVirial);
 883
 884     if (useSeparateForceWithVirialBuffer)
 885     {
 886         /* TODO: update comment
 887          * We only compute forces on local atoms. Note that vsites can
 888          * spread to non-local atoms, but that part of the buffer is
 889          * cleared separately in the vsite spreading code.
 890          */
 891         clearRVecs(forceWithVirial.force_, true);
 892     }
 893
 894     wallcycle_sub_stop(wcycle, WallCycleSubCounter::ClearForceBuffer);
 895
 896     return ForceOutputs(
 897             forceWithShiftForces, forceHelperBuffers->haveDirectVirialContributions(), forceWithVirial);
 898 }
 899
 900
 901 /*! \brief Set up flags that have the lifetime of the domain indicating what type of work is there to compute.
 902  */
 903 static DomainLifetimeWorkload setupDomainLifetimeWorkload(const t_inputrec&         inputrec,
 904                                                           const t_forcerec&         fr,
 905                                                           const pull_t*             pull_work,
 906                                                           const gmx_edsam*          ed,
 907                                                           const t_mdatoms&          mdatoms,
 908                                                           const SimulationWorkload& simulationWork,
 909                                                           const StepWorkload&       stepWork)
 910 {
 911     DomainLifetimeWorkload domainWork;
 912     // Note that haveSpecialForces is constant over the whole run
 913     domainWork.haveSpecialForces =
 914             haveSpecialForces(inputrec, *fr.forceProviders, pull_work, stepWork.computeForces, ed);
 915     domainWork.haveCpuListedForceWork = false;
 916     domainWork.haveCpuBondedWork      = false;
 917     for (const auto& listedForces : fr.listedForces)
 918     {
 919         if (listedForces.haveCpuListedForces(*fr.fcdata))
 920         {
 921             domainWork.haveCpuListedForceWork = true;
 922         }
 923         if (listedForces.haveCpuBondeds())
 924         {
 925             domainWork.haveCpuBondedWork = true;
 926         }
 927     }
 928     domainWork.haveGpuBondedWork = ((fr.gpuBonded != nullptr) && fr.gpuBonded->haveInteractions());
 929     // Note that haveFreeEnergyWork is constant over the whole run
 930     domainWork.haveFreeEnergyWork =
 931             (fr.efep != FreeEnergyPerturbationType::No && mdatoms.nPerturbed != 0);
 932     // We assume we have local force work if there are CPU
 933     // force tasks including PME or nonbondeds.
 934     domainWork.haveCpuLocalForceWork =
 935             domainWork.haveSpecialForces || domainWork.haveCpuListedForceWork
 936             || domainWork.haveFreeEnergyWork || simulationWork.useCpuNonbonded || simulationWork.useCpuPme
 937             || simulationWork.haveEwaldSurfaceContribution || inputrec.nwall > 0;
 938
 939     return domainWork;
 940 }
 941
 942 /*! \brief Set up force flag stuct from the force bitmask.
 943  *
 944  * \param[in]      legacyFlags          Force bitmask flags used to construct the new flags
 945  * \param[in]      mtsLevels            The multiple time-stepping levels, either empty or 2 levels
 946  * \param[in]      step                 The current MD step
 947  * \param[in]      simulationWork       Simulation workload description.
 948  * \param[in]      rankHasPmeDuty       If this rank computes PME.
 949  *
 950  * \returns New Stepworkload description.
 951  */
 952 static StepWorkload setupStepWorkload(const int                     legacyFlags,
 953                                       ArrayRef<const gmx::MtsLevel> mtsLevels,
 954                                       const int64_t                 step,
 955                                       const SimulationWorkload&     simulationWork,
 956                                       const bool                    rankHasPmeDuty)
 957 {
 958     GMX_ASSERT(mtsLevels.empty() || mtsLevels.size() == 2, "Expect 0 or 2 MTS levels");
 959     const bool computeSlowForces = (mtsLevels.empty() || step % mtsLevels[1].stepFactor == 0);
 960
 961     StepWorkload flags;
 962     flags.stateChanged                  = ((legacyFlags & GMX_FORCE_STATECHANGED) != 0);
 963     flags.haveDynamicBox                = ((legacyFlags & GMX_FORCE_DYNAMICBOX) != 0);
 964     flags.doNeighborSearch              = ((legacyFlags & GMX_FORCE_NS) != 0);
 965     flags.computeSlowForces             = computeSlowForces;
 966     flags.computeVirial                 = ((legacyFlags & GMX_FORCE_VIRIAL) != 0);
 967     flags.computeEnergy                 = ((legacyFlags & GMX_FORCE_ENERGY) != 0);
 968     flags.computeForces                 = ((legacyFlags & GMX_FORCE_FORCES) != 0);
 969     flags.useOnlyMtsCombinedForceBuffer = ((legacyFlags & GMX_FORCE_DO_NOT_NEED_NORMAL_FORCE) != 0);
 970     flags.computeListedForces           = ((legacyFlags & GMX_FORCE_LISTED) != 0);
 971     flags.computeNonbondedForces =
 972             ((legacyFlags & GMX_FORCE_NONBONDED) != 0) && simulationWork.computeNonbonded
 973             && !(simulationWork.computeNonbondedAtMtsLevel1 && !computeSlowForces);
 974     flags.computeDhdl = ((legacyFlags & GMX_FORCE_DHDL) != 0);
 975
 976     if (simulationWork.useGpuBufferOps)
 977     {
 978         GMX_ASSERT(simulationWork.useGpuNonbonded,
 979                    "Can only offload buffer ops if nonbonded computation is also offloaded");
 980     }
 981     flags.useGpuXBufferOps = simulationWork.useGpuBufferOps;
 982     // on virial steps the CPU reduction path is taken
 983     flags.useGpuFBufferOps = simulationWork.useGpuBufferOps && !flags.computeVirial;
 984     flags.useGpuPmeFReduction = flags.computeSlowForces && flags.useGpuFBufferOps && simulationWork.useGpuPme
 985                                 && (rankHasPmeDuty || simulationWork.useGpuPmePpCommunication);
 986     flags.useGpuXHalo          = simulationWork.useGpuHaloExchange;
 987     flags.useGpuFHalo          = simulationWork.useGpuHaloExchange && flags.useGpuFBufferOps;
 988     flags.haveGpuPmeOnThisRank = simulationWork.useGpuPme && rankHasPmeDuty && flags.computeSlowForces;
 989
 990     return flags;
 991 }
 992
 993
 994 /* \brief Launch end-of-step GPU tasks: buffer clearing and rolling pruning.
 995  *
 996  */
 997 static void launchGpuEndOfStepTasks(nonbonded_verlet_t*               nbv,
 998                                     gmx::GpuBonded*                   gpuBonded,
 999                                     gmx_pme_t*                        pmedata,
1000                                     gmx_enerdata_t*                   enerd,
1001                                     const gmx::MdrunScheduleWorkload& runScheduleWork,
1002                                     int64_t                           step,
1003                                     gmx_wallcycle*                    wcycle)
1004 {
1005     if (runScheduleWork.simulationWork.useGpuNonbonded && runScheduleWork.stepWork.computeNonbondedForces)
1006     {
1007         /* Launch pruning before buffer clearing because the API overhead of the
1008          * clear kernel launches can leave the GPU idle while it could be running
1009          * the prune kernel.
1010          */
1011         if (nbv->isDynamicPruningStepGpu(step))
1012         {
1013             nbv->dispatchPruneKernelGpu(step);
1014         }
1015
1016         /* now clear the GPU outputs while we finish the step on the CPU */
1017         wallcycle_start_nocount(wcycle, WallCycleCounter::LaunchGpu);
1018         wallcycle_sub_start_nocount(wcycle, WallCycleSubCounter::LaunchGpuNonBonded);
1019         Nbnxm::gpu_clear_outputs(nbv->gpu_nbv, runScheduleWork.stepWork.computeVirial);
1020         wallcycle_sub_stop(wcycle, WallCycleSubCounter::LaunchGpuNonBonded);
1021         wallcycle_stop(wcycle, WallCycleCounter::LaunchGpu);
1022     }
1023
1024     if (runScheduleWork.stepWork.haveGpuPmeOnThisRank)
1025     {
1026         pme_gpu_reinit_computation(pmedata, wcycle);
1027     }
1028
1029     if (runScheduleWork.domainWork.haveGpuBondedWork && runScheduleWork.stepWork.computeEnergy)
1030     {
1031         // in principle this should be included in the DD balancing region,
1032         // but generally it is infrequent so we'll omit it for the sake of
1033         // simpler code
1034         gpuBonded->waitAccumulateEnergyTerms(enerd);
1035
1036         gpuBonded->clearEnergies();
1037     }
1038 }
1039
1040 //! \brief Data structure to hold dipole-related data and staging arrays
1041 struct DipoleData
1042 {
1043     //! Dipole staging for fast summing over MPI
1044     gmx::DVec muStaging[2] = { { 0.0, 0.0, 0.0 } };
1045     //! Dipole staging for states A and B (index 0 and 1 resp.)
1046     gmx::RVec muStateAB[2] = { { 0.0_real, 0.0_real, 0.0_real } };
1047 };
1048
1049
1050 static void reduceAndUpdateMuTot(DipoleData*                   dipoleData,
1051                                  const t_commrec*              cr,
1052                                  const bool                    haveFreeEnergy,
1053                                  gmx::ArrayRef<const real>     lambda,
1054                                  rvec                          muTotal,
1055                                  const DDBalanceRegionHandler& ddBalanceRegionHandler)
1056 {
1057     if (PAR(cr))
1058     {
1059         gmx_sumd(2 * DIM, dipoleData->muStaging[0], cr);
1060         ddBalanceRegionHandler.reopenRegionCpu();
1061     }
1062     for (int i = 0; i < 2; i++)
1063     {
1064         for (int j = 0; j < DIM; j++)
1065         {
1066             dipoleData->muStateAB[i][j] = dipoleData->muStaging[i][j];
1067         }
1068     }
1069
1070     if (!haveFreeEnergy)
1071     {
1072         copy_rvec(dipoleData->muStateAB[0], muTotal);
1073     }
1074     else
1075     {
1076         for (int j = 0; j < DIM; j++)
1077         {
1078             muTotal[j] = (1.0 - lambda[static_cast<int>(FreeEnergyPerturbationCouplingType::Coul)])
1079                                  * dipoleData->muStateAB[0][j]
1080                          + lambda[static_cast<int>(FreeEnergyPerturbationCouplingType::Coul)]
1081                                    * dipoleData->muStateAB[1][j];
1082         }
1083     }
1084 }
1085
1086 /*! \brief Combines MTS level0 and level1 force buffes into a full and MTS-combined force buffer.
1087  *
1088  * \param[in]     numAtoms        The number of atoms to combine forces for
1089  * \param[in,out] forceMtsLevel0  Input: F_level0, output: F_level0 + F_level1
1090  * \param[in,out] forceMts        Input: F_level1, output: F_level0 + mtsFactor * F_level1
1091  * \param[in]     mtsFactor       The factor between the level0 and level1 time step
1092  */
1093 static void combineMtsForces(const int      numAtoms,
1094                              ArrayRef<RVec> forceMtsLevel0,
1095                              ArrayRef<RVec> forceMts,
1096                              const real     mtsFactor)
1097 {
1098     const int gmx_unused numThreads = gmx_omp_nthreads_get(ModuleMultiThread::Default);
1099 #pragma omp parallel for num_threads(numThreads) schedule(static)
1100     for (int i = 0; i < numAtoms; i++)
1101     {
1102         const RVec forceMtsLevel0Tmp = forceMtsLevel0[i];
1103         forceMtsLevel0[i] += forceMts[i];
1104         forceMts[i] = forceMtsLevel0Tmp + mtsFactor * forceMts[i];
1105     }
1106 }
1107
1108 /*! \brief Setup for the local and non-local GPU force reductions:
1109  * reinitialization plus the registration of forces and dependencies.
1110  *
1111  * \param [in] runScheduleWork               Schedule workload flag structure
1112  * \param [in] cr                            Communication record object
1113  * \param [in] fr                            Force record object
1114  */
1115 static void setupGpuForceReductions(gmx::MdrunScheduleWorkload* runScheduleWork,
1116                                     const t_commrec*            cr,
1117                                     t_forcerec*                 fr)
1118 {
1119
1120     nonbonded_verlet_t*          nbv      = fr->nbv.get();
1121     gmx::StatePropagatorDataGpu* stateGpu = fr->stateGpu;
1122
1123     // (re-)initialize local GPU force reduction
1124     const bool accumulate =
1125             runScheduleWork->domainWork.haveCpuLocalForceWork || havePPDomainDecomposition(cr);
1126     const int atomStart = 0;
1127     fr->gpuForceReduction[gmx::AtomLocality::Local]->reinit(stateGpu->getForces(),
1128                                                             nbv->getNumAtoms(AtomLocality::Local),
1129                                                             nbv->getGridIndices(),
1130                                                             atomStart,
1131                                                             accumulate,
1132                                                             stateGpu->fReducedOnDevice());
1133
1134     // register forces and add dependencies
1135     fr->gpuForceReduction[gmx::AtomLocality::Local]->registerNbnxmForce(nbv->getGpuForces());
1136
1137     if (runScheduleWork->simulationWork.useGpuPme
1138         && (thisRankHasDuty(cr, DUTY_PME) || runScheduleWork->simulationWork.useGpuPmePpCommunication))
1139     {
1140         DeviceBuffer<gmx::RVec> forcePtr =
1141                 thisRankHasDuty(cr, DUTY_PME) ? pme_gpu_get_device_f(fr->pmedata)
1142                                               :                    // PME force buffer on same GPU
1143                         fr->pmePpCommGpu->getGpuForceStagingPtr(); // buffer received from other GPU
1144         fr->gpuForceReduction[gmx::AtomLocality::Local]->registerRvecForce(forcePtr);
1145
1146         GpuEventSynchronizer* const pmeSynchronizer =
1147                 (thisRankHasDuty(cr, DUTY_PME) ? pme_gpu_get_f_ready_synchronizer(fr->pmedata)
1148                                                : // PME force buffer on same GPU
1149                          fr->pmePpCommGpu->getForcesReadySynchronizer()); // buffer received from other GPU
1150
1151         if (GMX_THREAD_MPI)
1152         {
1153             GMX_ASSERT(pmeSynchronizer != nullptr, "PME force ready cuda event should not be NULL");
1154             fr->gpuForceReduction[gmx::AtomLocality::Local]->addDependency(pmeSynchronizer);
1155         }
1156     }
1157
1158     if ((runScheduleWork->domainWork.haveCpuLocalForceWork || havePPDomainDecomposition(cr))
1159         && !runScheduleWork->simulationWork.useGpuHaloExchange)
1160     {
1161         auto forcesReadyLocality = havePPDomainDecomposition(cr) ? AtomLocality::Local : AtomLocality::All;
1162         const bool useGpuForceBufferOps = true;
1163         fr->gpuForceReduction[gmx::AtomLocality::Local]->addDependency(
1164                 stateGpu->getForcesReadyOnDeviceEvent(forcesReadyLocality, useGpuForceBufferOps));
1165     }
1166
1167     if (runScheduleWork->simulationWork.useGpuHaloExchange)
1168     {
1169         fr->gpuForceReduction[gmx::AtomLocality::Local]->addDependency(
1170                 cr->dd->gpuHaloExchange[0][0]->getForcesReadyOnDeviceEvent());
1171     }
1172
1173     if (havePPDomainDecomposition(cr))
1174     {
1175         // (re-)initialize non-local GPU force reduction
1176         const bool accumulate = runScheduleWork->domainWork.haveCpuBondedWork
1177                                 || runScheduleWork->domainWork.haveFreeEnergyWork;
1178         const int atomStart = dd_numHomeAtoms(*cr->dd);
1179         fr->gpuForceReduction[gmx::AtomLocality::NonLocal]->reinit(stateGpu->getForces(),
1180                                                                    nbv->getNumAtoms(AtomLocality::NonLocal),
1181                                                                    nbv->getGridIndices(),
1182                                                                    atomStart,
1183                                                                    accumulate);
1184
1185         // register forces and add dependencies
1186         fr->gpuForceReduction[gmx::AtomLocality::NonLocal]->registerNbnxmForce(nbv->getGpuForces());
1187         if (runScheduleWork->domainWork.haveCpuBondedWork || runScheduleWork->domainWork.haveFreeEnergyWork)
1188         {
1189             fr->gpuForceReduction[gmx::AtomLocality::NonLocal]->addDependency(
1190                     stateGpu->getForcesReadyOnDeviceEvent(AtomLocality::NonLocal, true));
1191         }
1192     }
1193 }
1194
1195
1196 void do_force(FILE*                               fplog,
1197               const t_commrec*                    cr,
1198               const gmx_multisim_t*               ms,
1199               const t_inputrec&                   inputrec,
1200               gmx::Awh*                           awh,
1201               gmx_enfrot*                         enforcedRotation,
1202               gmx::ImdSession*                    imdSession,
1203               pull_t*                             pull_work,
1204               int64_t                             step,
1205               t_nrnb*                             nrnb,
1206               gmx_wallcycle*                      wcycle,
1207               const gmx_localtop_t*               top,
1208               const matrix                        box,
1209               gmx::ArrayRefWithPadding<gmx::RVec> x,
1210               const history_t*                    hist,
1211               gmx::ForceBuffersView*              forceView,
1212               tensor                              vir_force,
1213               const t_mdatoms*                    mdatoms,
1214               gmx_enerdata_t*                     enerd,
1215               gmx::ArrayRef<const real>           lambda,
1216               t_forcerec*                         fr,
1217               gmx::MdrunScheduleWorkload*         runScheduleWork,
1218               gmx::VirtualSitesHandler*           vsite,
1219               rvec                                muTotal,
1220               double                              t,
1221               gmx_edsam*                          ed,
1222               int                                 legacyFlags,
1223               const DDBalanceRegionHandler&       ddBalanceRegionHandler)
1224 {
1225     auto force = forceView->forceWithPadding();
1226     GMX_ASSERT(force.unpaddedArrayRef().ssize() >= fr->natoms_force_constr,
1227                "The size of the force buffer should be at least the number of atoms to compute "
1228                "forces for");
1229
1230     nonbonded_verlet_t*  nbv = fr->nbv.get();
1231     interaction_const_t* ic  = fr->ic.get();
1232
1233     gmx::StatePropagatorDataGpu* stateGpu = fr->stateGpu;
1234
1235     const SimulationWorkload& simulationWork = runScheduleWork->simulationWork;
1236
1237     runScheduleWork->stepWork = setupStepWorkload(
1238             legacyFlags, inputrec.mtsLevels, step, simulationWork, thisRankHasDuty(cr, DUTY_PME));
1239     const StepWorkload& stepWork = runScheduleWork->stepWork;
1240
1241     /* At a search step we need to start the first balancing region
1242      * somewhere early inside the step after communication during domain
1243      * decomposition (and not during the previous step as usual).
1244      */
1245     if (stepWork.doNeighborSearch)
1246     {
1247         ddBalanceRegionHandler.openBeforeForceComputationCpu(DdAllowBalanceRegionReopen::yes);
1248     }
1249
1250     clear_mat(vir_force);
1251
1252     if (fr->pbcType != PbcType::No)
1253     {
1254         /* Compute shift vectors every step,
1255          * because of pressure coupling or box deformation!
1256          */
1257         if (stepWork.haveDynamicBox && stepWork.stateChanged)
1258         {
1259             calc_shifts(box, fr->shift_vec);
1260         }
1261
1262         const bool fillGrid = (stepWork.doNeighborSearch && stepWork.stateChanged);
1263         const bool calcCGCM = (fillGrid && !DOMAINDECOMP(cr));
1264         if (calcCGCM)
1265         {
1266             put_atoms_in_box_omp(fr->pbcType,
1267                                  box,
1268                                  x.unpaddedArrayRef().subArray(0, mdatoms->homenr),
1269                                  gmx_omp_nthreads_get(ModuleMultiThread::Default));
1270             inc_nrnb(nrnb, eNR_SHIFTX, mdatoms->homenr);
1271         }
1272     }
1273
1274     nbnxn_atomdata_copy_shiftvec(stepWork.haveDynamicBox, fr->shift_vec, nbv->nbat.get());
1275
1276     const bool pmeSendCoordinatesFromGpu =
1277             GMX_MPI && simulationWork.useGpuPmePpCommunication && !(stepWork.doNeighborSearch);
1278     const bool reinitGpuPmePpComms =
1279             GMX_MPI && simulationWork.useGpuPmePpCommunication && (stepWork.doNeighborSearch);
1280
1281     auto* localXReadyOnDevice = (stepWork.haveGpuPmeOnThisRank || simulationWork.useGpuBufferOps)
1282                                         ? stateGpu->getCoordinatesReadyOnDeviceEvent(
1283                                                 AtomLocality::Local, simulationWork, stepWork)
1284                                         : nullptr;
1285
1286     // Copy coordinate from the GPU if update is on the GPU and there
1287     // are forces to be computed on the CPU, or for the computation of
1288     // virial, or if host-side data will be transferred from this task
1289     // to a remote task for halo exchange or PME-PP communication. At
1290     // search steps the current coordinates are already on the host,
1291     // hence copy is not needed.
1292     const bool haveHostPmePpComms =
1293             !thisRankHasDuty(cr, DUTY_PME) && !simulationWork.useGpuPmePpCommunication;
1294
1295     GMX_ASSERT(simulationWork.useGpuHaloExchange
1296                        == ((cr->dd != nullptr) && (!cr->dd->gpuHaloExchange[0].empty())),
1297                "The GPU halo exchange is active, but it has not been constructed.");
1298     const bool haveHostHaloExchangeComms =
1299             havePPDomainDecomposition(cr) && !simulationWork.useGpuHaloExchange;
1300
1301     bool gmx_used_in_debug haveCopiedXFromGpu = false;
1302     if (simulationWork.useGpuUpdate && !stepWork.doNeighborSearch
1303         && (runScheduleWork->domainWork.haveCpuLocalForceWork || stepWork.computeVirial
1304             || haveHostPmePpComms || haveHostHaloExchangeComms || simulationWork.computeMuTot))
1305     {
1306         stateGpu->copyCoordinatesFromGpu(x.unpaddedArrayRef(), AtomLocality::Local);
1307         haveCopiedXFromGpu = true;
1308     }
1309
1310     // Coordinates on the device are needed if PME or BufferOps are offloaded.
1311     // The local coordinates can be copied right away.
1312     // NOTE: Consider moving this copy to right after they are updated and constrained,
1313     //       if the later is not offloaded.
1314     if (stepWork.haveGpuPmeOnThisRank || stepWork.useGpuXBufferOps)
1315     {
1316         if (stepWork.doNeighborSearch)
1317         {
1318             // TODO refactor this to do_md, after partitioning.
1319             stateGpu->reinit(mdatoms->homenr,
1320                              cr->dd != nullptr ? dd_numAtomsZones(*cr->dd) : mdatoms->homenr);
1321             if (stepWork.haveGpuPmeOnThisRank)
1322             {
1323                 // TODO: This should be moved into PME setup function ( pme_gpu_prepare_computation(...) )
1324                 pme_gpu_set_device_x(fr->pmedata, stateGpu->getCoordinates());
1325             }
1326         }
1327         // We need to copy coordinates when:
1328         // 1. Update is not offloaded
1329         // 2. The buffers were reinitialized on search step
1330         if (!simulationWork.useGpuUpdate || stepWork.doNeighborSearch)
1331         {
1332             GMX_ASSERT(stateGpu != nullptr, "stateGpu should not be null");
1333             stateGpu->copyCoordinatesToGpu(x.unpaddedArrayRef(), AtomLocality::Local);
1334         }
1335     }
1336
1337     if (GMX_MPI && !thisRankHasDuty(cr, DUTY_PME) && stepWork.computeSlowForces)
1338     {
1339         /* Send particle coordinates to the pme nodes */
1340         if (!pmeSendCoordinatesFromGpu && !stepWork.doNeighborSearch && simulationWork.useGpuUpdate)
1341         {
1342             GMX_ASSERT(haveCopiedXFromGpu,
1343                        "a wait should only be triggered if copy has been scheduled");
1344             stateGpu->waitCoordinatesReadyOnHost(AtomLocality::Local);
1345         }
1346
1347         gmx_pme_send_coordinates(fr,
1348                                  cr,
1349                                  box,
1350                                  as_rvec_array(x.unpaddedArrayRef().data()),
1351                                  lambda[static_cast<int>(FreeEnergyPerturbationCouplingType::Coul)],
1352                                  lambda[static_cast<int>(FreeEnergyPerturbationCouplingType::Vdw)],
1353                                  (stepWork.computeVirial || stepWork.computeEnergy),
1354                                  step,
1355                                  simulationWork.useGpuPmePpCommunication,
1356                                  reinitGpuPmePpComms,
1357                                  pmeSendCoordinatesFromGpu,
1358                                  localXReadyOnDevice,
1359                                  wcycle);
1360     }
1361
1362     if (stepWork.haveGpuPmeOnThisRank)
1363     {
1364         launchPmeGpuSpread(fr->pmedata,
1365                            box,
1366                            stepWork,
1367                            localXReadyOnDevice,
1368                            lambda[static_cast<int>(FreeEnergyPerturbationCouplingType::Coul)],
1369                            wcycle);
1370     }
1371
1372     const gmx::DomainLifetimeWorkload& domainWork = runScheduleWork->domainWork;
1373
1374     /* do gridding for pair search */
1375     if (stepWork.doNeighborSearch)
1376     {
1377         if (fr->wholeMoleculeTransform && stepWork.stateChanged)
1378         {
1379             fr->wholeMoleculeTransform->updateForAtomPbcJumps(x.unpaddedArrayRef(), box);
1380         }
1381
1382         wallcycle_start(wcycle, WallCycleCounter::NS);
1383         if (!DOMAINDECOMP(cr))
1384         {
1385             const rvec vzero       = { 0.0_real, 0.0_real, 0.0_real };
1386             const rvec boxDiagonal = { box[XX][XX], box[YY][YY], box[ZZ][ZZ] };
1387             wallcycle_sub_start(wcycle, WallCycleSubCounter::NBSGridLocal);
1388             nbnxn_put_on_grid(nbv,
1389                               box,
1390                               0,
1391                               vzero,
1392                               boxDiagonal,
1393                               nullptr,
1394                               { 0, mdatoms->homenr },
1395                               -1,
1396                               fr->cginfo,
1397                               x.unpaddedArrayRef(),
1398                               0,
1399                               nullptr);
1400             wallcycle_sub_stop(wcycle, WallCycleSubCounter::NBSGridLocal);
1401         }
1402         else
1403         {
1404             wallcycle_sub_start(wcycle, WallCycleSubCounter::NBSGridNonLocal);
1405             nbnxn_put_on_grid_nonlocal(nbv, domdec_zones(cr->dd), fr->cginfo, x.unpaddedArrayRef());
1406             wallcycle_sub_stop(wcycle, WallCycleSubCounter::NBSGridNonLocal);
1407         }
1408
1409         nbv->setAtomProperties(gmx::constArrayRefFromArray(mdatoms->typeA, mdatoms->nr),
1410                                gmx::constArrayRefFromArray(mdatoms->chargeA, mdatoms->nr),
1411                                fr->cginfo);
1412
1413         wallcycle_stop(wcycle, WallCycleCounter::NS);
1414
1415         /* initialize the GPU nbnxm atom data and bonded data structures */
1416         if (simulationWork.useGpuNonbonded)
1417         {
1418             // Note: cycle counting only nononbondeds, gpuBonded counts internally
1419             wallcycle_start_nocount(wcycle, WallCycleCounter::LaunchGpu);
1420             wallcycle_sub_start_nocount(wcycle, WallCycleSubCounter::LaunchGpuNonBonded);
1421             Nbnxm::gpu_init_atomdata(nbv->gpu_nbv, nbv->nbat.get());
1422             wallcycle_sub_stop(wcycle, WallCycleSubCounter::LaunchGpuNonBonded);
1423             wallcycle_stop(wcycle, WallCycleCounter::LaunchGpu);
1424
1425             if (fr->gpuBonded)
1426             {
1427                 /* Now we put all atoms on the grid, we can assign bonded
1428                  * interactions to the GPU, where the grid order is
1429                  * needed. Also the xq, f and fshift device buffers have
1430                  * been reallocated if needed, so the bonded code can
1431                  * learn about them. */
1432                 // TODO the xq, f, and fshift buffers are now shared
1433                 // resources, so they should be maintained by a
1434                 // higher-level object than the nb module.
1435                 fr->gpuBonded->updateInteractionListsAndDeviceBuffers(nbv->getGridIndices(),
1436                                                                       top->idef,
1437                                                                       Nbnxm::gpu_get_xq(nbv->gpu_nbv),
1438                                                                       Nbnxm::gpu_get_f(nbv->gpu_nbv),
1439                                                                       Nbnxm::gpu_get_fshift(nbv->gpu_nbv));
1440             }
1441         }
1442
1443         // Need to run after the GPU-offload bonded interaction lists
1444         // are set up to be able to determine whether there is bonded work.
1445         runScheduleWork->domainWork = setupDomainLifetimeWorkload(
1446                 inputrec, *fr, pull_work, ed, *mdatoms, simulationWork, stepWork);
1447
1448         wallcycle_start_nocount(wcycle, WallCycleCounter::NS);
1449         wallcycle_sub_start(wcycle, WallCycleSubCounter::NBSSearchLocal);
1450         /* Note that with a GPU the launch overhead of the list transfer is not timed separately */
1451         nbv->constructPairlist(InteractionLocality::Local, top->excls, step, nrnb);
1452
1453         nbv->setupGpuShortRangeWork(fr->gpuBonded, InteractionLocality::Local);
1454
1455         wallcycle_sub_stop(wcycle, WallCycleSubCounter::NBSSearchLocal);
1456         wallcycle_stop(wcycle, WallCycleCounter::NS);
1457
1458         if (stepWork.useGpuXBufferOps)
1459         {
1460             nbv->atomdata_init_copy_x_to_nbat_x_gpu();
1461         }
1462
1463         if (simulationWork.useGpuBufferOps)
1464         {
1465             setupGpuForceReductions(runScheduleWork, cr, fr);
1466         }
1467     }
1468     else if (!EI_TPI(inputrec.eI) && stepWork.computeNonbondedForces)
1469     {
1470         if (stepWork.useGpuXBufferOps)
1471         {
1472             GMX_ASSERT(stateGpu, "stateGpu should be valid when buffer ops are offloaded");
1473             nbv->convertCoordinatesGpu(AtomLocality::Local, stateGpu->getCoordinates(), localXReadyOnDevice);
1474         }
1475         else
1476         {
1477             if (simulationWork.useGpuUpdate)
1478             {
1479                 GMX_ASSERT(stateGpu, "need a valid stateGpu object");
1480                 GMX_ASSERT(haveCopiedXFromGpu,
1481                            "a wait should only be triggered if copy has been scheduled");
1482                 stateGpu->waitCoordinatesReadyOnHost(AtomLocality::Local);
1483             }
1484             nbv->convertCoordinates(AtomLocality::Local, x.unpaddedArrayRef());
1485         }
1486     }
1487
1488     if (simulationWork.useGpuNonbonded && (stepWork.computeNonbondedForces || domainWork.haveGpuBondedWork))
1489     {
1490         ddBalanceRegionHandler.openBeforeForceComputationGpu();
1491
1492         wallcycle_start(wcycle, WallCycleCounter::LaunchGpu);
1493         wallcycle_sub_start(wcycle, WallCycleSubCounter::LaunchGpuNonBonded);
1494         Nbnxm::gpu_upload_shiftvec(nbv->gpu_nbv, nbv->nbat.get());
1495         if (stepWork.doNeighborSearch || !stepWork.useGpuXBufferOps)
1496         {
1497             Nbnxm::gpu_copy_xq_to_gpu(nbv->gpu_nbv, nbv->nbat.get(), AtomLocality::Local);
1498         }
1499         wallcycle_sub_stop(wcycle, WallCycleSubCounter::LaunchGpuNonBonded);
1500         wallcycle_stop(wcycle, WallCycleCounter::LaunchGpu);
1501         // with X buffer ops offloaded to the GPU on all but the search steps
1502
1503         // bonded work not split into separate local and non-local, so with DD
1504         // we can only launch the kernel after non-local coordinates have been received.
1505         if (domainWork.haveGpuBondedWork && !havePPDomainDecomposition(cr))
1506         {
1507             fr->gpuBonded->setPbcAndlaunchKernel(fr->pbcType, box, fr->bMolPBC, stepWork);
1508         }
1509
1510         /* launch local nonbonded work on GPU */
1511         wallcycle_start_nocount(wcycle, WallCycleCounter::LaunchGpu);
1512         wallcycle_sub_start_nocount(wcycle, WallCycleSubCounter::LaunchGpuNonBonded);
1513         do_nb_verlet(fr, ic, enerd, stepWork, InteractionLocality::Local, enbvClearFNo, step, nrnb, wcycle);
1514         wallcycle_sub_stop(wcycle, WallCycleSubCounter::LaunchGpuNonBonded);
1515         wallcycle_stop(wcycle, WallCycleCounter::LaunchGpu);
1516     }
1517
1518     if (stepWork.haveGpuPmeOnThisRank)
1519     {
1520         // In PME GPU and mixed mode we launch FFT / gather after the
1521         // X copy/transform to allow overlap as well as after the GPU NB
1522         // launch to avoid FFT launch overhead hijacking the CPU and delaying
1523         // the nonbonded kernel.
1524         launchPmeGpuFftAndGather(fr->pmedata,
1525                                  lambda[static_cast<int>(FreeEnergyPerturbationCouplingType::Coul)],
1526                                  wcycle,
1527                                  stepWork);
1528     }
1529
1530     /* Communicate coordinates and sum dipole if necessary +
1531        do non-local pair search */
1532     if (havePPDomainDecomposition(cr))
1533     {
1534         if (stepWork.doNeighborSearch)
1535         {
1536             // TODO: fuse this branch with the above large stepWork.doNeighborSearch block
1537             wallcycle_start_nocount(wcycle, WallCycleCounter::NS);
1538             wallcycle_sub_start(wcycle, WallCycleSubCounter::NBSSearchNonLocal);
1539             /* Note that with a GPU the launch overhead of the list transfer is not timed separately */
1540             nbv->constructPairlist(InteractionLocality::NonLocal, top->excls, step, nrnb);
1541
1542             nbv->setupGpuShortRangeWork(fr->gpuBonded, InteractionLocality::NonLocal);
1543             wallcycle_sub_stop(wcycle, WallCycleSubCounter::NBSSearchNonLocal);
1544             wallcycle_stop(wcycle, WallCycleCounter::NS);
1545             // TODO refactor this GPU halo exchange re-initialisation
1546             // to location in do_md where GPU halo exchange is
1547             // constructed at partitioning, after above stateGpu
1548             // re-initialization has similarly been refactored
1549             if (simulationWork.useGpuHaloExchange)
1550             {
1551                 reinitGpuHaloExchange(*cr, stateGpu->getCoordinates(), stateGpu->getForces());
1552             }
1553         }
1554         else
1555         {
1556             if (stepWork.useGpuXHalo)
1557             {
1558                 // The following must be called after local setCoordinates (which records an event
1559                 // when the coordinate data has been copied to the device).
1560                 communicateGpuHaloCoordinates(*cr, box, localXReadyOnDevice);
1561
1562                 if (domainWork.haveCpuBondedWork || domainWork.haveFreeEnergyWork)
1563                 {
1564                     // non-local part of coordinate buffer must be copied back to host for CPU work
1565                     stateGpu->copyCoordinatesFromGpu(x.unpaddedArrayRef(), AtomLocality::NonLocal);
1566                 }
1567             }
1568             else
1569             {
1570                 if (simulationWork.useGpuUpdate)
1571                 {
1572                     GMX_ASSERT(haveCopiedXFromGpu,
1573                                "a wait should only be triggered if copy has been scheduled");
1574                     stateGpu->waitCoordinatesReadyOnHost(AtomLocality::Local);
1575                 }
1576                 dd_move_x(cr->dd, box, x.unpaddedArrayRef(), wcycle);
1577             }
1578
1579             if (stepWork.useGpuXBufferOps)
1580             {
1581                 if (!stepWork.haveGpuPmeOnThisRank && !stepWork.useGpuXHalo)
1582                 {
1583                     stateGpu->copyCoordinatesToGpu(x.unpaddedArrayRef(), AtomLocality::NonLocal);
1584                 }
1585                 nbv->convertCoordinatesGpu(AtomLocality::NonLocal,
1586                                            stateGpu->getCoordinates(),
1587                                            stateGpu->getCoordinatesReadyOnDeviceEvent(
1588                                                    AtomLocality::NonLocal, simulationWork, stepWork));
1589             }
1590             else
1591             {
1592                 nbv->convertCoordinates(AtomLocality::NonLocal, x.unpaddedArrayRef());
1593             }
1594         }
1595
1596         if (simulationWork.useGpuNonbonded)
1597         {
1598
1599             if (stepWork.doNeighborSearch || !stepWork.useGpuXBufferOps)
1600             {
1601                 wallcycle_start(wcycle, WallCycleCounter::LaunchGpu);
1602                 wallcycle_sub_start(wcycle, WallCycleSubCounter::LaunchGpuNonBonded);
1603                 Nbnxm::gpu_copy_xq_to_gpu(nbv->gpu_nbv, nbv->nbat.get(), AtomLocality::NonLocal);
1604                 wallcycle_sub_stop(wcycle, WallCycleSubCounter::LaunchGpuNonBonded);
1605                 wallcycle_stop(wcycle, WallCycleCounter::LaunchGpu);
1606             }
1607
1608             if (domainWork.haveGpuBondedWork)
1609             {
1610                 fr->gpuBonded->setPbcAndlaunchKernel(fr->pbcType, box, fr->bMolPBC, stepWork);
1611             }
1612
1613             /* launch non-local nonbonded tasks on GPU */
1614             wallcycle_start_nocount(wcycle, WallCycleCounter::LaunchGpu);
1615             wallcycle_sub_start(wcycle, WallCycleSubCounter::LaunchGpuNonBonded);
1616             do_nb_verlet(fr, ic, enerd, stepWork, InteractionLocality::NonLocal, enbvClearFNo, step, nrnb, wcycle);
1617             wallcycle_sub_stop(wcycle, WallCycleSubCounter::LaunchGpuNonBonded);
1618             wallcycle_stop(wcycle, WallCycleCounter::LaunchGpu);
1619         }
1620     }
1621
1622     if (simulationWork.useGpuNonbonded && stepWork.computeNonbondedForces)
1623     {
1624         /* launch D2H copy-back F */
1625         wallcycle_start_nocount(wcycle, WallCycleCounter::LaunchGpu);
1626         wallcycle_sub_start_nocount(wcycle, WallCycleSubCounter::LaunchGpuNonBonded);
1627
1628         if (havePPDomainDecomposition(cr))
1629         {
1630             Nbnxm::gpu_launch_cpyback(nbv->gpu_nbv, nbv->nbat.get(), stepWork, AtomLocality::NonLocal);
1631         }
1632         Nbnxm::gpu_launch_cpyback(nbv->gpu_nbv, nbv->nbat.get(), stepWork, AtomLocality::Local);
1633         wallcycle_sub_stop(wcycle, WallCycleSubCounter::LaunchGpuNonBonded);
1634
1635         if (domainWork.haveGpuBondedWork && stepWork.computeEnergy)
1636         {
1637             fr->gpuBonded->launchEnergyTransfer();
1638         }
1639         wallcycle_stop(wcycle, WallCycleCounter::LaunchGpu);
1640     }
1641
1642     gmx::ArrayRef<const gmx::RVec> xWholeMolecules;
1643     if (fr->wholeMoleculeTransform)
1644     {
1645         xWholeMolecules = fr->wholeMoleculeTransform->wholeMoleculeCoordinates(x.unpaddedArrayRef(), box);
1646     }
1647
1648     DipoleData dipoleData;
1649
1650     if (simulationWork.computeMuTot)
1651     {
1652         const int start = 0;
1653
1654         if (simulationWork.useGpuUpdate && !stepWork.doNeighborSearch)
1655         {
1656             GMX_ASSERT(haveCopiedXFromGpu,
1657                        "a wait should only be triggered if copy has been scheduled");
1658             stateGpu->waitCoordinatesReadyOnHost(AtomLocality::Local);
1659         }
1660
1661         /* Calculate total (local) dipole moment in a temporary common array.
1662          * This makes it possible to sum them over nodes faster.
1663          */
1664         gmx::ArrayRef<const gmx::RVec> xRef =
1665                 (xWholeMolecules.empty() ? x.unpaddedArrayRef() : xWholeMolecules);
1666         calc_mu(start,
1667                 mdatoms->homenr,
1668                 xRef,
1669                 mdatoms->chargeA ? gmx::arrayRefFromArray(mdatoms->chargeA, mdatoms->nr)
1670                                  : gmx::ArrayRef<real>{},
1671                 mdatoms->chargeB ? gmx::arrayRefFromArray(mdatoms->chargeB, mdatoms->nr)
1672                                  : gmx::ArrayRef<real>{},
1673                 mdatoms->nChargePerturbed != 0,
1674                 dipoleData.muStaging[0],
1675                 dipoleData.muStaging[1]);
1676
1677         reduceAndUpdateMuTot(
1678                 &dipoleData, cr, (fr->efep != FreeEnergyPerturbationType::No), lambda, muTotal, ddBalanceRegionHandler);
1679     }
1680
1681     /* Reset energies */
1682     reset_enerdata(enerd);
1683
1684     if (DOMAINDECOMP(cr) && !thisRankHasDuty(cr, DUTY_PME))
1685     {
1686         wallcycle_start(wcycle, WallCycleCounter::PpDuringPme);
1687         dd_force_flop_start(cr->dd, nrnb);
1688     }
1689
1690     // For the rest of the CPU tasks that depend on GPU-update produced coordinates,
1691     // this wait ensures that the D2H transfer is complete.
1692     if (simulationWork.useGpuUpdate && !stepWork.doNeighborSearch
1693         && (runScheduleWork->domainWork.haveCpuLocalForceWork || stepWork.computeVirial))
1694     {
1695         GMX_ASSERT(haveCopiedXFromGpu, "a wait should only be triggered if copy has been scheduled");
1696         stateGpu->waitCoordinatesReadyOnHost(AtomLocality::Local);
1697     }
1698
1699     if (inputrec.bRot)
1700     {
1701         wallcycle_start(wcycle, WallCycleCounter::Rot);
1702         do_rotation(cr, enforcedRotation, box, x.unpaddedConstArrayRef(), t, step, stepWork.doNeighborSearch);
1703         wallcycle_stop(wcycle, WallCycleCounter::Rot);
1704     }
1705
1706     /* Start the force cycle counter.
1707      * Note that a different counter is used for dynamic load balancing.
1708      */
1709     wallcycle_start(wcycle, WallCycleCounter::Force);
1710
1711     /* Set up and clear force outputs:
1712      * forceOutMtsLevel0:  everything except what is in the other two outputs
1713      * forceOutMtsLevel1:  PME-mesh and listed-forces group 1
1714      * forceOutNonbonded: non-bonded forces
1715      * Without multiple time stepping all point to the same object.
1716      * With multiple time-stepping the use is different for MTS fast (level0 only) and slow steps.
1717      */
1718     ForceOutputs forceOutMtsLevel0 = setupForceOutputs(
1719             &fr->forceHelperBuffers[0], force, domainWork, stepWork, havePPDomainDecomposition(cr), wcycle);
1720
1721     // Force output for MTS combined forces, only set at level1 MTS steps
1722     std::optional<ForceOutputs> forceOutMts =
1723             (fr->useMts && stepWork.computeSlowForces)
1724                     ? std::optional(setupForceOutputs(&fr->forceHelperBuffers[1],
1725                                                       forceView->forceMtsCombinedWithPadding(),
1726                                                       domainWork,
1727                                                       stepWork,
1728                                                       havePPDomainDecomposition(cr),
1729                                                       wcycle))
1730                     : std::nullopt;
1731
1732     ForceOutputs* forceOutMtsLevel1 =
1733             fr->useMts ? (stepWork.computeSlowForces ? &forceOutMts.value() : nullptr) : &forceOutMtsLevel0;
1734
1735     const bool nonbondedAtMtsLevel1 = runScheduleWork->simulationWork.computeNonbondedAtMtsLevel1;
1736
1737     ForceOutputs* forceOutNonbonded = nonbondedAtMtsLevel1 ? forceOutMtsLevel1 : &forceOutMtsLevel0;
1738
1739     if (inputrec.bPull && pull_have_constraint(*pull_work))
1740     {
1741         clear_pull_forces(pull_work);
1742     }
1743
1744     /* We calculate the non-bonded forces, when done on the CPU, here.
1745      * We do this before calling do_force_lowlevel, because in that
1746      * function, the listed forces are calculated before PME, which
1747      * does communication.  With this order, non-bonded and listed
1748      * force calculation imbalance can be balanced out by the domain
1749      * decomposition load balancing.
1750      */
1751
1752     const bool useOrEmulateGpuNb = simulationWork.useGpuNonbonded || fr->nbv->emulateGpu();
1753
1754     if (!useOrEmulateGpuNb)
1755     {
1756         do_nb_verlet(fr, ic, enerd, stepWork, InteractionLocality::Local, enbvClearFYes, step, nrnb, wcycle);
1757     }
1758
1759     if (fr->efep != FreeEnergyPerturbationType::No && stepWork.computeNonbondedForces)
1760     {
1761         /* Calculate the local and non-local free energy interactions here.
1762          * Happens here on the CPU both with and without GPU.
1763          */
1764         nbv->dispatchFreeEnergyKernel(
1765                 InteractionLocality::Local,
1766                 *fr,
1767                 x.unpaddedArrayRef(),
1768                 &forceOutNonbonded->forceWithShiftForces(),
1769                 mdatoms->chargeA ? gmx::arrayRefFromArray(mdatoms->chargeA, mdatoms->nr)
1770                                  : gmx::ArrayRef<real>{},
1771                 mdatoms->chargeB ? gmx::arrayRefFromArray(mdatoms->chargeB, mdatoms->nr)
1772                                  : gmx::ArrayRef<real>{},
1773                 mdatoms->typeA ? gmx::arrayRefFromArray(mdatoms->typeA, mdatoms->nr)
1774                                : gmx::ArrayRef<int>{},
1775                 mdatoms->typeB ? gmx::arrayRefFromArray(mdatoms->typeB, mdatoms->nr)
1776                                : gmx::ArrayRef<int>{},
1777                 inputrec.fepvals.get(),
1778                 lambda,
1779                 enerd,
1780                 stepWork,
1781                 nrnb);
1782
1783         if (havePPDomainDecomposition(cr))
1784         {
1785             nbv->dispatchFreeEnergyKernel(
1786                     InteractionLocality::NonLocal,
1787                     *fr,
1788                     x.unpaddedArrayRef(),
1789                     &forceOutNonbonded->forceWithShiftForces(),
1790                     mdatoms->chargeA ? gmx::arrayRefFromArray(mdatoms->chargeA, mdatoms->nr)
1791                                      : gmx::ArrayRef<real>{},
1792                     mdatoms->chargeB ? gmx::arrayRefFromArray(mdatoms->chargeB, mdatoms->nr)
1793                                      : gmx::ArrayRef<real>{},
1794                     mdatoms->typeA ? gmx::arrayRefFromArray(mdatoms->typeA, mdatoms->nr)
1795                                    : gmx::ArrayRef<int>{},
1796                     mdatoms->typeB ? gmx::arrayRefFromArray(mdatoms->typeB, mdatoms->nr)
1797                                    : gmx::ArrayRef<int>{},
1798                     inputrec.fepvals.get(),
1799                     lambda,
1800                     enerd,
1801                     stepWork,
1802                     nrnb);
1803         }
1804     }
1805
1806     if (stepWork.computeNonbondedForces && !useOrEmulateGpuNb)
1807     {
1808         if (havePPDomainDecomposition(cr))
1809         {
1810             do_nb_verlet(fr, ic, enerd, stepWork, InteractionLocality::NonLocal, enbvClearFNo, step, nrnb, wcycle);
1811         }
1812
1813         if (stepWork.computeForces)
1814         {
1815             /* Add all the non-bonded force to the normal force array.
1816              * This can be split into a local and a non-local part when overlapping
1817              * communication with calculation with domain decomposition.
1818              */
1819             wallcycle_stop(wcycle, WallCycleCounter::Force);
1820             nbv->atomdata_add_nbat_f_to_f(AtomLocality::All,
1821                                           forceOutNonbonded->forceWithShiftForces().force());
1822             wallcycle_start_nocount(wcycle, WallCycleCounter::Force);
1823         }
1824
1825         /* If there are multiple fshift output buffers we need to reduce them */
1826         if (stepWork.computeVirial)
1827         {
1828             /* This is not in a subcounter because it takes a
1829                negligible and constant-sized amount of time */
1830             nbnxn_atomdata_add_nbat_fshift_to_fshift(
1831                     *nbv->nbat, forceOutNonbonded->forceWithShiftForces().shiftForces());
1832         }
1833     }
1834
1835     // TODO Force flags should include haveFreeEnergyWork for this domain
1836     if (stepWork.useGpuXHalo && (domainWork.haveCpuBondedWork || domainWork.haveFreeEnergyWork))
1837     {
1838         wallcycle_stop(wcycle, WallCycleCounter::Force);
1839         /* Wait for non-local coordinate data to be copied from device */
1840         stateGpu->waitCoordinatesReadyOnHost(AtomLocality::NonLocal);
1841         wallcycle_start_nocount(wcycle, WallCycleCounter::Force);
1842     }
1843
1844     // Compute wall interactions, when present.
1845     // Note: should be moved to special forces.
1846     if (inputrec.nwall && stepWork.computeNonbondedForces)
1847     {
1848         /* foreign lambda component for walls */
1849         real dvdl_walls = do_walls(inputrec,
1850                                    *fr,
1851                                    box,
1852                                    mdatoms->typeA ? gmx::arrayRefFromArray(mdatoms->typeA, mdatoms->nr)
1853                                                   : gmx::ArrayRef<int>{},
1854                                    mdatoms->typeB ? gmx::arrayRefFromArray(mdatoms->typeB, mdatoms->nr)
1855                                                   : gmx::ArrayRef<int>{},
1856                                    mdatoms->cENER ? gmx::arrayRefFromArray(mdatoms->cENER, mdatoms->nr)
1857                                                   : gmx::ArrayRef<unsigned short>{},
1858                                    mdatoms->homenr,
1859                                    mdatoms->nPerturbed,
1860                                    x.unpaddedConstArrayRef(),
1861                                    &forceOutMtsLevel0.forceWithVirial(),
1862                                    lambda[static_cast<int>(FreeEnergyPerturbationCouplingType::Vdw)],
1863                                    enerd->grpp.energyGroupPairTerms[NonBondedEnergyTerms::LJSR],
1864                                    nrnb);
1865         enerd->dvdl_lin[FreeEnergyPerturbationCouplingType::Vdw] += dvdl_walls;
1866     }
1867
1868     if (stepWork.computeListedForces)
1869     {
1870         /* Check whether we need to take into account PBC in listed interactions */
1871         bool needMolPbc = false;
1872         for (const auto& listedForces : fr->listedForces)
1873         {
1874             if (listedForces.haveCpuListedForces(*fr->fcdata))
1875             {
1876                 needMolPbc = fr->bMolPBC;
1877             }
1878         }
1879
1880         t_pbc pbc;
1881
1882         if (needMolPbc)
1883         {
1884             /* Since all atoms are in the rectangular or triclinic unit-cell,
1885              * only single box vector shifts (2 in x) are required.
1886              */
1887             set_pbc_dd(&pbc, fr->pbcType, DOMAINDECOMP(cr) ? cr->dd->numCells : nullptr, TRUE, box);
1888         }
1889
1890         for (int mtsIndex = 0; mtsIndex < (fr->useMts && stepWork.computeSlowForces ? 2 : 1); mtsIndex++)
1891         {
1892             ListedForces& listedForces = fr->listedForces[mtsIndex];
1893             ForceOutputs& forceOut     = (mtsIndex == 0 ? forceOutMtsLevel0 : *forceOutMtsLevel1);
1894             listedForces.calculate(wcycle,
1895                                    box,
1896                                    inputrec.fepvals.get(),
1897                                    cr,
1898                                    ms,
1899                                    x,
1900                                    xWholeMolecules,
1901                                    fr->fcdata.get(),
1902                                    hist,
1903                                    &forceOut,
1904                                    fr,
1905                                    &pbc,
1906                                    enerd,
1907                                    nrnb,
1908                                    lambda,
1909                                    mdatoms,
1910                                    DOMAINDECOMP(cr) ? cr->dd->globalAtomIndices.data() : nullptr,
1911                                    stepWork);
1912         }
1913     }
1914
1915     if (stepWork.computeSlowForces)
1916     {
1917         calculateLongRangeNonbondeds(fr,
1918                                      inputrec,
1919                                      cr,
1920                                      nrnb,
1921                                      wcycle,
1922                                      mdatoms,
1923                                      x.unpaddedConstArrayRef(),
1924                                      &forceOutMtsLevel1->forceWithVirial(),
1925                                      enerd,
1926                                      box,
1927                                      lambda,
1928                                      dipoleData.muStateAB,
1929                                      stepWork,
1930                                      ddBalanceRegionHandler);
1931     }
1932
1933     wallcycle_stop(wcycle, WallCycleCounter::Force);
1934
1935     // VdW dispersion correction, only computed on master rank to avoid double counting
1936     if ((stepWork.computeEnergy || stepWork.computeVirial) && fr->dispersionCorrection && MASTER(cr))
1937     {
1938         // Calculate long range corrections to pressure and energy
1939         const DispersionCorrection::Correction correction = fr->dispersionCorrection->calculate(
1940                 box, lambda[static_cast<int>(FreeEnergyPerturbationCouplingType::Vdw)]);
1941
1942         if (stepWork.computeEnergy)
1943         {
1944             enerd->term[F_DISPCORR] = correction.energy;
1945             enerd->term[F_DVDL_VDW] += correction.dvdl;
1946             enerd->dvdl_lin[FreeEnergyPerturbationCouplingType::Vdw] += correction.dvdl;
1947         }
1948         if (stepWork.computeVirial)
1949         {
1950             correction.correctVirial(vir_force);
1951             enerd->term[F_PDISPCORR] = correction.pressure;
1952         }
1953     }
1954
1955     computeSpecialForces(fplog,
1956                          cr,
1957                          inputrec,
1958                          awh,
1959                          enforcedRotation,
1960                          imdSession,
1961                          pull_work,
1962                          step,
1963                          t,
1964                          wcycle,
1965                          fr->forceProviders,
1966                          box,
1967                          x.unpaddedArrayRef(),
1968                          mdatoms,
1969                          lambda,
1970                          stepWork,
1971                          &forceOutMtsLevel0.forceWithVirial(),
1972                          forceOutMtsLevel1 ? &forceOutMtsLevel1->forceWithVirial() : nullptr,
1973                          enerd,
1974                          ed,
1975                          stepWork.doNeighborSearch);
1976
1977     if (havePPDomainDecomposition(cr) && stepWork.computeForces && stepWork.useGpuFHalo
1978         && domainWork.haveCpuLocalForceWork)
1979     {
1980         stateGpu->copyForcesToGpu(forceOutMtsLevel0.forceWithShiftForces().force(), AtomLocality::Local);
1981     }
1982
1983     GMX_ASSERT(!(nonbondedAtMtsLevel1 && stepWork.useGpuFBufferOps),
1984                "The schedule below does not allow for nonbonded MTS with GPU buffer ops");
1985     GMX_ASSERT(!(nonbondedAtMtsLevel1 && stepWork.useGpuFHalo),
1986                "The schedule below does not allow for nonbonded MTS with GPU halo exchange");
1987     // Will store the amount of cycles spent waiting for the GPU that
1988     // will be later used in the DLB accounting.
1989     float cycles_wait_gpu = 0;
1990     if (useOrEmulateGpuNb && stepWork.computeNonbondedForces)
1991     {
1992         auto& forceWithShiftForces = forceOutNonbonded->forceWithShiftForces();
1993
1994         /* wait for non-local forces (or calculate in emulation mode) */
1995         if (havePPDomainDecomposition(cr))
1996         {
1997             if (simulationWork.useGpuNonbonded)
1998             {
1999                 cycles_wait_gpu += Nbnxm::gpu_wait_finish_task(
2000                         nbv->gpu_nbv,
2001                         stepWork,
2002                         AtomLocality::NonLocal,
2003                         enerd->grpp.energyGroupPairTerms[NonBondedEnergyTerms::LJSR].data(),
2004                         enerd->grpp.energyGroupPairTerms[NonBondedEnergyTerms::CoulombSR].data(),
2005                         forceWithShiftForces.shiftForces(),
2006                         wcycle);
2007             }
2008             else
2009             {
2010                 wallcycle_start_nocount(wcycle, WallCycleCounter::Force);
2011                 do_nb_verlet(
2012                         fr, ic, enerd, stepWork, InteractionLocality::NonLocal, enbvClearFYes, step, nrnb, wcycle);
2013                 wallcycle_stop(wcycle, WallCycleCounter::Force);
2014             }
2015
2016             if (stepWork.useGpuFBufferOps)
2017             {
2018                 // TODO: move this into DomainLifetimeWorkload, including the second part of the
2019                 // condition The bonded and free energy CPU tasks can have non-local force
2020                 // contributions which are a dependency for the GPU force reduction.
2021                 bool haveNonLocalForceContribInCpuBuffer =
2022                         domainWork.haveCpuBondedWork || domainWork.haveFreeEnergyWork;
2023
2024                 if (haveNonLocalForceContribInCpuBuffer)
2025                 {
2026                     stateGpu->copyForcesToGpu(forceOutMtsLevel0.forceWithShiftForces().force(),
2027                                               AtomLocality::NonLocal);
2028                 }
2029
2030
2031                 fr->gpuForceReduction[gmx::AtomLocality::NonLocal]->execute();
2032
2033                 if (!stepWork.useGpuFHalo)
2034                 {
2035                     // copy from GPU input for dd_move_f()
2036                     stateGpu->copyForcesFromGpu(forceOutMtsLevel0.forceWithShiftForces().force(),
2037                                                 AtomLocality::NonLocal);
2038                 }
2039             }
2040             else
2041             {
2042                 nbv->atomdata_add_nbat_f_to_f(AtomLocality::NonLocal, forceWithShiftForces.force());
2043             }
2044
2045             if (fr->nbv->emulateGpu() && stepWork.computeVirial)
2046             {
2047                 nbnxn_atomdata_add_nbat_fshift_to_fshift(*nbv->nbat, forceWithShiftForces.shiftForces());
2048             }
2049         }
2050     }
2051
2052     /* Combining the forces for multiple time stepping before the halo exchange, when possible,
2053      * avoids an extra halo exchange (when DD is used) and post-processing step.
2054      */
2055     const bool combineMtsForcesBeforeHaloExchange =
2056             (stepWork.computeForces && fr->useMts && stepWork.computeSlowForces && stepWork.useOnlyMtsCombinedForceBuffer
2057              && !(stepWork.computeVirial || simulationWork.useGpuNonbonded || stepWork.haveGpuPmeOnThisRank));
2058     if (combineMtsForcesBeforeHaloExchange)
2059     {
2060         const int numAtoms = havePPDomainDecomposition(cr) ? dd_numAtomsZones(*cr->dd) : mdatoms->homenr;
2061         combineMtsForces(numAtoms,
2062                          force.unpaddedArrayRef(),
2063                          forceView->forceMtsCombined(),
2064                          inputrec.mtsLevels[1].stepFactor);
2065     }
2066
2067     if (havePPDomainDecomposition(cr))
2068     {
2069         /* We are done with the CPU compute.
2070          * We will now communicate the non-local forces.
2071          * If we use a GPU this will overlap with GPU work, so in that case
2072          * we do not close the DD force balancing region here.
2073          */
2074         ddBalanceRegionHandler.closeAfterForceComputationCpu();
2075
2076         if (stepWork.computeForces)
2077         {
2078
2079             if (stepWork.useGpuFHalo)
2080             {
2081                 // If there exist CPU forces, data from halo exchange should accumulate into these
2082                 bool accumulateForces = domainWork.haveCpuLocalForceWork;
2083                 if (!accumulateForces)
2084                 {
2085                     // Force halo exchange will set a subset of local atoms with remote non-local data
2086                     // First clear local portion of force array, so that untouched atoms are zero
2087                     stateGpu->clearForcesOnGpu(AtomLocality::Local);
2088                 }
2089                 communicateGpuHaloForces(*cr, accumulateForces);
2090             }
2091             else
2092             {
2093                 if (stepWork.useGpuFBufferOps)
2094                 {
2095                     stateGpu->waitForcesReadyOnHost(AtomLocality::NonLocal);
2096                 }
2097
2098                 // Without MTS or with MTS at slow steps with uncombined forces we need to
2099                 // communicate the fast forces
2100                 if (!fr->useMts || !combineMtsForcesBeforeHaloExchange)
2101                 {
2102                     dd_move_f(cr->dd, &forceOutMtsLevel0.forceWithShiftForces(), wcycle);
2103                 }
2104                 // With MTS we need to communicate the slow or combined (in forceOutMtsLevel1) forces
2105                 if (fr->useMts && stepWork.computeSlowForces)
2106                 {
2107                     dd_move_f(cr->dd, &forceOutMtsLevel1->forceWithShiftForces(), wcycle);
2108                 }
2109             }
2110         }
2111     }
2112
2113     // With both nonbonded and PME offloaded a GPU on the same rank, we use
2114     // an alternating wait/reduction scheme.
2115     bool alternateGpuWait =
2116             (!c_disableAlternatingWait && stepWork.haveGpuPmeOnThisRank
2117              && simulationWork.useGpuNonbonded && !DOMAINDECOMP(cr) && !stepWork.useGpuFBufferOps);
2118     if (alternateGpuWait)
2119     {
2120         alternatePmeNbGpuWaitReduce(fr->nbv.get(),
2121                                     fr->pmedata,
2122                                     forceOutNonbonded,
2123                                     forceOutMtsLevel1,
2124                                     enerd,
2125                                     lambda[static_cast<int>(FreeEnergyPerturbationCouplingType::Coul)],
2126                                     stepWork,
2127                                     wcycle);
2128     }
2129
2130     if (!alternateGpuWait && stepWork.haveGpuPmeOnThisRank)
2131     {
2132         pme_gpu_wait_and_reduce(fr->pmedata,
2133                                 stepWork,
2134                                 wcycle,
2135                                 &forceOutMtsLevel1->forceWithVirial(),
2136                                 enerd,
2137                                 lambda[static_cast<int>(FreeEnergyPerturbationCouplingType::Coul)]);
2138     }
2139
2140     /* Wait for local GPU NB outputs on the non-alternating wait path */
2141     if (!alternateGpuWait && stepWork.computeNonbondedForces && simulationWork.useGpuNonbonded)
2142     {
2143         /* Measured overhead on CUDA and OpenCL with(out) GPU sharing
2144          * is between 0.5 and 1.5 Mcycles. So 2 MCycles is an overestimate,
2145          * but even with a step of 0.1 ms the difference is less than 1%
2146          * of the step time.
2147          */
2148         const float gpuWaitApiOverheadMargin = 2e6F; /* cycles */
2149         const float waitCycles               = Nbnxm::gpu_wait_finish_task(
2150                 nbv->gpu_nbv,
2151                 stepWork,
2152                 AtomLocality::Local,
2153                 enerd->grpp.energyGroupPairTerms[NonBondedEnergyTerms::LJSR].data(),
2154                 enerd->grpp.energyGroupPairTerms[NonBondedEnergyTerms::CoulombSR].data(),
2155                 forceOutNonbonded->forceWithShiftForces().shiftForces(),
2156                 wcycle);
2157
2158         if (ddBalanceRegionHandler.useBalancingRegion())
2159         {
2160             DdBalanceRegionWaitedForGpu waitedForGpu = DdBalanceRegionWaitedForGpu::yes;
2161             if (stepWork.computeForces && waitCycles <= gpuWaitApiOverheadMargin)
2162             {
2163                 /* We measured few cycles, it could be that the kernel
2164                  * and transfer finished earlier and there was no actual
2165                  * wait time, only API call overhead.
2166                  * Then the actual time could be anywhere between 0 and
2167                  * cycles_wait_est. We will use half of cycles_wait_est.
2168                  */
2169                 waitedForGpu = DdBalanceRegionWaitedForGpu::no;
2170             }
2171             ddBalanceRegionHandler.closeAfterForceComputationGpu(cycles_wait_gpu, waitedForGpu);
2172         }
2173     }
2174
2175     if (fr->nbv->emulateGpu())
2176     {
2177         // NOTE: emulation kernel is not included in the balancing region,
2178         // but emulation mode does not target performance anyway
2179         wallcycle_start_nocount(wcycle, WallCycleCounter::Force);
2180         do_nb_verlet(fr,
2181                      ic,
2182                      enerd,
2183                      stepWork,
2184                      InteractionLocality::Local,
2185                      DOMAINDECOMP(cr) ? enbvClearFNo : enbvClearFYes,
2186                      step,
2187                      nrnb,
2188                      wcycle);
2189         wallcycle_stop(wcycle, WallCycleCounter::Force);
2190     }
2191
2192     // If on GPU PME-PP comms path, receive forces from PME before GPU buffer ops
2193     // TODO refactor this and unify with below default-path call to the same function
2194     if (PAR(cr) && !thisRankHasDuty(cr, DUTY_PME) && stepWork.computeSlowForces
2195         && simulationWork.useGpuPmePpCommunication)
2196     {
2197         /* In case of node-splitting, the PP nodes receive the long-range
2198          * forces, virial and energy from the PME nodes here.
2199          */
2200         pme_receive_force_ener(fr,
2201                                cr,
2202                                &forceOutMtsLevel1->forceWithVirial(),
2203                                enerd,
2204                                simulationWork.useGpuPmePpCommunication,
2205                                stepWork.useGpuPmeFReduction,
2206                                wcycle);
2207     }
2208
2209
2210     /* Do the nonbonded GPU (or emulation) force buffer reduction
2211      * on the non-alternating path. */
2212     GMX_ASSERT(!(nonbondedAtMtsLevel1 && stepWork.useGpuFBufferOps),
2213                "The schedule below does not allow for nonbonded MTS with GPU buffer ops");
2214     if (useOrEmulateGpuNb && !alternateGpuWait)
2215     {
2216         if (stepWork.useGpuFBufferOps)
2217         {
2218             ArrayRef<gmx::RVec> forceWithShift = forceOutNonbonded->forceWithShiftForces().force();
2219
2220             // Flag to specify whether the CPU force buffer has contributions to
2221             // local atoms. This depends on whether there are CPU-based force tasks
2222             // or when DD is active the halo exchange has resulted in contributions
2223             // from the non-local part.
2224             const bool haveLocalForceContribInCpuBuffer =
2225                     (domainWork.haveCpuLocalForceWork || havePPDomainDecomposition(cr));
2226
2227             // TODO: move these steps as early as possible:
2228             // - CPU f H2D should be as soon as all CPU-side forces are done
2229             // - wait for force reduction does not need to block host (at least not here, it's sufficient to wait
2230             //   before the next CPU task that consumes the forces: vsite spread or update)
2231             // - copy is not perfomed if GPU force halo exchange is active, because it would overwrite the result
2232             //   of the halo exchange. In that case the copy is instead performed above, before the exchange.
2233             //   These should be unified.
2234             if (haveLocalForceContribInCpuBuffer && !stepWork.useGpuFHalo)
2235             {
2236                 // Note: AtomLocality::All is used for the non-DD case because, as in this
2237                 // case copyForcesToGpu() uses a separate stream, it allows overlap of
2238                 // CPU force H2D with GPU force tasks on all streams including those in the
2239                 // local stream which would otherwise be implicit dependencies for the
2240                 // transfer and would not overlap.
2241                 auto locality = havePPDomainDecomposition(cr) ? AtomLocality::Local : AtomLocality::All;
2242
2243                 stateGpu->copyForcesToGpu(forceWithShift, locality);
2244             }
2245
2246             if (stepWork.computeNonbondedForces)
2247             {
2248                 fr->gpuForceReduction[gmx::AtomLocality::Local]->execute();
2249             }
2250
2251             // Copy forces to host if they are needed for update or if virtual sites are enabled.
2252             // If there are vsites, we need to copy forces every step to spread vsite forces on host.
2253             // TODO: When the output flags will be included in step workload, this copy can be combined with the
2254             //       copy call done in sim_utils(...) for the output.
2255             // NOTE: If there are virtual sites, the forces are modified on host after this D2H copy. Hence,
2256             //       they should not be copied in do_md(...) for the output.
2257             if (!simulationWork.useGpuUpdate
2258                 || (simulationWork.useGpuUpdate && DOMAINDECOMP(cr) && haveHostPmePpComms) || vsite)
2259             {
2260                 stateGpu->copyForcesFromGpu(forceWithShift, AtomLocality::Local);
2261                 stateGpu->waitForcesReadyOnHost(AtomLocality::Local);
2262             }
2263         }
2264         else if (stepWork.computeNonbondedForces)
2265         {
2266             ArrayRef<gmx::RVec> forceWithShift = forceOutNonbonded->forceWithShiftForces().force();
2267             nbv->atomdata_add_nbat_f_to_f(AtomLocality::Local, forceWithShift);
2268         }
2269     }
2270
2271     launchGpuEndOfStepTasks(nbv, fr->gpuBonded, fr->pmedata, enerd, *runScheduleWork, step, wcycle);
2272
2273     if (DOMAINDECOMP(cr))
2274     {
2275         dd_force_flop_stop(cr->dd, nrnb);
2276     }
2277
2278     const bool haveCombinedMtsForces = (stepWork.computeForces && fr->useMts && stepWork.computeSlowForces
2279                                         && combineMtsForcesBeforeHaloExchange);
2280     if (stepWork.computeForces)
2281     {
2282         postProcessForceWithShiftForces(
2283                 nrnb, wcycle, box, x.unpaddedArrayRef(), &forceOutMtsLevel0, vir_force, *mdatoms, *fr, vsite, stepWork);
2284
2285         if (fr->useMts && stepWork.computeSlowForces && !haveCombinedMtsForces)
2286         {
2287             postProcessForceWithShiftForces(
2288                     nrnb, wcycle, box, x.unpaddedArrayRef(), forceOutMtsLevel1, vir_force, *mdatoms, *fr, vsite, stepWork);
2289         }
2290     }
2291
2292     // TODO refactor this and unify with above GPU PME-PP / GPU update path call to the same function
2293     if (PAR(cr) && !thisRankHasDuty(cr, DUTY_PME) && !simulationWork.useGpuPmePpCommunication
2294         && stepWork.computeSlowForces)
2295     {
2296         /* In case of node-splitting, the PP nodes receive the long-range
2297          * forces, virial and energy from the PME nodes here.
2298          */
2299         pme_receive_force_ener(fr,
2300                                cr,
2301                                &forceOutMtsLevel1->forceWithVirial(),
2302                                enerd,
2303                                simulationWork.useGpuPmePpCommunication,
2304                                false,
2305                                wcycle);
2306     }
2307
2308     if (stepWork.computeForces)
2309     {
2310         /* If we don't use MTS or if we already combined the MTS forces before, we only
2311          * need to post-process one ForceOutputs object here, called forceOutCombined,
2312          * otherwise we have to post-process two outputs and then combine them.
2313          */
2314         ForceOutputs& forceOutCombined = (haveCombinedMtsForces ? forceOutMts.value() : forceOutMtsLevel0);
2315         postProcessForces(
2316                 cr, step, nrnb, wcycle, box, x.unpaddedArrayRef(), &forceOutCombined, vir_force, mdatoms, fr, vsite, stepWork);
2317
2318         if (fr->useMts && stepWork.computeSlowForces && !haveCombinedMtsForces)
2319         {
2320             postProcessForces(
2321                     cr, step, nrnb, wcycle, box, x.unpaddedArrayRef(), forceOutMtsLevel1, vir_force, mdatoms, fr, vsite, stepWork);
2322
2323             combineMtsForces(mdatoms->homenr,
2324                              force.unpaddedArrayRef(),
2325                              forceView->forceMtsCombined(),
2326                              inputrec.mtsLevels[1].stepFactor);
2327         }
2328     }
2329
2330     if (stepWork.computeEnergy)
2331     {
2332         /* Compute the final potential energy terms */
2333         accumulatePotentialEnergies(enerd, lambda, inputrec.fepvals.get());
2334
2335         if (!EI_TPI(inputrec.eI))
2336         {
2337             checkPotentialEnergyValidity(step, *enerd, inputrec);
2338         }
2339     }
2340
2341     /* In case we don't have constraints and are using GPUs, the next balancing
2342      * region starts here.
2343      * Some "special" work at the end of do_force_cuts?, such as vsite spread,
2344      * virial calculation and COM pulling, is not thus not included in
2345      * the balance timing, which is ok as most tasks do communication.
2346      */
2347     ddBalanceRegionHandler.openBeforeForceComputationCpu(DdAllowBalanceRegionReopen::no);
2348 }