src/gromacs/mdrun/runner.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) 2011-2019,2020, 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 /*! \internal \file
  38  *
  39  * \brief Implements the MD runner routine calling all integrators.
  40  *
  41  * \author David van der Spoel <david.vanderspoel@icm.uu.se>
  42  * \ingroup module_mdrun
  43  */
  44 #include "gmxpre.h"
  45
  46 #include "runner.h"
  47
  48 #include "config.h"
  49
  50 #include <cassert>
  51 #include <cinttypes>
  52 #include <csignal>
  53 #include <cstdlib>
  54 #include <cstring>
  55
  56 #include <algorithm>
  57 #include <memory>
  58
  59 #include "gromacs/commandline/filenm.h"
  60 #include "gromacs/domdec/builder.h"
  61 #include "gromacs/domdec/domdec.h"
  62 #include "gromacs/domdec/domdec_struct.h"
  63 #include "gromacs/domdec/gpuhaloexchange.h"
  64 #include "gromacs/domdec/localatomsetmanager.h"
  65 #include "gromacs/domdec/partition.h"
  66 #include "gromacs/ewald/ewald_utils.h"
  67 #include "gromacs/ewald/pme_gpu_program.h"
  68 #include "gromacs/ewald/pme_only.h"
  69 #include "gromacs/ewald/pme_pp_comm_gpu.h"
  70 #include "gromacs/fileio/checkpoint.h"
  71 #include "gromacs/fileio/gmxfio.h"
  72 #include "gromacs/fileio/oenv.h"
  73 #include "gromacs/fileio/tpxio.h"
  74 #include "gromacs/gmxlib/network.h"
  75 #include "gromacs/gmxlib/nrnb.h"
  76 #include "gromacs/gpu_utils/device_context.h"
  77 #include "gromacs/gpu_utils/device_stream_manager.h"
  78 #include "gromacs/gpu_utils/gpu_utils.h"
  79 #include "gromacs/hardware/cpuinfo.h"
  80 #include "gromacs/hardware/detecthardware.h"
  81 #include "gromacs/hardware/printhardware.h"
  82 #include "gromacs/imd/imd.h"
  83 #include "gromacs/listed_forces/disre.h"
  84 #include "gromacs/listed_forces/gpubonded.h"
  85 #include "gromacs/listed_forces/listed_forces.h"
  86 #include "gromacs/listed_forces/orires.h"
  87 #include "gromacs/math/functions.h"
  88 #include "gromacs/math/utilities.h"
  89 #include "gromacs/math/vec.h"
  90 #include "gromacs/mdlib/boxdeformation.h"
  91 #include "gromacs/mdlib/broadcaststructs.h"
  92 #include "gromacs/mdlib/calc_verletbuf.h"
  93 #include "gromacs/mdlib/dispersioncorrection.h"
  94 #include "gromacs/mdlib/enerdata_utils.h"
  95 #include "gromacs/mdlib/force.h"
  96 #include "gromacs/mdlib/forcerec.h"
  97 #include "gromacs/mdlib/gmx_omp_nthreads.h"
  98 #include "gromacs/mdlib/makeconstraints.h"
  99 #include "gromacs/mdlib/md_support.h"
 100 #include "gromacs/mdlib/mdatoms.h"
 101 #include "gromacs/mdlib/membed.h"
 102 #include "gromacs/mdlib/sighandler.h"
 103 #include "gromacs/mdlib/stophandler.h"
 104 #include "gromacs/mdlib/tgroup.h"
 105 #include "gromacs/mdlib/updategroups.h"
 106 #include "gromacs/mdlib/vsite.h"
 107 #include "gromacs/mdrun/mdmodules.h"
 108 #include "gromacs/mdrun/simulationcontext.h"
 109 #include "gromacs/mdrunutility/handlerestart.h"
 110 #include "gromacs/mdrunutility/logging.h"
 111 #include "gromacs/mdrunutility/multisim.h"
 112 #include "gromacs/mdrunutility/printtime.h"
 113 #include "gromacs/mdrunutility/threadaffinity.h"
 114 #include "gromacs/mdtypes/commrec.h"
 115 #include "gromacs/mdtypes/enerdata.h"
 116 #include "gromacs/mdtypes/fcdata.h"
 117 #include "gromacs/mdtypes/forcerec.h"
 118 #include "gromacs/mdtypes/group.h"
 119 #include "gromacs/mdtypes/inputrec.h"
 120 #include "gromacs/mdtypes/interaction_const.h"
 121 #include "gromacs/mdtypes/md_enums.h"
 122 #include "gromacs/mdtypes/mdatom.h"
 123 #include "gromacs/mdtypes/mdrunoptions.h"
 124 #include "gromacs/mdtypes/observableshistory.h"
 125 #include "gromacs/mdtypes/simulation_workload.h"
 126 #include "gromacs/mdtypes/state.h"
 127 #include "gromacs/mdtypes/state_propagator_data_gpu.h"
 128 #include "gromacs/modularsimulator/modularsimulator.h"
 129 #include "gromacs/nbnxm/gpu_data_mgmt.h"
 130 #include "gromacs/nbnxm/nbnxm.h"
 131 #include "gromacs/nbnxm/pairlist_tuning.h"
 132 #include "gromacs/pbcutil/pbc.h"
 133 #include "gromacs/pulling/output.h"
 134 #include "gromacs/pulling/pull.h"
 135 #include "gromacs/pulling/pull_rotation.h"
 136 #include "gromacs/restraint/manager.h"
 137 #include "gromacs/restraint/restraintmdmodule.h"
 138 #include "gromacs/restraint/restraintpotential.h"
 139 #include "gromacs/swap/swapcoords.h"
 140 #include "gromacs/taskassignment/decidegpuusage.h"
 141 #include "gromacs/taskassignment/decidesimulationworkload.h"
 142 #include "gromacs/taskassignment/resourcedivision.h"
 143 #include "gromacs/taskassignment/taskassignment.h"
 144 #include "gromacs/taskassignment/usergpuids.h"
 145 #include "gromacs/timing/gpu_timing.h"
 146 #include "gromacs/timing/wallcycle.h"
 147 #include "gromacs/timing/wallcyclereporting.h"
 148 #include "gromacs/topology/mtop_util.h"
 149 #include "gromacs/trajectory/trajectoryframe.h"
 150 #include "gromacs/utility/basenetwork.h"
 151 #include "gromacs/utility/cstringutil.h"
 152 #include "gromacs/utility/exceptions.h"
 153 #include "gromacs/utility/fatalerror.h"
 154 #include "gromacs/utility/filestream.h"
 155 #include "gromacs/utility/gmxassert.h"
 156 #include "gromacs/utility/gmxmpi.h"
 157 #include "gromacs/utility/keyvaluetree.h"
 158 #include "gromacs/utility/logger.h"
 159 #include "gromacs/utility/loggerbuilder.h"
 160 #include "gromacs/utility/mdmodulenotification.h"
 161 #include "gromacs/utility/physicalnodecommunicator.h"
 162 #include "gromacs/utility/pleasecite.h"
 163 #include "gromacs/utility/programcontext.h"
 164 #include "gromacs/utility/smalloc.h"
 165 #include "gromacs/utility/stringutil.h"
 166
 167 #include "isimulator.h"
 168 #include "replicaexchange.h"
 169 #include "simulatorbuilder.h"
 170
 171 #if GMX_FAHCORE
 172 #    include "corewrap.h"
 173 #endif
 174
 175 namespace gmx
 176 {
 177
 178
 179 /*! \brief Manage any development feature flag variables encountered
 180  *
 181  * The use of dev features indicated by environment variables is
 182  * logged in order to ensure that runs with such features enabled can
 183  * be identified from their log and standard output. Any cross
 184  * dependencies are also checked, and if unsatisfied, a fatal error
 185  * issued.
 186  *
 187  * Note that some development features overrides are applied already here:
 188  * the GPU communication flags are set to false in non-tMPI and non-CUDA builds.
 189  *
 190  * \param[in]  mdlog                Logger object.
 191  * \param[in]  useGpuForNonbonded   True if the nonbonded task is offloaded in this run.
 192  * \param[in]  pmeRunMode           The PME run mode for this run
 193  * \returns                         The object populated with development feature flags.
 194  */
 195 static DevelopmentFeatureFlags manageDevelopmentFeatures(const gmx::MDLogger& mdlog,
 196                                                          const bool           useGpuForNonbonded,
 197                                                          const PmeRunMode     pmeRunMode)
 198 {
 199     DevelopmentFeatureFlags devFlags;
 200
 201     // Some builds of GCC 5 give false positive warnings that these
 202     // getenv results are ignored when clearly they are used.
 203 #pragma GCC diagnostic push
 204 #pragma GCC diagnostic ignored "-Wunused-result"
 205     devFlags.enableGpuBufferOps = (getenv("GMX_USE_GPU_BUFFER_OPS") != nullptr)
 206                                   && (GMX_GPU == GMX_GPU_CUDA) && useGpuForNonbonded;
 207     devFlags.forceGpuUpdateDefault = (getenv("GMX_FORCE_UPDATE_DEFAULT_GPU") != nullptr);
 208     devFlags.enableGpuHaloExchange =
 209             (getenv("GMX_GPU_DD_COMMS") != nullptr && GMX_THREAD_MPI && (GMX_GPU == GMX_GPU_CUDA));
 210     devFlags.enableGpuPmePPComm =
 211             (getenv("GMX_GPU_PME_PP_COMMS") != nullptr && GMX_THREAD_MPI && (GMX_GPU == GMX_GPU_CUDA));
 212 #pragma GCC diagnostic pop
 213
 214     if (devFlags.enableGpuBufferOps)
 215     {
 216         GMX_LOG(mdlog.warning)
 217                 .asParagraph()
 218                 .appendTextFormatted(
 219                         "This run uses the 'GPU buffer ops' feature, enabled by the "
 220                         "GMX_USE_GPU_BUFFER_OPS environment variable.");
 221     }
 222
 223     if (devFlags.forceGpuUpdateDefault)
 224     {
 225         GMX_LOG(mdlog.warning)
 226                 .asParagraph()
 227                 .appendTextFormatted(
 228                         "This run will default to '-update gpu' as requested by the "
 229                         "GMX_FORCE_UPDATE_DEFAULT_GPU environment variable. GPU update with domain "
 230                         "decomposition lacks substantial testing and should be used with caution.");
 231     }
 232
 233     if (devFlags.enableGpuHaloExchange)
 234     {
 235         if (useGpuForNonbonded)
 236         {
 237             if (!devFlags.enableGpuBufferOps)
 238             {
 239                 GMX_LOG(mdlog.warning)
 240                         .asParagraph()
 241                         .appendTextFormatted(
 242                                 "Enabling GPU buffer operations required by GMX_GPU_DD_COMMS "
 243                                 "(equivalent with GMX_USE_GPU_BUFFER_OPS=1).");
 244                 devFlags.enableGpuBufferOps = true;
 245             }
 246             GMX_LOG(mdlog.warning)
 247                     .asParagraph()
 248                     .appendTextFormatted(
 249                             "This run has requested the 'GPU halo exchange' feature, enabled by "
 250                             "the "
 251                             "GMX_GPU_DD_COMMS environment variable.");
 252         }
 253         else
 254         {
 255             GMX_LOG(mdlog.warning)
 256                     .asParagraph()
 257                     .appendTextFormatted(
 258                             "GMX_GPU_DD_COMMS environment variable detected, but the 'GPU "
 259                             "halo exchange' feature will not be enabled as nonbonded interactions "
 260                             "are not offloaded.");
 261             devFlags.enableGpuHaloExchange = false;
 262         }
 263     }
 264
 265     if (devFlags.enableGpuPmePPComm)
 266     {
 267         if (pmeRunMode == PmeRunMode::GPU)
 268         {
 269             GMX_LOG(mdlog.warning)
 270                     .asParagraph()
 271                     .appendTextFormatted(
 272                             "This run uses the 'GPU PME-PP communications' feature, enabled "
 273                             "by the GMX_GPU_PME_PP_COMMS environment variable.");
 274         }
 275         else
 276         {
 277             std::string clarification;
 278             if (pmeRunMode == PmeRunMode::Mixed)
 279             {
 280                 clarification =
 281                         "PME FFT and gather are not offloaded to the GPU (PME is running in mixed "
 282                         "mode).";
 283             }
 284             else
 285             {
 286                 clarification = "PME is not offloaded to the GPU.";
 287             }
 288             GMX_LOG(mdlog.warning)
 289                     .asParagraph()
 290                     .appendText(
 291                             "GMX_GPU_PME_PP_COMMS environment variable detected, but the "
 292                             "'GPU PME-PP communications' feature was not enabled as "
 293                             + clarification);
 294             devFlags.enableGpuPmePPComm = false;
 295         }
 296     }
 297
 298     return devFlags;
 299 }
 300
 301 /*! \brief Barrier for safe simultaneous thread access to mdrunner data
 302  *
 303  * Used to ensure that the master thread does not modify mdrunner during copy
 304  * on the spawned threads. */
 305 static void threadMpiMdrunnerAccessBarrier()
 306 {
 307 #if GMX_THREAD_MPI
 308     MPI_Barrier(MPI_COMM_WORLD);
 309 #endif
 310 }
 311
 312 Mdrunner Mdrunner::cloneOnSpawnedThread() const
 313 {
 314     auto newRunner = Mdrunner(std::make_unique<MDModules>());
 315
 316     // All runners in the same process share a restraint manager resource because it is
 317     // part of the interface to the client code, which is associated only with the
 318     // original thread. Handles to the same resources can be obtained by copy.
 319     {
 320         newRunner.restraintManager_ = std::make_unique<RestraintManager>(*restraintManager_);
 321     }
 322
 323     // Copy members of master runner.
 324     // \todo Replace with builder when Simulation context and/or runner phases are better defined.
 325     // Ref https://gitlab.com/gromacs/gromacs/-/issues/2587 and https://gitlab.com/gromacs/gromacs/-/issues/2375
 326     newRunner.hw_opt    = hw_opt;
 327     newRunner.filenames = filenames;
 328
 329     newRunner.oenv            = oenv;
 330     newRunner.mdrunOptions    = mdrunOptions;
 331     newRunner.domdecOptions   = domdecOptions;
 332     newRunner.nbpu_opt        = nbpu_opt;
 333     newRunner.pme_opt         = pme_opt;
 334     newRunner.pme_fft_opt     = pme_fft_opt;
 335     newRunner.bonded_opt      = bonded_opt;
 336     newRunner.update_opt      = update_opt;
 337     newRunner.nstlist_cmdline = nstlist_cmdline;
 338     newRunner.replExParams    = replExParams;
 339     newRunner.pforce          = pforce;
 340     // Give the spawned thread the newly created valid communicator
 341     // for the simulation.
 342     newRunner.communicator        = MPI_COMM_WORLD;
 343     newRunner.ms                  = ms;
 344     newRunner.startingBehavior    = startingBehavior;
 345     newRunner.stopHandlerBuilder_ = std::make_unique<StopHandlerBuilder>(*stopHandlerBuilder_);
 346
 347     threadMpiMdrunnerAccessBarrier();
 348
 349     return newRunner;
 350 }
 351
 352 /*! \brief The callback used for running on spawned threads.
 353  *
 354  * Obtains the pointer to the master mdrunner object from the one
 355  * argument permitted to the thread-launch API call, copies it to make
 356  * a new runner for this thread, reinitializes necessary data, and
 357  * proceeds to the simulation. */
 358 static void mdrunner_start_fn(const void* arg)
 359 {
 360     try
 361     {
 362         auto masterMdrunner = reinterpret_cast<const gmx::Mdrunner*>(arg);
 363         /* copy the arg list to make sure that it's thread-local. This
 364            doesn't copy pointed-to items, of course; fnm, cr and fplog
 365            are reset in the call below, all others should be const. */
 366         gmx::Mdrunner mdrunner = masterMdrunner->cloneOnSpawnedThread();
 367         mdrunner.mdrunner();
 368     }
 369     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR
 370 }
 371
 372
 373 void Mdrunner::spawnThreads(int numThreadsToLaunch)
 374 {
 375 #if GMX_THREAD_MPI
 376     /* now spawn new threads that start mdrunner_start_fn(), while
 377        the main thread returns. Thread affinity is handled later. */
 378     if (tMPI_Init_fn(TRUE, numThreadsToLaunch, TMPI_AFFINITY_NONE, mdrunner_start_fn,
 379                      static_cast<const void*>(this))
 380         != TMPI_SUCCESS)
 381     {
 382         GMX_THROW(gmx::InternalError("Failed to spawn thread-MPI threads"));
 383     }
 384
 385     // Give the master thread the newly created valid communicator for
 386     // the simulation.
 387     communicator = MPI_COMM_WORLD;
 388     threadMpiMdrunnerAccessBarrier();
 389 #else
 390     GMX_UNUSED_VALUE(numThreadsToLaunch);
 391     GMX_UNUSED_VALUE(mdrunner_start_fn);
 392 #endif
 393 }
 394
 395 } // namespace gmx
 396
 397 /*! \brief Initialize variables for Verlet scheme simulation */
 398 static void prepare_verlet_scheme(FILE*               fplog,
 399                                   t_commrec*          cr,
 400                                   t_inputrec*         ir,
 401                                   int                 nstlist_cmdline,
 402                                   const gmx_mtop_t*   mtop,
 403                                   const matrix        box,
 404                                   bool                makeGpuPairList,
 405                                   const gmx::CpuInfo& cpuinfo)
 406 {
 407     // We checked the cut-offs in grompp, but double-check here.
 408     // We have PME+LJcutoff kernels for rcoulomb>rvdw.
 409     if (EEL_PME_EWALD(ir->coulombtype) && ir->vdwtype == eelCUT)
 410     {
 411         GMX_RELEASE_ASSERT(ir->rcoulomb >= ir->rvdw,
 412                            "With Verlet lists and PME we should have rcoulomb>=rvdw");
 413     }
 414     else
 415     {
 416         GMX_RELEASE_ASSERT(ir->rcoulomb == ir->rvdw,
 417                            "With Verlet lists and no PME rcoulomb and rvdw should be identical");
 418     }
 419     /* For NVE simulations, we will retain the initial list buffer */
 420     if (EI_DYNAMICS(ir->eI) && ir->verletbuf_tol > 0 && !(EI_MD(ir->eI) && ir->etc == etcNO))
 421     {
 422         /* Update the Verlet buffer size for the current run setup */
 423
 424         /* Here we assume SIMD-enabled kernels are being used. But as currently
 425          * calc_verlet_buffer_size gives the same results for 4x8 and 4x4
 426          * and 4x2 gives a larger buffer than 4x4, this is ok.
 427          */
 428         ListSetupType listType =
 429                 (makeGpuPairList ? ListSetupType::Gpu : ListSetupType::CpuSimdWhenSupported);
 430         VerletbufListSetup listSetup = verletbufGetSafeListSetup(listType);
 431
 432         const real rlist_new =
 433                 calcVerletBufferSize(*mtop, det(box), *ir, ir->nstlist, ir->nstlist - 1, -1, listSetup);
 434
 435         if (rlist_new != ir->rlist)
 436         {
 437             if (fplog != nullptr)
 438             {
 439                 fprintf(fplog,
 440                         "\nChanging rlist from %g to %g for non-bonded %dx%d atom kernels\n\n",
 441                         ir->rlist, rlist_new, listSetup.cluster_size_i, listSetup.cluster_size_j);
 442             }
 443             ir->rlist = rlist_new;
 444         }
 445     }
 446
 447     if (nstlist_cmdline > 0 && (!EI_DYNAMICS(ir->eI) || ir->verletbuf_tol <= 0))
 448     {
 449         gmx_fatal(FARGS, "Can not set nstlist without %s",
 450                   !EI_DYNAMICS(ir->eI) ? "dynamics" : "verlet-buffer-tolerance");
 451     }
 452
 453     if (EI_DYNAMICS(ir->eI))
 454     {
 455         /* Set or try nstlist values */
 456         increaseNstlist(fplog, cr, ir, nstlist_cmdline, mtop, box, makeGpuPairList, cpuinfo);
 457     }
 458 }
 459
 460 /*! \brief Override the nslist value in inputrec
 461  *
 462  * with value passed on the command line (if any)
 463  */
 464 static void override_nsteps_cmdline(const gmx::MDLogger& mdlog, int64_t nsteps_cmdline, t_inputrec* ir)
 465 {
 466     assert(ir);
 467
 468     /* override with anything else than the default -2 */
 469     if (nsteps_cmdline > -2)
 470     {
 471         char sbuf_steps[STEPSTRSIZE];
 472         char sbuf_msg[STRLEN];
 473
 474         ir->nsteps = nsteps_cmdline;
 475         if (EI_DYNAMICS(ir->eI) && nsteps_cmdline != -1)
 476         {
 477             sprintf(sbuf_msg,
 478                     "Overriding nsteps with value passed on the command line: %s steps, %.3g ps",
 479                     gmx_step_str(nsteps_cmdline, sbuf_steps), fabs(nsteps_cmdline * ir->delta_t));
 480         }
 481         else
 482         {
 483             sprintf(sbuf_msg, "Overriding nsteps with value passed on the command line: %s steps",
 484                     gmx_step_str(nsteps_cmdline, sbuf_steps));
 485         }
 486
 487         GMX_LOG(mdlog.warning).asParagraph().appendText(sbuf_msg);
 488     }
 489     else if (nsteps_cmdline < -2)
 490     {
 491         gmx_fatal(FARGS, "Invalid nsteps value passed on the command line: %" PRId64, nsteps_cmdline);
 492     }
 493     /* Do nothing if nsteps_cmdline == -2 */
 494 }
 495
 496 namespace gmx
 497 {
 498
 499 /*! \brief Return whether GPU acceleration of nonbondeds is supported with the given settings.
 500  *
 501  * If not, and if a warning may be issued, logs a warning about
 502  * falling back to CPU code. With thread-MPI, only the first
 503  * call to this function should have \c issueWarning true. */
 504 static bool gpuAccelerationOfNonbondedIsUseful(const MDLogger& mdlog, const t_inputrec& ir, bool issueWarning)
 505 {
 506     bool        gpuIsUseful = true;
 507     std::string warning;
 508
 509     if (ir.opts.ngener - ir.nwall > 1)
 510     {
 511         /* The GPU code does not support more than one energy group.
 512          * If the user requested GPUs explicitly, a fatal error is given later.
 513          */
 514         gpuIsUseful = false;
 515         warning =
 516                 "Multiple energy groups is not implemented for GPUs, falling back to the CPU. "
 517                 "For better performance, run on the GPU without energy groups and then do "
 518                 "gmx mdrun -rerun option on the trajectory with an energy group .tpr file.";
 519     }
 520
 521     if (EI_TPI(ir.eI))
 522     {
 523         gpuIsUseful = false;
 524         warning     = "TPI is not implemented for GPUs.";
 525     }
 526
 527     if (!gpuIsUseful && issueWarning)
 528     {
 529         GMX_LOG(mdlog.warning).asParagraph().appendText(warning);
 530     }
 531
 532     return gpuIsUseful;
 533 }
 534
 535 //! Initializes the logger for mdrun.
 536 static gmx::LoggerOwner buildLogger(FILE* fplog, const bool isSimulationMasterRank)
 537 {
 538     gmx::LoggerBuilder builder;
 539     if (fplog != nullptr)
 540     {
 541         builder.addTargetFile(gmx::MDLogger::LogLevel::Info, fplog);
 542     }
 543     if (isSimulationMasterRank)
 544     {
 545         builder.addTargetStream(gmx::MDLogger::LogLevel::Warning, &gmx::TextOutputFile::standardError());
 546     }
 547     return builder.build();
 548 }
 549
 550 //! Make a TaskTarget from an mdrun argument string.
 551 static TaskTarget findTaskTarget(const char* optionString)
 552 {
 553     TaskTarget returnValue = TaskTarget::Auto;
 554
 555     if (strncmp(optionString, "auto", 3) == 0)
 556     {
 557         returnValue = TaskTarget::Auto;
 558     }
 559     else if (strncmp(optionString, "cpu", 3) == 0)
 560     {
 561         returnValue = TaskTarget::Cpu;
 562     }
 563     else if (strncmp(optionString, "gpu", 3) == 0)
 564     {
 565         returnValue = TaskTarget::Gpu;
 566     }
 567     else
 568     {
 569         GMX_ASSERT(false, "Option string should have been checked for sanity already");
 570     }
 571
 572     return returnValue;
 573 }
 574
 575 //! Finish run, aggregate data to print performance info.
 576 static void finish_run(FILE*                     fplog,
 577                        const gmx::MDLogger&      mdlog,
 578                        const t_commrec*          cr,
 579                        const t_inputrec*         inputrec,
 580                        t_nrnb                    nrnb[],
 581                        gmx_wallcycle_t           wcycle,
 582                        gmx_walltime_accounting_t walltime_accounting,
 583                        nonbonded_verlet_t*       nbv,
 584                        const gmx_pme_t*          pme,
 585                        gmx_bool                  bWriteStat)
 586 {
 587     double delta_t = 0;
 588     double nbfs = 0, mflop = 0;
 589     double elapsed_time, elapsed_time_over_all_ranks, elapsed_time_over_all_threads,
 590             elapsed_time_over_all_threads_over_all_ranks;
 591     /* Control whether it is valid to print a report. Only the
 592        simulation master may print, but it should not do so if the run
 593        terminated e.g. before a scheduled reset step. This is
 594        complicated by the fact that PME ranks are unaware of the
 595        reason why they were sent a pmerecvqxFINISH. To avoid
 596        communication deadlocks, we always do the communication for the
 597        report, even if we've decided not to write the report, because
 598        how long it takes to finish the run is not important when we've
 599        decided not to report on the simulation performance.
 600
 601        Further, we only report performance for dynamical integrators,
 602        because those are the only ones for which we plan to
 603        consider doing any optimizations. */
 604     bool printReport = EI_DYNAMICS(inputrec->eI) && SIMMASTER(cr);
 605
 606     if (printReport && !walltime_accounting_get_valid_finish(walltime_accounting))
 607     {
 608         GMX_LOG(mdlog.warning)
 609                 .asParagraph()
 610                 .appendText("Simulation ended prematurely, no performance report will be written.");
 611         printReport = false;
 612     }
 613
 614     t_nrnb*                 nrnb_tot;
 615     std::unique_ptr<t_nrnb> nrnbTotalStorage;
 616     if (cr->nnodes > 1)
 617     {
 618         nrnbTotalStorage = std::make_unique<t_nrnb>();
 619         nrnb_tot         = nrnbTotalStorage.get();
 620 #if GMX_MPI
 621         MPI_Allreduce(nrnb->n, nrnb_tot->n, eNRNB, MPI_DOUBLE, MPI_SUM, cr->mpi_comm_mysim);
 622 #endif
 623     }
 624     else
 625     {
 626         nrnb_tot = nrnb;
 627     }
 628
 629     elapsed_time = walltime_accounting_get_time_since_reset(walltime_accounting);
 630     elapsed_time_over_all_threads =
 631             walltime_accounting_get_time_since_reset_over_all_threads(walltime_accounting);
 632     if (cr->nnodes > 1)
 633     {
 634 #if GMX_MPI
 635         /* reduce elapsed_time over all MPI ranks in the current simulation */
 636         MPI_Allreduce(&elapsed_time, &elapsed_time_over_all_ranks, 1, MPI_DOUBLE, MPI_SUM,
 637                       cr->mpi_comm_mysim);
 638         elapsed_time_over_all_ranks /= cr->nnodes;
 639         /* Reduce elapsed_time_over_all_threads over all MPI ranks in the
 640          * current simulation. */
 641         MPI_Allreduce(&elapsed_time_over_all_threads, &elapsed_time_over_all_threads_over_all_ranks,
 642                       1, MPI_DOUBLE, MPI_SUM, cr->mpi_comm_mysim);
 643 #endif
 644     }
 645     else
 646     {
 647         elapsed_time_over_all_ranks                  = elapsed_time;
 648         elapsed_time_over_all_threads_over_all_ranks = elapsed_time_over_all_threads;
 649     }
 650
 651     if (printReport)
 652     {
 653         print_flop(fplog, nrnb_tot, &nbfs, &mflop);
 654     }
 655
 656     if (thisRankHasDuty(cr, DUTY_PP) && DOMAINDECOMP(cr))
 657     {
 658         print_dd_statistics(cr, inputrec, fplog);
 659     }
 660
 661     /* TODO Move the responsibility for any scaling by thread counts
 662      * to the code that handled the thread region, so that there's a
 663      * mechanism to keep cycle counting working during the transition
 664      * to task parallelism. */
 665     int nthreads_pp  = gmx_omp_nthreads_get(emntNonbonded);
 666     int nthreads_pme = gmx_omp_nthreads_get(emntPME);
 667     wallcycle_scale_by_num_threads(wcycle, thisRankHasDuty(cr, DUTY_PME) && !thisRankHasDuty(cr, DUTY_PP),
 668                                    nthreads_pp, nthreads_pme);
 669     auto cycle_sum(wallcycle_sum(cr, wcycle));
 670
 671     if (printReport)
 672     {
 673         auto nbnxn_gpu_timings =
 674                 (nbv != nullptr && nbv->useGpu()) ? Nbnxm::gpu_get_timings(nbv->gpu_nbv) : nullptr;
 675         gmx_wallclock_gpu_pme_t pme_gpu_timings = {};
 676
 677         if (pme_gpu_task_enabled(pme))
 678         {
 679             pme_gpu_get_timings(pme, &pme_gpu_timings);
 680         }
 681         wallcycle_print(fplog, mdlog, cr->nnodes, cr->npmenodes, nthreads_pp, nthreads_pme,
 682                         elapsed_time_over_all_ranks, wcycle, cycle_sum, nbnxn_gpu_timings,
 683                         &pme_gpu_timings);
 684
 685         if (EI_DYNAMICS(inputrec->eI))
 686         {
 687             delta_t = inputrec->delta_t;
 688         }
 689
 690         if (fplog)
 691         {
 692             print_perf(fplog, elapsed_time_over_all_threads_over_all_ranks, elapsed_time_over_all_ranks,
 693                        walltime_accounting_get_nsteps_done_since_reset(walltime_accounting),
 694                        delta_t, nbfs, mflop);
 695         }
 696         if (bWriteStat)
 697         {
 698             print_perf(stderr, elapsed_time_over_all_threads_over_all_ranks, elapsed_time_over_all_ranks,
 699                        walltime_accounting_get_nsteps_done_since_reset(walltime_accounting),
 700                        delta_t, nbfs, mflop);
 701         }
 702     }
 703 }
 704
 705 int Mdrunner::mdrunner()
 706 {
 707     matrix                    box;
 708     t_forcerec*               fr               = nullptr;
 709     real                      ewaldcoeff_q     = 0;
 710     real                      ewaldcoeff_lj    = 0;
 711     int                       nChargePerturbed = -1, nTypePerturbed = 0;
 712     gmx_wallcycle_t           wcycle;
 713     gmx_walltime_accounting_t walltime_accounting = nullptr;
 714     gmx_membed_t*             membed              = nullptr;
 715     gmx_hw_info_t*            hwinfo              = nullptr;
 716
 717     /* CAUTION: threads may be started later on in this function, so
 718        cr doesn't reflect the final parallel state right now */
 719     gmx_mtop_t mtop;
 720
 721     /* TODO: inputrec should tell us whether we use an algorithm, not a file option */
 722     const bool doEssentialDynamics = opt2bSet("-ei", filenames.size(), filenames.data());
 723     const bool doMembed            = opt2bSet("-membed", filenames.size(), filenames.data());
 724     const bool doRerun             = mdrunOptions.rerun;
 725
 726     // Handle task-assignment related user options.
 727     EmulateGpuNonbonded emulateGpuNonbonded =
 728             (getenv("GMX_EMULATE_GPU") != nullptr ? EmulateGpuNonbonded::Yes : EmulateGpuNonbonded::No);
 729
 730     std::vector<int> userGpuTaskAssignment;
 731     try
 732     {
 733         userGpuTaskAssignment = parseUserTaskAssignmentString(hw_opt.userGpuTaskAssignment);
 734     }
 735     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR
 736     auto nonbondedTarget = findTaskTarget(nbpu_opt);
 737     auto pmeTarget       = findTaskTarget(pme_opt);
 738     auto pmeFftTarget    = findTaskTarget(pme_fft_opt);
 739     auto bondedTarget    = findTaskTarget(bonded_opt);
 740     auto updateTarget    = findTaskTarget(update_opt);
 741
 742     FILE* fplog = nullptr;
 743     // If we are appending, we don't write log output because we need
 744     // to check that the old log file matches what the checkpoint file
 745     // expects. Otherwise, we should start to write log output now if
 746     // there is a file ready for it.
 747     if (logFileHandle != nullptr && startingBehavior != StartingBehavior::RestartWithAppending)
 748     {
 749         fplog = gmx_fio_getfp(logFileHandle);
 750     }
 751     const bool       isSimulationMasterRank = findIsSimulationMasterRank(ms, communicator);
 752     gmx::LoggerOwner logOwner(buildLogger(fplog, isSimulationMasterRank));
 753     gmx::MDLogger    mdlog(logOwner.logger());
 754
 755     // TODO The thread-MPI master rank makes a working
 756     // PhysicalNodeCommunicator here, but it gets rebuilt by all ranks
 757     // after the threads have been launched. This works because no use
 758     // is made of that communicator until after the execution paths
 759     // have rejoined. But it is likely that we can improve the way
 760     // this is expressed, e.g. by expressly running detection only the
 761     // master rank for thread-MPI, rather than relying on the mutex
 762     // and reference count.
 763     PhysicalNodeCommunicator physicalNodeComm(communicator, gmx_physicalnode_id_hash());
 764     hwinfo = gmx_detect_hardware(mdlog, physicalNodeComm);
 765
 766     gmx_print_detected_hardware(fplog, isSimulationMasterRank && isMasterSim(ms), mdlog, hwinfo);
 767
 768     std::vector<int> gpuIdsToUse = makeGpuIdsToUse(hwinfo->gpu_info, hw_opt.gpuIdsAvailable);
 769
 770     // Print citation requests after all software/hardware printing
 771     pleaseCiteGromacs(fplog);
 772
 773     // TODO Replace this by unique_ptr once t_inputrec is C++
 774     t_inputrec               inputrecInstance;
 775     t_inputrec*              inputrec = nullptr;
 776     std::unique_ptr<t_state> globalState;
 777
 778     auto partialDeserializedTpr = std::make_unique<PartialDeserializedTprFile>();
 779
 780     if (isSimulationMasterRank)
 781     {
 782         /* Only the master rank has the global state */
 783         globalState = std::make_unique<t_state>();
 784
 785         /* Read (nearly) all data required for the simulation
 786          * and keep the partly serialized tpr contents to send to other ranks later
 787          */
 788         *partialDeserializedTpr = read_tpx_state(ftp2fn(efTPR, filenames.size(), filenames.data()),
 789                                                  &inputrecInstance, globalState.get(), &mtop);
 790         inputrec                = &inputrecInstance;
 791     }
 792
 793     /* Check and update the hardware options for internal consistency */
 794     checkAndUpdateHardwareOptions(mdlog, &hw_opt, isSimulationMasterRank, domdecOptions.numPmeRanks,
 795                                   inputrec);
 796
 797     if (GMX_THREAD_MPI && isSimulationMasterRank)
 798     {
 799         bool useGpuForNonbonded = false;
 800         bool useGpuForPme       = false;
 801         try
 802         {
 803             GMX_RELEASE_ASSERT(inputrec != nullptr, "Keep the compiler happy");
 804
 805             // If the user specified the number of ranks, then we must
 806             // respect that, but in default mode, we need to allow for
 807             // the number of GPUs to choose the number of ranks.
 808             auto canUseGpuForNonbonded = buildSupportsNonbondedOnGpu(nullptr);
 809             useGpuForNonbonded         = decideWhetherToUseGpusForNonbondedWithThreadMpi(
 810                     nonbondedTarget, gpuIdsToUse, userGpuTaskAssignment, emulateGpuNonbonded,
 811                     canUseGpuForNonbonded,
 812                     gpuAccelerationOfNonbondedIsUseful(mdlog, *inputrec, GMX_THREAD_MPI),
 813                     hw_opt.nthreads_tmpi);
 814             useGpuForPme = decideWhetherToUseGpusForPmeWithThreadMpi(
 815                     useGpuForNonbonded, pmeTarget, gpuIdsToUse, userGpuTaskAssignment, *hwinfo,
 816                     *inputrec, mtop, hw_opt.nthreads_tmpi, domdecOptions.numPmeRanks);
 817         }
 818         GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR
 819
 820         /* Determine how many thread-MPI ranks to start.
 821          *
 822          * TODO Over-writing the user-supplied value here does
 823          * prevent any possible subsequent checks from working
 824          * correctly. */
 825         hw_opt.nthreads_tmpi = get_nthreads_mpi(hwinfo, &hw_opt, gpuIdsToUse, useGpuForNonbonded,
 826                                                 useGpuForPme, inputrec, &mtop, mdlog, doMembed);
 827
 828         // Now start the threads for thread MPI.
 829         spawnThreads(hw_opt.nthreads_tmpi);
 830         // The spawned threads enter mdrunner() and execution of
 831         // master and spawned threads joins at the end of this block.
 832         physicalNodeComm = PhysicalNodeCommunicator(communicator, gmx_physicalnode_id_hash());
 833     }
 834
 835     GMX_RELEASE_ASSERT(communicator == MPI_COMM_WORLD, "Must have valid world communicator");
 836     CommrecHandle crHandle = init_commrec(communicator, ms);
 837     t_commrec*    cr       = crHandle.get();
 838     GMX_RELEASE_ASSERT(cr != nullptr, "Must have valid commrec");
 839
 840     if (PAR(cr))
 841     {
 842         /* now broadcast everything to the non-master nodes/threads: */
 843         if (!isSimulationMasterRank)
 844         {
 845             inputrec = &inputrecInstance;
 846         }
 847         init_parallel(cr->mpi_comm_mygroup, MASTER(cr), inputrec, &mtop, partialDeserializedTpr.get());
 848     }
 849     GMX_RELEASE_ASSERT(inputrec != nullptr, "All ranks should have a valid inputrec now");
 850     partialDeserializedTpr.reset(nullptr);
 851
 852     // Now the number of ranks is known to all ranks, and each knows
 853     // the inputrec read by the master rank. The ranks can now all run
 854     // the task-deciding functions and will agree on the result
 855     // without needing to communicate.
 856     const bool useDomainDecomposition = (PAR(cr) && !(EI_TPI(inputrec->eI) || inputrec->eI == eiNM));
 857
 858     // Note that these variables describe only their own node.
 859     //
 860     // Note that when bonded interactions run on a GPU they always run
 861     // alongside a nonbonded task, so do not influence task assignment
 862     // even though they affect the force calculation workload.
 863     bool useGpuForNonbonded = false;
 864     bool useGpuForPme       = false;
 865     bool useGpuForBonded    = false;
 866     bool useGpuForUpdate    = false;
 867     bool gpusWereDetected   = hwinfo->ngpu_compatible_tot > 0;
 868     try
 869     {
 870         // It's possible that there are different numbers of GPUs on
 871         // different nodes, which is the user's responsibility to
 872         // handle. If unsuitable, we will notice that during task
 873         // assignment.
 874         auto canUseGpuForNonbonded = buildSupportsNonbondedOnGpu(nullptr);
 875         useGpuForNonbonded         = decideWhetherToUseGpusForNonbonded(
 876                 nonbondedTarget, userGpuTaskAssignment, emulateGpuNonbonded, canUseGpuForNonbonded,
 877                 gpuAccelerationOfNonbondedIsUseful(mdlog, *inputrec, !GMX_THREAD_MPI), gpusWereDetected);
 878         useGpuForPme = decideWhetherToUseGpusForPme(
 879                 useGpuForNonbonded, pmeTarget, userGpuTaskAssignment, *hwinfo, *inputrec, mtop,
 880                 cr->nnodes, domdecOptions.numPmeRanks, gpusWereDetected);
 881         auto canUseGpuForBonded = buildSupportsGpuBondeds(nullptr)
 882                                   && inputSupportsGpuBondeds(*inputrec, mtop, nullptr);
 883         useGpuForBonded = decideWhetherToUseGpusForBonded(
 884                 useGpuForNonbonded, useGpuForPme, bondedTarget, canUseGpuForBonded,
 885                 EVDW_PME(inputrec->vdwtype), EEL_PME_EWALD(inputrec->coulombtype),
 886                 domdecOptions.numPmeRanks, gpusWereDetected);
 887     }
 888     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR
 889
 890     const PmeRunMode pmeRunMode = determinePmeRunMode(useGpuForPme, pmeFftTarget, *inputrec);
 891
 892     // Initialize development feature flags that enabled by environment variable
 893     // and report those features that are enabled.
 894     const DevelopmentFeatureFlags devFlags =
 895             manageDevelopmentFeatures(mdlog, useGpuForNonbonded, pmeRunMode);
 896
 897     const bool useModularSimulator = checkUseModularSimulator(
 898             false, inputrec, doRerun, mtop, ms, replExParams, nullptr, doEssentialDynamics, doMembed);
 899
 900     // Build restraints.
 901     // TODO: hide restraint implementation details from Mdrunner.
 902     // There is nothing unique about restraints at this point as far as the
 903     // Mdrunner is concerned. The Mdrunner should just be getting a sequence of
 904     // factory functions from the SimulationContext on which to call mdModules_->add().
 905     // TODO: capture all restraints into a single RestraintModule, passed to the runner builder.
 906     for (auto&& restraint : restraintManager_->getRestraints())
 907     {
 908         auto module = RestraintMDModule::create(restraint, restraint->sites());
 909         mdModules_->add(std::move(module));
 910     }
 911
 912     // TODO: Error handling
 913     mdModules_->assignOptionsToModules(*inputrec->params, nullptr);
 914     // now that the MdModules know their options, they know which callbacks to sign up to
 915     mdModules_->subscribeToSimulationSetupNotifications();
 916     const auto& mdModulesNotifier = mdModules_->notifier().simulationSetupNotifications_;
 917
 918     if (inputrec->internalParameters != nullptr)
 919     {
 920         mdModulesNotifier.notify(*inputrec->internalParameters);
 921     }
 922
 923     if (fplog != nullptr)
 924     {
 925         pr_inputrec(fplog, 0, "Input Parameters", inputrec, FALSE);
 926         fprintf(fplog, "\n");
 927     }
 928
 929     if (SIMMASTER(cr))
 930     {
 931         /* In rerun, set velocities to zero if present */
 932         if (doRerun && ((globalState->flags & (1 << estV)) != 0))
 933         {
 934             // rerun does not use velocities
 935             GMX_LOG(mdlog.info)
 936                     .asParagraph()
 937                     .appendText(
 938                             "Rerun trajectory contains velocities. Rerun does only evaluate "
 939                             "potential energy and forces. The velocities will be ignored.");
 940             for (int i = 0; i < globalState->natoms; i++)
 941             {
 942                 clear_rvec(globalState->v[i]);
 943             }
 944             globalState->flags &= ~(1 << estV);
 945         }
 946
 947         /* now make sure the state is initialized and propagated */
 948         set_state_entries(globalState.get(), inputrec, useModularSimulator);
 949     }
 950
 951     /* NM and TPI parallelize over force/energy calculations, not atoms,
 952      * so we need to initialize and broadcast the global state.
 953      */
 954     if (inputrec->eI == eiNM || inputrec->eI == eiTPI)
 955     {
 956         if (!MASTER(cr))
 957         {
 958             globalState = std::make_unique<t_state>();
 959         }
 960         broadcastStateWithoutDynamics(cr->mpi_comm_mygroup, DOMAINDECOMP(cr), PAR(cr), globalState.get());
 961     }
 962
 963     /* A parallel command line option consistency check that we can
 964        only do after any threads have started. */
 965     if (!PAR(cr)
 966         && (domdecOptions.numCells[XX] > 1 || domdecOptions.numCells[YY] > 1
 967             || domdecOptions.numCells[ZZ] > 1 || domdecOptions.numPmeRanks > 0))
 968     {
 969         gmx_fatal(FARGS,
 970                   "The -dd or -npme option request a parallel simulation, "
 971 #if !GMX_MPI
 972                   "but %s was compiled without threads or MPI enabled",
 973                   output_env_get_program_display_name(oenv));
 974 #elif GMX_THREAD_MPI
 975                   "but the number of MPI-threads (option -ntmpi) is not set or is 1");
 976 #else
 977                   "but %s was not started through mpirun/mpiexec or only one rank was requested "
 978                   "through mpirun/mpiexec",
 979                   output_env_get_program_display_name(oenv));
 980 #endif
 981     }
 982
 983     if (doRerun && (EI_ENERGY_MINIMIZATION(inputrec->eI) || eiNM == inputrec->eI))
 984     {
 985         gmx_fatal(FARGS,
 986                   "The .mdp file specified an energy mininization or normal mode algorithm, and "
 987                   "these are not compatible with mdrun -rerun");
 988     }
 989
 990     if (!(EEL_PME(inputrec->coulombtype) || EVDW_PME(inputrec->vdwtype)))
 991     {
 992         if (domdecOptions.numPmeRanks > 0)
 993         {
 994             gmx_fatal_collective(FARGS, cr->mpi_comm_mysim, MASTER(cr),
 995                                  "PME-only ranks are requested, but the system does not use PME "
 996                                  "for electrostatics or LJ");
 997         }
 998
 999         domdecOptions.numPmeRanks = 0;
1000     }
1001
1002     if (useGpuForNonbonded && domdecOptions.numPmeRanks < 0)
1003     {
1004         /* With NB GPUs we don't automatically use PME-only CPU ranks. PME ranks can
1005          * improve performance with many threads per GPU, since our OpenMP
1006          * scaling is bad, but it's difficult to automate the setup.
1007          */
1008         domdecOptions.numPmeRanks = 0;
1009     }
1010     if (useGpuForPme)
1011     {
1012         if (domdecOptions.numPmeRanks < 0)
1013         {
1014             domdecOptions.numPmeRanks = 0;
1015             // TODO possibly print a note that one can opt-in for a separate PME GPU rank?
1016         }
1017         else
1018         {
1019             GMX_RELEASE_ASSERT(domdecOptions.numPmeRanks <= 1,
1020                                "PME GPU decomposition is not supported");
1021         }
1022     }
1023
1024 #if GMX_FAHCORE
1025     if (MASTER(cr))
1026     {
1027         fcRegisterSteps(inputrec->nsteps, inputrec->init_step);
1028     }
1029 #endif
1030
1031     /* NMR restraints must be initialized before load_checkpoint,
1032      * since with time averaging the history is added to t_state.
1033      * For proper consistency check we therefore need to extend
1034      * t_state here.
1035      * So the PME-only nodes (if present) will also initialize
1036      * the distance restraints.
1037      */
1038
1039     /* This needs to be called before read_checkpoint to extend the state */
1040     t_disresdata* disresdata;
1041     snew(disresdata, 1);
1042     init_disres(fplog, &mtop, inputrec, DisResRunMode::MDRun, MASTER(cr) ? DDRole::Master : DDRole::Agent,
1043                 PAR(cr) ? NumRanks::Multiple : NumRanks::Single, cr->mpi_comm_mysim, ms, disresdata,
1044                 globalState.get(), replExParams.exchangeInterval > 0);
1045
1046     t_oriresdata* oriresdata;
1047     snew(oriresdata, 1);
1048     init_orires(fplog, &mtop, inputrec, cr, ms, globalState.get(), oriresdata);
1049
1050     auto deform = prepareBoxDeformation(globalState->box, MASTER(cr) ? DDRole::Master : DDRole::Agent,
1051                                         PAR(cr) ? NumRanks::Multiple : NumRanks::Single,
1052                                         cr->mpi_comm_mygroup, *inputrec);
1053
1054     ObservablesHistory observablesHistory = {};
1055
1056     if (startingBehavior != StartingBehavior::NewSimulation)
1057     {
1058         /* Check if checkpoint file exists before doing continuation.
1059          * This way we can use identical input options for the first and subsequent runs...
1060          */
1061         if (mdrunOptions.numStepsCommandline > -2)
1062         {
1063             /* Temporarily set the number of steps to unlimited to avoid
1064              * triggering the nsteps check in load_checkpoint().
1065              * This hack will go away soon when the -nsteps option is removed.
1066              */
1067             inputrec->nsteps = -1;
1068         }
1069
1070         load_checkpoint(opt2fn_master("-cpi", filenames.size(), filenames.data(), cr),
1071                         logFileHandle, cr, domdecOptions.numCells, inputrec, globalState.get(),
1072                         &observablesHistory, mdrunOptions.reproducible, mdModules_->notifier());
1073
1074         if (startingBehavior == StartingBehavior::RestartWithAppending && logFileHandle)
1075         {
1076             // Now we can start normal logging to the truncated log file.
1077             fplog = gmx_fio_getfp(logFileHandle);
1078             prepareLogAppending(fplog);
1079             logOwner = buildLogger(fplog, MASTER(cr));
1080             mdlog    = logOwner.logger();
1081         }
1082     }
1083
1084     if (mdrunOptions.numStepsCommandline > -2)
1085     {
1086         GMX_LOG(mdlog.info)
1087                 .asParagraph()
1088                 .appendText(
1089                         "The -nsteps functionality is deprecated, and may be removed in a future "
1090                         "version. "
1091                         "Consider using gmx convert-tpr -nsteps or changing the appropriate .mdp "
1092                         "file field.");
1093     }
1094     /* override nsteps with value set on the commandline */
1095     override_nsteps_cmdline(mdlog, mdrunOptions.numStepsCommandline, inputrec);
1096
1097     if (SIMMASTER(cr))
1098     {
1099         copy_mat(globalState->box, box);
1100     }
1101
1102     if (PAR(cr))
1103     {
1104         gmx_bcast(sizeof(box), box, cr->mpi_comm_mygroup);
1105     }
1106
1107     if (inputrec->cutoff_scheme != ecutsVERLET)
1108     {
1109         gmx_fatal(FARGS,
1110                   "This group-scheme .tpr file can no longer be run by mdrun. Please update to the "
1111                   "Verlet scheme, or use an earlier version of GROMACS if necessary.");
1112     }
1113     /* Update rlist and nstlist. */
1114     prepare_verlet_scheme(fplog, cr, inputrec, nstlist_cmdline, &mtop, box,
1115                           useGpuForNonbonded || (emulateGpuNonbonded == EmulateGpuNonbonded::Yes),
1116                           *hwinfo->cpuInfo);
1117
1118     const bool prefer1DAnd1PulseDD = (devFlags.enableGpuHaloExchange && useGpuForNonbonded);
1119     // This builder is necessary while we have multi-part construction
1120     // of DD. Before DD is constructed, we use the existence of
1121     // the builder object to indicate that further construction of DD
1122     // is needed.
1123     std::unique_ptr<DomainDecompositionBuilder> ddBuilder;
1124     if (useDomainDecomposition)
1125     {
1126         ddBuilder = std::make_unique<DomainDecompositionBuilder>(
1127                 mdlog, cr, domdecOptions, mdrunOptions, prefer1DAnd1PulseDD, mtop, *inputrec, box,
1128                 positionsFromStatePointer(globalState.get()));
1129     }
1130     else
1131     {
1132         /* PME, if used, is done on all nodes with 1D decomposition */
1133         cr->npmenodes = 0;
1134         cr->duty      = (DUTY_PP | DUTY_PME);
1135
1136         if (inputrec->pbcType == PbcType::Screw)
1137         {
1138             gmx_fatal(FARGS, "pbc=screw is only implemented with domain decomposition");
1139         }
1140     }
1141
1142     // Produce the task assignment for this rank - done after DD is constructed
1143     GpuTaskAssignments gpuTaskAssignments = GpuTaskAssignmentsBuilder::build(
1144             gpuIdsToUse, userGpuTaskAssignment, *hwinfo, communicator, physicalNodeComm,
1145             nonbondedTarget, pmeTarget, bondedTarget, updateTarget, useGpuForNonbonded,
1146             useGpuForPme, thisRankHasDuty(cr, DUTY_PP),
1147             // TODO cr->duty & DUTY_PME should imply that a PME
1148             // algorithm is active, but currently does not.
1149             EEL_PME(inputrec->coulombtype) && thisRankHasDuty(cr, DUTY_PME));
1150
1151     // Get the device handles for the modules, nullptr when no task is assigned.
1152     int                deviceId   = -1;
1153     DeviceInformation* deviceInfo = gpuTaskAssignments.initDevice(&deviceId);
1154
1155     // timing enabling - TODO put this in gpu_utils (even though generally this is just option handling?)
1156     bool useTiming = true;
1157     if (GMX_GPU == GMX_GPU_CUDA)
1158     {
1159         /* WARNING: CUDA timings are incorrect with multiple streams.
1160          *          This is the main reason why they are disabled by default.
1161          */
1162         // TODO: Consider turning on by default when we can detect nr of streams.
1163         useTiming = (getenv("GMX_ENABLE_GPU_TIMING") != nullptr);
1164     }
1165     else if (GMX_GPU == GMX_GPU_OPENCL)
1166     {
1167         useTiming = (getenv("GMX_DISABLE_GPU_TIMING") == nullptr);
1168     }
1169
1170     // TODO Currently this is always built, yet DD partition code
1171     // checks if it is built before using it. Probably it should
1172     // become an MDModule that is made only when another module
1173     // requires it (e.g. pull, CompEl, density fitting), so that we
1174     // don't update the local atom sets unilaterally every step.
1175     LocalAtomSetManager atomSets;
1176     if (ddBuilder)
1177     {
1178         // TODO Pass the GPU streams to ddBuilder to use in buffer
1179         // transfers (e.g. halo exchange)
1180         cr->dd = ddBuilder->build(&atomSets);
1181         // The builder's job is done, so destruct it
1182         ddBuilder.reset(nullptr);
1183         // Note that local state still does not exist yet.
1184     }
1185
1186     // The GPU update is decided here because we need to know whether the constraints or
1187     // SETTLEs can span accross the domain borders (i.e. whether or not update groups are
1188     // defined). This is only known after DD is initialized, hence decision on using GPU
1189     // update is done so late.
1190     try
1191     {
1192         const bool useUpdateGroups = cr->dd ? ddUsesUpdateGroups(*cr->dd) : false;
1193
1194         useGpuForUpdate = decideWhetherToUseGpuForUpdate(
1195                 useDomainDecomposition, useUpdateGroups, pmeRunMode, domdecOptions.numPmeRanks > 0,
1196                 useGpuForNonbonded, updateTarget, gpusWereDetected, *inputrec, mtop,
1197                 doEssentialDynamics, gmx_mtop_ftype_count(mtop, F_ORIRES) > 0,
1198                 replExParams.exchangeInterval > 0, doRerun, devFlags, mdlog);
1199     }
1200     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR
1201
1202     const bool printHostName = (cr->nnodes > 1);
1203     gpuTaskAssignments.reportGpuUsage(mdlog, printHostName, useGpuForBonded, pmeRunMode, useGpuForUpdate);
1204
1205     std::unique_ptr<DeviceStreamManager> deviceStreamManager = nullptr;
1206
1207     if (deviceInfo != nullptr)
1208     {
1209         if (DOMAINDECOMP(cr) && thisRankHasDuty(cr, DUTY_PP))
1210         {
1211             dd_setup_dlb_resource_sharing(cr, deviceId);
1212         }
1213         deviceStreamManager = std::make_unique<DeviceStreamManager>(
1214                 *deviceInfo, useGpuForPme, useGpuForNonbonded, havePPDomainDecomposition(cr),
1215                 useGpuForUpdate, useTiming);
1216     }
1217
1218     // If the user chose a task assignment, give them some hints
1219     // where appropriate.
1220     if (!userGpuTaskAssignment.empty())
1221     {
1222         gpuTaskAssignments.logPerformanceHints(mdlog, ssize(gpuIdsToUse));
1223     }
1224
1225     if (PAR(cr))
1226     {
1227         /* After possible communicator splitting in make_dd_communicators.
1228          * we can set up the intra/inter node communication.
1229          */
1230         gmx_setup_nodecomm(fplog, cr);
1231     }
1232
1233 #if GMX_MPI
1234     if (isMultiSim(ms))
1235     {
1236         GMX_LOG(mdlog.warning)
1237                 .asParagraph()
1238                 .appendTextFormatted(
1239                         "This is simulation %d out of %d running as a composite GROMACS\n"
1240                         "multi-simulation job. Setup for this simulation:\n",
1241                         ms->sim, ms->nsim);
1242     }
1243     GMX_LOG(mdlog.warning)
1244             .appendTextFormatted("Using %d MPI %s\n", cr->nnodes,
1245 #    if GMX_THREAD_MPI
1246                                  cr->nnodes == 1 ? "thread" : "threads"
1247 #    else
1248                                  cr->nnodes == 1 ? "process" : "processes"
1249 #    endif
1250             );
1251     fflush(stderr);
1252 #endif
1253
1254     // If mdrun -pin auto honors any affinity setting that already
1255     // exists. If so, it is nice to provide feedback about whether
1256     // that existing affinity setting was from OpenMP or something
1257     // else, so we run this code both before and after we initialize
1258     // the OpenMP support.
1259     gmx_check_thread_affinity_set(mdlog, &hw_opt, hwinfo->nthreads_hw_avail, FALSE);
1260     /* Check and update the number of OpenMP threads requested */
1261     checkAndUpdateRequestedNumOpenmpThreads(&hw_opt, *hwinfo, cr, ms, physicalNodeComm.size_,
1262                                             pmeRunMode, mtop, *inputrec);
1263
1264     gmx_omp_nthreads_init(mdlog, cr, hwinfo->nthreads_hw_avail, physicalNodeComm.size_,
1265                           hw_opt.nthreads_omp, hw_opt.nthreads_omp_pme, !thisRankHasDuty(cr, DUTY_PP));
1266
1267     // Enable FP exception detection, but not in
1268     // Release mode and not for compilers with known buggy FP
1269     // exception support (clang with any optimization) or suspected
1270     // buggy FP exception support (gcc 7.* with optimization).
1271 #if !defined NDEBUG                                                                         \
1272         && !((defined __clang__ || (defined(__GNUC__) && !defined(__ICC) && __GNUC__ == 7)) \
1273              && defined __OPTIMIZE__)
1274     const bool bEnableFPE = true;
1275 #else
1276     const bool bEnableFPE = false;
1277 #endif
1278     // FIXME - reconcile with gmx_feenableexcept() call from CommandLineModuleManager::run()
1279     if (bEnableFPE)
1280     {
1281         gmx_feenableexcept();
1282     }
1283
1284     /* Now that we know the setup is consistent, check for efficiency */
1285     check_resource_division_efficiency(hwinfo, gpuTaskAssignments.thisRankHasAnyGpuTask(),
1286                                        mdrunOptions.ntompOptionIsSet, cr, mdlog);
1287
1288     /* getting number of PP/PME threads on this MPI / tMPI rank.
1289        PME: env variable should be read only on one node to make sure it is
1290        identical everywhere;
1291      */
1292     const int numThreadsOnThisRank = thisRankHasDuty(cr, DUTY_PP) ? gmx_omp_nthreads_get(emntNonbonded)
1293                                                                   : gmx_omp_nthreads_get(emntPME);
1294     checkHardwareOversubscription(numThreadsOnThisRank, cr->nodeid, *hwinfo->hardwareTopology,
1295                                   physicalNodeComm, mdlog);
1296
1297     // Enable Peer access between GPUs where available
1298     // Only for DD, only master PP rank needs to perform setup, and only if thread MPI plus
1299     // any of the GPU communication features are active.
1300     if (DOMAINDECOMP(cr) && MASTER(cr) && thisRankHasDuty(cr, DUTY_PP) && GMX_THREAD_MPI
1301         && (devFlags.enableGpuHaloExchange || devFlags.enableGpuPmePPComm))
1302     {
1303         setupGpuDevicePeerAccess(gpuIdsToUse, mdlog);
1304     }
1305
1306     if (hw_opt.threadAffinity != ThreadAffinity::Off)
1307     {
1308         /* Before setting affinity, check whether the affinity has changed
1309          * - which indicates that probably the OpenMP library has changed it
1310          * since we first checked).
1311          */
1312         gmx_check_thread_affinity_set(mdlog, &hw_opt, hwinfo->nthreads_hw_avail, TRUE);
1313
1314         int numThreadsOnThisNode, intraNodeThreadOffset;
1315         analyzeThreadsOnThisNode(physicalNodeComm, numThreadsOnThisRank, &numThreadsOnThisNode,
1316                                  &intraNodeThreadOffset);
1317
1318         /* Set the CPU affinity */
1319         gmx_set_thread_affinity(mdlog, cr, &hw_opt, *hwinfo->hardwareTopology, numThreadsOnThisRank,
1320                                 numThreadsOnThisNode, intraNodeThreadOffset, nullptr);
1321     }
1322
1323     if (mdrunOptions.timingOptions.resetStep > -1)
1324     {
1325         GMX_LOG(mdlog.info)
1326                 .asParagraph()
1327                 .appendText(
1328                         "The -resetstep functionality is deprecated, and may be removed in a "
1329                         "future version.");
1330     }
1331     wcycle = wallcycle_init(fplog, mdrunOptions.timingOptions.resetStep, cr);
1332
1333     if (PAR(cr))
1334     {
1335         /* Master synchronizes its value of reset_counters with all nodes
1336          * including PME only nodes */
1337         int64_t reset_counters = wcycle_get_reset_counters(wcycle);
1338         gmx_bcast(sizeof(reset_counters), &reset_counters, cr->mpi_comm_mysim);
1339         wcycle_set_reset_counters(wcycle, reset_counters);
1340     }
1341
1342     // Membrane embedding must be initialized before we call init_forcerec()
1343     if (doMembed)
1344     {
1345         if (MASTER(cr))
1346         {
1347             fprintf(stderr, "Initializing membed");
1348         }
1349         /* Note that membed cannot work in parallel because mtop is
1350          * changed here. Fix this if we ever want to make it run with
1351          * multiple ranks. */
1352         membed = init_membed(fplog, filenames.size(), filenames.data(), &mtop, inputrec,
1353                              globalState.get(), cr, &mdrunOptions.checkpointOptions.period);
1354     }
1355
1356     const bool               thisRankHasPmeGpuTask = gpuTaskAssignments.thisRankHasPmeGpuTask();
1357     std::unique_ptr<MDAtoms> mdAtoms;
1358     std::unique_ptr<VirtualSitesHandler> vsite;
1359     std::unique_ptr<GpuBonded>           gpuBonded;
1360
1361     t_nrnb nrnb;
1362     if (thisRankHasDuty(cr, DUTY_PP))
1363     {
1364         mdModulesNotifier.notify(*cr);
1365         mdModulesNotifier.notify(&atomSets);
1366         mdModulesNotifier.notify(inputrec->pbcType);
1367         mdModulesNotifier.notify(SimulationTimeStep{ inputrec->delta_t });
1368         /* Initiate forcerecord */
1369         fr                 = new t_forcerec;
1370         fr->forceProviders = mdModules_->initForceProviders();
1371         init_forcerec(fplog, mdlog, fr, inputrec, &mtop, cr, box,
1372                       opt2fn("-table", filenames.size(), filenames.data()),
1373                       opt2fn("-tablep", filenames.size(), filenames.data()),
1374                       opt2fns("-tableb", filenames.size(), filenames.data()), pforce);
1375         // Dirty hack, for fixing disres and orires should be made mdmodules
1376         fr->listedForces->fcdata().disres = disresdata;
1377         fr->listedForces->fcdata().orires = oriresdata;
1378
1379         // Save a handle to device stream manager to use elsewhere in the code
1380         // TODO: Forcerec is not a correct place to store it.
1381         fr->deviceStreamManager = deviceStreamManager.get();
1382
1383         if (devFlags.enableGpuPmePPComm && !thisRankHasDuty(cr, DUTY_PME))
1384         {
1385             GMX_RELEASE_ASSERT(
1386                     deviceStreamManager != nullptr,
1387                     "GPU device stream manager should be valid in order to use PME-PP direct "
1388                     "communications.");
1389             GMX_RELEASE_ASSERT(
1390                     deviceStreamManager->streamIsValid(DeviceStreamType::PmePpTransfer),
1391                     "GPU PP-PME stream should be valid in order to use GPU PME-PP direct "
1392                     "communications.");
1393             fr->pmePpCommGpu = std::make_unique<gmx::PmePpCommGpu>(
1394                     cr->mpi_comm_mysim, cr->dd->pme_nodeid, deviceStreamManager->context(),
1395                     deviceStreamManager->stream(DeviceStreamType::PmePpTransfer));
1396         }
1397
1398         fr->nbv = Nbnxm::init_nb_verlet(mdlog, inputrec, fr, cr, *hwinfo, useGpuForNonbonded,
1399                                         deviceStreamManager.get(), &mtop, box, wcycle);
1400         // TODO: Move the logic below to a GPU bonded builder
1401         if (useGpuForBonded)
1402         {
1403             GMX_RELEASE_ASSERT(deviceStreamManager != nullptr,
1404                                "GPU device stream manager should be valid in order to use GPU "
1405                                "version of bonded forces.");
1406             gpuBonded = std::make_unique<GpuBonded>(
1407                     mtop.ffparams, fr->ic->epsfac * fr->fudgeQQ, deviceStreamManager->context(),
1408                     deviceStreamManager->bondedStream(havePPDomainDecomposition(cr)), wcycle);
1409             fr->gpuBonded = gpuBonded.get();
1410         }
1411
1412         /* Initialize the mdAtoms structure.
1413          * mdAtoms is not filled with atom data,
1414          * as this can not be done now with domain decomposition.
1415          */
1416         mdAtoms = makeMDAtoms(fplog, mtop, *inputrec, thisRankHasPmeGpuTask);
1417         if (globalState && thisRankHasPmeGpuTask)
1418         {
1419             // The pinning of coordinates in the global state object works, because we only use
1420             // PME on GPU without DD or on a separate PME rank, and because the local state pointer
1421             // points to the global state object without DD.
1422             // FIXME: MD and EM separately set up the local state - this should happen in the same
1423             // function, which should also perform the pinning.
1424             changePinningPolicy(&globalState->x, pme_get_pinning_policy());
1425         }
1426
1427         /* Initialize the virtual site communication */
1428         vsite = makeVirtualSitesHandler(mtop, cr, fr->pbcType);
1429
1430         calc_shifts(box, fr->shift_vec);
1431
1432         /* With periodic molecules the charge groups should be whole at start up
1433          * and the virtual sites should not be far from their proper positions.
1434          */
1435         if (!inputrec->bContinuation && MASTER(cr)
1436             && !(inputrec->pbcType != PbcType::No && inputrec->bPeriodicMols))
1437         {
1438             /* Make molecules whole at start of run */
1439             if (fr->pbcType != PbcType::No)
1440             {
1441                 do_pbc_first_mtop(fplog, inputrec->pbcType, box, &mtop, globalState->x.rvec_array());
1442             }
1443             if (vsite)
1444             {
1445                 /* Correct initial vsite positions are required
1446                  * for the initial distribution in the domain decomposition
1447                  * and for the initial shell prediction.
1448                  */
1449                 constructVirtualSitesGlobal(mtop, globalState->x);
1450             }
1451         }
1452
1453         if (EEL_PME(fr->ic->eeltype) || EVDW_PME(fr->ic->vdwtype))
1454         {
1455             ewaldcoeff_q  = fr->ic->ewaldcoeff_q;
1456             ewaldcoeff_lj = fr->ic->ewaldcoeff_lj;
1457         }
1458     }
1459     else
1460     {
1461         /* This is a PME only node */
1462
1463         GMX_ASSERT(globalState == nullptr,
1464                    "We don't need the state on a PME only rank and expect it to be unitialized");
1465
1466         ewaldcoeff_q  = calc_ewaldcoeff_q(inputrec->rcoulomb, inputrec->ewald_rtol);
1467         ewaldcoeff_lj = calc_ewaldcoeff_lj(inputrec->rvdw, inputrec->ewald_rtol_lj);
1468     }
1469
1470     gmx_pme_t* sepPmeData = nullptr;
1471     // This reference hides the fact that PME data is owned by runner on PME-only ranks and by forcerec on other ranks
1472     GMX_ASSERT(thisRankHasDuty(cr, DUTY_PP) == (fr != nullptr),
1473                "Double-checking that only PME-only ranks have no forcerec");
1474     gmx_pme_t*& pmedata = fr ? fr->pmedata : sepPmeData;
1475
1476     // TODO should live in ewald module once its testing is improved
1477     //
1478     // Later, this program could contain kernels that might be later
1479     // re-used as auto-tuning progresses, or subsequent simulations
1480     // are invoked.
1481     PmeGpuProgramStorage pmeGpuProgram;
1482     if (thisRankHasPmeGpuTask)
1483     {
1484         GMX_RELEASE_ASSERT(
1485                 (deviceStreamManager != nullptr),
1486                 "GPU device stream manager should be initialized in order to use GPU for PME.");
1487         GMX_RELEASE_ASSERT((deviceInfo != nullptr),
1488                            "GPU device should be initialized in order to use GPU for PME.");
1489         pmeGpuProgram = buildPmeGpuProgram(deviceStreamManager->context());
1490     }
1491
1492     /* Initiate PME if necessary,
1493      * either on all nodes or on dedicated PME nodes only. */
1494     if (EEL_PME(inputrec->coulombtype) || EVDW_PME(inputrec->vdwtype))
1495     {
1496         if (mdAtoms && mdAtoms->mdatoms())
1497         {
1498             nChargePerturbed = mdAtoms->mdatoms()->nChargePerturbed;
1499             if (EVDW_PME(inputrec->vdwtype))
1500             {
1501                 nTypePerturbed = mdAtoms->mdatoms()->nTypePerturbed;
1502             }
1503         }
1504         if (cr->npmenodes > 0)
1505         {
1506             /* The PME only nodes need to know nChargePerturbed(FEP on Q) and nTypePerturbed(FEP on LJ)*/
1507             gmx_bcast(sizeof(nChargePerturbed), &nChargePerturbed, cr->mpi_comm_mysim);
1508             gmx_bcast(sizeof(nTypePerturbed), &nTypePerturbed, cr->mpi_comm_mysim);
1509         }
1510
1511         if (thisRankHasDuty(cr, DUTY_PME))
1512         {
1513             try
1514             {
1515                 // TODO: This should be in the builder.
1516                 GMX_RELEASE_ASSERT(!useGpuForPme || (deviceStreamManager != nullptr),
1517                                    "Device stream manager should be valid in order to use GPU "
1518                                    "version of PME.");
1519                 GMX_RELEASE_ASSERT(
1520                         !useGpuForPme || deviceStreamManager->streamIsValid(DeviceStreamType::Pme),
1521                         "GPU PME stream should be valid in order to use GPU version of PME.");
1522
1523                 const DeviceContext* deviceContext =
1524                         useGpuForPme ? &deviceStreamManager->context() : nullptr;
1525                 const DeviceStream* pmeStream =
1526                         useGpuForPme ? &deviceStreamManager->stream(DeviceStreamType::Pme) : nullptr;
1527
1528                 pmedata = gmx_pme_init(cr, getNumPmeDomains(cr->dd), inputrec, nChargePerturbed != 0,
1529                                        nTypePerturbed != 0, mdrunOptions.reproducible, ewaldcoeff_q,
1530                                        ewaldcoeff_lj, gmx_omp_nthreads_get(emntPME), pmeRunMode,
1531                                        nullptr, deviceContext, pmeStream, pmeGpuProgram.get(), mdlog);
1532             }
1533             GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR
1534         }
1535     }
1536
1537
1538     if (EI_DYNAMICS(inputrec->eI))
1539     {
1540         /* Turn on signal handling on all nodes */
1541         /*
1542          * (A user signal from the PME nodes (if any)
1543          * is communicated to the PP nodes.
1544          */
1545         signal_handler_install();
1546     }
1547
1548     pull_t* pull_work = nullptr;
1549     if (thisRankHasDuty(cr, DUTY_PP))
1550     {
1551         /* Assumes uniform use of the number of OpenMP threads */
1552         walltime_accounting = walltime_accounting_init(gmx_omp_nthreads_get(emntDefault));
1553
1554         if (inputrec->bPull)
1555         {
1556             /* Initialize pull code */
1557             pull_work = init_pull(fplog, inputrec->pull, inputrec, &mtop, cr, &atomSets,
1558                                   inputrec->fepvals->init_lambda);
1559             if (inputrec->pull->bXOutAverage || inputrec->pull->bFOutAverage)
1560             {
1561                 initPullHistory(pull_work, &observablesHistory);
1562             }
1563             if (EI_DYNAMICS(inputrec->eI) && MASTER(cr))
1564             {
1565                 init_pull_output_files(pull_work, filenames.size(), filenames.data(), oenv, startingBehavior);
1566             }
1567         }
1568
1569         std::unique_ptr<EnforcedRotation> enforcedRotation;
1570         if (inputrec->bRot)
1571         {
1572             /* Initialize enforced rotation code */
1573             enforcedRotation =
1574                     init_rot(fplog, inputrec, filenames.size(), filenames.data(), cr, &atomSets,
1575                              globalState.get(), &mtop, oenv, mdrunOptions, startingBehavior);
1576         }
1577
1578         t_swap* swap = nullptr;
1579         if (inputrec->eSwapCoords != eswapNO)
1580         {
1581             /* Initialize ion swapping code */
1582             swap = init_swapcoords(fplog, inputrec,
1583                                    opt2fn_master("-swap", filenames.size(), filenames.data(), cr),
1584                                    &mtop, globalState.get(), &observablesHistory, cr, &atomSets,
1585                                    oenv, mdrunOptions, startingBehavior);
1586         }
1587
1588         /* Let makeConstraints know whether we have essential dynamics constraints. */
1589         auto constr = makeConstraints(mtop, *inputrec, pull_work, doEssentialDynamics, fplog, cr,
1590                                       ms, &nrnb, wcycle, fr->bMolPBC);
1591
1592         /* Energy terms and groups */
1593         gmx_enerdata_t enerd(mtop.groups.groups[SimulationAtomGroupType::EnergyOutput].size(),
1594                              inputrec->fepvals->n_lambda);
1595
1596         /* Kinetic energy data */
1597         gmx_ekindata_t ekind;
1598         init_ekindata(fplog, &mtop, &(inputrec->opts), &ekind, inputrec->cos_accel);
1599
1600         /* Set up interactive MD (IMD) */
1601         auto imdSession =
1602                 makeImdSession(inputrec, cr, wcycle, &enerd, ms, &mtop, mdlog,
1603                                MASTER(cr) ? globalState->x.rvec_array() : nullptr, filenames.size(),
1604                                filenames.data(), oenv, mdrunOptions.imdOptions, startingBehavior);
1605
1606         if (DOMAINDECOMP(cr))
1607         {
1608             GMX_RELEASE_ASSERT(fr, "fr was NULL while cr->duty was DUTY_PP");
1609             /* This call is not included in init_domain_decomposition mainly
1610              * because fr->cginfo_mb is set later.
1611              */
1612             dd_init_bondeds(fplog, cr->dd, mtop, vsite.get(), inputrec,
1613                             domdecOptions.checkBondedInteractions, fr->cginfo_mb);
1614         }
1615
1616         // TODO This is not the right place to manage the lifetime of
1617         // this data structure, but currently it's the easiest way to
1618         // make it work.
1619         MdrunScheduleWorkload runScheduleWork;
1620         // Also populates the simulation constant workload description.
1621         runScheduleWork.simulationWork =
1622                 createSimulationWorkload(*inputrec, useGpuForNonbonded, pmeRunMode, useGpuForBonded,
1623                                          useGpuForUpdate, devFlags.enableGpuBufferOps,
1624                                          devFlags.enableGpuHaloExchange, devFlags.enableGpuPmePPComm);
1625
1626         std::unique_ptr<gmx::StatePropagatorDataGpu> stateGpu;
1627         if (gpusWereDetected
1628             && ((useGpuForPme && thisRankHasDuty(cr, DUTY_PME))
1629                 || runScheduleWork.simulationWork.useGpuBufferOps))
1630         {
1631             GpuApiCallBehavior transferKind = (inputrec->eI == eiMD && !doRerun && !useModularSimulator)
1632                                                       ? GpuApiCallBehavior::Async
1633                                                       : GpuApiCallBehavior::Sync;
1634             GMX_RELEASE_ASSERT(deviceStreamManager != nullptr,
1635                                "GPU device stream manager should be initialized to use GPU.");
1636             stateGpu = std::make_unique<gmx::StatePropagatorDataGpu>(
1637                     *deviceStreamManager, transferKind, pme_gpu_get_block_size(fr->pmedata), wcycle);
1638             fr->stateGpu = stateGpu.get();
1639         }
1640
1641         GMX_ASSERT(stopHandlerBuilder_, "Runner must provide StopHandlerBuilder to simulator.");
1642         SimulatorBuilder simulatorBuilder;
1643
1644         simulatorBuilder.add(std::move(stopHandlerBuilder_));
1645
1646         // build and run simulator object based on user-input
1647         auto simulator = simulatorBuilder.build(
1648                 useModularSimulator, fplog, cr, ms, mdlog, static_cast<int>(filenames.size()),
1649                 filenames.data(), oenv, mdrunOptions, startingBehavior, vsite.get(), constr.get(),
1650                 enforcedRotation ? enforcedRotation->getLegacyEnfrot() : nullptr, deform.get(),
1651                 mdModules_->outputProvider(), mdModules_->notifier(), inputrec, imdSession.get(),
1652                 pull_work, swap, &mtop, globalState.get(), &observablesHistory, mdAtoms.get(),
1653                 &nrnb, wcycle, fr, &enerd, &ekind, &runScheduleWork, replExParams, membed,
1654                 walltime_accounting, doRerun);
1655         simulator->run();
1656
1657         if (fr->pmePpCommGpu)
1658         {
1659             // destroy object since it is no longer required. (This needs to be done while the GPU context still exists.)
1660             fr->pmePpCommGpu.reset();
1661         }
1662
1663         if (inputrec->bPull)
1664         {
1665             finish_pull(pull_work);
1666         }
1667         finish_swapcoords(swap);
1668     }
1669     else
1670     {
1671         GMX_RELEASE_ASSERT(pmedata, "pmedata was NULL while cr->duty was not DUTY_PP");
1672         /* do PME only */
1673         walltime_accounting = walltime_accounting_init(gmx_omp_nthreads_get(emntPME));
1674         gmx_pmeonly(pmedata, cr, &nrnb, wcycle, walltime_accounting, inputrec, pmeRunMode,
1675                     deviceStreamManager.get());
1676     }
1677
1678     wallcycle_stop(wcycle, ewcRUN);
1679
1680     /* Finish up, write some stuff
1681      * if rerunMD, don't write last frame again
1682      */
1683     finish_run(fplog, mdlog, cr, inputrec, &nrnb, wcycle, walltime_accounting,
1684                fr ? fr->nbv.get() : nullptr, pmedata, EI_DYNAMICS(inputrec->eI) && !isMultiSim(ms));
1685
1686     // clean up cycle counter
1687     wallcycle_destroy(wcycle);
1688
1689     deviceStreamManager.reset(nullptr);
1690     // Free PME data
1691     if (pmedata)
1692     {
1693         gmx_pme_destroy(pmedata);
1694         pmedata = nullptr;
1695     }
1696
1697     // FIXME: this is only here to manually unpin mdAtoms->chargeA_ and state->x,
1698     // before we destroy the GPU context(s) in free_gpu().
1699     // Pinned buffers are associated with contexts in CUDA.
1700     // As soon as we destroy GPU contexts after mdrunner() exits, these lines should go.
1701     mdAtoms.reset(nullptr);
1702     globalState.reset(nullptr);
1703     mdModules_.reset(nullptr); // destruct force providers here as they might also use the GPU
1704     gpuBonded.reset(nullptr);
1705     /* Free pinned buffers in *fr */
1706     delete fr;
1707     fr = nullptr;
1708     // TODO convert to C++ so we can get rid of these frees
1709     sfree(disresdata);
1710     sfree(oriresdata);
1711
1712     if (hwinfo->gpu_info.n_dev > 0)
1713     {
1714         /* stop the GPU profiler (only CUDA) */
1715         stopGpuProfiler();
1716     }
1717
1718     /* With tMPI we need to wait for all ranks to finish deallocation before
1719      * destroying the CUDA context in free_gpu() as some tMPI ranks may be sharing
1720      * GPU and context.
1721      *
1722      * This is not a concern in OpenCL where we use one context per rank which
1723      * is freed in nbnxn_gpu_free().
1724      *
1725      * Note: it is safe to not call the barrier on the ranks which do not use GPU,
1726      * but it is easier and more futureproof to call it on the whole node.
1727      *
1728      * Note that this function needs to be called even if GPUs are not used
1729      * in this run because the PME ranks have no knowledge of whether GPUs
1730      * are used or not, but all ranks need to enter the barrier below.
1731      * \todo Remove this physical node barrier after making sure
1732      * that it's not needed anymore (with a shared GPU run).
1733      */
1734     if (GMX_THREAD_MPI)
1735     {
1736         physicalNodeComm.barrier();
1737     }
1738
1739     free_gpu(deviceInfo);
1740
1741     if (doMembed)
1742     {
1743         free_membed(membed);
1744     }
1745
1746     /* Does what it says */
1747     print_date_and_time(fplog, cr->nodeid, "Finished mdrun", gmx_gettime());
1748     walltime_accounting_destroy(walltime_accounting);
1749
1750     // Ensure log file content is written
1751     if (logFileHandle)
1752     {
1753         gmx_fio_flush(logFileHandle);
1754     }
1755
1756     /* Reset FPEs (important for unit tests) by disabling them. Assumes no
1757      * exceptions were enabled before function was called. */
1758     if (bEnableFPE)
1759     {
1760         gmx_fedisableexcept();
1761     }
1762
1763     auto rc = static_cast<int>(gmx_get_stop_condition());
1764
1765 #if GMX_THREAD_MPI
1766     /* we need to join all threads. The sub-threads join when they
1767        exit this function, but the master thread needs to be told to
1768        wait for that. */
1769     if (PAR(cr) && MASTER(cr))
1770     {
1771         tMPI_Finalize();
1772     }
1773 #endif
1774     return rc;
1775 } // namespace gmx
1776
1777 Mdrunner::~Mdrunner()
1778 {
1779     // Clean up of the Manager.
1780     // This will end up getting called on every thread-MPI rank, which is unnecessary,
1781     // but okay as long as threads synchronize some time before adding or accessing
1782     // a new set of restraints.
1783     if (restraintManager_)
1784     {
1785         restraintManager_->clear();
1786         GMX_ASSERT(restraintManager_->countRestraints() == 0,
1787                    "restraints added during runner life time should be cleared at runner "
1788                    "destruction.");
1789     }
1790 };
1791
1792 void Mdrunner::addPotential(std::shared_ptr<gmx::IRestraintPotential> puller, const std::string& name)
1793 {
1794     GMX_ASSERT(restraintManager_, "Mdrunner must have a restraint manager.");
1795     // Not sure if this should be logged through the md logger or something else,
1796     // but it is helpful to have some sort of INFO level message sent somewhere.
1797     //    std::cout << "Registering restraint named " << name << std::endl;
1798
1799     // When multiple restraints are used, it may be wasteful to register them separately.
1800     // Maybe instead register an entire Restraint Manager as a force provider.
1801     restraintManager_->addToSpec(std::move(puller), name);
1802 }
1803
1804 Mdrunner::Mdrunner(std::unique_ptr<MDModules> mdModules) : mdModules_(std::move(mdModules)) {}
1805
1806 Mdrunner::Mdrunner(Mdrunner&&) noexcept = default;
1807
1808 Mdrunner& Mdrunner::operator=(Mdrunner&& /*handle*/) noexcept = default;
1809
1810 class Mdrunner::BuilderImplementation
1811 {
1812 public:
1813     BuilderImplementation() = delete;
1814     BuilderImplementation(std::unique_ptr<MDModules> mdModules, compat::not_null<SimulationContext*> context);
1815     ~BuilderImplementation();
1816
1817     BuilderImplementation& setExtraMdrunOptions(const MdrunOptions& options,
1818                                                 real                forceWarningThreshold,
1819                                                 StartingBehavior    startingBehavior);
1820
1821     void addDomdec(const DomdecOptions& options);
1822
1823     void addVerletList(int nstlist);
1824
1825     void addReplicaExchange(const ReplicaExchangeParameters& params);
1826
1827     void addNonBonded(const char* nbpu_opt);
1828
1829     void addPME(const char* pme_opt_, const char* pme_fft_opt_);
1830
1831     void addBondedTaskAssignment(const char* bonded_opt);
1832
1833     void addUpdateTaskAssignment(const char* update_opt);
1834
1835     void addHardwareOptions(const gmx_hw_opt_t& hardwareOptions);
1836
1837     void addFilenames(ArrayRef<const t_filenm> filenames);
1838
1839     void addOutputEnvironment(gmx_output_env_t* outputEnvironment);
1840
1841     void addLogFile(t_fileio* logFileHandle);
1842
1843     void addStopHandlerBuilder(std::unique_ptr<StopHandlerBuilder> builder);
1844
1845     Mdrunner build();
1846
1847 private:
1848     // Default parameters copied from runner.h
1849     // \todo Clarify source(s) of default parameters.
1850
1851     const char* nbpu_opt_    = nullptr;
1852     const char* pme_opt_     = nullptr;
1853     const char* pme_fft_opt_ = nullptr;
1854     const char* bonded_opt_  = nullptr;
1855     const char* update_opt_  = nullptr;
1856
1857     MdrunOptions mdrunOptions_;
1858
1859     DomdecOptions domdecOptions_;
1860
1861     ReplicaExchangeParameters replicaExchangeParameters_;
1862
1863     //! Command-line override for the duration of a neighbor list with the Verlet scheme.
1864     int nstlist_ = 0;
1865
1866     //! Multisim communicator handle.
1867     gmx_multisim_t* multiSimulation_;
1868
1869     //! mdrun communicator
1870     MPI_Comm communicator_ = MPI_COMM_NULL;
1871
1872     //! Print a warning if any force is larger than this (in kJ/mol nm).
1873     real forceWarningThreshold_ = -1;
1874
1875     //! Whether the simulation will start afresh, or restart with/without appending.
1876     StartingBehavior startingBehavior_ = StartingBehavior::NewSimulation;
1877
1878     //! The modules that comprise the functionality of mdrun.
1879     std::unique_ptr<MDModules> mdModules_;
1880
1881     //! \brief Parallelism information.
1882     gmx_hw_opt_t hardwareOptions_;
1883
1884     //! filename options for simulation.
1885     ArrayRef<const t_filenm> filenames_;
1886
1887     /*! \brief Handle to output environment.
1888      *
1889      * \todo gmx_output_env_t needs lifetime management.
1890      */
1891     gmx_output_env_t* outputEnvironment_ = nullptr;
1892
1893     /*! \brief Non-owning handle to MD log file.
1894      *
1895      * \todo Context should own output facilities for client.
1896      * \todo Improve log file handle management.
1897      * \internal
1898      * Code managing the FILE* relies on the ability to set it to
1899      * nullptr to check whether the filehandle is valid.
1900      */
1901     t_fileio* logFileHandle_ = nullptr;
1902
1903     /*!
1904      * \brief Builder for simulation stop signal handler.
1905      */
1906     std::unique_ptr<StopHandlerBuilder> stopHandlerBuilder_ = nullptr;
1907 };
1908
1909 Mdrunner::BuilderImplementation::BuilderImplementation(std::unique_ptr<MDModules> mdModules,
1910                                                        compat::not_null<SimulationContext*> context) :
1911     mdModules_(std::move(mdModules))
1912 {
1913     communicator_    = context->communicator_;
1914     multiSimulation_ = context->multiSimulation_.get();
1915 }
1916
1917 Mdrunner::BuilderImplementation::~BuilderImplementation() = default;
1918
1919 Mdrunner::BuilderImplementation&
1920 Mdrunner::BuilderImplementation::setExtraMdrunOptions(const MdrunOptions&    options,
1921                                                       const real             forceWarningThreshold,
1922                                                       const StartingBehavior startingBehavior)
1923 {
1924     mdrunOptions_          = options;
1925     forceWarningThreshold_ = forceWarningThreshold;
1926     startingBehavior_      = startingBehavior;
1927     return *this;
1928 }
1929
1930 void Mdrunner::BuilderImplementation::addDomdec(const DomdecOptions& options)
1931 {
1932     domdecOptions_ = options;
1933 }
1934
1935 void Mdrunner::BuilderImplementation::addVerletList(int nstlist)
1936 {
1937     nstlist_ = nstlist;
1938 }
1939
1940 void Mdrunner::BuilderImplementation::addReplicaExchange(const ReplicaExchangeParameters& params)
1941 {
1942     replicaExchangeParameters_ = params;
1943 }
1944
1945 Mdrunner Mdrunner::BuilderImplementation::build()
1946 {
1947     auto newRunner = Mdrunner(std::move(mdModules_));
1948
1949     newRunner.mdrunOptions     = mdrunOptions_;
1950     newRunner.pforce           = forceWarningThreshold_;
1951     newRunner.startingBehavior = startingBehavior_;
1952     newRunner.domdecOptions    = domdecOptions_;
1953
1954     // \todo determine an invariant to check or confirm that all gmx_hw_opt_t objects are valid
1955     newRunner.hw_opt = hardwareOptions_;
1956
1957     // No invariant to check. This parameter exists to optionally override other behavior.
1958     newRunner.nstlist_cmdline = nstlist_;
1959
1960     newRunner.replExParams = replicaExchangeParameters_;
1961
1962     newRunner.filenames = filenames_;
1963
1964     newRunner.communicator = communicator_;
1965
1966     // nullptr is a valid value for the multisim handle
1967     newRunner.ms = multiSimulation_;
1968
1969     // \todo Clarify ownership and lifetime management for gmx_output_env_t
1970     // \todo Update sanity checking when output environment has clearly specified invariants.
1971     // Initialization and default values for oenv are not well specified in the current version.
1972     if (outputEnvironment_)
1973     {
1974         newRunner.oenv = outputEnvironment_;
1975     }
1976     else
1977     {
1978         GMX_THROW(gmx::APIError(
1979                 "MdrunnerBuilder::addOutputEnvironment() is required before build()"));
1980     }
1981
1982     newRunner.logFileHandle = logFileHandle_;
1983
1984     if (nbpu_opt_)
1985     {
1986         newRunner.nbpu_opt = nbpu_opt_;
1987     }
1988     else
1989     {
1990         GMX_THROW(gmx::APIError("MdrunnerBuilder::addNonBonded() is required before build()"));
1991     }
1992
1993     if (pme_opt_ && pme_fft_opt_)
1994     {
1995         newRunner.pme_opt     = pme_opt_;
1996         newRunner.pme_fft_opt = pme_fft_opt_;
1997     }
1998     else
1999     {
2000         GMX_THROW(gmx::APIError("MdrunnerBuilder::addElectrostatics() is required before build()"));
2001     }
2002
2003     if (bonded_opt_)
2004     {
2005         newRunner.bonded_opt = bonded_opt_;
2006     }
2007     else
2008     {
2009         GMX_THROW(gmx::APIError(
2010                 "MdrunnerBuilder::addBondedTaskAssignment() is required before build()"));
2011     }
2012
2013     if (update_opt_)
2014     {
2015         newRunner.update_opt = update_opt_;
2016     }
2017     else
2018     {
2019         GMX_THROW(gmx::APIError(
2020                 "MdrunnerBuilder::addUpdateTaskAssignment() is required before build()  "));
2021     }
2022
2023
2024     newRunner.restraintManager_ = std::make_unique<gmx::RestraintManager>();
2025
2026     if (stopHandlerBuilder_)
2027     {
2028         newRunner.stopHandlerBuilder_ = std::move(stopHandlerBuilder_);
2029     }
2030     else
2031     {
2032         newRunner.stopHandlerBuilder_ = std::make_unique<StopHandlerBuilder>();
2033     }
2034
2035     return newRunner;
2036 }
2037
2038 void Mdrunner::BuilderImplementation::addNonBonded(const char* nbpu_opt)
2039 {
2040     nbpu_opt_ = nbpu_opt;
2041 }
2042
2043 void Mdrunner::BuilderImplementation::addPME(const char* pme_opt, const char* pme_fft_opt)
2044 {
2045     pme_opt_     = pme_opt;
2046     pme_fft_opt_ = pme_fft_opt;
2047 }
2048
2049 void Mdrunner::BuilderImplementation::addBondedTaskAssignment(const char* bonded_opt)
2050 {
2051     bonded_opt_ = bonded_opt;
2052 }
2053
2054 void Mdrunner::BuilderImplementation::addUpdateTaskAssignment(const char* update_opt)
2055 {
2056     update_opt_ = update_opt;
2057 }
2058
2059 void Mdrunner::BuilderImplementation::addHardwareOptions(const gmx_hw_opt_t& hardwareOptions)
2060 {
2061     hardwareOptions_ = hardwareOptions;
2062 }
2063
2064 void Mdrunner::BuilderImplementation::addFilenames(ArrayRef<const t_filenm> filenames)
2065 {
2066     filenames_ = filenames;
2067 }
2068
2069 void Mdrunner::BuilderImplementation::addOutputEnvironment(gmx_output_env_t* outputEnvironment)
2070 {
2071     outputEnvironment_ = outputEnvironment;
2072 }
2073
2074 void Mdrunner::BuilderImplementation::addLogFile(t_fileio* logFileHandle)
2075 {
2076     logFileHandle_ = logFileHandle;
2077 }
2078
2079 void Mdrunner::BuilderImplementation::addStopHandlerBuilder(std::unique_ptr<StopHandlerBuilder> builder)
2080 {
2081     stopHandlerBuilder_ = std::move(builder);
2082 }
2083
2084 MdrunnerBuilder::MdrunnerBuilder(std::unique_ptr<MDModules>           mdModules,
2085                                  compat::not_null<SimulationContext*> context) :
2086     impl_{ std::make_unique<Mdrunner::BuilderImplementation>(std::move(mdModules), context) }
2087 {
2088 }
2089
2090 MdrunnerBuilder::~MdrunnerBuilder() = default;
2091
2092 MdrunnerBuilder& MdrunnerBuilder::addSimulationMethod(const MdrunOptions&    options,
2093                                                       real                   forceWarningThreshold,
2094                                                       const StartingBehavior startingBehavior)
2095 {
2096     impl_->setExtraMdrunOptions(options, forceWarningThreshold, startingBehavior);
2097     return *this;
2098 }
2099
2100 MdrunnerBuilder& MdrunnerBuilder::addDomainDecomposition(const DomdecOptions& options)
2101 {
2102     impl_->addDomdec(options);
2103     return *this;
2104 }
2105
2106 MdrunnerBuilder& MdrunnerBuilder::addNeighborList(int nstlist)
2107 {
2108     impl_->addVerletList(nstlist);
2109     return *this;
2110 }
2111
2112 MdrunnerBuilder& MdrunnerBuilder::addReplicaExchange(const ReplicaExchangeParameters& params)
2113 {
2114     impl_->addReplicaExchange(params);
2115     return *this;
2116 }
2117
2118 MdrunnerBuilder& MdrunnerBuilder::addNonBonded(const char* nbpu_opt)
2119 {
2120     impl_->addNonBonded(nbpu_opt);
2121     return *this;
2122 }
2123
2124 MdrunnerBuilder& MdrunnerBuilder::addElectrostatics(const char* pme_opt, const char* pme_fft_opt)
2125 {
2126     // The builder method may become more general in the future, but in this version,
2127     // parameters for PME electrostatics are both required and the only parameters
2128     // available.
2129     if (pme_opt && pme_fft_opt)
2130     {
2131         impl_->addPME(pme_opt, pme_fft_opt);
2132     }
2133     else
2134     {
2135         GMX_THROW(
2136                 gmx::InvalidInputError("addElectrostatics() arguments must be non-null pointers."));
2137     }
2138     return *this;
2139 }
2140
2141 MdrunnerBuilder& MdrunnerBuilder::addBondedTaskAssignment(const char* bonded_opt)
2142 {
2143     impl_->addBondedTaskAssignment(bonded_opt);
2144     return *this;
2145 }
2146
2147 MdrunnerBuilder& MdrunnerBuilder::addUpdateTaskAssignment(const char* update_opt)
2148 {
2149     impl_->addUpdateTaskAssignment(update_opt);
2150     return *this;
2151 }
2152
2153 Mdrunner MdrunnerBuilder::build()
2154 {
2155     return impl_->build();
2156 }
2157
2158 MdrunnerBuilder& MdrunnerBuilder::addHardwareOptions(const gmx_hw_opt_t& hardwareOptions)
2159 {
2160     impl_->addHardwareOptions(hardwareOptions);
2161     return *this;
2162 }
2163
2164 MdrunnerBuilder& MdrunnerBuilder::addFilenames(ArrayRef<const t_filenm> filenames)
2165 {
2166     impl_->addFilenames(filenames);
2167     return *this;
2168 }
2169
2170 MdrunnerBuilder& MdrunnerBuilder::addOutputEnvironment(gmx_output_env_t* outputEnvironment)
2171 {
2172     impl_->addOutputEnvironment(outputEnvironment);
2173     return *this;
2174 }
2175
2176 MdrunnerBuilder& MdrunnerBuilder::addLogFile(t_fileio* logFileHandle)
2177 {
2178     impl_->addLogFile(logFileHandle);
2179     return *this;
2180 }
2181
2182 MdrunnerBuilder& MdrunnerBuilder::addStopHandlerBuilder(std::unique_ptr<StopHandlerBuilder> builder)
2183 {
2184     impl_->addStopHandlerBuilder(std::move(builder));
2185     return *this;
2186 }
2187
2188 MdrunnerBuilder::MdrunnerBuilder(MdrunnerBuilder&&) noexcept = default;
2189
2190 MdrunnerBuilder& MdrunnerBuilder::operator=(MdrunnerBuilder&&) noexcept = default;
2191
2192 } // namespace gmx