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,2014,2015,2016,2017,2018,2019, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 #include "gmxpre.h"
  38
  39 #include "config.h"
  40
  41 #include <cmath>
  42 #include <cstdint>
  43 #include <cstdio>
  44 #include <cstring>
  45
  46 #include <array>
  47
  48 #include "gromacs/awh/awh.h"
  49 #include "gromacs/domdec/dlbtiming.h"
  50 #include "gromacs/domdec/domdec.h"
  51 #include "gromacs/domdec/domdec_struct.h"
  52 #include "gromacs/domdec/gpuhaloexchange.h"
  53 #include "gromacs/domdec/partition.h"
  54 #include "gromacs/essentialdynamics/edsam.h"
  55 #include "gromacs/ewald/pme.h"
  56 #include "gromacs/ewald/pme_pp_comm_gpu.h"
  57 #include "gromacs/gmxlib/network.h"
  58 #include "gromacs/gmxlib/nonbonded/nb_free_energy.h"
  59 #include "gromacs/gmxlib/nonbonded/nb_kernel.h"
  60 #include "gromacs/gmxlib/nonbonded/nonbonded.h"
  61 #include "gromacs/gpu_utils/gpu_utils.h"
  62 #include "gromacs/imd/imd.h"
  63 #include "gromacs/listed_forces/disre.h"
  64 #include "gromacs/listed_forces/gpubonded.h"
  65 #include "gromacs/listed_forces/listed_forces.h"
  66 #include "gromacs/listed_forces/manage_threading.h"
  67 #include "gromacs/listed_forces/orires.h"
  68 #include "gromacs/math/arrayrefwithpadding.h"
  69 #include "gromacs/math/functions.h"
  70 #include "gromacs/math/units.h"
  71 #include "gromacs/math/vec.h"
  72 #include "gromacs/math/vecdump.h"
  73 #include "gromacs/mdlib/calcmu.h"
  74 #include "gromacs/mdlib/calcvir.h"
  75 #include "gromacs/mdlib/constr.h"
  76 #include "gromacs/mdlib/enerdata_utils.h"
  77 #include "gromacs/mdlib/force.h"
  78 #include "gromacs/mdlib/forcerec.h"
  79 #include "gromacs/mdlib/gmx_omp_nthreads.h"
  80 #include "gromacs/mdlib/qmmm.h"
  81 #include "gromacs/mdlib/update.h"
  82 #include "gromacs/mdtypes/commrec.h"
  83 #include "gromacs/mdtypes/enerdata.h"
  84 #include "gromacs/mdtypes/forceoutput.h"
  85 #include "gromacs/mdtypes/iforceprovider.h"
  86 #include "gromacs/mdtypes/inputrec.h"
  87 #include "gromacs/mdtypes/md_enums.h"
  88 #include "gromacs/mdtypes/simulation_workload.h"
  89 #include "gromacs/mdtypes/state.h"
  90 #include "gromacs/mdtypes/state_propagator_data_gpu.h"
  91 #include "gromacs/nbnxm/gpu_data_mgmt.h"
  92 #include "gromacs/nbnxm/nbnxm.h"
  93 #include "gromacs/pbcutil/ishift.h"
  94 #include "gromacs/pbcutil/mshift.h"
  95 #include "gromacs/pbcutil/pbc.h"
  96 #include "gromacs/pulling/pull.h"
  97 #include "gromacs/pulling/pull_rotation.h"
  98 #include "gromacs/timing/cyclecounter.h"
  99 #include "gromacs/timing/gpu_timing.h"
 100 #include "gromacs/timing/wallcycle.h"
 101 #include "gromacs/timing/wallcyclereporting.h"
 102 #include "gromacs/timing/walltime_accounting.h"
 103 #include "gromacs/topology/topology.h"
 104 #include "gromacs/utility/arrayref.h"
 105 #include "gromacs/utility/basedefinitions.h"
 106 #include "gromacs/utility/cstringutil.h"
 107 #include "gromacs/utility/exceptions.h"
 108 #include "gromacs/utility/fatalerror.h"
 109 #include "gromacs/utility/fixedcapacityvector.h"
 110 #include "gromacs/utility/gmxassert.h"
 111 #include "gromacs/utility/gmxmpi.h"
 112 #include "gromacs/utility/logger.h"
 113 #include "gromacs/utility/smalloc.h"
 114 #include "gromacs/utility/strconvert.h"
 115 #include "gromacs/utility/sysinfo.h"
 116
 117 using gmx::ForceOutputs;
 118 using gmx::StepWorkload;
 119 using gmx::DomainLifetimeWorkload;
 120 using gmx::SimulationWorkload;
 121 using gmx::AtomLocality;
 122 using gmx::InteractionLocality;
 123
 124 // TODO: this environment variable allows us to verify before release
 125 // that on less common architectures the total cost of polling is not larger than
 126 // a blocking wait (so polling does not introduce overhead when the static
 127 // PME-first ordering would suffice).
 128 static const bool c_disableAlternatingWait = (getenv("GMX_DISABLE_ALTERNATING_GPU_WAIT") != nullptr);
 129
 130 static void sum_forces(rvec f[], gmx::ArrayRef<const gmx::RVec> forceToAdd)
 131 {
 132     const int      end = forceToAdd.size();
 133
 134     int gmx_unused nt = gmx_omp_nthreads_get(emntDefault);
 135 #pragma omp parallel for num_threads(nt) schedule(static)
 136     for (int i = 0; i < end; i++)
 137     {
 138         rvec_inc(f[i], forceToAdd[i]);
 139     }
 140 }
 141
 142 static void calc_virial(int start, int homenr, const rvec x[],
 143                         const gmx::ForceWithShiftForces &forceWithShiftForces,
 144                         tensor vir_part, const t_graph *graph, const matrix box,
 145                         t_nrnb *nrnb, const t_forcerec *fr, int ePBC)
 146 {
 147     /* The short-range virial from surrounding boxes */
 148     const rvec *fshift = as_rvec_array(forceWithShiftForces.shiftForces().data());
 149     calc_vir(SHIFTS, fr->shift_vec, fshift, vir_part, ePBC == epbcSCREW, box);
 150     inc_nrnb(nrnb, eNR_VIRIAL, SHIFTS);
 151
 152     /* Calculate partial virial, for local atoms only, based on short range.
 153      * Total virial is computed in global_stat, called from do_md
 154      */
 155     const rvec *f = as_rvec_array(forceWithShiftForces.force().data());
 156     f_calc_vir(start, start+homenr, x, f, vir_part, graph, box);
 157     inc_nrnb(nrnb, eNR_VIRIAL, homenr);
 158
 159     if (debug)
 160     {
 161         pr_rvecs(debug, 0, "vir_part", vir_part, DIM);
 162     }
 163 }
 164
 165 static void pull_potential_wrapper(const t_commrec *cr,
 166                                    const t_inputrec *ir,
 167                                    const matrix box, gmx::ArrayRef<const gmx::RVec> x,
 168                                    gmx::ForceWithVirial *force,
 169                                    const t_mdatoms *mdatoms,
 170                                    gmx_enerdata_t *enerd,
 171                                    pull_t *pull_work,
 172                                    const real *lambda,
 173                                    double t,
 174                                    gmx_wallcycle_t wcycle)
 175 {
 176     t_pbc  pbc;
 177     real   dvdl;
 178
 179     /* Calculate the center of mass forces, this requires communication,
 180      * which is why pull_potential is called close to other communication.
 181      */
 182     wallcycle_start(wcycle, ewcPULLPOT);
 183     set_pbc(&pbc, ir->ePBC, box);
 184     dvdl                     = 0;
 185     enerd->term[F_COM_PULL] +=
 186         pull_potential(pull_work, mdatoms, &pbc,
 187                        cr, t, lambda[efptRESTRAINT], as_rvec_array(x.data()), force, &dvdl);
 188     enerd->dvdl_lin[efptRESTRAINT] += dvdl;
 189     wallcycle_stop(wcycle, ewcPULLPOT);
 190 }
 191
 192 static void pme_receive_force_ener(t_forcerec           *fr,
 193                                    const t_commrec      *cr,
 194                                    gmx::ForceWithVirial *forceWithVirial,
 195                                    gmx_enerdata_t       *enerd,
 196                                    bool                  useGpuPmePpComms,
 197                                    bool                  receivePmeForceToGpu,
 198                                    gmx_wallcycle_t       wcycle)
 199 {
 200     real   e_q, e_lj, dvdl_q, dvdl_lj;
 201     float  cycles_ppdpme, cycles_seppme;
 202
 203     cycles_ppdpme = wallcycle_stop(wcycle, ewcPPDURINGPME);
 204     dd_cycles_add(cr->dd, cycles_ppdpme, ddCyclPPduringPME);
 205
 206     /* In case of node-splitting, the PP nodes receive the long-range
 207      * forces, virial and energy from the PME nodes here.
 208      */
 209     wallcycle_start(wcycle, ewcPP_PMEWAITRECVF);
 210     dvdl_q  = 0;
 211     dvdl_lj = 0;
 212     gmx_pme_receive_f(fr->pmePpCommGpu.get(),
 213                       cr, forceWithVirial, &e_q, &e_lj, &dvdl_q, &dvdl_lj,
 214                       useGpuPmePpComms, receivePmeForceToGpu, &cycles_seppme);
 215     enerd->term[F_COUL_RECIP] += e_q;
 216     enerd->term[F_LJ_RECIP]   += e_lj;
 217     enerd->dvdl_lin[efptCOUL] += dvdl_q;
 218     enerd->dvdl_lin[efptVDW]  += dvdl_lj;
 219
 220     if (wcycle)
 221     {
 222         dd_cycles_add(cr->dd, cycles_seppme, ddCyclPME);
 223     }
 224     wallcycle_stop(wcycle, ewcPP_PMEWAITRECVF);
 225 }
 226
 227 static void print_large_forces(FILE            *fp,
 228                                const t_mdatoms *md,
 229                                const t_commrec *cr,
 230                                int64_t          step,
 231                                real             forceTolerance,
 232                                const rvec      *x,
 233                                const rvec      *f)
 234 {
 235     real           force2Tolerance = gmx::square(forceTolerance);
 236     gmx::index     numNonFinite    = 0;
 237     for (int i = 0; i < md->homenr; i++)
 238     {
 239         real force2    = norm2(f[i]);
 240         bool nonFinite = !std::isfinite(force2);
 241         if (force2 >= force2Tolerance || nonFinite)
 242         {
 243             fprintf(fp, "step %" PRId64 " atom %6d  x %8.3f %8.3f %8.3f  force %12.5e\n",
 244                     step,
 245                     ddglatnr(cr->dd, i), x[i][XX], x[i][YY], x[i][ZZ], std::sqrt(force2));
 246         }
 247         if (nonFinite)
 248         {
 249             numNonFinite++;
 250         }
 251     }
 252     if (numNonFinite > 0)
 253     {
 254         /* Note that with MPI this fatal call on one rank might interrupt
 255          * the printing on other ranks. But we can only avoid that with
 256          * an expensive MPI barrier that we would need at each step.
 257          */
 258         gmx_fatal(FARGS, "At step %" PRId64 " detected non-finite forces on %td atoms", step, numNonFinite);
 259     }
 260 }
 261
 262 static void post_process_forces(const t_commrec       *cr,
 263                                 int64_t                step,
 264                                 t_nrnb                *nrnb,
 265                                 gmx_wallcycle_t        wcycle,
 266                                 const gmx_localtop_t  *top,
 267                                 const matrix           box,
 268                                 const rvec             x[],
 269                                 ForceOutputs          *forceOutputs,
 270                                 tensor                 vir_force,
 271                                 const t_mdatoms       *mdatoms,
 272                                 const t_graph         *graph,
 273                                 const t_forcerec      *fr,
 274                                 const gmx_vsite_t     *vsite,
 275                                 const StepWorkload    &stepWork)
 276 {
 277     rvec *f = as_rvec_array(forceOutputs->forceWithShiftForces().force().data());
 278
 279     if (fr->haveDirectVirialContributions)
 280     {
 281         auto &forceWithVirial = forceOutputs->forceWithVirial();
 282         rvec *fDirectVir      = as_rvec_array(forceWithVirial.force_.data());
 283
 284         if (vsite)
 285         {
 286             /* Spread the mesh force on virtual sites to the other particles...
 287              * This is parallellized. MPI communication is performed
 288              * if the constructing atoms aren't local.
 289              */
 290             matrix virial = { { 0 } };
 291             spread_vsite_f(vsite, x, fDirectVir, nullptr,
 292                            stepWork.computeVirial, virial,
 293                            nrnb,
 294                            &top->idef, fr->ePBC, fr->bMolPBC, graph, box, cr, wcycle);
 295             forceWithVirial.addVirialContribution(virial);
 296         }
 297
 298         if (stepWork.computeVirial)
 299         {
 300             /* Now add the forces, this is local */
 301             sum_forces(f, forceWithVirial.force_);
 302
 303             /* Add the direct virial contributions */
 304             GMX_ASSERT(forceWithVirial.computeVirial_, "forceWithVirial should request virial computation when we request the virial");
 305             m_add(vir_force, forceWithVirial.getVirial(), vir_force);
 306
 307             if (debug)
 308             {
 309                 pr_rvecs(debug, 0, "vir_force", vir_force, DIM);
 310             }
 311         }
 312     }
 313
 314     if (fr->print_force >= 0)
 315     {
 316         print_large_forces(stderr, mdatoms, cr, step, fr->print_force, x, f);
 317     }
 318 }
 319
 320 static void do_nb_verlet(t_forcerec                       *fr,
 321                          const interaction_const_t        *ic,
 322                          gmx_enerdata_t                   *enerd,
 323                          const StepWorkload               &stepWork,
 324                          const InteractionLocality         ilocality,
 325                          const int                         clearF,
 326                          const int64_t                     step,
 327                          t_nrnb                           *nrnb,
 328                          gmx_wallcycle_t                   wcycle)
 329 {
 330     if (!stepWork.computeNonbondedForces)
 331     {
 332         /* skip non-bonded calculation */
 333         return;
 334     }
 335
 336     nonbonded_verlet_t *nbv  = fr->nbv.get();
 337
 338     /* GPU kernel launch overhead is already timed separately */
 339     if (fr->cutoff_scheme != ecutsVERLET)
 340     {
 341         gmx_incons("Invalid cut-off scheme passed!");
 342     }
 343
 344     if (!nbv->useGpu())
 345     {
 346         /* When dynamic pair-list  pruning is requested, we need to prune
 347          * at nstlistPrune steps.
 348          */
 349         if (nbv->isDynamicPruningStepCpu(step))
 350         {
 351             /* Prune the pair-list beyond fr->ic->rlistPrune using
 352              * the current coordinates of the atoms.
 353              */
 354             wallcycle_sub_start(wcycle, ewcsNONBONDED_PRUNING);
 355             nbv->dispatchPruneKernelCpu(ilocality, fr->shift_vec);
 356             wallcycle_sub_stop(wcycle, ewcsNONBONDED_PRUNING);
 357         }
 358     }
 359
 360     nbv->dispatchNonbondedKernel(ilocality, *ic, stepWork, clearF, *fr, enerd, nrnb);
 361 }
 362
 363 static inline void clear_rvecs_omp(int n, rvec v[])
 364 {
 365     int nth = gmx_omp_nthreads_get_simple_rvec_task(emntDefault, n);
 366
 367     /* Note that we would like to avoid this conditional by putting it
 368      * into the omp pragma instead, but then we still take the full
 369      * omp parallel for overhead (at least with gcc5).
 370      */
 371     if (nth == 1)
 372     {
 373         for (int i = 0; i < n; i++)
 374         {
 375             clear_rvec(v[i]);
 376         }
 377     }
 378     else
 379     {
 380 #pragma omp parallel for num_threads(nth) schedule(static)
 381         for (int i = 0; i < n; i++)
 382         {
 383             clear_rvec(v[i]);
 384         }
 385     }
 386 }
 387
 388 /*! \brief Return an estimate of the average kinetic energy or 0 when unreliable
 389  *
 390  * \param groupOptions  Group options, containing T-coupling options
 391  */
 392 static real averageKineticEnergyEstimate(const t_grpopts &groupOptions)
 393 {
 394     real nrdfCoupled   = 0;
 395     real nrdfUncoupled = 0;
 396     real kineticEnergy = 0;
 397     for (int g = 0; g < groupOptions.ngtc; g++)
 398     {
 399         if (groupOptions.tau_t[g] >= 0)
 400         {
 401             nrdfCoupled   += groupOptions.nrdf[g];
 402             kineticEnergy += groupOptions.nrdf[g]*0.5*groupOptions.ref_t[g]*BOLTZ;
 403         }
 404         else
 405         {
 406             nrdfUncoupled += groupOptions.nrdf[g];
 407         }
 408     }
 409
 410     /* This conditional with > also catches nrdf=0 */
 411     if (nrdfCoupled > nrdfUncoupled)
 412     {
 413         return kineticEnergy*(nrdfCoupled + nrdfUncoupled)/nrdfCoupled;
 414     }
 415     else
 416     {
 417         return 0;
 418     }
 419 }
 420
 421 /*! \brief This routine checks that the potential energy is finite.
 422  *
 423  * Always checks that the potential energy is finite. If step equals
 424  * inputrec.init_step also checks that the magnitude of the potential energy
 425  * is reasonable. Terminates with a fatal error when a check fails.
 426  * Note that passing this check does not guarantee finite forces,
 427  * since those use slightly different arithmetics. But in most cases
 428  * there is just a narrow coordinate range where forces are not finite
 429  * and energies are finite.
 430  *
 431  * \param[in] step      The step number, used for checking and printing
 432  * \param[in] enerd     The energy data; the non-bonded group energies need to be added to enerd.term[F_EPOT] before calling this routine
 433  * \param[in] inputrec  The input record
 434  */
 435 static void checkPotentialEnergyValidity(int64_t               step,
 436                                          const gmx_enerdata_t &enerd,
 437                                          const t_inputrec     &inputrec)
 438 {
 439     /* Threshold valid for comparing absolute potential energy against
 440      * the kinetic energy. Normally one should not consider absolute
 441      * potential energy values, but with a factor of one million
 442      * we should never get false positives.
 443      */
 444     constexpr real c_thresholdFactor = 1e6;
 445
 446     bool           energyIsNotFinite    = !std::isfinite(enerd.term[F_EPOT]);
 447     real           averageKineticEnergy = 0;
 448     /* We only check for large potential energy at the initial step,
 449      * because that is by far the most likely step for this too occur
 450      * and because computing the average kinetic energy is not free.
 451      * Note: nstcalcenergy >> 1 often does not allow to catch large energies
 452      * before they become NaN.
 453      */
 454     if (step == inputrec.init_step && EI_DYNAMICS(inputrec.eI))
 455     {
 456         averageKineticEnergy = averageKineticEnergyEstimate(inputrec.opts);
 457     }
 458
 459     if (energyIsNotFinite || (averageKineticEnergy > 0 &&
 460                               enerd.term[F_EPOT] > c_thresholdFactor*averageKineticEnergy))
 461     {
 462         gmx_fatal(FARGS, "Step %" PRId64 ": The total potential energy is %g, which is %s. The LJ and electrostatic contributions to the energy are %g and %g, respectively. A %s potential energy can be caused by overlapping interactions in bonded interactions or very large%s coordinate values. Usually this is caused by a badly- or non-equilibrated initial configuration, incorrect interactions or parameters in the topology.",
 463                   step,
 464                   enerd.term[F_EPOT],
 465                   energyIsNotFinite ? "not finite" : "extremely high",
 466                   enerd.term[F_LJ],
 467                   enerd.term[F_COUL_SR],
 468                   energyIsNotFinite ? "non-finite" : "very high",
 469                   energyIsNotFinite ? " or Nan" : "");
 470     }
 471 }
 472
 473 /*! \brief Return true if there are special forces computed this step.
 474  *
 475  * The conditionals exactly correspond to those in computeSpecialForces().
 476  */
 477 static bool
 478 haveSpecialForces(const t_inputrec              &inputrec,
 479                   const gmx::ForceProviders     &forceProviders,
 480                   const pull_t                  *pull_work,
 481                   const bool                     computeForces,
 482                   const gmx_edsam               *ed)
 483 {
 484
 485     return
 486         ((computeForces && forceProviders.hasForceProvider()) ||         // forceProviders
 487          (inputrec.bPull && pull_have_potential(pull_work)) ||           // pull
 488          inputrec.bRot ||                                                // enforced rotation
 489          (ed != nullptr) ||                                              // flooding
 490          (inputrec.bIMD && computeForces));                              // IMD
 491 }
 492
 493 /*! \brief Compute forces and/or energies for special algorithms
 494  *
 495  * The intention is to collect all calls to algorithms that compute
 496  * forces on local atoms only and that do not contribute to the local
 497  * virial sum (but add their virial contribution separately).
 498  * Eventually these should likely all become ForceProviders.
 499  * Within this function the intention is to have algorithms that do
 500  * global communication at the end, so global barriers within the MD loop
 501  * are as close together as possible.
 502  *
 503  * \param[in]     fplog            The log file
 504  * \param[in]     cr               The communication record
 505  * \param[in]     inputrec         The input record
 506  * \param[in]     awh              The Awh module (nullptr if none in use).
 507  * \param[in]     enforcedRotation Enforced rotation module.
 508  * \param[in]     imdSession       The IMD session
 509  * \param[in]     pull_work        The pull work structure.
 510  * \param[in]     step             The current MD step
 511  * \param[in]     t                The current time
 512  * \param[in,out] wcycle           Wallcycle accounting struct
 513  * \param[in,out] forceProviders   Pointer to a list of force providers
 514  * \param[in]     box              The unit cell
 515  * \param[in]     x                The coordinates
 516  * \param[in]     mdatoms          Per atom properties
 517  * \param[in]     lambda           Array of free-energy lambda values
 518  * \param[in]     stepWork         Step schedule flags
 519  * \param[in,out] forceWithVirial  Force and virial buffers
 520  * \param[in,out] enerd            Energy buffer
 521  * \param[in,out] ed               Essential dynamics pointer
 522  * \param[in]     didNeighborSearch Tells if we did neighbor searching this step, used for ED sampling
 523  *
 524  * \todo Remove didNeighborSearch, which is used incorrectly.
 525  * \todo Convert all other algorithms called here to ForceProviders.
 526  */
 527 static void
 528 computeSpecialForces(FILE                          *fplog,
 529                      const t_commrec               *cr,
 530                      const t_inputrec              *inputrec,
 531                      gmx::Awh                      *awh,
 532                      gmx_enfrot                    *enforcedRotation,
 533                      gmx::ImdSession               *imdSession,
 534                      pull_t                        *pull_work,
 535                      int64_t                        step,
 536                      double                         t,
 537                      gmx_wallcycle_t                wcycle,
 538                      gmx::ForceProviders           *forceProviders,
 539                      const matrix                   box,
 540                      gmx::ArrayRef<const gmx::RVec> x,
 541                      const t_mdatoms               *mdatoms,
 542                      real                          *lambda,
 543                      const StepWorkload            &stepWork,
 544                      gmx::ForceWithVirial          *forceWithVirial,
 545                      gmx_enerdata_t                *enerd,
 546                      gmx_edsam                     *ed,
 547                      bool                           didNeighborSearch)
 548 {
 549     /* NOTE: Currently all ForceProviders only provide forces.
 550      *       When they also provide energies, remove this conditional.
 551      */
 552     if (stepWork.computeForces)
 553     {
 554         gmx::ForceProviderInput  forceProviderInput(x, *mdatoms, t, box, *cr);
 555         gmx::ForceProviderOutput forceProviderOutput(forceWithVirial, enerd);
 556
 557         /* Collect forces from modules */
 558         forceProviders->calculateForces(forceProviderInput, &forceProviderOutput);
 559     }
 560
 561     if (inputrec->bPull && pull_have_potential(pull_work))
 562     {
 563         pull_potential_wrapper(cr, inputrec, box, x,
 564                                forceWithVirial,
 565                                mdatoms, enerd, pull_work, lambda, t,
 566                                wcycle);
 567
 568         if (awh)
 569         {
 570             enerd->term[F_COM_PULL] +=
 571                 awh->applyBiasForcesAndUpdateBias(inputrec->ePBC, *mdatoms, box,
 572                                                   forceWithVirial,
 573                                                   t, step, wcycle, fplog);
 574         }
 575     }
 576
 577     rvec *f = as_rvec_array(forceWithVirial->force_.data());
 578
 579     /* Add the forces from enforced rotation potentials (if any) */
 580     if (inputrec->bRot)
 581     {
 582         wallcycle_start(wcycle, ewcROTadd);
 583         enerd->term[F_COM_PULL] += add_rot_forces(enforcedRotation, f, cr, step, t);
 584         wallcycle_stop(wcycle, ewcROTadd);
 585     }
 586
 587     if (ed)
 588     {
 589         /* Note that since init_edsam() is called after the initialization
 590          * of forcerec, edsam doesn't request the noVirSum force buffer.
 591          * Thus if no other algorithm (e.g. PME) requires it, the forces
 592          * here will contribute to the virial.
 593          */
 594         do_flood(cr, inputrec, as_rvec_array(x.data()), f, ed, box, step, didNeighborSearch);
 595     }
 596
 597     /* Add forces from interactive molecular dynamics (IMD), if any */
 598     if (inputrec->bIMD && stepWork.computeForces)
 599     {
 600         imdSession->applyForces(f);
 601     }
 602 }
 603
 604 /*! \brief Makes PME flags from StepWorkload data.
 605  *
 606  * \param[in]  stepWork     Step schedule flags
 607  * \returns                 PME flags
 608  */
 609 static int makePmeFlags(const StepWorkload &stepWork)
 610 {
 611     return GMX_PME_SPREAD | GMX_PME_SOLVE |
 612            (stepWork.computeVirial ? GMX_PME_CALC_ENER_VIR : 0) |
 613            (stepWork.computeEnergy ? GMX_PME_CALC_ENER_VIR : 0) |
 614            (stepWork.computeForces ? GMX_PME_CALC_F        : 0);
 615 }
 616
 617 /*! \brief Launch the prepare_step and spread stages of PME GPU.
 618  *
 619  * \param[in]  pmedata              The PME structure
 620  * \param[in]  box                  The box matrix
 621  * \param[in]  stepWork             Step schedule flags
 622  * \param[in]  pmeFlags             PME flags
 623  * \param[in]  xReadyOnDevice       Event synchronizer indicating that the coordinates are ready in the device memory.
 624  * \param[in]  wcycle               The wallcycle structure
 625  */
 626 static inline void launchPmeGpuSpread(gmx_pme_t            *pmedata,
 627                                       const matrix          box,
 628                                       const StepWorkload   &stepWork,
 629                                       int                   pmeFlags,
 630                                       GpuEventSynchronizer *xReadyOnDevice,
 631                                       gmx_wallcycle_t       wcycle)
 632 {
 633     pme_gpu_prepare_computation(pmedata, stepWork.haveDynamicBox, box, wcycle, pmeFlags, stepWork.useGpuPmeFReduction);
 634     pme_gpu_launch_spread(pmedata, xReadyOnDevice, wcycle);
 635 }
 636
 637 /*! \brief Launch the FFT and gather stages of PME GPU
 638  *
 639  * This function only implements setting the output forces (no accumulation).
 640  *
 641  * \param[in]  pmedata        The PME structure
 642  * \param[in]  wcycle         The wallcycle structure
 643  */
 644 static void launchPmeGpuFftAndGather(gmx_pme_t        *pmedata,
 645                                      gmx_wallcycle_t   wcycle)
 646 {
 647     pme_gpu_launch_complex_transforms(pmedata, wcycle);
 648     pme_gpu_launch_gather(pmedata, wcycle, PmeForceOutputHandling::Set);
 649 }
 650
 651 /*! \brief
 652  *  Polling wait for either of the PME or nonbonded GPU tasks.
 653  *
 654  * Instead of a static order in waiting for GPU tasks, this function
 655  * polls checking which of the two tasks completes first, and does the
 656  * associated force buffer reduction overlapped with the other task.
 657  * By doing that, unlike static scheduling order, it can always overlap
 658  * one of the reductions, regardless of the GPU task completion order.
 659  *
 660  * \param[in]     nbv              Nonbonded verlet structure
 661  * \param[in,out] pmedata          PME module data
 662  * \param[in,out] forceOutputs     Output buffer for the forces and virial
 663  * \param[in,out] enerd            Energy data structure results are reduced into
 664  * \param[in]     stepWork         Step schedule flags
 665  * \param[in]     pmeFlags         PME flags
 666  * \param[in]     wcycle           The wallcycle structure
 667  */
 668 static void alternatePmeNbGpuWaitReduce(nonbonded_verlet_t *nbv,
 669                                         gmx_pme_t          *pmedata,
 670                                         gmx::ForceOutputs  *forceOutputs,
 671                                         gmx_enerdata_t     *enerd,
 672                                         const StepWorkload &stepWork,
 673                                         int                 pmeFlags,
 674                                         gmx_wallcycle_t     wcycle)
 675 {
 676     bool isPmeGpuDone = false;
 677     bool isNbGpuDone  = false;
 678
 679
 680
 681     gmx::ForceWithShiftForces      &forceWithShiftForces = forceOutputs->forceWithShiftForces();
 682     gmx::ForceWithVirial           &forceWithVirial      = forceOutputs->forceWithVirial();
 683
 684     gmx::ArrayRef<const gmx::RVec>  pmeGpuForces;
 685
 686     while (!isPmeGpuDone || !isNbGpuDone)
 687     {
 688         if (!isPmeGpuDone)
 689         {
 690             GpuTaskCompletion completionType = (isNbGpuDone) ? GpuTaskCompletion::Wait : GpuTaskCompletion::Check;
 691             isPmeGpuDone = pme_gpu_try_finish_task(pmedata, pmeFlags, wcycle, &forceWithVirial, enerd, completionType);
 692         }
 693
 694         if (!isNbGpuDone)
 695         {
 696             GpuTaskCompletion completionType = (isPmeGpuDone) ? GpuTaskCompletion::Wait : GpuTaskCompletion::Check;
 697             isNbGpuDone = Nbnxm::gpu_try_finish_task(nbv->gpu_nbv,
 698                                                      stepWork,
 699                                                      AtomLocality::Local,
 700                                                      enerd->grpp.ener[egLJSR].data(),
 701                                                      enerd->grpp.ener[egCOULSR].data(),
 702                                                      forceWithShiftForces.shiftForces(), completionType, wcycle);
 703
 704             if (isNbGpuDone)
 705             {
 706                 nbv->atomdata_add_nbat_f_to_f(AtomLocality::Local,
 707                                               forceWithShiftForces.force());
 708             }
 709         }
 710     }
 711 }
 712
 713 /*! \brief Set up the different force buffers; also does clearing.
 714  *
 715  * \param[in] fr        force record pointer
 716  * \param[in] pull_work The pull work object.
 717  * \param[in] inputrec  input record
 718  * \param[in] force     force array
 719  * \param[in] stepWork  Step schedule flags
 720  * \param[out] wcycle   wallcycle recording structure
 721  *
 722  * \returns             Cleared force output structure
 723  */
 724 static ForceOutputs
 725 setupForceOutputs(t_forcerec                          *fr,
 726                   pull_t                              *pull_work,
 727                   const t_inputrec                    &inputrec,
 728                   gmx::ArrayRefWithPadding<gmx::RVec>  force,
 729                   const StepWorkload                  &stepWork,
 730                   gmx_wallcycle_t                      wcycle)
 731 {
 732     wallcycle_sub_start(wcycle, ewcsCLEAR_FORCE_BUFFER);
 733
 734     /* NOTE: We assume fr->shiftForces is all zeros here */
 735     gmx::ForceWithShiftForces forceWithShiftForces(force, stepWork.computeVirial, fr->shiftForces);
 736
 737     if (stepWork.computeForces)
 738     {
 739         /* Clear the short- and long-range forces */
 740         clear_rvecs_omp(fr->natoms_force_constr,
 741                         as_rvec_array(forceWithShiftForces.force().data()));
 742     }
 743
 744     /* If we need to compute the virial, we might need a separate
 745      * force buffer for algorithms for which the virial is calculated
 746      * directly, such as PME. Otherwise, forceWithVirial uses the
 747      * the same force (f in legacy calls) buffer as other algorithms.
 748      */
 749     const bool useSeparateForceWithVirialBuffer = (stepWork.computeForces &&
 750                                                    (stepWork.computeVirial && fr->haveDirectVirialContributions));
 751     /* forceWithVirial uses the local atom range only */
 752     gmx::ForceWithVirial forceWithVirial(useSeparateForceWithVirialBuffer ?
 753                                          fr->forceBufferForDirectVirialContributions : force.unpaddedArrayRef(),
 754                                          stepWork.computeVirial);
 755
 756     if (useSeparateForceWithVirialBuffer)
 757     {
 758         /* TODO: update comment
 759          * We only compute forces on local atoms. Note that vsites can
 760          * spread to non-local atoms, but that part of the buffer is
 761          * cleared separately in the vsite spreading code.
 762          */
 763         clear_rvecs_omp(forceWithVirial.force_.size(), as_rvec_array(forceWithVirial.force_.data()));
 764     }
 765
 766     if (inputrec.bPull && pull_have_constraint(pull_work))
 767     {
 768         clear_pull_forces(pull_work);
 769     }
 770
 771     wallcycle_sub_stop(wcycle, ewcsCLEAR_FORCE_BUFFER);
 772
 773     return ForceOutputs(forceWithShiftForces, forceWithVirial);
 774 }
 775
 776
 777 /*! \brief Set up flags that have the lifetime of the domain indicating what type of work is there to compute.
 778  */
 779 static DomainLifetimeWorkload
 780 setupDomainLifetimeWorkload(const t_inputrec       &inputrec,
 781                             const t_forcerec       &fr,
 782                             const pull_t           *pull_work,
 783                             const gmx_edsam        *ed,
 784                             const t_idef           &idef,
 785                             const t_fcdata         &fcd,
 786                             const t_mdatoms        &mdatoms,
 787                             const StepWorkload     &stepWork)
 788 {
 789     DomainLifetimeWorkload domainWork;
 790     // Note that haveSpecialForces is constant over the whole run
 791     domainWork.haveSpecialForces      = haveSpecialForces(inputrec, *fr.forceProviders, pull_work, stepWork.computeForces, ed);
 792     domainWork.haveCpuBondedWork      = haveCpuBondeds(fr);
 793     domainWork.haveGpuBondedWork      = ((fr.gpuBonded != nullptr) && fr.gpuBonded->haveInteractions());
 794     domainWork.haveRestraintsWork     = haveRestraints(idef, fcd);
 795     domainWork.haveCpuListedForceWork = haveCpuListedForces(fr, idef, fcd);
 796     // Note that haveFreeEnergyWork is constant over the whole run
 797     domainWork.haveFreeEnergyWork     = (fr.efep != efepNO && mdatoms.nPerturbed != 0);
 798     return domainWork;
 799 }
 800
 801 /*! \brief Set up force flag stuct from the force bitmask.
 802  *
 803  * \param[in]      legacyFlags          Force bitmask flags used to construct the new flags
 804  * \param[in]      isNonbondedOn        Global override, if false forces to turn off all nonbonded calculation.
 805  * \param[in]      simulationWork       Simulation workload description.
 806  * \param[in]      rankHasPmeDuty       If this rank computes PME.
 807  *
 808  * \returns New Stepworkload description.
 809  */
 810 static StepWorkload
 811 setupStepWorkload(const int                 legacyFlags,
 812                   const bool                isNonbondedOn,
 813                   const SimulationWorkload &simulationWork,
 814                   const bool                rankHasPmeDuty)
 815 {
 816     StepWorkload flags;
 817     flags.stateChanged           = ((legacyFlags & GMX_FORCE_STATECHANGED) != 0);
 818     flags.haveDynamicBox         = ((legacyFlags & GMX_FORCE_DYNAMICBOX) != 0);
 819     flags.doNeighborSearch       = ((legacyFlags & GMX_FORCE_NS) != 0);
 820     flags.computeVirial          = ((legacyFlags & GMX_FORCE_VIRIAL) != 0);
 821     flags.computeEnergy          = ((legacyFlags & GMX_FORCE_ENERGY) != 0);
 822     flags.computeForces          = ((legacyFlags & GMX_FORCE_FORCES) != 0);
 823     flags.computeListedForces    = ((legacyFlags & GMX_FORCE_LISTED) != 0);
 824     flags.computeNonbondedForces = ((legacyFlags & GMX_FORCE_NONBONDED) != 0) && isNonbondedOn;
 825     flags.computeDhdl            = ((legacyFlags & GMX_FORCE_DHDL) != 0);
 826
 827     if (simulationWork.useGpuBufferOps)
 828     {
 829         GMX_ASSERT(simulationWork.useGpuNonbonded, "Can only offload buffer ops if nonbonded computation is also offloaded");
 830     }
 831     flags.useGpuXBufferOps = simulationWork.useGpuBufferOps;
 832     // on virial steps the CPU reduction path is taken
 833     // TODO: remove flags.computeEnergy, ref #3128
 834     flags.useGpuFBufferOps    = simulationWork.useGpuBufferOps && !(flags.computeVirial || flags.computeEnergy);
 835     flags.useGpuPmeFReduction = flags.useGpuFBufferOps && (simulationWork.usePmeGpu &&
 836                                                            (rankHasPmeDuty || simulationWork.useGpuPmePPCommunication));
 837
 838     return flags;
 839 }
 840
 841
 842 /* \brief Launch end-of-step GPU tasks: buffer clearing and rolling pruning.
 843  *
 844  * TODO: eliminate the \p useGpuNonbonded and \p useGpuNonbonded when these are
 845  * incorporated in DomainLifetimeWorkload.
 846  */
 847 static void
 848 launchGpuEndOfStepTasks(nonbonded_verlet_t               *nbv,
 849                         gmx::GpuBonded                   *gpuBonded,
 850                         gmx_pme_t                        *pmedata,
 851                         gmx_enerdata_t                   *enerd,
 852                         const gmx::MdrunScheduleWorkload &runScheduleWork,
 853                         bool                              useGpuNonbonded,
 854                         bool                              useGpuPme,
 855                         int64_t                           step,
 856                         gmx_wallcycle_t                   wcycle)
 857 {
 858     if (useGpuNonbonded)
 859     {
 860         /* Launch pruning before buffer clearing because the API overhead of the
 861          * clear kernel launches can leave the GPU idle while it could be running
 862          * the prune kernel.
 863          */
 864         if (nbv->isDynamicPruningStepGpu(step))
 865         {
 866             nbv->dispatchPruneKernelGpu(step);
 867         }
 868
 869         /* now clear the GPU outputs while we finish the step on the CPU */
 870         wallcycle_start_nocount(wcycle, ewcLAUNCH_GPU);
 871         wallcycle_sub_start_nocount(wcycle, ewcsLAUNCH_GPU_NONBONDED);
 872         Nbnxm::gpu_clear_outputs(nbv->gpu_nbv, runScheduleWork.stepWork.computeVirial);
 873         wallcycle_sub_stop(wcycle, ewcsLAUNCH_GPU_NONBONDED);
 874         wallcycle_stop(wcycle, ewcLAUNCH_GPU);
 875     }
 876
 877     if (useGpuPme)
 878     {
 879         pme_gpu_reinit_computation(pmedata, wcycle);
 880     }
 881
 882     if (runScheduleWork.domainWork.haveGpuBondedWork && runScheduleWork.stepWork.computeEnergy)
 883     {
 884         // in principle this should be included in the DD balancing region,
 885         // but generally it is infrequent so we'll omit it for the sake of
 886         // simpler code
 887         gpuBonded->waitAccumulateEnergyTerms(enerd);
 888
 889         gpuBonded->clearEnergies();
 890     }
 891 }
 892
 893
 894 void do_force(FILE                                     *fplog,
 895               const t_commrec                          *cr,
 896               const gmx_multisim_t                     *ms,
 897               const t_inputrec                         *inputrec,
 898               gmx::Awh                                 *awh,
 899               gmx_enfrot                               *enforcedRotation,
 900               gmx::ImdSession                          *imdSession,
 901               pull_t                                   *pull_work,
 902               int64_t                                   step,
 903               t_nrnb                                   *nrnb,
 904               gmx_wallcycle_t                           wcycle,
 905               const gmx_localtop_t                     *top,
 906               const matrix                              box,
 907               gmx::ArrayRefWithPadding<gmx::RVec>       x,
 908               history_t                                *hist,
 909               gmx::ArrayRefWithPadding<gmx::RVec>       force,
 910               tensor                                    vir_force,
 911               const t_mdatoms                          *mdatoms,
 912               gmx_enerdata_t                           *enerd,
 913               t_fcdata                                 *fcd,
 914               gmx::ArrayRef<real>                       lambda,
 915               t_graph                                  *graph,
 916               t_forcerec                               *fr,
 917               gmx::MdrunScheduleWorkload               *runScheduleWork,
 918               const gmx_vsite_t                        *vsite,
 919               rvec                                      mu_tot,
 920               double                                    t,
 921               gmx_edsam                                *ed,
 922               int                                       legacyFlags,
 923               const DDBalanceRegionHandler             &ddBalanceRegionHandler)
 924 {
 925     int                          i, j;
 926     double                       mu[2*DIM];
 927     nonbonded_verlet_t          *nbv      = fr->nbv.get();
 928     interaction_const_t         *ic       = fr->ic;
 929     gmx::StatePropagatorDataGpu *stateGpu = fr->stateGpu;
 930
 931     // TODO remove the code below when the legacy flags are not in use anymore
 932     /* modify force flag if not doing nonbonded */
 933     if (!fr->bNonbonded)
 934     {
 935         legacyFlags &= ~GMX_FORCE_NONBONDED;
 936     }
 937
 938     const SimulationWorkload &simulationWork = runScheduleWork->simulationWork;
 939
 940
 941     runScheduleWork->stepWork = setupStepWorkload(legacyFlags, fr->bNonbonded,
 942                                                   simulationWork, thisRankHasDuty(cr, DUTY_PME));
 943     const StepWorkload &stepWork = runScheduleWork->stepWork;
 944
 945
 946     const bool useGpuPmeOnThisRank = simulationWork.usePmeGpu && thisRankHasDuty(cr, DUTY_PME);
 947     const int  pmeFlags            = makePmeFlags(stepWork);
 948
 949     // Switches on whether to use GPU for position and force buffer operations
 950     // TODO consider all possible combinations of triggers, and how to combine optimally in each case.
 951     const BufferOpsUseGpu useGpuXBufOps = stepWork.useGpuXBufferOps ? BufferOpsUseGpu::True : BufferOpsUseGpu::False;
 952     // GPU Force buffer ops are disabled on virial steps, because the virial calc is not yet ported to GPU
 953     const BufferOpsUseGpu useGpuFBufOps = stepWork.useGpuFBufferOps ? BufferOpsUseGpu::True : BufferOpsUseGpu::False;
 954
 955     /* At a search step we need to start the first balancing region
 956      * somewhere early inside the step after communication during domain
 957      * decomposition (and not during the previous step as usual).
 958      */
 959     if (stepWork.doNeighborSearch)
 960     {
 961         ddBalanceRegionHandler.openBeforeForceComputationCpu(DdAllowBalanceRegionReopen::yes);
 962     }
 963
 964     const int start  = 0;
 965     const int homenr = mdatoms->homenr;
 966
 967     clear_mat(vir_force);
 968
 969     if (stepWork.stateChanged)
 970     {
 971         if (inputrecNeedMutot(inputrec))
 972         {
 973             /* Calculate total (local) dipole moment in a temporary common array.
 974              * This makes it possible to sum them over nodes faster.
 975              */
 976             calc_mu(start, homenr,
 977                     x.unpaddedArrayRef(), mdatoms->chargeA, mdatoms->chargeB, mdatoms->nChargePerturbed,
 978                     mu, mu+DIM);
 979         }
 980     }
 981
 982     if (fr->ePBC != epbcNONE)
 983     {
 984         /* Compute shift vectors every step,
 985          * because of pressure coupling or box deformation!
 986          */
 987         if (stepWork.haveDynamicBox && stepWork.stateChanged)
 988         {
 989             calc_shifts(box, fr->shift_vec);
 990         }
 991
 992         const bool fillGrid = (stepWork.doNeighborSearch && stepWork.stateChanged);
 993         const bool calcCGCM = (fillGrid && !DOMAINDECOMP(cr));
 994         if (calcCGCM)
 995         {
 996             put_atoms_in_box_omp(fr->ePBC, box, x.unpaddedArrayRef().subArray(0, homenr), gmx_omp_nthreads_get(emntDefault));
 997             inc_nrnb(nrnb, eNR_SHIFTX, homenr);
 998         }
 999         else if (EI_ENERGY_MINIMIZATION(inputrec->eI) && graph)
1000         {
1001             unshift_self(graph, box, as_rvec_array(x.unpaddedArrayRef().data()));
1002         }
1003     }
1004
1005     nbnxn_atomdata_copy_shiftvec(stepWork.haveDynamicBox,
1006                                  fr->shift_vec, nbv->nbat.get());
1007
1008     // Coordinates on the device are needed if PME or BufferOps are offloaded.
1009     // The local coordinates can be copied right away.
1010     // NOTE: Consider moving this copy to right after they are updated and constrained,
1011     //       if the later is not offloaded.
1012     if (useGpuPmeOnThisRank || useGpuXBufOps == BufferOpsUseGpu::True)
1013     {
1014         if (stepWork.doNeighborSearch)
1015         {
1016             stateGpu->reinit(mdatoms->homenr, cr->dd != nullptr ? dd_numAtomsZones(*cr->dd) : mdatoms->homenr);
1017             if (useGpuPmeOnThisRank)
1018             {
1019                 // TODO: This should be moved into PME setup function ( pme_gpu_prepare_computation(...) )
1020                 pme_gpu_set_device_x(fr->pmedata, stateGpu->getCoordinates());
1021             }
1022         }
1023         // We need to copy coordinates when:
1024         // 1. Update is not offloaded
1025         // 2. The buffers were reinitialized on search step
1026         if (!simulationWork.useGpuUpdate || stepWork.doNeighborSearch)
1027         {
1028             stateGpu->copyCoordinatesToGpu(x.unpaddedArrayRef(), AtomLocality::Local);
1029         }
1030     }
1031
1032 #if GMX_MPI
1033     if (!thisRankHasDuty(cr, DUTY_PME))
1034     {
1035         /* Send particle coordinates to the pme nodes.
1036          * Since this is only implemented for domain decomposition
1037          * and domain decomposition does not use the graph,
1038          * we do not need to worry about shifting.
1039          */
1040         bool reinitGpuPmePpComms    = simulationWork.useGpuPmePPCommunication && (stepWork.doNeighborSearch);
1041         bool sendCoordinatesFromGpu = simulationWork.useGpuPmePPCommunication && !(stepWork.doNeighborSearch);
1042         gmx_pme_send_coordinates(fr, cr, box, as_rvec_array(x.unpaddedArrayRef().data()),
1043                                  lambda[efptCOUL], lambda[efptVDW],
1044                                  (stepWork.computeVirial || stepWork.computeEnergy),
1045                                  step, simulationWork.useGpuPmePPCommunication, reinitGpuPmePpComms,
1046                                  sendCoordinatesFromGpu, wcycle);
1047     }
1048 #endif /* GMX_MPI */
1049
1050     const auto localXReadyOnDevice = (stateGpu != nullptr) ? stateGpu->getCoordinatesReadyOnDeviceEvent(AtomLocality::Local,
1051                                                                                                         simulationWork, stepWork) : nullptr;
1052     if (useGpuPmeOnThisRank)
1053     {
1054         launchPmeGpuSpread(fr->pmedata, box, stepWork, pmeFlags,
1055                            localXReadyOnDevice, wcycle);
1056     }
1057
1058     /* do gridding for pair search */
1059     if (stepWork.doNeighborSearch)
1060     {
1061         if (graph && stepWork.stateChanged)
1062         {
1063             /* Calculate intramolecular shift vectors to make molecules whole */
1064             mk_mshift(fplog, graph, fr->ePBC, box, as_rvec_array(x.unpaddedArrayRef().data()));
1065         }
1066
1067         // TODO
1068         // - vzero is constant, do we need to pass it?
1069         // - box_diag should be passed directly to nbnxn_put_on_grid
1070         //
1071         rvec vzero;
1072         clear_rvec(vzero);
1073
1074         rvec box_diag;
1075         box_diag[XX] = box[XX][XX];
1076         box_diag[YY] = box[YY][YY];
1077         box_diag[ZZ] = box[ZZ][ZZ];
1078
1079         wallcycle_start(wcycle, ewcNS);
1080         if (!DOMAINDECOMP(cr))
1081         {
1082             wallcycle_sub_start(wcycle, ewcsNBS_GRID_LOCAL);
1083             nbnxn_put_on_grid(nbv, box,
1084                               0, vzero, box_diag,
1085                               nullptr, { 0, mdatoms->homenr }, -1,
1086                               fr->cginfo, x.unpaddedArrayRef(),
1087                               0, nullptr);
1088             wallcycle_sub_stop(wcycle, ewcsNBS_GRID_LOCAL);
1089         }
1090         else
1091         {
1092             wallcycle_sub_start(wcycle, ewcsNBS_GRID_NONLOCAL);
1093             nbnxn_put_on_grid_nonlocal(nbv, domdec_zones(cr->dd),
1094                                        fr->cginfo, x.unpaddedArrayRef());
1095             wallcycle_sub_stop(wcycle, ewcsNBS_GRID_NONLOCAL);
1096         }
1097
1098         nbv->setAtomProperties(*mdatoms, fr->cginfo);
1099
1100         wallcycle_stop(wcycle, ewcNS);
1101
1102         /* initialize the GPU nbnxm atom data and bonded data structures */
1103         if (simulationWork.useGpuNonbonded)
1104         {
1105             wallcycle_start_nocount(wcycle, ewcLAUNCH_GPU);
1106
1107             wallcycle_sub_start_nocount(wcycle, ewcsLAUNCH_GPU_NONBONDED);
1108             Nbnxm::gpu_init_atomdata(nbv->gpu_nbv, nbv->nbat.get());
1109             wallcycle_sub_stop(wcycle, ewcsLAUNCH_GPU_NONBONDED);
1110
1111             if (fr->gpuBonded)
1112             {
1113                 /* Now we put all atoms on the grid, we can assign bonded
1114                  * interactions to the GPU, where the grid order is
1115                  * needed. Also the xq, f and fshift device buffers have
1116                  * been reallocated if needed, so the bonded code can
1117                  * learn about them. */
1118                 // TODO the xq, f, and fshift buffers are now shared
1119                 // resources, so they should be maintained by a
1120                 // higher-level object than the nb module.
1121                 fr->gpuBonded->updateInteractionListsAndDeviceBuffers(nbv->getGridIndices(),
1122                                                                       top->idef,
1123                                                                       Nbnxm::gpu_get_xq(nbv->gpu_nbv),
1124                                                                       Nbnxm::gpu_get_f(nbv->gpu_nbv),
1125                                                                       Nbnxm::gpu_get_fshift(nbv->gpu_nbv));
1126             }
1127             wallcycle_stop(wcycle, ewcLAUNCH_GPU);
1128         }
1129     }
1130
1131     if (stepWork.doNeighborSearch)
1132     {
1133         // Need to run after the GPU-offload bonded interaction lists
1134         // are set up to be able to determine whether there is bonded work.
1135         runScheduleWork->domainWork =
1136             setupDomainLifetimeWorkload(*inputrec,
1137                                         *fr,
1138                                         pull_work,
1139                                         ed,
1140                                         top->idef,
1141                                         *fcd,
1142                                         *mdatoms,
1143                                         stepWork);
1144
1145         wallcycle_start_nocount(wcycle, ewcNS);
1146         wallcycle_sub_start(wcycle, ewcsNBS_SEARCH_LOCAL);
1147         /* Note that with a GPU the launch overhead of the list transfer is not timed separately */
1148         nbv->constructPairlist(InteractionLocality::Local,
1149                                &top->excls, step, nrnb);
1150
1151         nbv->setupGpuShortRangeWork(fr->gpuBonded, InteractionLocality::Local);
1152
1153         wallcycle_sub_stop(wcycle, ewcsNBS_SEARCH_LOCAL);
1154         wallcycle_stop(wcycle, ewcNS);
1155
1156         if (useGpuXBufOps == BufferOpsUseGpu::True)
1157         {
1158             nbv->atomdata_init_copy_x_to_nbat_x_gpu();
1159         }
1160         // For force buffer ops, we use the below conditon rather than
1161         // useGpuFBufOps to ensure that init is performed even if this
1162         // NS step is also a virial step (on which f buf ops are deactivated).
1163         if (simulationWork.useGpuBufferOps && simulationWork.useGpuNonbonded && (GMX_GPU == GMX_GPU_CUDA))
1164         {
1165             GMX_ASSERT(stateGpu, "stateGpu should be valid when buffer ops are offloaded");
1166             nbv->atomdata_init_add_nbat_f_to_f_gpu(stateGpu->fReducedOnDevice());
1167         }
1168     }
1169     else if (!EI_TPI(inputrec->eI))
1170     {
1171         if (useGpuXBufOps == BufferOpsUseGpu::True)
1172         {
1173             GMX_ASSERT(stateGpu, "stateGpu should be valid when buffer ops are offloaded");
1174             nbv->convertCoordinatesGpu(AtomLocality::Local, false,
1175                                        stateGpu->getCoordinates(),
1176                                        localXReadyOnDevice);
1177         }
1178         else
1179         {
1180             nbv->convertCoordinates(AtomLocality::Local, false,
1181                                     x.unpaddedArrayRef());
1182         }
1183     }
1184
1185     const gmx::DomainLifetimeWorkload &domainWork = runScheduleWork->domainWork;
1186
1187     if (simulationWork.useGpuNonbonded)
1188     {
1189         ddBalanceRegionHandler.openBeforeForceComputationGpu();
1190
1191         wallcycle_start(wcycle, ewcLAUNCH_GPU);
1192
1193         wallcycle_sub_start(wcycle, ewcsLAUNCH_GPU_NONBONDED);
1194         Nbnxm::gpu_upload_shiftvec(nbv->gpu_nbv, nbv->nbat.get());
1195         if (stepWork.doNeighborSearch || (useGpuXBufOps == BufferOpsUseGpu::False))
1196         {
1197             Nbnxm::gpu_copy_xq_to_gpu(nbv->gpu_nbv, nbv->nbat.get(),
1198                                       AtomLocality::Local);
1199         }
1200         wallcycle_sub_stop(wcycle, ewcsLAUNCH_GPU_NONBONDED);
1201         // with X buffer ops offloaded to the GPU on all but the search steps
1202
1203         // bonded work not split into separate local and non-local, so with DD
1204         // we can only launch the kernel after non-local coordinates have been received.
1205         if (domainWork.haveGpuBondedWork && !havePPDomainDecomposition(cr))
1206         {
1207             wallcycle_sub_start(wcycle, ewcsLAUNCH_GPU_BONDED);
1208             fr->gpuBonded->launchKernel(fr, stepWork, box);
1209             wallcycle_sub_stop(wcycle, ewcsLAUNCH_GPU_BONDED);
1210         }
1211
1212         /* launch local nonbonded work on GPU */
1213         wallcycle_sub_start_nocount(wcycle, ewcsLAUNCH_GPU_NONBONDED);
1214         do_nb_verlet(fr, ic, enerd, stepWork, InteractionLocality::Local, enbvClearFNo,
1215                      step, nrnb, wcycle);
1216         wallcycle_sub_stop(wcycle, ewcsLAUNCH_GPU_NONBONDED);
1217         wallcycle_stop(wcycle, ewcLAUNCH_GPU);
1218     }
1219
1220     if (useGpuPmeOnThisRank)
1221     {
1222         // In PME GPU and mixed mode we launch FFT / gather after the
1223         // X copy/transform to allow overlap as well as after the GPU NB
1224         // launch to avoid FFT launch overhead hijacking the CPU and delaying
1225         // the nonbonded kernel.
1226         launchPmeGpuFftAndGather(fr->pmedata, wcycle);
1227     }
1228
1229     // TODO Update this comment when introducing SimulationWorkload
1230     //
1231     // The conditions for gpuHaloExchange e.g. using GPU buffer
1232     // operations were checked before construction, so here we can
1233     // just use it and assert upon any conditions.
1234     gmx::GpuHaloExchange *gpuHaloExchange              = (havePPDomainDecomposition(cr) ? cr->dd->gpuHaloExchange.get() : nullptr);
1235     const bool            ddUsesGpuDirectCommunication = (gpuHaloExchange != nullptr);
1236     GMX_ASSERT(!ddUsesGpuDirectCommunication || (useGpuXBufOps == BufferOpsUseGpu::True),
1237                "Must use coordinate buffer ops with GPU halo exchange");
1238     const bool useGpuForcesHaloExchange = ddUsesGpuDirectCommunication && (useGpuFBufOps == BufferOpsUseGpu::True);
1239
1240     /* Communicate coordinates and sum dipole if necessary +
1241        do non-local pair search */
1242     if (havePPDomainDecomposition(cr))
1243     {
1244         if (stepWork.doNeighborSearch)
1245         {
1246             // TODO: fuse this branch with the above large stepWork.doNeighborSearch block
1247             wallcycle_start_nocount(wcycle, ewcNS);
1248             wallcycle_sub_start(wcycle, ewcsNBS_SEARCH_NONLOCAL);
1249             /* Note that with a GPU the launch overhead of the list transfer is not timed separately */
1250             nbv->constructPairlist(InteractionLocality::NonLocal,
1251                                    &top->excls, step, nrnb);
1252
1253             nbv->setupGpuShortRangeWork(fr->gpuBonded, InteractionLocality::NonLocal);
1254             wallcycle_sub_stop(wcycle, ewcsNBS_SEARCH_NONLOCAL);
1255             wallcycle_stop(wcycle, ewcNS);
1256             if (ddUsesGpuDirectCommunication)
1257             {
1258                 gpuHaloExchange->reinitHalo(stateGpu->getCoordinates(), stateGpu->getForces());
1259             }
1260         }
1261         else
1262         {
1263             if (ddUsesGpuDirectCommunication)
1264             {
1265                 // The following must be called after local setCoordinates (which records an event
1266                 // when the coordinate data has been copied to the device).
1267                 gpuHaloExchange->communicateHaloCoordinates(box);
1268
1269                 if (domainWork.haveCpuBondedWork || domainWork.haveFreeEnergyWork)
1270                 {
1271                     //non-local part of coordinate buffer must be copied back to host for CPU work
1272                     stateGpu->copyCoordinatesFromGpu(x.unpaddedArrayRef(), AtomLocality::NonLocal);
1273                 }
1274             }
1275             else
1276             {
1277                 dd_move_x(cr->dd, box, x.unpaddedArrayRef(), wcycle);
1278             }
1279
1280             if (useGpuXBufOps == BufferOpsUseGpu::True)
1281             {
1282                 // The condition here was (pme != nullptr && pme_gpu_get_device_x(fr->pmedata) != nullptr)
1283                 if (!useGpuPmeOnThisRank && !ddUsesGpuDirectCommunication)
1284                 {
1285                     stateGpu->copyCoordinatesToGpu(x.unpaddedArrayRef(), AtomLocality::NonLocal);
1286                 }
1287                 nbv->convertCoordinatesGpu(AtomLocality::NonLocal, false,
1288                                            stateGpu->getCoordinates(),
1289                                            stateGpu->getCoordinatesReadyOnDeviceEvent(AtomLocality::NonLocal,
1290                                                                                       simulationWork, stepWork));
1291             }
1292             else
1293             {
1294                 nbv->convertCoordinates(AtomLocality::NonLocal, false,
1295                                         x.unpaddedArrayRef());
1296             }
1297
1298         }
1299
1300         if (simulationWork.useGpuNonbonded)
1301         {
1302             wallcycle_start(wcycle, ewcLAUNCH_GPU);
1303
1304             if (stepWork.doNeighborSearch || (useGpuXBufOps == BufferOpsUseGpu::False))
1305             {
1306                 wallcycle_sub_start(wcycle, ewcsLAUNCH_GPU_NONBONDED);
1307                 Nbnxm::gpu_copy_xq_to_gpu(nbv->gpu_nbv, nbv->nbat.get(),
1308                                           AtomLocality::NonLocal);
1309                 wallcycle_sub_stop(wcycle, ewcsLAUNCH_GPU_NONBONDED);
1310             }
1311
1312             if (domainWork.haveGpuBondedWork)
1313             {
1314                 wallcycle_sub_start(wcycle, ewcsLAUNCH_GPU_BONDED);
1315                 fr->gpuBonded->launchKernel(fr, stepWork, box);
1316                 wallcycle_sub_stop(wcycle, ewcsLAUNCH_GPU_BONDED);
1317             }
1318
1319             /* launch non-local nonbonded tasks on GPU */
1320             wallcycle_sub_start(wcycle, ewcsLAUNCH_GPU_NONBONDED);
1321             do_nb_verlet(fr, ic, enerd, stepWork, InteractionLocality::NonLocal, enbvClearFNo,
1322                          step, nrnb, wcycle);
1323             wallcycle_sub_stop(wcycle, ewcsLAUNCH_GPU_NONBONDED);
1324
1325             wallcycle_stop(wcycle, ewcLAUNCH_GPU);
1326         }
1327     }
1328
1329     if (simulationWork.useGpuNonbonded)
1330     {
1331         /* launch D2H copy-back F */
1332         wallcycle_start_nocount(wcycle, ewcLAUNCH_GPU);
1333         wallcycle_sub_start_nocount(wcycle, ewcsLAUNCH_GPU_NONBONDED);
1334
1335         if (havePPDomainDecomposition(cr))
1336         {
1337             Nbnxm::gpu_launch_cpyback(nbv->gpu_nbv, nbv->nbat.get(),
1338                                       stepWork, AtomLocality::NonLocal);
1339         }
1340         Nbnxm::gpu_launch_cpyback(nbv->gpu_nbv, nbv->nbat.get(),
1341                                   stepWork, AtomLocality::Local);
1342         wallcycle_sub_stop(wcycle, ewcsLAUNCH_GPU_NONBONDED);
1343
1344         if (domainWork.haveGpuBondedWork && stepWork.computeEnergy)
1345         {
1346             fr->gpuBonded->launchEnergyTransfer();
1347         }
1348         wallcycle_stop(wcycle, ewcLAUNCH_GPU);
1349     }
1350
1351     if (stepWork.stateChanged && inputrecNeedMutot(inputrec))
1352     {
1353         if (PAR(cr))
1354         {
1355             gmx_sumd(2*DIM, mu, cr);
1356
1357             ddBalanceRegionHandler.reopenRegionCpu();
1358         }
1359
1360         for (i = 0; i < 2; i++)
1361         {
1362             for (j = 0; j < DIM; j++)
1363             {
1364                 fr->mu_tot[i][j] = mu[i*DIM + j];
1365             }
1366         }
1367     }
1368     if (mdatoms->nChargePerturbed == 0)
1369     {
1370         copy_rvec(fr->mu_tot[0], mu_tot);
1371     }
1372     else
1373     {
1374         for (j = 0; j < DIM; j++)
1375         {
1376             mu_tot[j] =
1377                 (1.0 - lambda[efptCOUL])*fr->mu_tot[0][j] +
1378                 lambda[efptCOUL]*fr->mu_tot[1][j];
1379         }
1380     }
1381
1382     /* Reset energies */
1383     reset_enerdata(enerd);
1384     /* Clear the shift forces */
1385     // TODO: This should be linked to the shift force buffer in use, or cleared before use instead
1386     for (gmx::RVec &elem : fr->shiftForces)
1387     {
1388         elem = { 0.0_real, 0.0_real, 0.0_real };
1389     }
1390
1391     if (DOMAINDECOMP(cr) && !thisRankHasDuty(cr, DUTY_PME))
1392     {
1393         wallcycle_start(wcycle, ewcPPDURINGPME);
1394         dd_force_flop_start(cr->dd, nrnb);
1395     }
1396
1397     if (inputrec->bRot)
1398     {
1399         wallcycle_start(wcycle, ewcROT);
1400         do_rotation(cr, enforcedRotation, box, as_rvec_array(x.unpaddedArrayRef().data()), t, step, stepWork.doNeighborSearch);
1401         wallcycle_stop(wcycle, ewcROT);
1402     }
1403
1404     /* Start the force cycle counter.
1405      * Note that a different counter is used for dynamic load balancing.
1406      */
1407     wallcycle_start(wcycle, ewcFORCE);
1408
1409     // Set up and clear force outputs.
1410     // We use std::move to keep the compiler happy, it has no effect.
1411     ForceOutputs forceOut = setupForceOutputs(fr, pull_work, *inputrec, std::move(force), stepWork, wcycle);
1412
1413     /* We calculate the non-bonded forces, when done on the CPU, here.
1414      * We do this before calling do_force_lowlevel, because in that
1415      * function, the listed forces are calculated before PME, which
1416      * does communication.  With this order, non-bonded and listed
1417      * force calculation imbalance can be balanced out by the domain
1418      * decomposition load balancing.
1419      */
1420
1421     const bool useOrEmulateGpuNb = simulationWork.useGpuNonbonded || fr->nbv->emulateGpu();
1422
1423     if (!useOrEmulateGpuNb)
1424     {
1425         do_nb_verlet(fr, ic, enerd, stepWork, InteractionLocality::Local, enbvClearFYes,
1426                      step, nrnb, wcycle);
1427     }
1428
1429     if (fr->efep != efepNO)
1430     {
1431         /* Calculate the local and non-local free energy interactions here.
1432          * Happens here on the CPU both with and without GPU.
1433          */
1434         nbv->dispatchFreeEnergyKernel(InteractionLocality::Local,
1435                                       fr, as_rvec_array(x.unpaddedArrayRef().data()), &forceOut.forceWithShiftForces(), *mdatoms,
1436                                       inputrec->fepvals, lambda.data(),
1437                                       enerd, stepWork, nrnb);
1438
1439         if (havePPDomainDecomposition(cr))
1440         {
1441             nbv->dispatchFreeEnergyKernel(InteractionLocality::NonLocal,
1442                                           fr, as_rvec_array(x.unpaddedArrayRef().data()), &forceOut.forceWithShiftForces(), *mdatoms,
1443                                           inputrec->fepvals, lambda.data(),
1444                                           enerd, stepWork, nrnb);
1445         }
1446     }
1447
1448     if (!useOrEmulateGpuNb)
1449     {
1450         if (havePPDomainDecomposition(cr))
1451         {
1452             do_nb_verlet(fr, ic, enerd, stepWork, InteractionLocality::NonLocal, enbvClearFNo,
1453                          step, nrnb, wcycle);
1454         }
1455
1456         if (stepWork.computeForces)
1457         {
1458             /* Add all the non-bonded force to the normal force array.
1459              * This can be split into a local and a non-local part when overlapping
1460              * communication with calculation with domain decomposition.
1461              */
1462             wallcycle_stop(wcycle, ewcFORCE);
1463             nbv->atomdata_add_nbat_f_to_f(AtomLocality::All, forceOut.forceWithShiftForces().force());
1464             wallcycle_start_nocount(wcycle, ewcFORCE);
1465         }
1466
1467         /* If there are multiple fshift output buffers we need to reduce them */
1468         if (stepWork.computeVirial)
1469         {
1470             /* This is not in a subcounter because it takes a
1471                negligible and constant-sized amount of time */
1472             nbnxn_atomdata_add_nbat_fshift_to_fshift(*nbv->nbat,
1473                                                      forceOut.forceWithShiftForces().shiftForces());
1474         }
1475     }
1476
1477     /* update QMMMrec, if necessary */
1478     if (fr->bQMMM)
1479     {
1480         update_QMMMrec(cr, fr, as_rvec_array(x.unpaddedArrayRef().data()), mdatoms, box);
1481     }
1482
1483     // TODO Force flags should include haveFreeEnergyWork for this domain
1484     if (ddUsesGpuDirectCommunication &&
1485         (domainWork.haveCpuBondedWork || domainWork.haveFreeEnergyWork))
1486     {
1487         /* Wait for non-local coordinate data to be copied from device */
1488         nbv->wait_nonlocal_x_copy_D2H_done();
1489     }
1490     /* Compute the bonded and non-bonded energies and optionally forces */
1491     do_force_lowlevel(fr, inputrec, &(top->idef),
1492                       cr, ms, nrnb, wcycle, mdatoms,
1493                       x, hist, &forceOut, enerd, fcd,
1494                       box, lambda.data(), graph, fr->mu_tot,
1495                       stepWork,
1496                       ddBalanceRegionHandler);
1497
1498     wallcycle_stop(wcycle, ewcFORCE);
1499
1500     computeSpecialForces(fplog, cr, inputrec, awh, enforcedRotation,
1501                          imdSession, pull_work, step, t, wcycle,
1502                          fr->forceProviders, box, x.unpaddedArrayRef(), mdatoms, lambda.data(),
1503                          stepWork, &forceOut.forceWithVirial(), enerd,
1504                          ed, stepWork.doNeighborSearch);
1505
1506
1507     // Will store the amount of cycles spent waiting for the GPU that
1508     // will be later used in the DLB accounting.
1509     float cycles_wait_gpu = 0;
1510     if (useOrEmulateGpuNb)
1511     {
1512         auto &forceWithShiftForces = forceOut.forceWithShiftForces();
1513
1514         /* wait for non-local forces (or calculate in emulation mode) */
1515         if (havePPDomainDecomposition(cr))
1516         {
1517             if (simulationWork.useGpuNonbonded)
1518             {
1519                 cycles_wait_gpu += Nbnxm::gpu_wait_finish_task(nbv->gpu_nbv,
1520                                                                stepWork, AtomLocality::NonLocal,
1521                                                                enerd->grpp.ener[egLJSR].data(),
1522                                                                enerd->grpp.ener[egCOULSR].data(),
1523                                                                forceWithShiftForces.shiftForces(),
1524                                                                wcycle);
1525             }
1526             else
1527             {
1528                 wallcycle_start_nocount(wcycle, ewcFORCE);
1529                 do_nb_verlet(fr, ic, enerd, stepWork, InteractionLocality::NonLocal, enbvClearFYes,
1530                              step, nrnb, wcycle);
1531                 wallcycle_stop(wcycle, ewcFORCE);
1532             }
1533
1534             if (useGpuFBufOps == BufferOpsUseGpu::True)
1535             {
1536                 gmx::FixedCapacityVector<GpuEventSynchronizer*, 1> dependencyList;
1537
1538                 // TODO: move this into DomainLifetimeWorkload, including the second part of the condition
1539                 // The bonded and free energy CPU tasks can have non-local force contributions
1540                 // which are a dependency for the GPU force reduction.
1541                 bool  haveNonLocalForceContribInCpuBuffer = domainWork.haveCpuBondedWork || domainWork.haveFreeEnergyWork;
1542
1543                 if (haveNonLocalForceContribInCpuBuffer)
1544                 {
1545                     stateGpu->copyForcesToGpu(forceOut.forceWithShiftForces().force(), AtomLocality::NonLocal);
1546                     dependencyList.push_back(stateGpu->getForcesReadyOnDeviceEvent(AtomLocality::NonLocal,
1547                                                                                    useGpuFBufOps == BufferOpsUseGpu::True));
1548                 }
1549
1550                 nbv->atomdata_add_nbat_f_to_f_gpu(AtomLocality::NonLocal,
1551                                                   stateGpu->getForces(),
1552                                                   pme_gpu_get_device_f(fr->pmedata),
1553                                                   dependencyList,
1554                                                   false, haveNonLocalForceContribInCpuBuffer);
1555                 if (!useGpuForcesHaloExchange)
1556                 {
1557                     // copy from GPU input for dd_move_f()
1558                     stateGpu->copyForcesFromGpu(forceOut.forceWithShiftForces().force(), AtomLocality::NonLocal);
1559                 }
1560             }
1561             else
1562             {
1563                 nbv->atomdata_add_nbat_f_to_f(AtomLocality::NonLocal,
1564                                               forceWithShiftForces.force());
1565             }
1566
1567
1568             if (fr->nbv->emulateGpu() && stepWork.computeVirial)
1569             {
1570                 nbnxn_atomdata_add_nbat_fshift_to_fshift(*nbv->nbat,
1571                                                          forceWithShiftForces.shiftForces());
1572             }
1573         }
1574     }
1575
1576     // TODO move this into StepWorkload
1577     const bool useCpuPmeFReduction      = thisRankHasDuty(cr, DUTY_PME) && !stepWork.useGpuPmeFReduction;
1578     // TODO: move this into DomainLifetimeWorkload, including the second part of the condition
1579     const bool haveCpuLocalForces     = (domainWork.haveSpecialForces || domainWork.haveCpuListedForceWork || useCpuPmeFReduction ||
1580                                          (fr->efep != efepNO));
1581
1582     if (havePPDomainDecomposition(cr))
1583     {
1584         /* We are done with the CPU compute.
1585          * We will now communicate the non-local forces.
1586          * If we use a GPU this will overlap with GPU work, so in that case
1587          * we do not close the DD force balancing region here.
1588          */
1589         ddBalanceRegionHandler.closeAfterForceComputationCpu();
1590
1591         if (stepWork.computeForces)
1592         {
1593
1594             if (useGpuForcesHaloExchange)
1595             {
1596                 if (haveCpuLocalForces)
1597                 {
1598                     stateGpu->copyForcesToGpu(forceOut.forceWithShiftForces().force(), AtomLocality::Local);
1599                 }
1600                 gpuHaloExchange->communicateHaloForces(haveCpuLocalForces);
1601             }
1602             else
1603             {
1604                 if (useGpuFBufOps == BufferOpsUseGpu::True)
1605                 {
1606                     stateGpu->waitForcesReadyOnHost(AtomLocality::NonLocal);
1607                 }
1608                 dd_move_f(cr->dd, &forceOut.forceWithShiftForces(), wcycle);
1609             }
1610
1611         }
1612     }
1613
1614     // With both nonbonded and PME offloaded a GPU on the same rank, we use
1615     // an alternating wait/reduction scheme.
1616     bool alternateGpuWait = (!c_disableAlternatingWait && useGpuPmeOnThisRank && simulationWork.useGpuNonbonded && !DOMAINDECOMP(cr) &&
1617                              (useGpuFBufOps == BufferOpsUseGpu::False));
1618     if (alternateGpuWait)
1619     {
1620         alternatePmeNbGpuWaitReduce(fr->nbv.get(), fr->pmedata, &forceOut, enerd,
1621                                     stepWork, pmeFlags, wcycle);
1622     }
1623
1624     if (!alternateGpuWait && useGpuPmeOnThisRank)
1625     {
1626         pme_gpu_wait_and_reduce(fr->pmedata, pmeFlags, wcycle, &forceOut.forceWithVirial(), enerd);
1627     }
1628
1629     /* Wait for local GPU NB outputs on the non-alternating wait path */
1630     if (!alternateGpuWait && simulationWork.useGpuNonbonded)
1631     {
1632         /* Measured overhead on CUDA and OpenCL with(out) GPU sharing
1633          * is between 0.5 and 1.5 Mcycles. So 2 MCycles is an overestimate,
1634          * but even with a step of 0.1 ms the difference is less than 1%
1635          * of the step time.
1636          */
1637         const float gpuWaitApiOverheadMargin = 2e6F; /* cycles */
1638         const float waitCycles               =
1639             Nbnxm::gpu_wait_finish_task(nbv->gpu_nbv,
1640                                         stepWork, AtomLocality::Local,
1641                                         enerd->grpp.ener[egLJSR].data(),
1642                                         enerd->grpp.ener[egCOULSR].data(),
1643                                         forceOut.forceWithShiftForces().shiftForces(),
1644                                         wcycle);
1645
1646         if (ddBalanceRegionHandler.useBalancingRegion())
1647         {
1648             DdBalanceRegionWaitedForGpu waitedForGpu = DdBalanceRegionWaitedForGpu::yes;
1649             if (stepWork.computeForces &&  waitCycles <= gpuWaitApiOverheadMargin)
1650             {
1651                 /* We measured few cycles, it could be that the kernel
1652                  * and transfer finished earlier and there was no actual
1653                  * wait time, only API call overhead.
1654                  * Then the actual time could be anywhere between 0 and
1655                  * cycles_wait_est. We will use half of cycles_wait_est.
1656                  */
1657                 waitedForGpu = DdBalanceRegionWaitedForGpu::no;
1658             }
1659             ddBalanceRegionHandler.closeAfterForceComputationGpu(cycles_wait_gpu, waitedForGpu);
1660         }
1661     }
1662
1663     if (fr->nbv->emulateGpu())
1664     {
1665         // NOTE: emulation kernel is not included in the balancing region,
1666         // but emulation mode does not target performance anyway
1667         wallcycle_start_nocount(wcycle, ewcFORCE);
1668         do_nb_verlet(fr, ic, enerd, stepWork, InteractionLocality::Local,
1669                      DOMAINDECOMP(cr) ? enbvClearFNo : enbvClearFYes,
1670                      step, nrnb, wcycle);
1671         wallcycle_stop(wcycle, ewcFORCE);
1672     }
1673
1674     // If on GPU PME-PP comms path, receive forces from PME before GPU buffer ops
1675     // TODO refoactor this and unify with below default-path call to the same function
1676     if (PAR(cr) && !thisRankHasDuty(cr, DUTY_PME) && simulationWork.useGpuPmePPCommunication)
1677     {
1678         /* In case of node-splitting, the PP nodes receive the long-range
1679          * forces, virial and energy from the PME nodes here.
1680          */
1681         pme_receive_force_ener(fr, cr, &forceOut.forceWithVirial(), enerd, simulationWork.useGpuPmePPCommunication, stepWork.useGpuPmeFReduction, wcycle);
1682     }
1683
1684
1685     /* Do the nonbonded GPU (or emulation) force buffer reduction
1686      * on the non-alternating path. */
1687     if (useOrEmulateGpuNb && !alternateGpuWait)
1688     {
1689         //TODO simplify the below conditionals. Pass buffer and sync pointers at init stage rather than here. Unify getter fns for sameGPU/otherGPU cases.
1690         void* pmeForcePtr = stepWork.useGpuPmeFReduction ?
1691             (thisRankHasDuty(cr, DUTY_PME) ?
1692              pme_gpu_get_device_f(fr->pmedata) :        // PME force buffer on same GPU
1693              fr->pmePpCommGpu->getGpuForceStagingPtr()) // buffer received from other GPU
1694             : nullptr;                                  // PME reduction not active on GPU
1695
1696         GpuEventSynchronizer* const pmeSynchronizer = stepWork.useGpuPmeFReduction ?
1697             (thisRankHasDuty(cr, DUTY_PME) ?
1698              pme_gpu_get_f_ready_synchronizer(fr->pmedata) :   // PME force buffer on same GPU
1699              static_cast<GpuEventSynchronizer*>
1700              (fr->pmePpCommGpu->getForcesReadySynchronizer())) // buffer received from other GPU
1701             : nullptr;                                         // PME reduction not active on GPU
1702
1703         gmx::FixedCapacityVector<GpuEventSynchronizer*, 2> dependencyList;
1704
1705         if (stepWork.useGpuPmeFReduction)
1706         {
1707             dependencyList.push_back(pmeSynchronizer);
1708         }
1709
1710         gmx::ArrayRef<gmx::RVec>  forceWithShift = forceOut.forceWithShiftForces().force();
1711
1712         if (useGpuFBufOps == BufferOpsUseGpu::True)
1713         {
1714             // Flag to specify whether the CPU force buffer has contributions to
1715             // local atoms. This depends on whether there are CPU-based force tasks
1716             // or when DD is active the halo exchange has resulted in contributions
1717             // from the non-local part.
1718             const bool haveLocalForceContribInCpuBuffer = (haveCpuLocalForces || havePPDomainDecomposition(cr));
1719
1720             // TODO: move these steps as early as possible:
1721             // - CPU f H2D should be as soon as all CPU-side forces are done
1722             // - wait for force reduction does not need to block host (at least not here, it's sufficient to wait
1723             //   before the next CPU task that consumes the forces: vsite spread or update)
1724             // - copy is not perfomed if GPU force halo exchange is active, because it would overwrite the result
1725             //   of the halo exchange. In that case the copy is instead performed above, before the exchange.
1726             //   These should be unified.
1727             if (haveLocalForceContribInCpuBuffer && !useGpuForcesHaloExchange)
1728             {
1729                 stateGpu->copyForcesToGpu(forceWithShift, AtomLocality::Local);
1730                 dependencyList.push_back(stateGpu->getForcesReadyOnDeviceEvent(AtomLocality::Local,
1731                                                                                useGpuFBufOps == BufferOpsUseGpu::True));
1732             }
1733             if (useGpuForcesHaloExchange)
1734             {
1735                 // Add a stream synchronization to satisfy a dependency
1736                 // for the local buffer ops on the result of GPU halo
1737                 // exchange, which operates in the non-local stream and
1738                 // writes to to local parf og the force buffer.
1739                 //
1740                 // TODO improve this through use of an event - see Redmine #3093
1741                 //      push the event into the dependencyList
1742                 nbv->stream_local_wait_for_nonlocal();
1743             }
1744             nbv->atomdata_add_nbat_f_to_f_gpu(AtomLocality::Local,
1745                                               stateGpu->getForces(),
1746                                               pmeForcePtr,
1747                                               dependencyList,
1748                                               stepWork.useGpuPmeFReduction, haveLocalForceContribInCpuBuffer);
1749             stateGpu->copyForcesFromGpu(forceWithShift, AtomLocality::Local);
1750             stateGpu->waitForcesReadyOnHost(AtomLocality::Local);
1751         }
1752         else
1753         {
1754             nbv->atomdata_add_nbat_f_to_f(AtomLocality::Local, forceWithShift);
1755         }
1756
1757     }
1758
1759     launchGpuEndOfStepTasks(nbv, fr->gpuBonded, fr->pmedata, enerd,
1760                             *runScheduleWork,
1761                             simulationWork.useGpuNonbonded, useGpuPmeOnThisRank,
1762                             step,
1763                             wcycle);
1764
1765     if (DOMAINDECOMP(cr))
1766     {
1767         dd_force_flop_stop(cr->dd, nrnb);
1768     }
1769
1770     if (stepWork.computeForces)
1771     {
1772         rvec *f = as_rvec_array(forceOut.forceWithShiftForces().force().data());
1773
1774         /* If we have NoVirSum forces, but we do not calculate the virial,
1775          * we sum fr->f_novirsum=forceOut.f later.
1776          */
1777         if (vsite && !(fr->haveDirectVirialContributions && !stepWork.computeVirial))
1778         {
1779             rvec *fshift = as_rvec_array(forceOut.forceWithShiftForces().shiftForces().data());
1780             spread_vsite_f(vsite, as_rvec_array(x.unpaddedArrayRef().data()), f, fshift, FALSE, nullptr, nrnb,
1781                            &top->idef, fr->ePBC, fr->bMolPBC, graph, box, cr, wcycle);
1782         }
1783
1784         if (stepWork.computeVirial)
1785         {
1786             /* Calculation of the virial must be done after vsites! */
1787             calc_virial(0, mdatoms->homenr, as_rvec_array(x.unpaddedArrayRef().data()),
1788                         forceOut.forceWithShiftForces(),
1789                         vir_force, graph, box, nrnb, fr, inputrec->ePBC);
1790         }
1791     }
1792
1793     // TODO refoactor this and unify with above PME-PP GPU communication path call to the same function
1794     if (PAR(cr) && !thisRankHasDuty(cr, DUTY_PME) && !simulationWork.useGpuPmePPCommunication)
1795     {
1796         /* In case of node-splitting, the PP nodes receive the long-range
1797          * forces, virial and energy from the PME nodes here.
1798          */
1799         pme_receive_force_ener(fr, cr, &forceOut.forceWithVirial(), enerd,
1800                                simulationWork.useGpuPmePPCommunication, false, wcycle);
1801     }
1802
1803     if (stepWork.computeForces)
1804     {
1805         post_process_forces(cr, step, nrnb, wcycle,
1806                             top, box, as_rvec_array(x.unpaddedArrayRef().data()), &forceOut,
1807                             vir_force, mdatoms, graph, fr, vsite,
1808                             stepWork);
1809     }
1810
1811     if (stepWork.computeEnergy)
1812     {
1813         /* Sum the potential energy terms from group contributions */
1814         sum_epot(&(enerd->grpp), enerd->term);
1815
1816         if (!EI_TPI(inputrec->eI))
1817         {
1818             checkPotentialEnergyValidity(step, *enerd, *inputrec);
1819         }
1820     }
1821
1822     /* In case we don't have constraints and are using GPUs, the next balancing
1823      * region starts here.
1824      * Some "special" work at the end of do_force_cuts?, such as vsite spread,
1825      * virial calculation and COM pulling, is not thus not included in
1826      * the balance timing, which is ok as most tasks do communication.
1827      */
1828     ddBalanceRegionHandler.openBeforeForceComputationCpu(DdAllowBalanceRegionReopen::no);
1829 }