src/gromacs/mdrun/rerun.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019,2020,2021, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \internal \file
  36  *
  37  * \brief Implements the loop for simulation reruns
  38  *
  39  * \author Pascal Merz <pascal.merz@colorado.edu>
  40  * \ingroup module_mdrun
  41  */
  42 #include "gmxpre.h"
  43
  44 #include <cinttypes>
  45 #include <cmath>
  46 #include <cstdio>
  47 #include <cstdlib>
  48
  49 #include <algorithm>
  50 #include <memory>
  51
  52 #include "gromacs/applied_forces/awh/awh.h"
  53 #include "gromacs/commandline/filenm.h"
  54 #include "gromacs/domdec/collect.h"
  55 #include "gromacs/domdec/dlbtiming.h"
  56 #include "gromacs/domdec/domdec.h"
  57 #include "gromacs/domdec/domdec_network.h"
  58 #include "gromacs/domdec/domdec_struct.h"
  59 #include "gromacs/domdec/localtopologychecker.h"
  60 #include "gromacs/domdec/mdsetup.h"
  61 #include "gromacs/domdec/partition.h"
  62 #include "gromacs/essentialdynamics/edsam.h"
  63 #include "gromacs/ewald/pme_load_balancing.h"
  64 #include "gromacs/ewald/pme_pp.h"
  65 #include "gromacs/fileio/trxio.h"
  66 #include "gromacs/gmxlib/network.h"
  67 #include "gromacs/gmxlib/nrnb.h"
  68 #include "gromacs/gpu_utils/gpu_utils.h"
  69 #include "gromacs/listed_forces/listed_forces.h"
  70 #include "gromacs/math/functions.h"
  71 #include "gromacs/math/utilities.h"
  72 #include "gromacs/math/vec.h"
  73 #include "gromacs/math/vectypes.h"
  74 #include "gromacs/mdlib/checkpointhandler.h"
  75 #include "gromacs/mdlib/compute_io.h"
  76 #include "gromacs/mdlib/constr.h"
  77 #include "gromacs/mdlib/ebin.h"
  78 #include "gromacs/mdlib/enerdata_utils.h"
  79 #include "gromacs/mdlib/energyoutput.h"
  80 #include "gromacs/mdlib/expanded.h"
  81 #include "gromacs/mdlib/force.h"
  82 #include "gromacs/mdlib/force_flags.h"
  83 #include "gromacs/mdlib/forcerec.h"
  84 #include "gromacs/mdlib/freeenergyparameters.h"
  85 #include "gromacs/mdlib/md_support.h"
  86 #include "gromacs/mdlib/mdatoms.h"
  87 #include "gromacs/mdlib/mdoutf.h"
  88 #include "gromacs/mdlib/membed.h"
  89 #include "gromacs/mdlib/resethandler.h"
  90 #include "gromacs/mdlib/sighandler.h"
  91 #include "gromacs/mdlib/simulationsignal.h"
  92 #include "gromacs/mdlib/stat.h"
  93 #include "gromacs/mdlib/stophandler.h"
  94 #include "gromacs/mdlib/tgroup.h"
  95 #include "gromacs/mdlib/trajectory_writing.h"
  96 #include "gromacs/mdlib/update.h"
  97 #include "gromacs/mdlib/vcm.h"
  98 #include "gromacs/mdlib/vsite.h"
  99 #include "gromacs/mdrunutility/handlerestart.h"
 100 #include "gromacs/mdrunutility/multisim.h"
 101 #include "gromacs/mdrunutility/printtime.h"
 102 #include "gromacs/mdtypes/awh_history.h"
 103 #include "gromacs/mdtypes/awh_params.h"
 104 #include "gromacs/mdtypes/commrec.h"
 105 #include "gromacs/mdtypes/df_history.h"
 106 #include "gromacs/mdtypes/energyhistory.h"
 107 #include "gromacs/mdtypes/forcebuffers.h"
 108 #include "gromacs/mdtypes/forcerec.h"
 109 #include "gromacs/mdtypes/group.h"
 110 #include "gromacs/mdtypes/inputrec.h"
 111 #include "gromacs/mdtypes/interaction_const.h"
 112 #include "gromacs/mdtypes/md_enums.h"
 113 #include "gromacs/mdtypes/mdatom.h"
 114 #include "gromacs/mdtypes/mdrunoptions.h"
 115 #include "gromacs/mdtypes/observableshistory.h"
 116 #include "gromacs/mdtypes/observablesreducer.h"
 117 #include "gromacs/mdtypes/simulation_workload.h"
 118 #include "gromacs/mdtypes/state.h"
 119 #include "gromacs/mimic/utilities.h"
 120 #include "gromacs/pbcutil/pbc.h"
 121 #include "gromacs/pulling/output.h"
 122 #include "gromacs/pulling/pull.h"
 123 #include "gromacs/swap/swapcoords.h"
 124 #include "gromacs/timing/wallcycle.h"
 125 #include "gromacs/timing/walltime_accounting.h"
 126 #include "gromacs/topology/atoms.h"
 127 #include "gromacs/topology/idef.h"
 128 #include "gromacs/topology/mtop_util.h"
 129 #include "gromacs/topology/topology.h"
 130 #include "gromacs/trajectory/trajectoryframe.h"
 131 #include "gromacs/utility/basedefinitions.h"
 132 #include "gromacs/utility/cstringutil.h"
 133 #include "gromacs/utility/fatalerror.h"
 134 #include "gromacs/utility/logger.h"
 135 #include "gromacs/utility/real.h"
 136
 137 #include "legacysimulator.h"
 138 #include "replicaexchange.h"
 139 #include "shellfc.h"
 140
 141 using gmx::SimulationSignaller;
 142 using gmx::VirtualSitesHandler;
 143
 144 /*! \brief Copy the state from \p rerunFrame to \p globalState and, if requested, construct vsites
 145  *
 146  * \param[in]     rerunFrame      The trajectory frame to compute energy/forces for
 147  * \param[in,out] globalState     The global state container
 148  * \param[in]     constructVsites When true, vsite coordinates are constructed
 149  * \param[in]     vsite           Vsite setup, can be nullptr when \p constructVsites = false
 150  */
 151 static void prepareRerunState(const t_trxframe&          rerunFrame,
 152                               t_state*                   globalState,
 153                               bool                       constructVsites,
 154                               const VirtualSitesHandler* vsite)
 155 {
 156     auto x      = makeArrayRef(globalState->x);
 157     auto rerunX = arrayRefFromArray(reinterpret_cast<gmx::RVec*>(rerunFrame.x), globalState->natoms);
 158     std::copy(rerunX.begin(), rerunX.end(), x.begin());
 159     copy_mat(rerunFrame.box, globalState->box);
 160
 161     if (constructVsites)
 162     {
 163         GMX_ASSERT(vsite, "Need valid vsite for constructing vsites");
 164
 165         vsite->construct(globalState->x, globalState->v, globalState->box, gmx::VSiteOperation::PositionsAndVelocities);
 166     }
 167 }
 168
 169 void gmx::LegacySimulator::do_rerun()
 170 {
 171     // TODO Historically, the EM and MD "integrators" used different
 172     // names for the t_inputrec *parameter, but these must have the
 173     // same name, now that it's a member of a struct. We use this ir
 174     // alias to avoid a large ripple of nearly useless changes.
 175     // t_inputrec is being replaced by IMdpOptionsProvider, so this
 176     // will go away eventually.
 177     const t_inputrec* ir = inputrec;
 178     double            t;
 179     bool              isLastStep               = false;
 180     bool              doFreeEnergyPerturbation = false;
 181     unsigned int      force_flags;
 182     tensor            force_vir, shake_vir, total_vir, pres;
 183     t_trxstatus*      status = nullptr;
 184     rvec              mu_tot;
 185     t_trxframe        rerun_fr;
 186     ForceBuffers      f;
 187     gmx_global_stat_t gstat;
 188     gmx_shellfc_t*    shellfc;
 189
 190     double cycles;
 191
 192     SimulationSignals signals;
 193     // Most global communnication stages don't propagate mdrun
 194     // signals, and will use this object to achieve that.
 195     SimulationSignaller nullSignaller(nullptr, nullptr, nullptr, false, false);
 196
 197     GMX_LOG(mdlog.info)
 198             .asParagraph()
 199             .appendText(
 200                     "Note that it is planned that the command gmx mdrun -rerun will "
 201                     "be available in a different form in a future version of GROMACS, "
 202                     "e.g. gmx rerun -f.");
 203
 204     if (ir->efep != FreeEnergyPerturbationType::No
 205         && (mdAtoms->mdatoms()->nMassPerturbed > 0 || (constr && constr->havePerturbedConstraints())))
 206     {
 207         gmx_fatal(FARGS,
 208                   "Perturbed masses or constraints are not supported by rerun. "
 209                   "Either make a .tpr without mass and constraint perturbation, "
 210                   "or use GROMACS 2018.4, 2018.5 or later 2018 version.");
 211     }
 212     if (ir->bExpanded)
 213     {
 214         gmx_fatal(FARGS, "Expanded ensemble not supported by rerun.");
 215     }
 216     if (ir->bSimTemp)
 217     {
 218         gmx_fatal(FARGS, "Simulated tempering not supported by rerun.");
 219     }
 220     if (ir->bDoAwh)
 221     {
 222         gmx_fatal(FARGS, "AWH not supported by rerun.");
 223     }
 224     if (replExParams.exchangeInterval > 0)
 225     {
 226         gmx_fatal(FARGS, "Replica exchange not supported by rerun.");
 227     }
 228     if (opt2bSet("-ei", nfile, fnm) || observablesHistory->edsamHistory != nullptr)
 229     {
 230         gmx_fatal(FARGS, "Essential dynamics not supported by rerun.");
 231     }
 232     if (ir->bIMD)
 233     {
 234         gmx_fatal(FARGS, "Interactive MD not supported by rerun.");
 235     }
 236     if (isMultiSim(ms))
 237     {
 238         gmx_fatal(FARGS, "Multiple simulations not supported by rerun.");
 239     }
 240     if (std::any_of(ir->opts.annealing, ir->opts.annealing + ir->opts.ngtc, [](SimulatedAnnealing i) {
 241             return i != SimulatedAnnealing::No;
 242         }))
 243     {
 244         gmx_fatal(FARGS, "Simulated annealing not supported by rerun.");
 245     }
 246
 247     /* Rerun can't work if an output file name is the same as the input file name.
 248      * If this is the case, the user will get an error telling them what the issue is.
 249      */
 250     if (strcmp(opt2fn("-rerun", nfile, fnm), opt2fn("-o", nfile, fnm)) == 0
 251         || strcmp(opt2fn("-rerun", nfile, fnm), opt2fn("-x", nfile, fnm)) == 0)
 252     {
 253         gmx_fatal(FARGS,
 254                   "When using mdrun -rerun, the name of the input trajectory file "
 255                   "%s cannot be identical to the name of an output file (whether "
 256                   "given explicitly with -o or -x, or by default)",
 257                   opt2fn("-rerun", nfile, fnm));
 258     }
 259
 260     /* Settings for rerun */
 261     {
 262         // TODO: Avoid changing inputrec (#3854)
 263         auto* nonConstInputrec               = const_cast<t_inputrec*>(inputrec);
 264         nonConstInputrec->nstlist            = 1;
 265         nonConstInputrec->nstcalcenergy      = 1;
 266         nonConstInputrec->nstxout_compressed = 0;
 267     }
 268     int        nstglobalcomm = 1;
 269     const bool bNS           = true;
 270
 271     ObservablesReducer observablesReducer = observablesReducerBuilder->build();
 272
 273     const SimulationGroups* groups = &top_global.groups;
 274     if (ir->eI == IntegrationAlgorithm::Mimic)
 275     {
 276         auto* nonConstGlobalTopology                         = const_cast<gmx_mtop_t*>(&top_global);
 277         nonConstGlobalTopology->intermolecularExclusionGroup = genQmmmIndices(top_global);
 278     }
 279     int*                fep_state = MASTER(cr) ? &state_global->fep_state : nullptr;
 280     gmx::ArrayRef<real> lambda    = MASTER(cr) ? state_global->lambda : gmx::ArrayRef<real>();
 281     initialize_lambdas(fplog,
 282                        ir->efep,
 283                        ir->bSimTemp,
 284                        *ir->fepvals,
 285                        ir->simtempvals->temperatures,
 286                        gmx::arrayRefFromArray(ir->opts.ref_t, ir->opts.ngtc),
 287                        MASTER(cr),
 288                        fep_state,
 289                        lambda);
 290     const bool        simulationsShareState = false;
 291     gmx_mdoutf*       outf                  = init_mdoutf(fplog,
 292                                    nfile,
 293                                    fnm,
 294                                    mdrunOptions,
 295                                    cr,
 296                                    outputProvider,
 297                                    mdModulesNotifiers,
 298                                    ir,
 299                                    top_global,
 300                                    oenv,
 301                                    wcycle,
 302                                    StartingBehavior::NewSimulation,
 303                                    simulationsShareState,
 304                                    ms);
 305     gmx::EnergyOutput energyOutput(mdoutf_get_fp_ene(outf),
 306                                    top_global,
 307                                    *ir,
 308                                    pull_work,
 309                                    mdoutf_get_fp_dhdl(outf),
 310                                    true,
 311                                    StartingBehavior::NewSimulation,
 312                                    simulationsShareState,
 313                                    mdModulesNotifiers);
 314
 315     gstat = global_stat_init(ir);
 316
 317     /* Check for polarizable models and flexible constraints */
 318     shellfc = init_shell_flexcon(fplog,
 319                                  top_global,
 320                                  constr ? constr->numFlexibleConstraints() : 0,
 321                                  ir->nstcalcenergy,
 322                                  haveDDAtomOrdering(*cr),
 323                                  runScheduleWork->simulationWork.useGpuPme);
 324
 325     {
 326         double io = compute_io(ir, top_global.natoms, *groups, energyOutput.numEnergyTerms(), 1);
 327         if ((io > 2000) && MASTER(cr))
 328         {
 329             fprintf(stderr, "\nWARNING: This run will generate roughly %.0f Mb of data\n\n", io);
 330         }
 331     }
 332
 333     if (haveDDAtomOrdering(*cr))
 334     {
 335         // Local state only becomes valid now.
 336         dd_init_local_state(*cr->dd, state_global, state);
 337
 338         /* Distribute the charge groups over the nodes from the master node */
 339         dd_partition_system(fplog,
 340                             mdlog,
 341                             ir->init_step,
 342                             cr,
 343                             TRUE,
 344                             1,
 345                             state_global,
 346                             top_global,
 347                             *ir,
 348                             imdSession,
 349                             pull_work,
 350                             state,
 351                             &f,
 352                             mdAtoms,
 353                             top,
 354                             fr,
 355                             vsite,
 356                             constr,
 357                             nrnb,
 358                             nullptr,
 359                             FALSE);
 360     }
 361     else
 362     {
 363         state_change_natoms(state_global, state_global->natoms);
 364         /* Copy the pointer to the global state */
 365         state = state_global;
 366
 367         mdAlgorithmsSetupAtomData(cr, *ir, top_global, top, fr, &f, mdAtoms, constr, vsite, shellfc);
 368     }
 369
 370     auto* mdatoms = mdAtoms->mdatoms();
 371     fr->longRangeNonbondeds->updateAfterPartition(*mdatoms);
 372
 373     // NOTE: The global state is no longer used at this point.
 374     // But state_global is still used as temporary storage space for writing
 375     // the global state to file and potentially for replica exchange.
 376     // (Global topology should persist.)
 377
 378     update_mdatoms(mdatoms, state->lambda[FreeEnergyPerturbationCouplingType::Mass]);
 379
 380     if (ir->efep != FreeEnergyPerturbationType::No && ir->fepvals->nstdhdl != 0)
 381     {
 382         doFreeEnergyPerturbation = true;
 383     }
 384
 385     int64_t step     = ir->init_step;
 386     int64_t step_rel = 0;
 387
 388     {
 389         int    cglo_flags   = CGLO_GSTAT;
 390         bool   bSumEkinhOld = false;
 391         t_vcm* vcm          = nullptr;
 392         compute_globals(gstat,
 393                         cr,
 394                         ir,
 395                         fr,
 396                         ekind,
 397                         makeConstArrayRef(state->x),
 398                         makeConstArrayRef(state->v),
 399                         state->box,
 400                         mdatoms,
 401                         nrnb,
 402                         vcm,
 403                         nullptr,
 404                         enerd,
 405                         force_vir,
 406                         shake_vir,
 407                         total_vir,
 408                         pres,
 409                         &nullSignaller,
 410                         state->box,
 411                         &bSumEkinhOld,
 412                         cglo_flags,
 413                         step,
 414                         &observablesReducer);
 415         // Clean up after pre-step use of compute_globals()
 416         observablesReducer.markAsReadyToReduce();
 417     }
 418
 419     if (MASTER(cr))
 420     {
 421         fprintf(stderr,
 422                 "starting md rerun '%s', reading coordinates from"
 423                 " input trajectory '%s'\n\n",
 424                 *(top_global.name),
 425                 opt2fn("-rerun", nfile, fnm));
 426         if (mdrunOptions.verbose)
 427         {
 428             fprintf(stderr,
 429                     "Calculated time to finish depends on nsteps from "
 430                     "run input file,\nwhich may not correspond to the time "
 431                     "needed to process input trajectory.\n\n");
 432         }
 433         fprintf(fplog, "\n");
 434     }
 435
 436     walltime_accounting_start_time(walltime_accounting);
 437     wallcycle_start(wcycle, WallCycleCounter::Run);
 438     print_start(fplog, cr, walltime_accounting, "mdrun");
 439
 440     /***********************************************************
 441      *
 442      *             Loop over MD steps
 443      *
 444      ************************************************************/
 445
 446     if (constr)
 447     {
 448         GMX_LOG(mdlog.info)
 449                 .asParagraph()
 450                 .appendText("Simulations has constraints. Rerun does not recalculate constraints.");
 451     }
 452
 453     rerun_fr.natoms = 0;
 454     if (MASTER(cr))
 455     {
 456         isLastStep = !read_first_frame(oenv, &status, opt2fn("-rerun", nfile, fnm), &rerun_fr, TRX_NEED_X);
 457         if (rerun_fr.natoms != top_global.natoms)
 458         {
 459             gmx_fatal(FARGS,
 460                       "Number of atoms in trajectory (%d) does not match the "
 461                       "run input file (%d)\n",
 462                       rerun_fr.natoms,
 463                       top_global.natoms);
 464         }
 465
 466         if (ir->pbcType != PbcType::No)
 467         {
 468             if (!rerun_fr.bBox)
 469             {
 470                 gmx_fatal(FARGS,
 471                           "Rerun trajectory frame step %" PRId64
 472                           " time %f "
 473                           "does not contain a box, while pbc is used",
 474                           rerun_fr.step,
 475                           rerun_fr.time);
 476             }
 477             if (max_cutoff2(ir->pbcType, rerun_fr.box) < gmx::square(fr->rlist))
 478             {
 479                 gmx_fatal(FARGS,
 480                           "Rerun trajectory frame step %" PRId64
 481                           " time %f "
 482                           "has too small box dimensions",
 483                           rerun_fr.step,
 484                           rerun_fr.time);
 485             }
 486         }
 487     }
 488
 489     GMX_LOG(mdlog.info)
 490             .asParagraph()
 491             .appendText(
 492                     "Rerun does not report kinetic energy, total energy, temperature, virial and "
 493                     "pressure.");
 494
 495     if (PAR(cr))
 496     {
 497         rerun_parallel_comm(cr, &rerun_fr, &isLastStep);
 498     }
 499
 500     if (ir->pbcType != PbcType::No)
 501     {
 502         /* Set the shift vectors.
 503          * Necessary here when have a static box different from the tpr box.
 504          */
 505         calc_shifts(rerun_fr.box, fr->shift_vec);
 506     }
 507
 508     auto stopHandler = stopHandlerBuilder->getStopHandlerMD(
 509             compat::not_null<SimulationSignal*>(&signals[eglsSTOPCOND]),
 510             false,
 511             MASTER(cr),
 512             ir->nstlist,
 513             mdrunOptions.reproducible,
 514             nstglobalcomm,
 515             mdrunOptions.maximumHoursToRun,
 516             ir->nstlist == 0,
 517             fplog,
 518             step,
 519             bNS,
 520             walltime_accounting);
 521
 522     // we don't do counter resetting in rerun - finish will always be valid
 523     walltime_accounting_set_valid_finish(walltime_accounting);
 524
 525     const DDBalanceRegionHandler ddBalanceRegionHandler(cr);
 526
 527     /* and stop now if we should */
 528     isLastStep = (isLastStep || (ir->nsteps >= 0 && step_rel > ir->nsteps));
 529     while (!isLastStep)
 530     {
 531         wallcycle_start(wcycle, WallCycleCounter::Step);
 532
 533         if (rerun_fr.bStep)
 534         {
 535             step     = rerun_fr.step;
 536             step_rel = step - ir->init_step;
 537         }
 538         if (rerun_fr.bTime)
 539         {
 540             t = rerun_fr.time;
 541         }
 542         else
 543         {
 544             t = step;
 545         }
 546
 547         if (ir->efep != FreeEnergyPerturbationType::No && MASTER(cr))
 548         {
 549             if (rerun_fr.bLambda)
 550             {
 551                 ir->fepvals->init_lambda = rerun_fr.lambda;
 552             }
 553             else
 554             {
 555                 if (rerun_fr.bFepState)
 556                 {
 557                     state->fep_state = rerun_fr.fep_state;
 558                 }
 559             }
 560
 561             state_global->lambda = currentLambdas(step, *(ir->fepvals), state->fep_state);
 562         }
 563
 564         if (MASTER(cr))
 565         {
 566             const bool constructVsites = ((vsite != nullptr) && mdrunOptions.rerunConstructVsites);
 567             if (constructVsites && haveDDAtomOrdering(*cr))
 568             {
 569                 gmx_fatal(FARGS,
 570                           "Vsite recalculation with -rerun is not implemented with domain "
 571                           "decomposition, "
 572                           "use a single rank");
 573             }
 574             prepareRerunState(rerun_fr, state_global, constructVsites, vsite);
 575         }
 576
 577         isLastStep = isLastStep || stopHandler->stoppingAfterCurrentStep(bNS);
 578
 579         if (haveDDAtomOrdering(*cr))
 580         {
 581             /* Repartition the domain decomposition */
 582             const bool bMasterState = true;
 583             dd_partition_system(fplog,
 584                                 mdlog,
 585                                 step,
 586                                 cr,
 587                                 bMasterState,
 588                                 nstglobalcomm,
 589                                 state_global,
 590                                 top_global,
 591                                 *ir,
 592                                 imdSession,
 593                                 pull_work,
 594                                 state,
 595                                 &f,
 596                                 mdAtoms,
 597                                 top,
 598                                 fr,
 599                                 vsite,
 600                                 constr,
 601                                 nrnb,
 602                                 wcycle,
 603                                 mdrunOptions.verbose);
 604         }
 605
 606         if (MASTER(cr))
 607         {
 608             EnergyOutput::printHeader(fplog, step, t); /* can we improve the information printed here? */
 609         }
 610
 611         if (ir->efep != FreeEnergyPerturbationType::No)
 612         {
 613             update_mdatoms(mdatoms, state->lambda[FreeEnergyPerturbationCouplingType::Mass]);
 614         }
 615
 616         fr->longRangeNonbondeds->updateAfterPartition(*mdatoms);
 617
 618         force_flags = (GMX_FORCE_STATECHANGED | GMX_FORCE_DYNAMICBOX | GMX_FORCE_ALLFORCES
 619                        | GMX_FORCE_VIRIAL | // TODO: Get rid of this once #2649 and #3400 are solved
 620                        GMX_FORCE_ENERGY | (doFreeEnergyPerturbation ? GMX_FORCE_DHDL : 0));
 621
 622         if (shellfc)
 623         {
 624             /* Now is the time to relax the shells */
 625             relax_shell_flexcon(fplog,
 626                                 cr,
 627                                 ms,
 628                                 mdrunOptions.verbose,
 629                                 enforcedRotation,
 630                                 step,
 631                                 ir,
 632                                 imdSession,
 633                                 pull_work,
 634                                 bNS,
 635                                 force_flags,
 636                                 top,
 637                                 constr,
 638                                 enerd,
 639                                 state->natoms,
 640                                 state->x.arrayRefWithPadding(),
 641                                 state->v.arrayRefWithPadding(),
 642                                 state->box,
 643                                 state->lambda,
 644                                 &state->hist,
 645                                 &f.view(),
 646                                 force_vir,
 647                                 *mdatoms,
 648                                 fr->longRangeNonbondeds.get(),
 649                                 nrnb,
 650                                 wcycle,
 651                                 shellfc,
 652                                 fr,
 653                                 runScheduleWork,
 654                                 t,
 655                                 mu_tot,
 656                                 vsite,
 657                                 ddBalanceRegionHandler);
 658         }
 659         else
 660         {
 661             /* The coordinates (x) are shifted (to get whole molecules)
 662              * in do_force.
 663              * This is parallellized as well, and does communication too.
 664              * Check comments in sim_util.c
 665              */
 666             Awh*       awh = nullptr;
 667             gmx_edsam* ed  = nullptr;
 668             do_force(fplog,
 669                      cr,
 670                      ms,
 671                      *ir,
 672                      awh,
 673                      enforcedRotation,
 674                      imdSession,
 675                      pull_work,
 676                      step,
 677                      nrnb,
 678                      wcycle,
 679                      top,
 680                      state->box,
 681                      state->x.arrayRefWithPadding(),
 682                      &state->hist,
 683                      &f.view(),
 684                      force_vir,
 685                      mdatoms,
 686                      enerd,
 687                      state->lambda,
 688                      fr,
 689                      runScheduleWork,
 690                      vsite,
 691                      mu_tot,
 692                      t,
 693                      ed,
 694                      fr->longRangeNonbondeds.get(),
 695                      GMX_FORCE_NS | force_flags,
 696                      ddBalanceRegionHandler);
 697         }
 698
 699         /* Now we have the energies and forces corresponding to the
 700          * coordinates at time t.
 701          */
 702         {
 703             const bool isCheckpointingStep = false;
 704             const bool doRerun             = true;
 705             const bool bSumEkinhOld        = false;
 706             do_md_trajectory_writing(fplog,
 707                                      cr,
 708                                      nfile,
 709                                      fnm,
 710                                      step,
 711                                      step_rel,
 712                                      t,
 713                                      ir,
 714                                      state,
 715                                      state_global,
 716                                      observablesHistory,
 717                                      top_global,
 718                                      fr,
 719                                      outf,
 720                                      energyOutput,
 721                                      ekind,
 722                                      f.view().force(),
 723                                      isCheckpointingStep,
 724                                      doRerun,
 725                                      isLastStep,
 726                                      mdrunOptions.writeConfout,
 727                                      bSumEkinhOld);
 728         }
 729
 730         stopHandler->setSignal();
 731
 732         {
 733             const bool          doInterSimSignal = false;
 734             const bool          doIntraSimSignal = true;
 735             bool                bSumEkinhOld     = false;
 736             t_vcm*              vcm              = nullptr;
 737             SimulationSignaller signaller(&signals, cr, ms, doInterSimSignal, doIntraSimSignal);
 738
 739             int cglo_flags = CGLO_GSTAT | CGLO_ENERGY;
 740             compute_globals(gstat,
 741                             cr,
 742                             ir,
 743                             fr,
 744                             ekind,
 745                             makeConstArrayRef(state->x),
 746                             makeConstArrayRef(state->v),
 747                             state->box,
 748                             mdatoms,
 749                             nrnb,
 750                             vcm,
 751                             wcycle,
 752                             enerd,
 753                             force_vir,
 754                             shake_vir,
 755                             total_vir,
 756                             pres,
 757                             &signaller,
 758                             state->box,
 759                             &bSumEkinhOld,
 760                             cglo_flags,
 761                             step,
 762                             &observablesReducer);
 763             // Clean up after pre-step use of compute_globals()
 764             observablesReducer.markAsReadyToReduce();
 765         }
 766
 767         /* Note: this is OK, but there are some numerical precision issues with using the convergence of
 768            the virial that should probably be addressed eventually. state->veta has better properies,
 769            but what we actually need entering the new cycle is the new shake_vir value. Ideally, we could
 770            generate the new shake_vir, but test the veta value for convergence.  This will take some thought. */
 771
 772         /* Output stuff */
 773         if (MASTER(cr))
 774         {
 775             const bool bCalcEnerStep = true;
 776             energyOutput.addDataAtEnergyStep(doFreeEnergyPerturbation,
 777                                              bCalcEnerStep,
 778                                              t,
 779                                              mdatoms->tmass,
 780                                              enerd,
 781                                              ir->fepvals.get(),
 782                                              state->box,
 783                                              PTCouplingArrays({ state->boxv,
 784                                                                 state->nosehoover_xi,
 785                                                                 state->nosehoover_vxi,
 786                                                                 state->nhpres_xi,
 787                                                                 state->nhpres_vxi }),
 788                                              state->fep_state,
 789                                              total_vir,
 790                                              pres,
 791                                              ekind,
 792                                              mu_tot,
 793                                              constr);
 794
 795             const bool do_ene = true;
 796             const bool do_log = true;
 797             Awh*       awh    = nullptr;
 798             const bool do_dr  = ir->nstdisreout != 0;
 799             const bool do_or  = ir->nstorireout != 0;
 800
 801             EnergyOutput::printAnnealingTemperatures(do_log ? fplog : nullptr, groups, &(ir->opts));
 802             energyOutput.printStepToEnergyFile(mdoutf_get_fp_ene(outf),
 803                                                do_ene,
 804                                                do_dr,
 805                                                do_or,
 806                                                do_log ? fplog : nullptr,
 807                                                step,
 808                                                t,
 809                                                fr->fcdata.get(),
 810                                                awh);
 811
 812             if (ir->bPull)
 813             {
 814                 pull_print_output(pull_work, step, t);
 815             }
 816
 817             if (do_per_step(step, ir->nstlog))
 818             {
 819                 if (fflush(fplog) != 0)
 820                 {
 821                     gmx_fatal(FARGS, "Cannot flush logfile - maybe you are out of disk space?");
 822                 }
 823             }
 824         }
 825
 826         /* Print the remaining wall clock time for the run */
 827         if (isMasterSimMasterRank(ms, MASTER(cr)) && (mdrunOptions.verbose || gmx_got_usr_signal()))
 828         {
 829             if (shellfc)
 830             {
 831                 fprintf(stderr, "\n");
 832             }
 833             print_time(stderr, walltime_accounting, step, ir, cr);
 834         }
 835
 836         /* Ion/water position swapping.
 837          * Not done in last step since trajectory writing happens before this call
 838          * in the MD loop and exchanges would be lost anyway. */
 839         if ((ir->eSwapCoords != SwapType::No) && (step > 0) && !isLastStep
 840             && do_per_step(step, ir->swap->nstswap))
 841         {
 842             const bool doRerun = true;
 843             do_swapcoords(cr,
 844                           step,
 845                           t,
 846                           ir,
 847                           swap,
 848                           wcycle,
 849                           rerun_fr.x,
 850                           rerun_fr.box,
 851                           MASTER(cr) && mdrunOptions.verbose,
 852                           doRerun);
 853         }
 854
 855         if (MASTER(cr))
 856         {
 857             /* read next frame from input trajectory */
 858             isLastStep = !read_next_frame(oenv, status, &rerun_fr);
 859         }
 860
 861         if (PAR(cr))
 862         {
 863             rerun_parallel_comm(cr, &rerun_fr, &isLastStep);
 864         }
 865
 866         cycles = wallcycle_stop(wcycle, WallCycleCounter::Step);
 867         if (haveDDAtomOrdering(*cr) && wcycle)
 868         {
 869             dd_cycles_add(cr->dd, cycles, ddCyclStep);
 870         }
 871
 872         if (!rerun_fr.bStep)
 873         {
 874             /* increase the MD step number */
 875             step++;
 876             step_rel++;
 877         }
 878         observablesReducer.markAsReadyToReduce();
 879     }
 880     /* End of main MD loop */
 881
 882     /* Closing TNG files can include compressing data. Therefore it is good to do that
 883      * before stopping the time measurements. */
 884     mdoutf_tng_close(outf);
 885
 886     /* Stop measuring walltime */
 887     walltime_accounting_end_time(walltime_accounting);
 888
 889     if (MASTER(cr))
 890     {
 891         close_trx(status);
 892     }
 893
 894     if (!thisRankHasDuty(cr, DUTY_PME))
 895     {
 896         /* Tell the PME only node to finish */
 897         gmx_pme_send_finish(cr);
 898     }
 899
 900     done_mdoutf(outf);
 901
 902     done_shellfc(fplog, shellfc, step_rel);
 903
 904     walltime_accounting_set_nsteps_done(walltime_accounting, step_rel);
 905 }