src/gromacs/mdrun/minimize.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015,2016,2017 The GROMACS development team.
   7  * Copyright (c) 2018,2019,2020,2021, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 /*! \internal \file
  39  *
  40  * \brief This file defines integrators for energy minimization
  41  *
  42  * \author Berk Hess <hess@kth.se>
  43  * \author Erik Lindahl <erik@kth.se>
  44  * \ingroup module_mdrun
  45  */
  46 #include "gmxpre.h"
  47
  48 #include "config.h"
  49
  50 #include <cmath>
  51 #include <cstring>
  52 #include <ctime>
  53
  54 #include <algorithm>
  55 #include <vector>
  56
  57 #include "gromacs/commandline/filenm.h"
  58 #include "gromacs/domdec/collect.h"
  59 #include "gromacs/domdec/dlbtiming.h"
  60 #include "gromacs/domdec/domdec.h"
  61 #include "gromacs/domdec/domdec_struct.h"
  62 #include "gromacs/domdec/mdsetup.h"
  63 #include "gromacs/domdec/partition.h"
  64 #include "gromacs/ewald/pme_pp.h"
  65 #include "gromacs/fileio/confio.h"
  66 #include "gromacs/fileio/mtxio.h"
  67 #include "gromacs/gmxlib/network.h"
  68 #include "gromacs/gmxlib/nrnb.h"
  69 #include "gromacs/imd/imd.h"
  70 #include "gromacs/linearalgebra/sparsematrix.h"
  71 #include "gromacs/listed_forces/listed_forces.h"
  72 #include "gromacs/math/functions.h"
  73 #include "gromacs/math/vec.h"
  74 #include "gromacs/mdlib/constr.h"
  75 #include "gromacs/mdlib/coupling.h"
  76 #include "gromacs/mdlib/dispersioncorrection.h"
  77 #include "gromacs/mdlib/ebin.h"
  78 #include "gromacs/mdlib/enerdata_utils.h"
  79 #include "gromacs/mdlib/energyoutput.h"
  80 #include "gromacs/mdlib/force.h"
  81 #include "gromacs/mdlib/force_flags.h"
  82 #include "gromacs/mdlib/forcerec.h"
  83 #include "gromacs/mdlib/gmx_omp_nthreads.h"
  84 #include "gromacs/mdlib/md_support.h"
  85 #include "gromacs/mdlib/mdatoms.h"
  86 #include "gromacs/mdlib/stat.h"
  87 #include "gromacs/mdlib/tgroup.h"
  88 #include "gromacs/mdlib/trajectory_writing.h"
  89 #include "gromacs/mdlib/update.h"
  90 #include "gromacs/mdlib/vsite.h"
  91 #include "gromacs/mdrunutility/handlerestart.h"
  92 #include "gromacs/mdrunutility/printtime.h"
  93 #include "gromacs/mdtypes/checkpointdata.h"
  94 #include "gromacs/mdtypes/commrec.h"
  95 #include "gromacs/mdtypes/forcebuffers.h"
  96 #include "gromacs/mdtypes/forcerec.h"
  97 #include "gromacs/mdtypes/inputrec.h"
  98 #include "gromacs/mdtypes/interaction_const.h"
  99 #include "gromacs/mdtypes/md_enums.h"
 100 #include "gromacs/mdtypes/mdatom.h"
 101 #include "gromacs/mdtypes/mdrunoptions.h"
 102 #include "gromacs/mdtypes/state.h"
 103 #include "gromacs/pbcutil/pbc.h"
 104 #include "gromacs/timing/wallcycle.h"
 105 #include "gromacs/timing/walltime_accounting.h"
 106 #include "gromacs/topology/mtop_util.h"
 107 #include "gromacs/topology/topology.h"
 108 #include "gromacs/utility/cstringutil.h"
 109 #include "gromacs/utility/exceptions.h"
 110 #include "gromacs/utility/fatalerror.h"
 111 #include "gromacs/utility/logger.h"
 112 #include "gromacs/utility/smalloc.h"
 113
 114 #include "legacysimulator.h"
 115 #include "shellfc.h"
 116
 117 using gmx::ArrayRef;
 118 using gmx::MdrunScheduleWorkload;
 119 using gmx::RVec;
 120 using gmx::VirtualSitesHandler;
 121
 122 //! Utility structure for manipulating states during EM
 123 typedef struct em_state
 124 {
 125     //! Copy of the global state
 126     t_state s;
 127     //! Force array
 128     gmx::ForceBuffers f;
 129     //! Potential energy
 130     real epot;
 131     //! Norm of the force
 132     real fnorm;
 133     //! Maximum force
 134     real fmax;
 135     //! Direction
 136     int a_fmax;
 137 } em_state_t;
 138
 139 //! Print the EM starting conditions
 140 static void print_em_start(FILE*                     fplog,
 141                            const t_commrec*          cr,
 142                            gmx_walltime_accounting_t walltime_accounting,
 143                            gmx_wallcycle_t           wcycle,
 144                            const char*               name)
 145 {
 146     walltime_accounting_start_time(walltime_accounting);
 147     wallcycle_start(wcycle, ewcRUN);
 148     print_start(fplog, cr, walltime_accounting, name);
 149 }
 150
 151 //! Stop counting time for EM
 152 static void em_time_end(gmx_walltime_accounting_t walltime_accounting, gmx_wallcycle_t wcycle)
 153 {
 154     wallcycle_stop(wcycle, ewcRUN);
 155
 156     walltime_accounting_end_time(walltime_accounting);
 157 }
 158
 159 //! Printing a log file and console header
 160 static void sp_header(FILE* out, const char* minimizer, real ftol, int nsteps)
 161 {
 162     fprintf(out, "\n");
 163     fprintf(out, "%s:\n", minimizer);
 164     fprintf(out, "   Tolerance (Fmax)   = %12.5e\n", ftol);
 165     fprintf(out, "   Number of steps    = %12d\n", nsteps);
 166 }
 167
 168 //! Print warning message
 169 static void warn_step(FILE* fp, real ftol, real fmax, gmx_bool bLastStep, gmx_bool bConstrain)
 170 {
 171     constexpr bool realIsDouble = GMX_DOUBLE;
 172     char           buffer[2048];
 173
 174     if (!std::isfinite(fmax))
 175     {
 176         sprintf(buffer,
 177                 "\nEnergy minimization has stopped because the force "
 178                 "on at least one atom is not finite. This usually means "
 179                 "atoms are overlapping. Modify the input coordinates to "
 180                 "remove atom overlap or use soft-core potentials with "
 181                 "the free energy code to avoid infinite forces.\n%s",
 182                 !realIsDouble ? "You could also be lucky that switching to double precision "
 183                                 "is sufficient to obtain finite forces.\n"
 184                               : "");
 185     }
 186     else if (bLastStep)
 187     {
 188         sprintf(buffer,
 189                 "\nEnergy minimization reached the maximum number "
 190                 "of steps before the forces reached the requested "
 191                 "precision Fmax < %g.\n",
 192                 ftol);
 193     }
 194     else
 195     {
 196         sprintf(buffer,
 197                 "\nEnergy minimization has stopped, but the forces have "
 198                 "not converged to the requested precision Fmax < %g (which "
 199                 "may not be possible for your system). It stopped "
 200                 "because the algorithm tried to make a new step whose size "
 201                 "was too small, or there was no change in the energy since "
 202                 "last step. Either way, we regard the minimization as "
 203                 "converged to within the available machine precision, "
 204                 "given your starting configuration and EM parameters.\n%s%s",
 205                 ftol,
 206                 !realIsDouble ? "\nDouble precision normally gives you higher accuracy, but "
 207                                 "this is often not needed for preparing to run molecular "
 208                                 "dynamics.\n"
 209                               : "",
 210                 bConstrain ? "You might need to increase your constraint accuracy, or turn\n"
 211                              "off constraints altogether (set constraints = none in mdp file)\n"
 212                            : "");
 213     }
 214
 215     fputs(wrap_lines(buffer, 78, 0, FALSE), stderr);
 216     fputs(wrap_lines(buffer, 78, 0, FALSE), fp);
 217 }
 218
 219 //! Print message about convergence of the EM
 220 static void print_converged(FILE*             fp,
 221                             const char*       alg,
 222                             real              ftol,
 223                             int64_t           count,
 224                             gmx_bool          bDone,
 225                             int64_t           nsteps,
 226                             const em_state_t* ems,
 227                             double            sqrtNumAtoms)
 228 {
 229     char buf[STEPSTRSIZE];
 230
 231     if (bDone)
 232     {
 233         fprintf(fp, "\n%s converged to Fmax < %g in %s steps\n", alg, ftol, gmx_step_str(count, buf));
 234     }
 235     else if (count < nsteps)
 236     {
 237         fprintf(fp,
 238                 "\n%s converged to machine precision in %s steps,\n"
 239                 "but did not reach the requested Fmax < %g.\n",
 240                 alg,
 241                 gmx_step_str(count, buf),
 242                 ftol);
 243     }
 244     else
 245     {
 246         fprintf(fp, "\n%s did not converge to Fmax < %g in %s steps.\n", alg, ftol, gmx_step_str(count, buf));
 247     }
 248
 249 #if GMX_DOUBLE
 250     fprintf(fp, "Potential Energy  = %21.14e\n", ems->epot);
 251     fprintf(fp, "Maximum force     = %21.14e on atom %d\n", ems->fmax, ems->a_fmax + 1);
 252     fprintf(fp, "Norm of force     = %21.14e\n", ems->fnorm / sqrtNumAtoms);
 253 #else
 254     fprintf(fp, "Potential Energy  = %14.7e\n", ems->epot);
 255     fprintf(fp, "Maximum force     = %14.7e on atom %d\n", ems->fmax, ems->a_fmax + 1);
 256     fprintf(fp, "Norm of force     = %14.7e\n", ems->fnorm / sqrtNumAtoms);
 257 #endif
 258 }
 259
 260 //! Compute the norm and max of the force array in parallel
 261 static void get_f_norm_max(const t_commrec*               cr,
 262                            const t_grpopts*               opts,
 263                            t_mdatoms*                     mdatoms,
 264                            gmx::ArrayRef<const gmx::RVec> f,
 265                            real*                          fnorm,
 266                            real*                          fmax,
 267                            int*                           a_fmax)
 268 {
 269     double fnorm2, *sum;
 270     real   fmax2, fam;
 271     int    la_max, a_max, start, end, i, m, gf;
 272
 273     /* This routine finds the largest force and returns it.
 274      * On parallel machines the global max is taken.
 275      */
 276     fnorm2 = 0;
 277     fmax2  = 0;
 278     la_max = -1;
 279     start  = 0;
 280     end    = mdatoms->homenr;
 281     if (mdatoms->cFREEZE)
 282     {
 283         for (i = start; i < end; i++)
 284         {
 285             gf  = mdatoms->cFREEZE[i];
 286             fam = 0;
 287             for (m = 0; m < DIM; m++)
 288             {
 289                 if (!opts->nFreeze[gf][m])
 290                 {
 291                     fam += gmx::square(f[i][m]);
 292                 }
 293             }
 294             fnorm2 += fam;
 295             if (fam > fmax2)
 296             {
 297                 fmax2  = fam;
 298                 la_max = i;
 299             }
 300         }
 301     }
 302     else
 303     {
 304         for (i = start; i < end; i++)
 305         {
 306             fam = norm2(f[i]);
 307             fnorm2 += fam;
 308             if (fam > fmax2)
 309             {
 310                 fmax2  = fam;
 311                 la_max = i;
 312             }
 313         }
 314     }
 315
 316     if (la_max >= 0 && DOMAINDECOMP(cr))
 317     {
 318         a_max = cr->dd->globalAtomIndices[la_max];
 319     }
 320     else
 321     {
 322         a_max = la_max;
 323     }
 324     if (PAR(cr))
 325     {
 326         snew(sum, 2 * cr->nnodes + 1);
 327         sum[2 * cr->nodeid]     = fmax2;
 328         sum[2 * cr->nodeid + 1] = a_max;
 329         sum[2 * cr->nnodes]     = fnorm2;
 330         gmx_sumd(2 * cr->nnodes + 1, sum, cr);
 331         fnorm2 = sum[2 * cr->nnodes];
 332         /* Determine the global maximum */
 333         for (i = 0; i < cr->nnodes; i++)
 334         {
 335             if (sum[2 * i] > fmax2)
 336             {
 337                 fmax2 = sum[2 * i];
 338                 a_max = gmx::roundToInt(sum[2 * i + 1]);
 339             }
 340         }
 341         sfree(sum);
 342     }
 343
 344     if (fnorm)
 345     {
 346         *fnorm = sqrt(fnorm2);
 347     }
 348     if (fmax)
 349     {
 350         *fmax = sqrt(fmax2);
 351     }
 352     if (a_fmax)
 353     {
 354         *a_fmax = a_max;
 355     }
 356 }
 357
 358 //! Compute the norm of the force
 359 static void get_state_f_norm_max(const t_commrec* cr, const t_grpopts* opts, t_mdatoms* mdatoms, em_state_t* ems)
 360 {
 361     get_f_norm_max(cr, opts, mdatoms, ems->f.view().force(), &ems->fnorm, &ems->fmax, &ems->a_fmax);
 362 }
 363
 364 //! Initialize the energy minimization
 365 static void init_em(FILE*                fplog,
 366                     const gmx::MDLogger& mdlog,
 367                     const char*          title,
 368                     const t_commrec*     cr,
 369                     const t_inputrec*    ir,
 370                     gmx::ImdSession*     imdSession,
 371                     pull_t*              pull_work,
 372                     t_state*             state_global,
 373                     const gmx_mtop_t*    top_global,
 374                     em_state_t*          ems,
 375                     gmx_localtop_t*      top,
 376                     t_nrnb*              nrnb,
 377                     t_forcerec*          fr,
 378                     gmx::MDAtoms*        mdAtoms,
 379                     gmx_global_stat_t*   gstat,
 380                     VirtualSitesHandler* vsite,
 381                     gmx::Constraints*    constr,
 382                     gmx_shellfc_t**      shellfc)
 383 {
 384     real dvdl_constr;
 385
 386     if (fplog)
 387     {
 388         fprintf(fplog, "Initiating %s\n", title);
 389     }
 390
 391     if (MASTER(cr))
 392     {
 393         state_global->ngtc = 0;
 394     }
 395     int*                fep_state = MASTER(cr) ? &state_global->fep_state : nullptr;
 396     gmx::ArrayRef<real> lambda    = MASTER(cr) ? state_global->lambda : gmx::ArrayRef<real>();
 397     initialize_lambdas(fplog, *ir, MASTER(cr), fep_state, lambda);
 398
 399     if (ir->eI == IntegrationAlgorithm::NM)
 400     {
 401         GMX_ASSERT(shellfc != nullptr, "With NM we always support shells");
 402
 403         *shellfc = init_shell_flexcon(stdout,
 404                                       top_global,
 405                                       constr ? constr->numFlexibleConstraints() : 0,
 406                                       ir->nstcalcenergy,
 407                                       DOMAINDECOMP(cr),
 408                                       thisRankHasDuty(cr, DUTY_PME));
 409     }
 410     else
 411     {
 412         GMX_ASSERT(EI_ENERGY_MINIMIZATION(ir->eI),
 413                    "This else currently only handles energy minimizers, consider if your algorithm "
 414                    "needs shell/flexible-constraint support");
 415
 416         /* With energy minimization, shells and flexible constraints are
 417          * automatically minimized when treated like normal DOFS.
 418          */
 419         if (shellfc != nullptr)
 420         {
 421             *shellfc = nullptr;
 422         }
 423     }
 424
 425     if (DOMAINDECOMP(cr))
 426     {
 427         dd_init_local_state(cr->dd, state_global, &ems->s);
 428
 429         /* Distribute the charge groups over the nodes from the master node */
 430         dd_partition_system(fplog,
 431                             mdlog,
 432                             ir->init_step,
 433                             cr,
 434                             TRUE,
 435                             1,
 436                             state_global,
 437                             *top_global,
 438                             ir,
 439                             imdSession,
 440                             pull_work,
 441                             &ems->s,
 442                             &ems->f,
 443                             mdAtoms,
 444                             top,
 445                             fr,
 446                             vsite,
 447                             constr,
 448                             nrnb,
 449                             nullptr,
 450                             FALSE);
 451         dd_store_state(cr->dd, &ems->s);
 452     }
 453     else
 454     {
 455         state_change_natoms(state_global, state_global->natoms);
 456         /* Just copy the state */
 457         ems->s = *state_global;
 458         state_change_natoms(&ems->s, ems->s.natoms);
 459
 460         mdAlgorithmsSetupAtomData(
 461                 cr, ir, *top_global, top, fr, &ems->f, mdAtoms, constr, vsite, shellfc ? *shellfc : nullptr);
 462     }
 463
 464     update_mdatoms(mdAtoms->mdatoms(), ems->s.lambda[FreeEnergyPerturbationCouplingType::Mass]);
 465
 466     if (constr)
 467     {
 468         // TODO how should this cross-module support dependency be managed?
 469         if (ir->eConstrAlg == ConstraintAlgorithm::Shake && gmx_mtop_ftype_count(top_global, F_CONSTR) > 0)
 470         {
 471             gmx_fatal(FARGS,
 472                       "Can not do energy minimization with %s, use %s\n",
 473                       enumValueToString(ConstraintAlgorithm::Shake),
 474                       enumValueToString(ConstraintAlgorithm::Lincs));
 475         }
 476
 477         if (!ir->bContinuation)
 478         {
 479             /* Constrain the starting coordinates */
 480             bool needsLogging  = true;
 481             bool computeEnergy = true;
 482             bool computeVirial = false;
 483             dvdl_constr        = 0;
 484             constr->apply(needsLogging,
 485                           computeEnergy,
 486                           -1,
 487                           0,
 488                           1.0,
 489                           ems->s.x.arrayRefWithPadding(),
 490                           ems->s.x.arrayRefWithPadding(),
 491                           ArrayRef<RVec>(),
 492                           ems->s.box,
 493                           ems->s.lambda[FreeEnergyPerturbationCouplingType::Fep],
 494                           &dvdl_constr,
 495                           gmx::ArrayRefWithPadding<RVec>(),
 496                           computeVirial,
 497                           nullptr,
 498                           gmx::ConstraintVariable::Positions);
 499         }
 500     }
 501
 502     if (PAR(cr))
 503     {
 504         *gstat = global_stat_init(ir);
 505     }
 506     else
 507     {
 508         *gstat = nullptr;
 509     }
 510
 511     calc_shifts(ems->s.box, fr->shift_vec);
 512 }
 513
 514 //! Finalize the minimization
 515 static void finish_em(const t_commrec*          cr,
 516                       gmx_mdoutf_t              outf,
 517                       gmx_walltime_accounting_t walltime_accounting,
 518                       gmx_wallcycle_t           wcycle)
 519 {
 520     if (!thisRankHasDuty(cr, DUTY_PME))
 521     {
 522         /* Tell the PME only node to finish */
 523         gmx_pme_send_finish(cr);
 524     }
 525
 526     done_mdoutf(outf);
 527
 528     em_time_end(walltime_accounting, wcycle);
 529 }
 530
 531 //! Swap two different EM states during minimization
 532 static void swap_em_state(em_state_t** ems1, em_state_t** ems2)
 533 {
 534     em_state_t* tmp;
 535
 536     tmp   = *ems1;
 537     *ems1 = *ems2;
 538     *ems2 = tmp;
 539 }
 540
 541 //! Save the EM trajectory
 542 static void write_em_traj(FILE*               fplog,
 543                           const t_commrec*    cr,
 544                           gmx_mdoutf_t        outf,
 545                           gmx_bool            bX,
 546                           gmx_bool            bF,
 547                           const char*         confout,
 548                           const gmx_mtop_t*   top_global,
 549                           const t_inputrec*   ir,
 550                           int64_t             step,
 551                           em_state_t*         state,
 552                           t_state*            state_global,
 553                           ObservablesHistory* observablesHistory)
 554 {
 555     int mdof_flags = 0;
 556
 557     if (bX)
 558     {
 559         mdof_flags |= MDOF_X;
 560     }
 561     if (bF)
 562     {
 563         mdof_flags |= MDOF_F;
 564     }
 565
 566     /* If we want IMD output, set appropriate MDOF flag */
 567     if (ir->bIMD)
 568     {
 569         mdof_flags |= MDOF_IMD;
 570     }
 571
 572     gmx::WriteCheckpointDataHolder checkpointDataHolder;
 573     mdoutf_write_to_trajectory_files(fplog,
 574                                      cr,
 575                                      outf,
 576                                      mdof_flags,
 577                                      top_global->natoms,
 578                                      step,
 579                                      static_cast<double>(step),
 580                                      &state->s,
 581                                      state_global,
 582                                      observablesHistory,
 583                                      state->f.view().force(),
 584                                      &checkpointDataHolder);
 585
 586     if (confout != nullptr)
 587     {
 588         if (DOMAINDECOMP(cr))
 589         {
 590             /* If bX=true, x was collected to state_global in the call above */
 591             if (!bX)
 592             {
 593                 auto globalXRef = MASTER(cr) ? state_global->x : gmx::ArrayRef<gmx::RVec>();
 594                 dd_collect_vec(
 595                         cr->dd, state->s.ddp_count, state->s.ddp_count_cg_gl, state->s.cg_gl, state->s.x, globalXRef);
 596             }
 597         }
 598         else
 599         {
 600             /* Copy the local state pointer */
 601             state_global = &state->s;
 602         }
 603
 604         if (MASTER(cr))
 605         {
 606             if (ir->pbcType != PbcType::No && !ir->bPeriodicMols && DOMAINDECOMP(cr))
 607             {
 608                 /* Make molecules whole only for confout writing */
 609                 do_pbc_mtop(ir->pbcType, state->s.box, top_global, state_global->x.rvec_array());
 610             }
 611
 612             write_sto_conf_mtop(confout,
 613                                 *top_global->name,
 614                                 top_global,
 615                                 state_global->x.rvec_array(),
 616                                 nullptr,
 617                                 ir->pbcType,
 618                                 state->s.box);
 619         }
 620     }
 621 }
 622
 623 //! \brief Do one minimization step
 624 //
 625 // \returns true when the step succeeded, false when a constraint error occurred
 626 static bool do_em_step(const t_commrec*                          cr,
 627                        const t_inputrec*                         ir,
 628                        t_mdatoms*                                md,
 629                        em_state_t*                               ems1,
 630                        real                                      a,
 631                        gmx::ArrayRefWithPadding<const gmx::RVec> force,
 632                        em_state_t*                               ems2,
 633                        gmx::Constraints*                         constr,
 634                        int64_t                                   count)
 635
 636 {
 637     t_state *s1, *s2;
 638     int      start, end;
 639     real     dvdl_constr;
 640     int nthreads gmx_unused;
 641
 642     bool validStep = true;
 643
 644     s1 = &ems1->s;
 645     s2 = &ems2->s;
 646
 647     if (DOMAINDECOMP(cr) && s1->ddp_count != cr->dd->ddp_count)
 648     {
 649         gmx_incons("state mismatch in do_em_step");
 650     }
 651
 652     s2->flags = s1->flags;
 653
 654     if (s2->natoms != s1->natoms)
 655     {
 656         state_change_natoms(s2, s1->natoms);
 657         ems2->f.resize(s2->natoms);
 658     }
 659     if (DOMAINDECOMP(cr) && s2->cg_gl.size() != s1->cg_gl.size())
 660     {
 661         s2->cg_gl.resize(s1->cg_gl.size());
 662     }
 663
 664     copy_mat(s1->box, s2->box);
 665     /* Copy free energy state */
 666     s2->lambda = s1->lambda;
 667     copy_mat(s1->box, s2->box);
 668
 669     start = 0;
 670     end   = md->homenr;
 671
 672     nthreads = gmx_omp_nthreads_get(emntUpdate);
 673 #pragma omp parallel num_threads(nthreads)
 674     {
 675         const rvec* x1 = s1->x.rvec_array();
 676         rvec*       x2 = s2->x.rvec_array();
 677         const rvec* f  = as_rvec_array(force.unpaddedArrayRef().data());
 678
 679         int gf = 0;
 680 #pragma omp for schedule(static) nowait
 681         for (int i = start; i < end; i++)
 682         {
 683             try
 684             {
 685                 if (md->cFREEZE)
 686                 {
 687                     gf = md->cFREEZE[i];
 688                 }
 689                 for (int m = 0; m < DIM; m++)
 690                 {
 691                     if (ir->opts.nFreeze[gf][m])
 692                     {
 693                         x2[i][m] = x1[i][m];
 694                     }
 695                     else
 696                     {
 697                         x2[i][m] = x1[i][m] + a * f[i][m];
 698                     }
 699                 }
 700             }
 701             GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR
 702         }
 703
 704         if (s2->flags & (1 << estCGP))
 705         {
 706             /* Copy the CG p vector */
 707             const rvec* p1 = s1->cg_p.rvec_array();
 708             rvec*       p2 = s2->cg_p.rvec_array();
 709 #pragma omp for schedule(static) nowait
 710             for (int i = start; i < end; i++)
 711             {
 712                 // Trivial OpenMP block that does not throw
 713                 copy_rvec(p1[i], p2[i]);
 714             }
 715         }
 716
 717         if (DOMAINDECOMP(cr))
 718         {
 719             /* OpenMP does not supported unsigned loop variables */
 720 #pragma omp for schedule(static) nowait
 721             for (gmx::index i = 0; i < gmx::ssize(s2->cg_gl); i++)
 722             {
 723                 s2->cg_gl[i] = s1->cg_gl[i];
 724             }
 725         }
 726     }
 727
 728     if (DOMAINDECOMP(cr))
 729     {
 730         s2->ddp_count       = s1->ddp_count;
 731         s2->ddp_count_cg_gl = s1->ddp_count_cg_gl;
 732     }
 733
 734     if (constr)
 735     {
 736         dvdl_constr = 0;
 737         validStep   = constr->apply(TRUE,
 738                                   TRUE,
 739                                   count,
 740                                   0,
 741                                   1.0,
 742                                   s1->x.arrayRefWithPadding(),
 743                                   s2->x.arrayRefWithPadding(),
 744                                   ArrayRef<RVec>(),
 745                                   s2->box,
 746                                   s2->lambda[FreeEnergyPerturbationCouplingType::Bonded],
 747                                   &dvdl_constr,
 748                                   gmx::ArrayRefWithPadding<RVec>(),
 749                                   false,
 750                                   nullptr,
 751                                   gmx::ConstraintVariable::Positions);
 752
 753         if (cr->nnodes > 1)
 754         {
 755             /* This global reduction will affect performance at high
 756              * parallelization, but we can not really avoid it.
 757              * But usually EM is not run at high parallelization.
 758              */
 759             int reductionBuffer = static_cast<int>(!validStep);
 760             gmx_sumi(1, &reductionBuffer, cr);
 761             validStep = (reductionBuffer == 0);
 762         }
 763
 764         // We should move this check to the different minimizers
 765         if (!validStep && ir->eI != IntegrationAlgorithm::Steep)
 766         {
 767             gmx_fatal(FARGS,
 768                       "The coordinates could not be constrained. Minimizer '%s' can not handle "
 769                       "constraint failures, use minimizer '%s' before using '%s'.",
 770                       enumValueToString(ir->eI),
 771                       enumValueToString(IntegrationAlgorithm::Steep),
 772                       enumValueToString(ir->eI));
 773         }
 774     }
 775
 776     return validStep;
 777 }
 778
 779 //! Prepare EM for using domain decomposition parallellization
 780 static void em_dd_partition_system(FILE*                fplog,
 781                                    const gmx::MDLogger& mdlog,
 782                                    int                  step,
 783                                    const t_commrec*     cr,
 784                                    const gmx_mtop_t*    top_global,
 785                                    const t_inputrec*    ir,
 786                                    gmx::ImdSession*     imdSession,
 787                                    pull_t*              pull_work,
 788                                    em_state_t*          ems,
 789                                    gmx_localtop_t*      top,
 790                                    gmx::MDAtoms*        mdAtoms,
 791                                    t_forcerec*          fr,
 792                                    VirtualSitesHandler* vsite,
 793                                    gmx::Constraints*    constr,
 794                                    t_nrnb*              nrnb,
 795                                    gmx_wallcycle_t      wcycle)
 796 {
 797     /* Repartition the domain decomposition */
 798     dd_partition_system(fplog,
 799                         mdlog,
 800                         step,
 801                         cr,
 802                         FALSE,
 803                         1,
 804                         nullptr,
 805                         *top_global,
 806                         ir,
 807                         imdSession,
 808                         pull_work,
 809                         &ems->s,
 810                         &ems->f,
 811                         mdAtoms,
 812                         top,
 813                         fr,
 814                         vsite,
 815                         constr,
 816                         nrnb,
 817                         wcycle,
 818                         FALSE);
 819     dd_store_state(cr->dd, &ems->s);
 820 }
 821
 822 namespace
 823 {
 824
 825 /*! \brief Class to handle the work of setting and doing an energy evaluation.
 826  *
 827  * This class is a mere aggregate of parameters to pass to evaluate an
 828  * energy, so that future changes to names and types of them consume
 829  * less time when refactoring other code.
 830  *
 831  * Aggregate initialization is used, for which the chief risk is that
 832  * if a member is added at the end and not all initializer lists are
 833  * updated, then the member will be value initialized, which will
 834  * typically mean initialization to zero.
 835  *
 836  * Use a braced initializer list to construct one of these. */
 837 class EnergyEvaluator
 838 {
 839 public:
 840     /*! \brief Evaluates an energy on the state in \c ems.
 841      *
 842      * \todo In practice, the same objects mu_tot, vir, and pres
 843      * are always passed to this function, so we would rather have
 844      * them as data members. However, their C-array types are
 845      * unsuited for aggregate initialization. When the types
 846      * improve, the call signature of this method can be reduced.
 847      */
 848     void run(em_state_t* ems, rvec mu_tot, tensor vir, tensor pres, int64_t count, gmx_bool bFirst);
 849     //! Handles logging (deprecated).
 850     FILE* fplog;
 851     //! Handles logging.
 852     const gmx::MDLogger& mdlog;
 853     //! Handles communication.
 854     const t_commrec* cr;
 855     //! Coordinates multi-simulations.
 856     const gmx_multisim_t* ms;
 857     //! Holds the simulation topology.
 858     const gmx_mtop_t* top_global;
 859     //! Holds the domain topology.
 860     gmx_localtop_t* top;
 861     //! User input options.
 862     const t_inputrec* inputrec;
 863     //! The Interactive Molecular Dynamics session.
 864     gmx::ImdSession* imdSession;
 865     //! The pull work object.
 866     pull_t* pull_work;
 867     //! Manages flop accounting.
 868     t_nrnb* nrnb;
 869     //! Manages wall cycle accounting.
 870     gmx_wallcycle_t wcycle;
 871     //! Coordinates global reduction.
 872     gmx_global_stat_t gstat;
 873     //! Handles virtual sites.
 874     VirtualSitesHandler* vsite;
 875     //! Handles constraints.
 876     gmx::Constraints* constr;
 877     //! Per-atom data for this domain.
 878     gmx::MDAtoms* mdAtoms;
 879     //! Handles how to calculate the forces.
 880     t_forcerec* fr;
 881     //! Schedule of force-calculation work each step for this task.
 882     MdrunScheduleWorkload* runScheduleWork;
 883     //! Stores the computed energies.
 884     gmx_enerdata_t* enerd;
 885 };
 886
 887 void EnergyEvaluator::run(em_state_t* ems, rvec mu_tot, tensor vir, tensor pres, int64_t count, gmx_bool bFirst)
 888 {
 889     real     t;
 890     gmx_bool bNS;
 891     tensor   force_vir, shake_vir, ekin;
 892     real     dvdl_constr;
 893     real     terminate = 0;
 894
 895     /* Set the time to the initial time, the time does not change during EM */
 896     t = inputrec->init_t;
 897
 898     if (bFirst || (DOMAINDECOMP(cr) && ems->s.ddp_count < cr->dd->ddp_count))
 899     {
 900         /* This is the first state or an old state used before the last ns */
 901         bNS = TRUE;
 902     }
 903     else
 904     {
 905         bNS = FALSE;
 906         if (inputrec->nstlist > 0)
 907         {
 908             bNS = TRUE;
 909         }
 910     }
 911
 912     if (vsite)
 913     {
 914         vsite->construct(ems->s.x, {}, ems->s.box, gmx::VSiteOperation::Positions);
 915     }
 916
 917     if (DOMAINDECOMP(cr) && bNS)
 918     {
 919         /* Repartition the domain decomposition */
 920         em_dd_partition_system(
 921                 fplog, mdlog, count, cr, top_global, inputrec, imdSession, pull_work, ems, top, mdAtoms, fr, vsite, constr, nrnb, wcycle);
 922     }
 923
 924     /* Calc force & energy on new trial position  */
 925     /* do_force always puts the charge groups in the box and shifts again
 926      * We do not unshift, so molecules are always whole in congrad.c
 927      */
 928     do_force(fplog,
 929              cr,
 930              ms,
 931              *inputrec,
 932              nullptr,
 933              nullptr,
 934              imdSession,
 935              pull_work,
 936              count,
 937              nrnb,
 938              wcycle,
 939              top,
 940              ems->s.box,
 941              ems->s.x.arrayRefWithPadding(),
 942              &ems->s.hist,
 943              &ems->f.view(),
 944              force_vir,
 945              mdAtoms->mdatoms(),
 946              enerd,
 947              ems->s.lambda,
 948              fr,
 949              runScheduleWork,
 950              vsite,
 951              mu_tot,
 952              t,
 953              nullptr,
 954              GMX_FORCE_STATECHANGED | GMX_FORCE_ALLFORCES | GMX_FORCE_VIRIAL | GMX_FORCE_ENERGY
 955                      | (bNS ? GMX_FORCE_NS : 0),
 956              DDBalanceRegionHandler(cr));
 957
 958     /* Clear the unused shake virial and pressure */
 959     clear_mat(shake_vir);
 960     clear_mat(pres);
 961
 962     /* Communicate stuff when parallel */
 963     if (PAR(cr) && inputrec->eI != IntegrationAlgorithm::NM)
 964     {
 965         wallcycle_start(wcycle, ewcMoveE);
 966
 967         global_stat(gstat,
 968                     cr,
 969                     enerd,
 970                     force_vir,
 971                     shake_vir,
 972                     inputrec,
 973                     nullptr,
 974                     gmx::ArrayRef<real>{},
 975                     nullptr,
 976                     1,
 977                     &terminate,
 978                     nullptr,
 979                     FALSE,
 980                     CGLO_ENERGY | CGLO_PRESSURE | CGLO_CONSTRAINT);
 981
 982         wallcycle_stop(wcycle, ewcMoveE);
 983     }
 984
 985     if (fr->dispersionCorrection)
 986     {
 987         /* Calculate long range corrections to pressure and energy */
 988         const DispersionCorrection::Correction correction = fr->dispersionCorrection->calculate(
 989                 ems->s.box, ems->s.lambda[FreeEnergyPerturbationCouplingType::Vdw]);
 990
 991         enerd->term[F_DISPCORR] = correction.energy;
 992         enerd->term[F_EPOT] += correction.energy;
 993         enerd->term[F_PRES] += correction.pressure;
 994         enerd->term[F_DVDL] += correction.dvdl;
 995     }
 996     else
 997     {
 998         enerd->term[F_DISPCORR] = 0;
 999     }
1000
1001     ems->epot = enerd->term[F_EPOT];
1002
1003     if (constr)
1004     {
1005         /* Project out the constraint components of the force */
1006         bool needsLogging  = false;
1007         bool computeEnergy = false;
1008         bool computeVirial = true;
1009         dvdl_constr        = 0;
1010         auto f             = ems->f.view().forceWithPadding();
1011         constr->apply(needsLogging,
1012                       computeEnergy,
1013                       count,
1014                       0,
1015                       1.0,
1016                       ems->s.x.arrayRefWithPadding(),
1017                       f,
1018                       f.unpaddedArrayRef(),
1019                       ems->s.box,
1020                       ems->s.lambda[FreeEnergyPerturbationCouplingType::Bonded],
1021                       &dvdl_constr,
1022                       gmx::ArrayRefWithPadding<RVec>(),
1023                       computeVirial,
1024                       shake_vir,
1025                       gmx::ConstraintVariable::ForceDispl);
1026         enerd->term[F_DVDL_CONSTR] += dvdl_constr;
1027         m_add(force_vir, shake_vir, vir);
1028     }
1029     else
1030     {
1031         copy_mat(force_vir, vir);
1032     }
1033
1034     clear_mat(ekin);
1035     enerd->term[F_PRES] = calc_pres(fr->pbcType, inputrec->nwall, ems->s.box, ekin, vir, pres);
1036
1037     if (inputrec->efep != FreeEnergyPerturbationType::No)
1038     {
1039         accumulateKineticLambdaComponents(enerd, ems->s.lambda, *inputrec->fepvals);
1040     }
1041
1042     if (EI_ENERGY_MINIMIZATION(inputrec->eI))
1043     {
1044         get_state_f_norm_max(cr, &(inputrec->opts), mdAtoms->mdatoms(), ems);
1045     }
1046 }
1047
1048 } // namespace
1049
1050 //! Parallel utility summing energies and forces
1051 static double reorder_partsum(const t_commrec*  cr,
1052                               const t_grpopts*  opts,
1053                               const gmx_mtop_t* top_global,
1054                               const em_state_t* s_min,
1055                               const em_state_t* s_b)
1056 {
1057     if (debug)
1058     {
1059         fprintf(debug, "Doing reorder_partsum\n");
1060     }
1061
1062     auto fm = s_min->f.view().force();
1063     auto fb = s_b->f.view().force();
1064
1065     /* Collect fm in a global vector fmg.
1066      * This conflicts with the spirit of domain decomposition,
1067      * but to fully optimize this a much more complicated algorithm is required.
1068      */
1069     const int natoms = top_global->natoms;
1070     rvec*     fmg;
1071     snew(fmg, natoms);
1072
1073     gmx::ArrayRef<const int> indicesMin = s_min->s.cg_gl;
1074     int                      i          = 0;
1075     for (int a : indicesMin)
1076     {
1077         copy_rvec(fm[i], fmg[a]);
1078         i++;
1079     }
1080     gmx_sum(top_global->natoms * 3, fmg[0], cr);
1081
1082     /* Now we will determine the part of the sum for the cgs in state s_b */
1083     gmx::ArrayRef<const int> indicesB = s_b->s.cg_gl;
1084
1085     double partsum                        = 0;
1086     i                                     = 0;
1087     int                                gf = 0;
1088     gmx::ArrayRef<const unsigned char> grpnrFREEZE =
1089             top_global->groups.groupNumbers[SimulationAtomGroupType::Freeze];
1090     for (int a : indicesB)
1091     {
1092         if (!grpnrFREEZE.empty())
1093         {
1094             gf = grpnrFREEZE[i];
1095         }
1096         for (int m = 0; m < DIM; m++)
1097         {
1098             if (!opts->nFreeze[gf][m])
1099             {
1100                 partsum += (fb[i][m] - fmg[a][m]) * fb[i][m];
1101             }
1102         }
1103         i++;
1104     }
1105
1106     sfree(fmg);
1107
1108     return partsum;
1109 }
1110
1111 //! Print some stuff, like beta, whatever that means.
1112 static real pr_beta(const t_commrec*  cr,
1113                     const t_grpopts*  opts,
1114                     t_mdatoms*        mdatoms,
1115                     const gmx_mtop_t* top_global,
1116                     const em_state_t* s_min,
1117                     const em_state_t* s_b)
1118 {
1119     double sum;
1120
1121     /* This is just the classical Polak-Ribiere calculation of beta;
1122      * it looks a bit complicated since we take freeze groups into account,
1123      * and might have to sum it in parallel runs.
1124      */
1125
1126     if (!DOMAINDECOMP(cr)
1127         || (s_min->s.ddp_count == cr->dd->ddp_count && s_b->s.ddp_count == cr->dd->ddp_count))
1128     {
1129         auto fm = s_min->f.view().force();
1130         auto fb = s_b->f.view().force();
1131         sum     = 0;
1132         int gf  = 0;
1133         /* This part of code can be incorrect with DD,
1134          * since the atom ordering in s_b and s_min might differ.
1135          */
1136         for (int i = 0; i < mdatoms->homenr; i++)
1137         {
1138             if (mdatoms->cFREEZE)
1139             {
1140                 gf = mdatoms->cFREEZE[i];
1141             }
1142             for (int m = 0; m < DIM; m++)
1143             {
1144                 if (!opts->nFreeze[gf][m])
1145                 {
1146                     sum += (fb[i][m] - fm[i][m]) * fb[i][m];
1147                 }
1148             }
1149         }
1150     }
1151     else
1152     {
1153         /* We need to reorder cgs while summing */
1154         sum = reorder_partsum(cr, opts, top_global, s_min, s_b);
1155     }
1156     if (PAR(cr))
1157     {
1158         gmx_sumd(1, &sum, cr);
1159     }
1160
1161     return sum / gmx::square(s_min->fnorm);
1162 }
1163
1164 namespace gmx
1165 {
1166
1167 void LegacySimulator::do_cg()
1168 {
1169     const char* CG = "Polak-Ribiere Conjugate Gradients";
1170
1171     gmx_localtop_t    top(top_global->ffparams);
1172     gmx_global_stat_t gstat;
1173     double            tmp, minstep;
1174     real              stepsize;
1175     real              a, b, c, beta = 0.0;
1176     real              epot_repl = 0;
1177     real              pnorm;
1178     gmx_bool          converged, foundlower;
1179     rvec              mu_tot = { 0 };
1180     gmx_bool          do_log = FALSE, do_ene = FALSE, do_x, do_f;
1181     tensor            vir, pres;
1182     int               number_steps, neval = 0, nstcg = inputrec->nstcgsteep;
1183     int               m, step, nminstep;
1184     auto              mdatoms = mdAtoms->mdatoms();
1185
1186     GMX_LOG(mdlog.info)
1187             .asParagraph()
1188             .appendText(
1189                     "Note that activating conjugate gradient energy minimization via the "
1190                     "integrator .mdp option and the command gmx mdrun may "
1191                     "be available in a different form in a future version of GROMACS, "
1192                     "e.g. gmx minimize and an .mdp option.");
1193
1194     step = 0;
1195
1196     if (MASTER(cr))
1197     {
1198         // In CG, the state is extended with a search direction
1199         state_global->flags |= (1 << estCGP);
1200
1201         // Ensure the extra per-atom state array gets allocated
1202         state_change_natoms(state_global, state_global->natoms);
1203
1204         // Initialize the search direction to zero
1205         for (RVec& cg_p : state_global->cg_p)
1206         {
1207             cg_p = { 0, 0, 0 };
1208         }
1209     }
1210
1211     /* Create 4 states on the stack and extract pointers that we will swap */
1212     em_state_t  s0{}, s1{}, s2{}, s3{};
1213     em_state_t* s_min = &s0;
1214     em_state_t* s_a   = &s1;
1215     em_state_t* s_b   = &s2;
1216     em_state_t* s_c   = &s3;
1217
1218     /* Init em and store the local state in s_min */
1219     init_em(fplog,
1220             mdlog,
1221             CG,
1222             cr,
1223             inputrec,
1224             imdSession,
1225             pull_work,
1226             state_global,
1227             top_global,
1228             s_min,
1229             &top,
1230             nrnb,
1231             fr,
1232             mdAtoms,
1233             &gstat,
1234             vsite,
1235             constr,
1236             nullptr);
1237     const bool        simulationsShareState = false;
1238     gmx_mdoutf*       outf                  = init_mdoutf(fplog,
1239                                    nfile,
1240                                    fnm,
1241                                    mdrunOptions,
1242                                    cr,
1243                                    outputProvider,
1244                                    mdModulesNotifier,
1245                                    inputrec,
1246                                    top_global,
1247                                    nullptr,
1248                                    wcycle,
1249                                    StartingBehavior::NewSimulation,
1250                                    simulationsShareState,
1251                                    ms);
1252     gmx::EnergyOutput energyOutput(mdoutf_get_fp_ene(outf),
1253                                    top_global,
1254                                    inputrec,
1255                                    pull_work,
1256                                    nullptr,
1257                                    false,
1258                                    StartingBehavior::NewSimulation,
1259                                    simulationsShareState,
1260                                    mdModulesNotifier);
1261
1262     /* Print to log file */
1263     print_em_start(fplog, cr, walltime_accounting, wcycle, CG);
1264
1265     /* Max number of steps */
1266     number_steps = inputrec->nsteps;
1267
1268     if (MASTER(cr))
1269     {
1270         sp_header(stderr, CG, inputrec->em_tol, number_steps);
1271     }
1272     if (fplog)
1273     {
1274         sp_header(fplog, CG, inputrec->em_tol, number_steps);
1275     }
1276
1277     EnergyEvaluator energyEvaluator{ fplog,    mdlog,      cr,        ms,   top_global,      &top,
1278                                      inputrec, imdSession, pull_work, nrnb, wcycle,          gstat,
1279                                      vsite,    constr,     mdAtoms,   fr,   runScheduleWork, enerd };
1280     /* Call the force routine and some auxiliary (neighboursearching etc.) */
1281     /* do_force always puts the charge groups in the box and shifts again
1282      * We do not unshift, so molecules are always whole in congrad.c
1283      */
1284     energyEvaluator.run(s_min, mu_tot, vir, pres, -1, TRUE);
1285
1286     if (MASTER(cr))
1287     {
1288         /* Copy stuff to the energy bin for easy printing etc. */
1289         matrix nullBox = {};
1290         energyOutput.addDataAtEnergyStep(false,
1291                                          false,
1292                                          static_cast<double>(step),
1293                                          mdatoms->tmass,
1294                                          enerd,
1295                                          nullptr,
1296                                          nullptr,
1297                                          nullBox,
1298                                          PTCouplingArrays(),
1299                                          0,
1300                                          nullptr,
1301                                          nullptr,
1302                                          vir,
1303                                          pres,
1304                                          nullptr,
1305                                          mu_tot,
1306                                          constr);
1307
1308         EnergyOutput::printHeader(fplog, step, step);
1309         energyOutput.printStepToEnergyFile(
1310                 mdoutf_get_fp_ene(outf), TRUE, FALSE, FALSE, fplog, step, step, fr->fcdata.get(), nullptr);
1311     }
1312
1313     /* Estimate/guess the initial stepsize */
1314     stepsize = inputrec->em_stepsize / s_min->fnorm;
1315
1316     if (MASTER(cr))
1317     {
1318         double sqrtNumAtoms = sqrt(static_cast<double>(state_global->natoms));
1319         fprintf(stderr, "   F-max             = %12.5e on atom %d\n", s_min->fmax, s_min->a_fmax + 1);
1320         fprintf(stderr, "   F-Norm            = %12.5e\n", s_min->fnorm / sqrtNumAtoms);
1321         fprintf(stderr, "\n");
1322         /* and copy to the log file too... */
1323         fprintf(fplog, "   F-max             = %12.5e on atom %d\n", s_min->fmax, s_min->a_fmax + 1);
1324         fprintf(fplog, "   F-Norm            = %12.5e\n", s_min->fnorm / sqrtNumAtoms);
1325         fprintf(fplog, "\n");
1326     }
1327     /* Start the loop over CG steps.
1328      * Each successful step is counted, and we continue until
1329      * we either converge or reach the max number of steps.
1330      */
1331     converged = FALSE;
1332     for (step = 0; (number_steps < 0 || step <= number_steps) && !converged; step++)
1333     {
1334
1335         /* start taking steps in a new direction
1336          * First time we enter the routine, beta=0, and the direction is
1337          * simply the negative gradient.
1338          */
1339
1340         /* Calculate the new direction in p, and the gradient in this direction, gpa */
1341         gmx::ArrayRef<gmx::RVec>       pm  = s_min->s.cg_p;
1342         gmx::ArrayRef<const gmx::RVec> sfm = s_min->f.view().force();
1343         double                         gpa = 0;
1344         int                            gf  = 0;
1345         for (int i = 0; i < mdatoms->homenr; i++)
1346         {
1347             if (mdatoms->cFREEZE)
1348             {
1349                 gf = mdatoms->cFREEZE[i];
1350             }
1351             for (m = 0; m < DIM; m++)
1352             {
1353                 if (!inputrec->opts.nFreeze[gf][m])
1354                 {
1355                     pm[i][m] = sfm[i][m] + beta * pm[i][m];
1356                     gpa -= pm[i][m] * sfm[i][m];
1357                     /* f is negative gradient, thus the sign */
1358                 }
1359                 else
1360                 {
1361                     pm[i][m] = 0;
1362                 }
1363             }
1364         }
1365
1366         /* Sum the gradient along the line across CPUs */
1367         if (PAR(cr))
1368         {
1369             gmx_sumd(1, &gpa, cr);
1370         }
1371
1372         /* Calculate the norm of the search vector */
1373         get_f_norm_max(cr, &(inputrec->opts), mdatoms, pm, &pnorm, nullptr, nullptr);
1374
1375         /* Just in case stepsize reaches zero due to numerical precision... */
1376         if (stepsize <= 0)
1377         {
1378             stepsize = inputrec->em_stepsize / pnorm;
1379         }
1380
1381         /*
1382          * Double check the value of the derivative in the search direction.
1383          * If it is positive it must be due to the old information in the
1384          * CG formula, so just remove that and start over with beta=0.
1385          * This corresponds to a steepest descent step.
1386          */
1387         if (gpa > 0)
1388         {
1389             beta = 0;
1390             step--;   /* Don't count this step since we are restarting */
1391             continue; /* Go back to the beginning of the big for-loop */
1392         }
1393
1394         /* Calculate minimum allowed stepsize, before the average (norm)
1395          * relative change in coordinate is smaller than precision
1396          */
1397         minstep      = 0;
1398         auto s_min_x = makeArrayRef(s_min->s.x);
1399         for (int i = 0; i < mdatoms->homenr; i++)
1400         {
1401             for (m = 0; m < DIM; m++)
1402             {
1403                 tmp = fabs(s_min_x[i][m]);
1404                 if (tmp < 1.0)
1405                 {
1406                     tmp = 1.0;
1407                 }
1408                 tmp = pm[i][m] / tmp;
1409                 minstep += tmp * tmp;
1410             }
1411         }
1412         /* Add up from all CPUs */
1413         if (PAR(cr))
1414         {
1415             gmx_sumd(1, &minstep, cr);
1416         }
1417
1418         minstep = GMX_REAL_EPS / sqrt(minstep / (3 * top_global->natoms));
1419
1420         if (stepsize < minstep)
1421         {
1422             converged = TRUE;
1423             break;
1424         }
1425
1426         /* Write coordinates if necessary */
1427         do_x = do_per_step(step, inputrec->nstxout);
1428         do_f = do_per_step(step, inputrec->nstfout);
1429
1430         write_em_traj(
1431                 fplog, cr, outf, do_x, do_f, nullptr, top_global, inputrec, step, s_min, state_global, observablesHistory);
1432
1433         /* Take a step downhill.
1434          * In theory, we should minimize the function along this direction.
1435          * That is quite possible, but it turns out to take 5-10 function evaluations
1436          * for each line. However, we dont really need to find the exact minimum -
1437          * it is much better to start a new CG step in a modified direction as soon
1438          * as we are close to it. This will save a lot of energy evaluations.
1439          *
1440          * In practice, we just try to take a single step.
1441          * If it worked (i.e. lowered the energy), we increase the stepsize but
1442          * the continue straight to the next CG step without trying to find any minimum.
1443          * If it didn't work (higher energy), there must be a minimum somewhere between
1444          * the old position and the new one.
1445          *
1446          * Due to the finite numerical accuracy, it turns out that it is a good idea
1447          * to even accept a SMALL increase in energy, if the derivative is still downhill.
1448          * This leads to lower final energies in the tests I've done. / Erik
1449          */
1450         s_a->epot = s_min->epot;
1451         a         = 0.0;
1452         c         = a + stepsize; /* reference position along line is zero */
1453
1454         if (DOMAINDECOMP(cr) && s_min->s.ddp_count < cr->dd->ddp_count)
1455         {
1456             em_dd_partition_system(fplog,
1457                                    mdlog,
1458                                    step,
1459                                    cr,
1460                                    top_global,
1461                                    inputrec,
1462                                    imdSession,
1463                                    pull_work,
1464                                    s_min,
1465                                    &top,
1466                                    mdAtoms,
1467                                    fr,
1468                                    vsite,
1469                                    constr,
1470                                    nrnb,
1471                                    wcycle);
1472         }
1473
1474         /* Take a trial step (new coords in s_c) */
1475         do_em_step(cr, inputrec, mdatoms, s_min, c, s_min->s.cg_p.constArrayRefWithPadding(), s_c, constr, -1);
1476
1477         neval++;
1478         /* Calculate energy for the trial step */
1479         energyEvaluator.run(s_c, mu_tot, vir, pres, -1, FALSE);
1480
1481         /* Calc derivative along line */
1482         const rvec*                    pc  = s_c->s.cg_p.rvec_array();
1483         gmx::ArrayRef<const gmx::RVec> sfc = s_c->f.view().force();
1484         double                         gpc = 0;
1485         for (int i = 0; i < mdatoms->homenr; i++)
1486         {
1487             for (m = 0; m < DIM; m++)
1488             {
1489                 gpc -= pc[i][m] * sfc[i][m]; /* f is negative gradient, thus the sign */
1490             }
1491         }
1492         /* Sum the gradient along the line across CPUs */
1493         if (PAR(cr))
1494         {
1495             gmx_sumd(1, &gpc, cr);
1496         }
1497
1498         /* This is the max amount of increase in energy we tolerate */
1499         tmp = std::sqrt(GMX_REAL_EPS) * fabs(s_a->epot);
1500
1501         /* Accept the step if the energy is lower, or if it is not significantly higher
1502          * and the line derivative is still negative.
1503          */
1504         if (s_c->epot < s_a->epot || (gpc < 0 && s_c->epot < (s_a->epot + tmp)))
1505         {
1506             foundlower = TRUE;
1507             /* Great, we found a better energy. Increase step for next iteration
1508              * if we are still going down, decrease it otherwise
1509              */
1510             if (gpc < 0)
1511             {
1512                 stepsize *= 1.618034; /* The golden section */
1513             }
1514             else
1515             {
1516                 stepsize *= 0.618034; /* 1/golden section */
1517             }
1518         }
1519         else
1520         {
1521             /* New energy is the same or higher. We will have to do some work
1522              * to find a smaller value in the interval. Take smaller step next time!
1523              */
1524             foundlower = FALSE;
1525             stepsize *= 0.618034;
1526         }
1527
1528
1529         /* OK, if we didn't find a lower value we will have to locate one now - there must
1530          * be one in the interval [a=0,c].
1531          * The same thing is valid here, though: Don't spend dozens of iterations to find
1532          * the line minimum. We try to interpolate based on the derivative at the endpoints,
1533          * and only continue until we find a lower value. In most cases this means 1-2 iterations.
1534          *
1535          * I also have a safeguard for potentially really pathological functions so we never
1536          * take more than 20 steps before we give up ...
1537          *
1538          * If we already found a lower value we just skip this step and continue to the update.
1539          */
1540         double gpb;
1541         if (!foundlower)
1542         {
1543             nminstep = 0;
1544
1545             do
1546             {
1547                 /* Select a new trial point.
1548                  * If the derivatives at points a & c have different sign we interpolate to zero,
1549                  * otherwise just do a bisection.
1550                  */
1551                 if (gpa < 0 && gpc > 0)
1552                 {
1553                     b = a + gpa * (a - c) / (gpc - gpa);
1554                 }
1555                 else
1556                 {
1557                     b = 0.5 * (a + c);
1558                 }
1559
1560                 /* safeguard if interpolation close to machine accuracy causes errors:
1561                  * never go outside the interval
1562                  */
1563                 if (b <= a || b >= c)
1564                 {
1565                     b = 0.5 * (a + c);
1566                 }
1567
1568                 if (DOMAINDECOMP(cr) && s_min->s.ddp_count != cr->dd->ddp_count)
1569                 {
1570                     /* Reload the old state */
1571                     em_dd_partition_system(fplog,
1572                                            mdlog,
1573                                            -1,
1574                                            cr,
1575                                            top_global,
1576                                            inputrec,
1577                                            imdSession,
1578                                            pull_work,
1579                                            s_min,
1580                                            &top,
1581                                            mdAtoms,
1582                                            fr,
1583                                            vsite,
1584                                            constr,
1585                                            nrnb,
1586                                            wcycle);
1587                 }
1588
1589                 /* Take a trial step to this new point - new coords in s_b */
1590                 do_em_step(cr, inputrec, mdatoms, s_min, b, s_min->s.cg_p.constArrayRefWithPadding(), s_b, constr, -1);
1591
1592                 neval++;
1593                 /* Calculate energy for the trial step */
1594                 energyEvaluator.run(s_b, mu_tot, vir, pres, -1, FALSE);
1595
1596                 /* p does not change within a step, but since the domain decomposition
1597                  * might change, we have to use cg_p of s_b here.
1598                  */
1599                 const rvec*                    pb  = s_b->s.cg_p.rvec_array();
1600                 gmx::ArrayRef<const gmx::RVec> sfb = s_b->f.view().force();
1601                 gpb                                = 0;
1602                 for (int i = 0; i < mdatoms->homenr; i++)
1603                 {
1604                     for (m = 0; m < DIM; m++)
1605                     {
1606                         gpb -= pb[i][m] * sfb[i][m]; /* f is negative gradient, thus the sign */
1607                     }
1608                 }
1609                 /* Sum the gradient along the line across CPUs */
1610                 if (PAR(cr))
1611                 {
1612                     gmx_sumd(1, &gpb, cr);
1613                 }
1614
1615                 if (debug)
1616                 {
1617                     fprintf(debug, "CGE: EpotA %f EpotB %f EpotC %f gpb %f\n", s_a->epot, s_b->epot, s_c->epot, gpb);
1618                 }
1619
1620                 epot_repl = s_b->epot;
1621
1622                 /* Keep one of the intervals based on the value of the derivative at the new point */
1623                 if (gpb > 0)
1624                 {
1625                     /* Replace c endpoint with b */
1626                     swap_em_state(&s_b, &s_c);
1627                     c   = b;
1628                     gpc = gpb;
1629                 }
1630                 else
1631                 {
1632                     /* Replace a endpoint with b */
1633                     swap_em_state(&s_b, &s_a);
1634                     a   = b;
1635                     gpa = gpb;
1636                 }
1637
1638                 /*
1639                  * Stop search as soon as we find a value smaller than the endpoints.
1640                  * Never run more than 20 steps, no matter what.
1641                  */
1642                 nminstep++;
1643             } while ((epot_repl > s_a->epot || epot_repl > s_c->epot) && (nminstep < 20));
1644
1645             if (std::fabs(epot_repl - s_min->epot) < fabs(s_min->epot) * GMX_REAL_EPS || nminstep >= 20)
1646             {
1647                 /* OK. We couldn't find a significantly lower energy.
1648                  * If beta==0 this was steepest descent, and then we give up.
1649                  * If not, set beta=0 and restart with steepest descent before quitting.
1650                  */
1651                 if (beta == 0.0)
1652                 {
1653                     /* Converged */
1654                     converged = TRUE;
1655                     break;
1656                 }
1657                 else
1658                 {
1659                     /* Reset memory before giving up */
1660                     beta = 0.0;
1661                     continue;
1662                 }
1663             }
1664
1665             /* Select min energy state of A & C, put the best in B.
1666              */
1667             if (s_c->epot < s_a->epot)
1668             {
1669                 if (debug)
1670                 {
1671                     fprintf(debug, "CGE: C (%f) is lower than A (%f), moving C to B\n", s_c->epot, s_a->epot);
1672                 }
1673                 swap_em_state(&s_b, &s_c);
1674                 gpb = gpc;
1675             }
1676             else
1677             {
1678                 if (debug)
1679                 {
1680                     fprintf(debug, "CGE: A (%f) is lower than C (%f), moving A to B\n", s_a->epot, s_c->epot);
1681                 }
1682                 swap_em_state(&s_b, &s_a);
1683                 gpb = gpa;
1684             }
1685         }
1686         else
1687         {
1688             if (debug)
1689             {
1690                 fprintf(debug, "CGE: Found a lower energy %f, moving C to B\n", s_c->epot);
1691             }
1692             swap_em_state(&s_b, &s_c);
1693             gpb = gpc;
1694         }
1695
1696         /* new search direction */
1697         /* beta = 0 means forget all memory and restart with steepest descents. */
1698         if (nstcg && ((step % nstcg) == 0))
1699         {
1700             beta = 0.0;
1701         }
1702         else
1703         {
1704             /* s_min->fnorm cannot be zero, because then we would have converged
1705              * and broken out.
1706              */
1707
1708             /* Polak-Ribiere update.
1709              * Change to fnorm2/fnorm2_old for Fletcher-Reeves
1710              */
1711             beta = pr_beta(cr, &inputrec->opts, mdatoms, top_global, s_min, s_b);
1712         }
1713         /* Limit beta to prevent oscillations */
1714         if (fabs(beta) > 5.0)
1715         {
1716             beta = 0.0;
1717         }
1718
1719
1720         /* update positions */
1721         swap_em_state(&s_min, &s_b);
1722         gpa = gpb;
1723
1724         /* Print it if necessary */
1725         if (MASTER(cr))
1726         {
1727             if (mdrunOptions.verbose)
1728             {
1729                 double sqrtNumAtoms = sqrt(static_cast<double>(state_global->natoms));
1730                 fprintf(stderr,
1731                         "\rStep %d, Epot=%12.6e, Fnorm=%9.3e, Fmax=%9.3e (atom %d)\n",
1732                         step,
1733                         s_min->epot,
1734                         s_min->fnorm / sqrtNumAtoms,
1735                         s_min->fmax,
1736                         s_min->a_fmax + 1);
1737                 fflush(stderr);
1738             }
1739             /* Store the new (lower) energies */
1740             matrix nullBox = {};
1741             energyOutput.addDataAtEnergyStep(false,
1742                                              false,
1743                                              static_cast<double>(step),
1744                                              mdatoms->tmass,
1745                                              enerd,
1746                                              nullptr,
1747                                              nullptr,
1748                                              nullBox,
1749                                              PTCouplingArrays(),
1750                                              0,
1751                                              nullptr,
1752                                              nullptr,
1753                                              vir,
1754                                              pres,
1755                                              nullptr,
1756                                              mu_tot,
1757                                              constr);
1758
1759             do_log = do_per_step(step, inputrec->nstlog);
1760             do_ene = do_per_step(step, inputrec->nstenergy);
1761
1762             imdSession->fillEnergyRecord(step, TRUE);
1763
1764             if (do_log)
1765             {
1766                 EnergyOutput::printHeader(fplog, step, step);
1767             }
1768             energyOutput.printStepToEnergyFile(mdoutf_get_fp_ene(outf),
1769                                                do_ene,
1770                                                FALSE,
1771                                                FALSE,
1772                                                do_log ? fplog : nullptr,
1773                                                step,
1774                                                step,
1775                                                fr->fcdata.get(),
1776                                                nullptr);
1777         }
1778
1779         /* Send energies and positions to the IMD client if bIMD is TRUE. */
1780         if (MASTER(cr) && imdSession->run(step, TRUE, state_global->box, state_global->x.rvec_array(), 0))
1781         {
1782             imdSession->sendPositionsAndEnergies();
1783         }
1784
1785         /* Stop when the maximum force lies below tolerance.
1786          * If we have reached machine precision, converged is already set to true.
1787          */
1788         converged = converged || (s_min->fmax < inputrec->em_tol);
1789
1790     } /* End of the loop */
1791
1792     if (converged)
1793     {
1794         step--; /* we never took that last step in this case */
1795     }
1796     if (s_min->fmax > inputrec->em_tol)
1797     {
1798         if (MASTER(cr))
1799         {
1800             warn_step(fplog, inputrec->em_tol, s_min->fmax, step - 1 == number_steps, FALSE);
1801         }
1802         converged = FALSE;
1803     }
1804
1805     if (MASTER(cr))
1806     {
1807         /* If we printed energy and/or logfile last step (which was the last step)
1808          * we don't have to do it again, but otherwise print the final values.
1809          */
1810         if (!do_log)
1811         {
1812             /* Write final value to log since we didn't do anything the last step */
1813             EnergyOutput::printHeader(fplog, step, step);
1814         }
1815         if (!do_ene || !do_log)
1816         {
1817             /* Write final energy file entries */
1818             energyOutput.printStepToEnergyFile(mdoutf_get_fp_ene(outf),
1819                                                !do_ene,
1820                                                FALSE,
1821                                                FALSE,
1822                                                !do_log ? fplog : nullptr,
1823                                                step,
1824                                                step,
1825                                                fr->fcdata.get(),
1826                                                nullptr);
1827         }
1828     }
1829
1830     /* Print some stuff... */
1831     if (MASTER(cr))
1832     {
1833         fprintf(stderr, "\nwriting lowest energy coordinates.\n");
1834     }
1835
1836     /* IMPORTANT!
1837      * For accurate normal mode calculation it is imperative that we
1838      * store the last conformation into the full precision binary trajectory.
1839      *
1840      * However, we should only do it if we did NOT already write this step
1841      * above (which we did if do_x or do_f was true).
1842      */
1843     /* Note that with 0 < nstfout != nstxout we can end up with two frames
1844      * in the trajectory with the same step number.
1845      */
1846     do_x = !do_per_step(step, inputrec->nstxout);
1847     do_f = (inputrec->nstfout > 0 && !do_per_step(step, inputrec->nstfout));
1848
1849     write_em_traj(
1850             fplog, cr, outf, do_x, do_f, ftp2fn(efSTO, nfile, fnm), top_global, inputrec, step, s_min, state_global, observablesHistory);
1851
1852
1853     if (MASTER(cr))
1854     {
1855         double sqrtNumAtoms = sqrt(static_cast<double>(state_global->natoms));
1856         print_converged(stderr, CG, inputrec->em_tol, step, converged, number_steps, s_min, sqrtNumAtoms);
1857         print_converged(fplog, CG, inputrec->em_tol, step, converged, number_steps, s_min, sqrtNumAtoms);
1858
1859         fprintf(fplog, "\nPerformed %d energy evaluations in total.\n", neval);
1860     }
1861
1862     finish_em(cr, outf, walltime_accounting, wcycle);
1863
1864     /* To print the actual number of steps we needed somewhere */
1865     walltime_accounting_set_nsteps_done(walltime_accounting, step);
1866 }
1867
1868
1869 void LegacySimulator::do_lbfgs()
1870 {
1871     static const char* LBFGS = "Low-Memory BFGS Minimizer";
1872     em_state_t         ems;
1873     gmx_localtop_t     top(top_global->ffparams);
1874     gmx_global_stat_t  gstat;
1875     int                ncorr, nmaxcorr, point, cp, neval, nminstep;
1876     double             stepsize, step_taken, gpa, gpb, gpc, tmp, minstep;
1877     real *             rho, *alpha, *p, *s, **dx, **dg;
1878     real               a, b, c, maxdelta, delta;
1879     real               diag, Epot0;
1880     real               dgdx, dgdg, sq, yr, beta;
1881     gmx_bool           converged;
1882     rvec               mu_tot = { 0 };
1883     gmx_bool           do_log, do_ene, do_x, do_f, foundlower, *frozen;
1884     tensor             vir, pres;
1885     int                start, end, number_steps;
1886     int                i, k, m, n, gf, step;
1887     int                mdof_flags;
1888     auto               mdatoms = mdAtoms->mdatoms();
1889
1890     GMX_LOG(mdlog.info)
1891             .asParagraph()
1892             .appendText(
1893                     "Note that activating L-BFGS energy minimization via the "
1894                     "integrator .mdp option and the command gmx mdrun may "
1895                     "be available in a different form in a future version of GROMACS, "
1896                     "e.g. gmx minimize and an .mdp option.");
1897
1898     if (PAR(cr))
1899     {
1900         gmx_fatal(FARGS, "L-BFGS minimization only supports a single rank");
1901     }
1902
1903     if (nullptr != constr)
1904     {
1905         gmx_fatal(
1906                 FARGS,
1907                 "The combination of constraints and L-BFGS minimization is not implemented. Either "
1908                 "do not use constraints, or use another minimizer (e.g. steepest descent).");
1909     }
1910
1911     n        = 3 * state_global->natoms;
1912     nmaxcorr = inputrec->nbfgscorr;
1913
1914     snew(frozen, n);
1915
1916     snew(p, n);
1917     snew(rho, nmaxcorr);
1918     snew(alpha, nmaxcorr);
1919
1920     snew(dx, nmaxcorr);
1921     for (i = 0; i < nmaxcorr; i++)
1922     {
1923         snew(dx[i], n);
1924     }
1925
1926     snew(dg, nmaxcorr);
1927     for (i = 0; i < nmaxcorr; i++)
1928     {
1929         snew(dg[i], n);
1930     }
1931
1932     step  = 0;
1933     neval = 0;
1934
1935     /* Init em */
1936     init_em(fplog,
1937             mdlog,
1938             LBFGS,
1939             cr,
1940             inputrec,
1941             imdSession,
1942             pull_work,
1943             state_global,
1944             top_global,
1945             &ems,
1946             &top,
1947             nrnb,
1948             fr,
1949             mdAtoms,
1950             &gstat,
1951             vsite,
1952             constr,
1953             nullptr);
1954     const bool        simulationsShareState = false;
1955     gmx_mdoutf*       outf                  = init_mdoutf(fplog,
1956                                    nfile,
1957                                    fnm,
1958                                    mdrunOptions,
1959                                    cr,
1960                                    outputProvider,
1961                                    mdModulesNotifier,
1962                                    inputrec,
1963                                    top_global,
1964                                    nullptr,
1965                                    wcycle,
1966                                    StartingBehavior::NewSimulation,
1967                                    simulationsShareState,
1968                                    ms);
1969     gmx::EnergyOutput energyOutput(mdoutf_get_fp_ene(outf),
1970                                    top_global,
1971                                    inputrec,
1972                                    pull_work,
1973                                    nullptr,
1974                                    false,
1975                                    StartingBehavior::NewSimulation,
1976                                    simulationsShareState,
1977                                    mdModulesNotifier);
1978
1979     start = 0;
1980     end   = mdatoms->homenr;
1981
1982     /* We need 4 working states */
1983     em_state_t  s0{}, s1{}, s2{}, s3{};
1984     em_state_t* sa   = &s0;
1985     em_state_t* sb   = &s1;
1986     em_state_t* sc   = &s2;
1987     em_state_t* last = &s3;
1988     /* Initialize by copying the state from ems (we could skip x and f here) */
1989     *sa = ems;
1990     *sb = ems;
1991     *sc = ems;
1992
1993     /* Print to log file */
1994     print_em_start(fplog, cr, walltime_accounting, wcycle, LBFGS);
1995
1996     do_log = do_ene = do_f = TRUE;
1997
1998     /* Max number of steps */
1999     number_steps = inputrec->nsteps;
2000
2001     /* Create a 3*natoms index to tell whether each degree of freedom is frozen */
2002     gf = 0;
2003     for (i = start; i < end; i++)
2004     {
2005         if (mdatoms->cFREEZE)
2006         {
2007             gf = mdatoms->cFREEZE[i];
2008         }
2009         for (m = 0; m < DIM; m++)
2010         {
2011             frozen[3 * i + m] = (inputrec->opts.nFreeze[gf][m] != 0);
2012         }
2013     }
2014     if (MASTER(cr))
2015     {
2016         sp_header(stderr, LBFGS, inputrec->em_tol, number_steps);
2017     }
2018     if (fplog)
2019     {
2020         sp_header(fplog, LBFGS, inputrec->em_tol, number_steps);
2021     }
2022
2023     if (vsite)
2024     {
2025         vsite->construct(state_global->x, {}, state_global->box, VSiteOperation::Positions);
2026     }
2027
2028     /* Call the force routine and some auxiliary (neighboursearching etc.) */
2029     /* do_force always puts the charge groups in the box and shifts again
2030      * We do not unshift, so molecules are always whole
2031      */
2032     neval++;
2033     EnergyEvaluator energyEvaluator{ fplog,    mdlog,      cr,        ms,   top_global,      &top,
2034                                      inputrec, imdSession, pull_work, nrnb, wcycle,          gstat,
2035                                      vsite,    constr,     mdAtoms,   fr,   runScheduleWork, enerd };
2036     energyEvaluator.run(&ems, mu_tot, vir, pres, -1, TRUE);
2037
2038     if (MASTER(cr))
2039     {
2040         /* Copy stuff to the energy bin for easy printing etc. */
2041         matrix nullBox = {};
2042         energyOutput.addDataAtEnergyStep(false,
2043                                          false,
2044                                          static_cast<double>(step),
2045                                          mdatoms->tmass,
2046                                          enerd,
2047                                          nullptr,
2048                                          nullptr,
2049                                          nullBox,
2050                                          PTCouplingArrays(),
2051                                          0,
2052                                          nullptr,
2053                                          nullptr,
2054                                          vir,
2055                                          pres,
2056                                          nullptr,
2057                                          mu_tot,
2058                                          constr);
2059
2060         EnergyOutput::printHeader(fplog, step, step);
2061         energyOutput.printStepToEnergyFile(
2062                 mdoutf_get_fp_ene(outf), TRUE, FALSE, FALSE, fplog, step, step, fr->fcdata.get(), nullptr);
2063     }
2064
2065     /* Set the initial step.
2066      * since it will be multiplied by the non-normalized search direction
2067      * vector (force vector the first time), we scale it by the
2068      * norm of the force.
2069      */
2070
2071     if (MASTER(cr))
2072     {
2073         double sqrtNumAtoms = sqrt(static_cast<double>(state_global->natoms));
2074         fprintf(stderr, "Using %d BFGS correction steps.\n\n", nmaxcorr);
2075         fprintf(stderr, "   F-max             = %12.5e on atom %d\n", ems.fmax, ems.a_fmax + 1);
2076         fprintf(stderr, "   F-Norm            = %12.5e\n", ems.fnorm / sqrtNumAtoms);
2077         fprintf(stderr, "\n");
2078         /* and copy to the log file too... */
2079         fprintf(fplog, "Using %d BFGS correction steps.\n\n", nmaxcorr);
2080         fprintf(fplog, "   F-max             = %12.5e on atom %d\n", ems.fmax, ems.a_fmax + 1);
2081         fprintf(fplog, "   F-Norm            = %12.5e\n", ems.fnorm / sqrtNumAtoms);
2082         fprintf(fplog, "\n");
2083     }
2084
2085     // Point is an index to the memory of search directions, where 0 is the first one.
2086     point = 0;
2087
2088     // Set initial search direction to the force (-gradient), or 0 for frozen particles.
2089     real* fInit = static_cast<real*>(ems.f.view().force().data()[0]);
2090     for (i = 0; i < n; i++)
2091     {
2092         if (!frozen[i])
2093         {
2094             dx[point][i] = fInit[i]; /* Initial search direction */
2095         }
2096         else
2097         {
2098             dx[point][i] = 0;
2099         }
2100     }
2101
2102     // Stepsize will be modified during the search, and actually it is not critical
2103     // (the main efficiency in the algorithm comes from changing directions), but
2104     // we still need an initial value, so estimate it as the inverse of the norm
2105     // so we take small steps where the potential fluctuates a lot.
2106     stepsize = 1.0 / ems.fnorm;
2107
2108     /* Start the loop over BFGS steps.
2109      * Each successful step is counted, and we continue until
2110      * we either converge or reach the max number of steps.
2111      */
2112
2113     ncorr = 0;
2114
2115     /* Set the gradient from the force */
2116     converged = FALSE;
2117     for (step = 0; (number_steps < 0 || step <= number_steps) && !converged; step++)
2118     {
2119
2120         /* Write coordinates if necessary */
2121         do_x = do_per_step(step, inputrec->nstxout);
2122         do_f = do_per_step(step, inputrec->nstfout);
2123
2124         mdof_flags = 0;
2125         if (do_x)
2126         {
2127             mdof_flags |= MDOF_X;
2128         }
2129
2130         if (do_f)
2131         {
2132             mdof_flags |= MDOF_F;
2133         }
2134
2135         if (inputrec->bIMD)
2136         {
2137             mdof_flags |= MDOF_IMD;
2138         }
2139
2140         gmx::WriteCheckpointDataHolder checkpointDataHolder;
2141         mdoutf_write_to_trajectory_files(fplog,
2142                                          cr,
2143                                          outf,
2144                                          mdof_flags,
2145                                          top_global->natoms,
2146                                          step,
2147                                          static_cast<real>(step),
2148                                          &ems.s,
2149                                          state_global,
2150                                          observablesHistory,
2151                                          ems.f.view().force(),
2152                                          &checkpointDataHolder);
2153
2154         /* Do the linesearching in the direction dx[point][0..(n-1)] */
2155
2156         /* make s a pointer to current search direction - point=0 first time we get here */
2157         s = dx[point];
2158
2159         real* xx = static_cast<real*>(ems.s.x.rvec_array()[0]);
2160         real* ff = static_cast<real*>(ems.f.view().force().data()[0]);
2161
2162         // calculate line gradient in position A
2163         for (gpa = 0, i = 0; i < n; i++)
2164         {
2165             gpa -= s[i] * ff[i];
2166         }
2167
2168         /* Calculate minimum allowed stepsize along the line, before the average (norm)
2169          * relative change in coordinate is smaller than precision
2170          */
2171         for (minstep = 0, i = 0; i < n; i++)
2172         {
2173             tmp = fabs(xx[i]);
2174             if (tmp < 1.0)
2175             {
2176                 tmp = 1.0;
2177             }
2178             tmp = s[i] / tmp;
2179             minstep += tmp * tmp;
2180         }
2181         minstep = GMX_REAL_EPS / sqrt(minstep / n);
2182
2183         if (stepsize < minstep)
2184         {
2185             converged = TRUE;
2186             break;
2187         }
2188
2189         // Before taking any steps along the line, store the old position
2190         *last       = ems;
2191         real* lastx = static_cast<real*>(last->s.x.data()[0]);
2192         real* lastf = static_cast<real*>(last->f.view().force().data()[0]);
2193         Epot0       = ems.epot;
2194
2195         *sa = ems;
2196
2197         /* Take a step downhill.
2198          * In theory, we should find the actual minimum of the function in this
2199          * direction, somewhere along the line.
2200          * That is quite possible, but it turns out to take 5-10 function evaluations
2201          * for each line. However, we dont really need to find the exact minimum -
2202          * it is much better to start a new BFGS step in a modified direction as soon
2203          * as we are close to it. This will save a lot of energy evaluations.
2204          *
2205          * In practice, we just try to take a single step.
2206          * If it worked (i.e. lowered the energy), we increase the stepsize but
2207          * continue straight to the next BFGS step without trying to find any minimum,
2208          * i.e. we change the search direction too. If the line was smooth, it is
2209          * likely we are in a smooth region, and then it makes sense to take longer
2210          * steps in the modified search direction too.
2211          *
2212          * If it didn't work (higher energy), there must be a minimum somewhere between
2213          * the old position and the new one. Then we need to start by finding a lower
2214          * value before we change search direction. Since the energy was apparently
2215          * quite rough, we need to decrease the step size.
2216          *
2217          * Due to the finite numerical accuracy, it turns out that it is a good idea
2218          * to accept a SMALL increase in energy, if the derivative is still downhill.
2219          * This leads to lower final energies in the tests I've done. / Erik
2220          */
2221
2222         // State "A" is the first position along the line.
2223         // reference position along line is initially zero
2224         a = 0.0;
2225
2226         // Check stepsize first. We do not allow displacements
2227         // larger than emstep.
2228         //
2229         do
2230         {
2231             // Pick a new position C by adding stepsize to A.
2232             c = a + stepsize;
2233
2234             // Calculate what the largest change in any individual coordinate
2235             // would be (translation along line * gradient along line)
2236             maxdelta = 0;
2237             for (i = 0; i < n; i++)
2238             {
2239                 delta = c * s[i];
2240                 if (delta > maxdelta)
2241                 {
2242                     maxdelta = delta;
2243                 }
2244             }
2245             // If any displacement is larger than the stepsize limit, reduce the step
2246             if (maxdelta > inputrec->em_stepsize)
2247             {
2248                 stepsize *= 0.1;
2249             }
2250         } while (maxdelta > inputrec->em_stepsize);
2251
2252         // Take a trial step and move the coordinate array xc[] to position C
2253         real* xc = static_cast<real*>(sc->s.x.rvec_array()[0]);
2254         for (i = 0; i < n; i++)
2255         {
2256             xc[i] = lastx[i] + c * s[i];
2257         }
2258
2259         neval++;
2260         // Calculate energy for the trial step in position C
2261         energyEvaluator.run(sc, mu_tot, vir, pres, step, FALSE);
2262
2263         // Calc line gradient in position C
2264         real* fc = static_cast<real*>(sc->f.view().force()[0]);
2265         for (gpc = 0, i = 0; i < n; i++)
2266         {
2267             gpc -= s[i] * fc[i]; /* f is negative gradient, thus the sign */
2268         }
2269         /* Sum the gradient along the line across CPUs */
2270         if (PAR(cr))
2271         {
2272             gmx_sumd(1, &gpc, cr);
2273         }
2274
2275         // This is the max amount of increase in energy we tolerate.
2276         // By allowing VERY small changes (close to numerical precision) we
2277         // frequently find even better (lower) final energies.
2278         tmp = std::sqrt(GMX_REAL_EPS) * fabs(sa->epot);
2279
2280         // Accept the step if the energy is lower in the new position C (compared to A),
2281         // or if it is not significantly higher and the line derivative is still negative.
2282         foundlower = sc->epot < sa->epot || (gpc < 0 && sc->epot < (sa->epot + tmp));
2283         // If true, great, we found a better energy. We no longer try to alter the
2284         // stepsize, but simply accept this new better position. The we select a new
2285         // search direction instead, which will be much more efficient than continuing
2286         // to take smaller steps along a line. Set fnorm based on the new C position,
2287         // which will be used to update the stepsize to 1/fnorm further down.
2288
2289         // If false, the energy is NOT lower in point C, i.e. it will be the same
2290         // or higher than in point A. In this case it is pointless to move to point C,
2291         // so we will have to do more iterations along the same line to find a smaller
2292         // value in the interval [A=0.0,C].
2293         // Here, A is still 0.0, but that will change when we do a search in the interval
2294         // [0.0,C] below. That search we will do by interpolation or bisection rather
2295         // than with the stepsize, so no need to modify it. For the next search direction
2296         // it will be reset to 1/fnorm anyway.
2297
2298         if (!foundlower)
2299         {
2300             // OK, if we didn't find a lower value we will have to locate one now - there must
2301             // be one in the interval [a,c].
2302             // The same thing is valid here, though: Don't spend dozens of iterations to find
2303             // the line minimum. We try to interpolate based on the derivative at the endpoints,
2304             // and only continue until we find a lower value. In most cases this means 1-2 iterations.
2305             // I also have a safeguard for potentially really pathological functions so we never
2306             // take more than 20 steps before we give up.
2307             // If we already found a lower value we just skip this step and continue to the update.
2308             real fnorm = 0;
2309             nminstep   = 0;
2310             do
2311             {
2312                 // Select a new trial point B in the interval [A,C].
2313                 // If the derivatives at points a & c have different sign we interpolate to zero,
2314                 // otherwise just do a bisection since there might be multiple minima/maxima
2315                 // inside the interval.
2316                 if (gpa < 0 && gpc > 0)
2317                 {
2318                     b = a + gpa * (a - c) / (gpc - gpa);
2319                 }
2320                 else
2321                 {
2322                     b = 0.5 * (a + c);
2323                 }
2324
2325                 /* safeguard if interpolation close to machine accuracy causes errors:
2326                  * never go outside the interval
2327                  */
2328                 if (b <= a || b >= c)
2329                 {
2330                     b = 0.5 * (a + c);
2331                 }
2332
2333                 // Take a trial step to point B
2334                 real* xb = static_cast<real*>(sb->s.x.rvec_array()[0]);
2335                 for (i = 0; i < n; i++)
2336                 {
2337                     xb[i] = lastx[i] + b * s[i];
2338                 }
2339
2340                 neval++;
2341                 // Calculate energy for the trial step in point B
2342                 energyEvaluator.run(sb, mu_tot, vir, pres, step, FALSE);
2343                 fnorm = sb->fnorm;
2344
2345                 // Calculate gradient in point B
2346                 real* fb = static_cast<real*>(sb->f.view().force()[0]);
2347                 for (gpb = 0, i = 0; i < n; i++)
2348                 {
2349                     gpb -= s[i] * fb[i]; /* f is negative gradient, thus the sign */
2350                 }
2351                 /* Sum the gradient along the line across CPUs */
2352                 if (PAR(cr))
2353                 {
2354                     gmx_sumd(1, &gpb, cr);
2355                 }
2356
2357                 // Keep one of the intervals [A,B] or [B,C] based on the value of the derivative
2358                 // at the new point B, and rename the endpoints of this new interval A and C.
2359                 if (gpb > 0)
2360                 {
2361                     /* Replace c endpoint with b */
2362                     c = b;
2363                     /* copy state b to c */
2364                     *sc = *sb;
2365                 }
2366                 else
2367                 {
2368                     /* Replace a endpoint with b */
2369                     a = b;
2370                     /* copy state b to a */
2371                     *sa = *sb;
2372                 }
2373
2374                 /*
2375                  * Stop search as soon as we find a value smaller than the endpoints,
2376                  * or if the tolerance is below machine precision.
2377                  * Never run more than 20 steps, no matter what.
2378                  */
2379                 nminstep++;
2380             } while ((sb->epot > sa->epot || sb->epot > sc->epot) && (nminstep < 20));
2381
2382             if (std::fabs(sb->epot - Epot0) < GMX_REAL_EPS || nminstep >= 20)
2383             {
2384                 /* OK. We couldn't find a significantly lower energy.
2385                  * If ncorr==0 this was steepest descent, and then we give up.
2386                  * If not, reset memory to restart as steepest descent before quitting.
2387                  */
2388                 if (ncorr == 0)
2389                 {
2390                     /* Converged */
2391                     converged = TRUE;
2392                     break;
2393                 }
2394                 else
2395                 {
2396                     /* Reset memory */
2397                     ncorr = 0;
2398                     /* Search in gradient direction */
2399                     for (i = 0; i < n; i++)
2400                     {
2401                         dx[point][i] = ff[i];
2402                     }
2403                     /* Reset stepsize */
2404                     stepsize = 1.0 / fnorm;
2405                     continue;
2406                 }
2407             }
2408
2409             /* Select min energy state of A & C, put the best in xx/ff/Epot
2410              */
2411             if (sc->epot < sa->epot)
2412             {
2413                 /* Use state C */
2414                 ems        = *sc;
2415                 step_taken = c;
2416             }
2417             else
2418             {
2419                 /* Use state A */
2420                 ems        = *sa;
2421                 step_taken = a;
2422             }
2423         }
2424         else
2425         {
2426             /* found lower */
2427             /* Use state C */
2428             ems        = *sc;
2429             step_taken = c;
2430         }
2431
2432         /* Update the memory information, and calculate a new
2433          * approximation of the inverse hessian
2434          */
2435
2436         /* Have new data in Epot, xx, ff */
2437         if (ncorr < nmaxcorr)
2438         {
2439             ncorr++;
2440         }
2441
2442         for (i = 0; i < n; i++)
2443         {
2444             dg[point][i] = lastf[i] - ff[i];
2445             dx[point][i] *= step_taken;
2446         }
2447
2448         dgdg = 0;
2449         dgdx = 0;
2450         for (i = 0; i < n; i++)
2451         {
2452             dgdg += dg[point][i] * dg[point][i];
2453             dgdx += dg[point][i] * dx[point][i];
2454         }
2455
2456         diag = dgdx / dgdg;
2457
2458         rho[point] = 1.0 / dgdx;
2459         point++;
2460
2461         if (point >= nmaxcorr)
2462         {
2463             point = 0;
2464         }
2465
2466         /* Update */
2467         for (i = 0; i < n; i++)
2468         {
2469             p[i] = ff[i];
2470         }
2471
2472         cp = point;
2473
2474         /* Recursive update. First go back over the memory points */
2475         for (k = 0; k < ncorr; k++)
2476         {
2477             cp--;
2478             if (cp < 0)
2479             {
2480                 cp = ncorr - 1;
2481             }
2482
2483             sq = 0;
2484             for (i = 0; i < n; i++)
2485             {
2486                 sq += dx[cp][i] * p[i];
2487             }
2488
2489             alpha[cp] = rho[cp] * sq;
2490
2491             for (i = 0; i < n; i++)
2492             {
2493                 p[i] -= alpha[cp] * dg[cp][i];
2494             }
2495         }
2496
2497         for (i = 0; i < n; i++)
2498         {
2499             p[i] *= diag;
2500         }
2501
2502         /* And then go forward again */
2503         for (k = 0; k < ncorr; k++)
2504         {
2505             yr = 0;
2506             for (i = 0; i < n; i++)
2507             {
2508                 yr += p[i] * dg[cp][i];
2509             }
2510
2511             beta = rho[cp] * yr;
2512             beta = alpha[cp] - beta;
2513
2514             for (i = 0; i < n; i++)
2515             {
2516                 p[i] += beta * dx[cp][i];
2517             }
2518
2519             cp++;
2520             if (cp >= ncorr)
2521             {
2522                 cp = 0;
2523             }
2524         }
2525
2526         for (i = 0; i < n; i++)
2527         {
2528             if (!frozen[i])
2529             {
2530                 dx[point][i] = p[i];
2531             }
2532             else
2533             {
2534                 dx[point][i] = 0;
2535             }
2536         }
2537
2538         /* Print it if necessary */
2539         if (MASTER(cr))
2540         {
2541             if (mdrunOptions.verbose)
2542             {
2543                 double sqrtNumAtoms = sqrt(static_cast<double>(state_global->natoms));
2544                 fprintf(stderr,
2545                         "\rStep %d, Epot=%12.6e, Fnorm=%9.3e, Fmax=%9.3e (atom %d)\n",
2546                         step,
2547                         ems.epot,
2548                         ems.fnorm / sqrtNumAtoms,
2549                         ems.fmax,
2550                         ems.a_fmax + 1);
2551                 fflush(stderr);
2552             }
2553             /* Store the new (lower) energies */
2554             matrix nullBox = {};
2555             energyOutput.addDataAtEnergyStep(false,
2556                                              false,
2557                                              static_cast<double>(step),
2558                                              mdatoms->tmass,
2559                                              enerd,
2560                                              nullptr,
2561                                              nullptr,
2562                                              nullBox,
2563                                              PTCouplingArrays(),
2564                                              0,
2565                                              nullptr,
2566                                              nullptr,
2567                                              vir,
2568                                              pres,
2569                                              nullptr,
2570                                              mu_tot,
2571                                              constr);
2572
2573             do_log = do_per_step(step, inputrec->nstlog);
2574             do_ene = do_per_step(step, inputrec->nstenergy);
2575
2576             imdSession->fillEnergyRecord(step, TRUE);
2577
2578             if (do_log)
2579             {
2580                 EnergyOutput::printHeader(fplog, step, step);
2581             }
2582             energyOutput.printStepToEnergyFile(mdoutf_get_fp_ene(outf),
2583                                                do_ene,
2584                                                FALSE,
2585                                                FALSE,
2586                                                do_log ? fplog : nullptr,
2587                                                step,
2588                                                step,
2589                                                fr->fcdata.get(),
2590                                                nullptr);
2591         }
2592
2593         /* Send x and E to IMD client, if bIMD is TRUE. */
2594         if (imdSession->run(step, TRUE, state_global->box, state_global->x.rvec_array(), 0) && MASTER(cr))
2595         {
2596             imdSession->sendPositionsAndEnergies();
2597         }
2598
2599         // Reset stepsize in we are doing more iterations
2600         stepsize = 1.0;
2601
2602         /* Stop when the maximum force lies below tolerance.
2603          * If we have reached machine precision, converged is already set to true.
2604          */
2605         converged = converged || (ems.fmax < inputrec->em_tol);
2606
2607     } /* End of the loop */
2608
2609     if (converged)
2610     {
2611         step--; /* we never took that last step in this case */
2612     }
2613     if (ems.fmax > inputrec->em_tol)
2614     {
2615         if (MASTER(cr))
2616         {
2617             warn_step(fplog, inputrec->em_tol, ems.fmax, step - 1 == number_steps, FALSE);
2618         }
2619         converged = FALSE;
2620     }
2621
2622     /* If we printed energy and/or logfile last step (which was the last step)
2623      * we don't have to do it again, but otherwise print the final values.
2624      */
2625     if (!do_log) /* Write final value to log since we didn't do anythin last step */
2626     {
2627         EnergyOutput::printHeader(fplog, step, step);
2628     }
2629     if (!do_ene || !do_log) /* Write final energy file entries */
2630     {
2631         energyOutput.printStepToEnergyFile(mdoutf_get_fp_ene(outf),
2632                                            !do_ene,
2633                                            FALSE,
2634                                            FALSE,
2635                                            !do_log ? fplog : nullptr,
2636                                            step,
2637                                            step,
2638                                            fr->fcdata.get(),
2639                                            nullptr);
2640     }
2641
2642     /* Print some stuff... */
2643     if (MASTER(cr))
2644     {
2645         fprintf(stderr, "\nwriting lowest energy coordinates.\n");
2646     }
2647
2648     /* IMPORTANT!
2649      * For accurate normal mode calculation it is imperative that we
2650      * store the last conformation into the full precision binary trajectory.
2651      *
2652      * However, we should only do it if we did NOT already write this step
2653      * above (which we did if do_x or do_f was true).
2654      */
2655     do_x = !do_per_step(step, inputrec->nstxout);
2656     do_f = !do_per_step(step, inputrec->nstfout);
2657     write_em_traj(
2658             fplog, cr, outf, do_x, do_f, ftp2fn(efSTO, nfile, fnm), top_global, inputrec, step, &ems, state_global, observablesHistory);
2659
2660     if (MASTER(cr))
2661     {
2662         double sqrtNumAtoms = sqrt(static_cast<double>(state_global->natoms));
2663         print_converged(stderr, LBFGS, inputrec->em_tol, step, converged, number_steps, &ems, sqrtNumAtoms);
2664         print_converged(fplog, LBFGS, inputrec->em_tol, step, converged, number_steps, &ems, sqrtNumAtoms);
2665
2666         fprintf(fplog, "\nPerformed %d energy evaluations in total.\n", neval);
2667     }
2668
2669     finish_em(cr, outf, walltime_accounting, wcycle);
2670
2671     /* To print the actual number of steps we needed somewhere */
2672     walltime_accounting_set_nsteps_done(walltime_accounting, step);
2673 }
2674
2675 void LegacySimulator::do_steep()
2676 {
2677     const char*       SD = "Steepest Descents";
2678     gmx_localtop_t    top(top_global->ffparams);
2679     gmx_global_stat_t gstat;
2680     real              stepsize;
2681     real              ustep;
2682     gmx_bool          bDone, bAbort, do_x, do_f;
2683     tensor            vir, pres;
2684     rvec              mu_tot = { 0 };
2685     int               nsteps;
2686     int               count          = 0;
2687     int               steps_accepted = 0;
2688     auto              mdatoms        = mdAtoms->mdatoms();
2689
2690     GMX_LOG(mdlog.info)
2691             .asParagraph()
2692             .appendText(
2693                     "Note that activating steepest-descent energy minimization via the "
2694                     "integrator .mdp option and the command gmx mdrun may "
2695                     "be available in a different form in a future version of GROMACS, "
2696                     "e.g. gmx minimize and an .mdp option.");
2697
2698     /* Create 2 states on the stack and extract pointers that we will swap */
2699     em_state_t  s0{}, s1{};
2700     em_state_t* s_min = &s0;
2701     em_state_t* s_try = &s1;
2702
2703     /* Init em and store the local state in s_try */
2704     init_em(fplog,
2705             mdlog,
2706             SD,
2707             cr,
2708             inputrec,
2709             imdSession,
2710             pull_work,
2711             state_global,
2712             top_global,
2713             s_try,
2714             &top,
2715             nrnb,
2716             fr,
2717             mdAtoms,
2718             &gstat,
2719             vsite,
2720             constr,
2721             nullptr);
2722     const bool        simulationsShareState = false;
2723     gmx_mdoutf*       outf                  = init_mdoutf(fplog,
2724                                    nfile,
2725                                    fnm,
2726                                    mdrunOptions,
2727                                    cr,
2728                                    outputProvider,
2729                                    mdModulesNotifier,
2730                                    inputrec,
2731                                    top_global,
2732                                    nullptr,
2733                                    wcycle,
2734                                    StartingBehavior::NewSimulation,
2735                                    simulationsShareState,
2736                                    ms);
2737     gmx::EnergyOutput energyOutput(mdoutf_get_fp_ene(outf),
2738                                    top_global,
2739                                    inputrec,
2740                                    pull_work,
2741                                    nullptr,
2742                                    false,
2743                                    StartingBehavior::NewSimulation,
2744                                    simulationsShareState,
2745                                    mdModulesNotifier);
2746
2747     /* Print to log file  */
2748     print_em_start(fplog, cr, walltime_accounting, wcycle, SD);
2749
2750     /* Set variables for stepsize (in nm). This is the largest
2751      * step that we are going to make in any direction.
2752      */
2753     ustep    = inputrec->em_stepsize;
2754     stepsize = 0;
2755
2756     /* Max number of steps  */
2757     nsteps = inputrec->nsteps;
2758
2759     if (MASTER(cr))
2760     {
2761         /* Print to the screen  */
2762         sp_header(stderr, SD, inputrec->em_tol, nsteps);
2763     }
2764     if (fplog)
2765     {
2766         sp_header(fplog, SD, inputrec->em_tol, nsteps);
2767     }
2768     EnergyEvaluator energyEvaluator{ fplog,    mdlog,      cr,        ms,   top_global,      &top,
2769                                      inputrec, imdSession, pull_work, nrnb, wcycle,          gstat,
2770                                      vsite,    constr,     mdAtoms,   fr,   runScheduleWork, enerd };
2771
2772     /**** HERE STARTS THE LOOP ****
2773      * count is the counter for the number of steps
2774      * bDone will be TRUE when the minimization has converged
2775      * bAbort will be TRUE when nsteps steps have been performed or when
2776      * the stepsize becomes smaller than is reasonable for machine precision
2777      */
2778     count  = 0;
2779     bDone  = FALSE;
2780     bAbort = FALSE;
2781     while (!bDone && !bAbort)
2782     {
2783         bAbort = (nsteps >= 0) && (count == nsteps);
2784
2785         /* set new coordinates, except for first step */
2786         bool validStep = true;
2787         if (count > 0)
2788         {
2789             validStep = do_em_step(
2790                     cr, inputrec, mdatoms, s_min, stepsize, s_min->f.view().forceWithPadding(), s_try, constr, count);
2791         }
2792
2793         if (validStep)
2794         {
2795             energyEvaluator.run(s_try, mu_tot, vir, pres, count, count == 0);
2796         }
2797         else
2798         {
2799             // Signal constraint error during stepping with energy=inf
2800             s_try->epot = std::numeric_limits<real>::infinity();
2801         }
2802
2803         if (MASTER(cr))
2804         {
2805             EnergyOutput::printHeader(fplog, count, count);
2806         }
2807
2808         if (count == 0)
2809         {
2810             s_min->epot = s_try->epot;
2811         }
2812
2813         /* Print it if necessary  */
2814         if (MASTER(cr))
2815         {
2816             if (mdrunOptions.verbose)
2817             {
2818                 fprintf(stderr,
2819                         "Step=%5d, Dmax= %6.1e nm, Epot= %12.5e Fmax= %11.5e, atom= %d%c",
2820                         count,
2821                         ustep,
2822                         s_try->epot,
2823                         s_try->fmax,
2824                         s_try->a_fmax + 1,
2825                         ((count == 0) || (s_try->epot < s_min->epot)) ? '\n' : '\r');
2826                 fflush(stderr);
2827             }
2828
2829             if ((count == 0) || (s_try->epot < s_min->epot))
2830             {
2831                 /* Store the new (lower) energies  */
2832                 matrix nullBox = {};
2833                 energyOutput.addDataAtEnergyStep(false,
2834                                                  false,
2835                                                  static_cast<double>(count),
2836                                                  mdatoms->tmass,
2837                                                  enerd,
2838                                                  nullptr,
2839                                                  nullptr,
2840                                                  nullBox,
2841                                                  PTCouplingArrays(),
2842                                                  0,
2843                                                  nullptr,
2844                                                  nullptr,
2845                                                  vir,
2846                                                  pres,
2847                                                  nullptr,
2848                                                  mu_tot,
2849                                                  constr);
2850
2851                 imdSession->fillEnergyRecord(count, TRUE);
2852
2853                 const bool do_dr = do_per_step(steps_accepted, inputrec->nstdisreout);
2854                 const bool do_or = do_per_step(steps_accepted, inputrec->nstorireout);
2855                 energyOutput.printStepToEnergyFile(
2856                         mdoutf_get_fp_ene(outf), TRUE, do_dr, do_or, fplog, count, count, fr->fcdata.get(), nullptr);
2857                 fflush(fplog);
2858             }
2859         }
2860
2861         /* Now if the new energy is smaller than the previous...
2862          * or if this is the first step!
2863          * or if we did random steps!
2864          */
2865
2866         if ((count == 0) || (s_try->epot < s_min->epot))
2867         {
2868             steps_accepted++;
2869
2870             /* Test whether the convergence criterion is met...  */
2871             bDone = (s_try->fmax < inputrec->em_tol);
2872
2873             /* Copy the arrays for force, positions and energy  */
2874             /* The 'Min' array always holds the coords and forces of the minimal
2875                sampled energy  */
2876             swap_em_state(&s_min, &s_try);
2877             if (count > 0)
2878             {
2879                 ustep *= 1.2;
2880             }
2881
2882             /* Write to trn, if necessary */
2883             do_x = do_per_step(steps_accepted, inputrec->nstxout);
2884             do_f = do_per_step(steps_accepted, inputrec->nstfout);
2885             write_em_traj(
2886                     fplog, cr, outf, do_x, do_f, nullptr, top_global, inputrec, count, s_min, state_global, observablesHistory);
2887         }
2888         else
2889         {
2890             /* If energy is not smaller make the step smaller...  */
2891             ustep *= 0.5;
2892
2893             if (DOMAINDECOMP(cr) && s_min->s.ddp_count != cr->dd->ddp_count)
2894             {
2895                 /* Reload the old state */
2896                 em_dd_partition_system(fplog,
2897                                        mdlog,
2898                                        count,
2899                                        cr,
2900                                        top_global,
2901                                        inputrec,
2902                                        imdSession,
2903                                        pull_work,
2904                                        s_min,
2905                                        &top,
2906                                        mdAtoms,
2907                                        fr,
2908                                        vsite,
2909                                        constr,
2910                                        nrnb,
2911                                        wcycle);
2912             }
2913         }
2914
2915         // If the force is very small after finishing minimization,
2916         // we risk dividing by zero when calculating the step size.
2917         // So we check first if the minimization has stopped before
2918         // trying to obtain a new step size.
2919         if (!bDone)
2920         {
2921             /* Determine new step  */
2922             stepsize = ustep / s_min->fmax;
2923         }
2924
2925         /* Check if stepsize is too small, with 1 nm as a characteristic length */
2926 #if GMX_DOUBLE
2927         if (count == nsteps || ustep < 1e-12)
2928 #else
2929         if (count == nsteps || ustep < 1e-6)
2930 #endif
2931         {
2932             if (MASTER(cr))
2933             {
2934                 warn_step(fplog, inputrec->em_tol, s_min->fmax, count == nsteps, constr != nullptr);
2935             }
2936             bAbort = TRUE;
2937         }
2938
2939         /* Send IMD energies and positions, if bIMD is TRUE. */
2940         if (imdSession->run(count,
2941                             TRUE,
2942                             MASTER(cr) ? state_global->box : nullptr,
2943                             MASTER(cr) ? state_global->x.rvec_array() : nullptr,
2944                             0)
2945             && MASTER(cr))
2946         {
2947             imdSession->sendPositionsAndEnergies();
2948         }
2949
2950         count++;
2951     } /* End of the loop  */
2952
2953     /* Print some data...  */
2954     if (MASTER(cr))
2955     {
2956         fprintf(stderr, "\nwriting lowest energy coordinates.\n");
2957     }
2958     write_em_traj(fplog,
2959                   cr,
2960                   outf,
2961                   TRUE,
2962                   inputrec->nstfout != 0,
2963                   ftp2fn(efSTO, nfile, fnm),
2964                   top_global,
2965                   inputrec,
2966                   count,
2967                   s_min,
2968                   state_global,
2969                   observablesHistory);
2970
2971     if (MASTER(cr))
2972     {
2973         double sqrtNumAtoms = sqrt(static_cast<double>(state_global->natoms));
2974
2975         print_converged(stderr, SD, inputrec->em_tol, count, bDone, nsteps, s_min, sqrtNumAtoms);
2976         print_converged(fplog, SD, inputrec->em_tol, count, bDone, nsteps, s_min, sqrtNumAtoms);
2977     }
2978
2979     finish_em(cr, outf, walltime_accounting, wcycle);
2980
2981     /* To print the actual number of steps we needed somewhere */
2982     {
2983         // TODO: Avoid changing inputrec (#3854)
2984         auto* nonConstInputrec   = const_cast<t_inputrec*>(inputrec);
2985         nonConstInputrec->nsteps = count;
2986     }
2987
2988     walltime_accounting_set_nsteps_done(walltime_accounting, count);
2989 }
2990
2991 void LegacySimulator::do_nm()
2992 {
2993     const char*         NM = "Normal Mode Analysis";
2994     int                 nnodes;
2995     gmx_localtop_t      top(top_global->ffparams);
2996     gmx_global_stat_t   gstat;
2997     tensor              vir, pres;
2998     rvec                mu_tot = { 0 };
2999     rvec*               dfdx;
3000     gmx_bool            bSparse; /* use sparse matrix storage format */
3001     size_t              sz;
3002     gmx_sparsematrix_t* sparse_matrix = nullptr;
3003     real*               full_matrix   = nullptr;
3004
3005     /* added with respect to mdrun */
3006     int  row, col;
3007     real der_range = 10.0 * std::sqrt(GMX_REAL_EPS);
3008     real x_min;
3009     bool bIsMaster = MASTER(cr);
3010     auto mdatoms   = mdAtoms->mdatoms();
3011
3012     GMX_LOG(mdlog.info)
3013             .asParagraph()
3014             .appendText(
3015                     "Note that activating normal-mode analysis via the integrator "
3016                     ".mdp option and the command gmx mdrun may "
3017                     "be available in a different form in a future version of GROMACS, "
3018                     "e.g. gmx normal-modes.");
3019
3020     if (constr != nullptr)
3021     {
3022         gmx_fatal(
3023                 FARGS,
3024                 "Constraints present with Normal Mode Analysis, this combination is not supported");
3025     }
3026
3027     gmx_shellfc_t* shellfc;
3028
3029     em_state_t state_work{};
3030
3031     /* Init em and store the local state in state_minimum */
3032     init_em(fplog,
3033             mdlog,
3034             NM,
3035             cr,
3036             inputrec,
3037             imdSession,
3038             pull_work,
3039             state_global,
3040             top_global,
3041             &state_work,
3042             &top,
3043             nrnb,
3044             fr,
3045             mdAtoms,
3046             &gstat,
3047             vsite,
3048             constr,
3049             &shellfc);
3050     const bool  simulationsShareState = false;
3051     gmx_mdoutf* outf                  = init_mdoutf(fplog,
3052                                    nfile,
3053                                    fnm,
3054                                    mdrunOptions,
3055                                    cr,
3056                                    outputProvider,
3057                                    mdModulesNotifier,
3058                                    inputrec,
3059                                    top_global,
3060                                    nullptr,
3061                                    wcycle,
3062                                    StartingBehavior::NewSimulation,
3063                                    simulationsShareState,
3064                                    ms);
3065
3066     std::vector<int>       atom_index = get_atom_index(top_global);
3067     std::vector<gmx::RVec> fneg(atom_index.size(), { 0, 0, 0 });
3068     snew(dfdx, atom_index.size());
3069
3070 #if !GMX_DOUBLE
3071     if (bIsMaster)
3072     {
3073         fprintf(stderr,
3074                 "NOTE: This version of GROMACS has been compiled in single precision,\n"
3075                 "      which MIGHT not be accurate enough for normal mode analysis.\n"
3076                 "      GROMACS now uses sparse matrix storage, so the memory requirements\n"
3077                 "      are fairly modest even if you recompile in double precision.\n\n");
3078     }
3079 #endif
3080
3081     /* Check if we can/should use sparse storage format.
3082      *
3083      * Sparse format is only useful when the Hessian itself is sparse, which it
3084      * will be when we use a cutoff.
3085      * For small systems (n<1000) it is easier to always use full matrix format, though.
3086      */
3087     if (EEL_FULL(fr->ic->eeltype) || fr->rlist == 0.0)
3088     {
3089         GMX_LOG(mdlog.warning)
3090                 .appendText("Non-cutoff electrostatics used, forcing full Hessian format.");
3091         bSparse = FALSE;
3092     }
3093     else if (atom_index.size() < 1000)
3094     {
3095         GMX_LOG(mdlog.warning)
3096                 .appendTextFormatted("Small system size (N=%zu), using full Hessian format.",
3097                                      atom_index.size());
3098         bSparse = FALSE;
3099     }
3100     else
3101     {
3102         GMX_LOG(mdlog.warning).appendText("Using compressed symmetric sparse Hessian format.");
3103         bSparse = TRUE;
3104     }
3105
3106     /* Number of dimensions, based on real atoms, that is not vsites or shell */
3107     sz = DIM * atom_index.size();
3108
3109     fprintf(stderr, "Allocating Hessian memory...\n\n");
3110
3111     if (bSparse)
3112     {
3113         sparse_matrix                       = gmx_sparsematrix_init(sz);
3114         sparse_matrix->compressed_symmetric = TRUE;
3115     }
3116     else
3117     {
3118         snew(full_matrix, sz * sz);
3119     }
3120
3121     /* Write start time and temperature */
3122     print_em_start(fplog, cr, walltime_accounting, wcycle, NM);
3123
3124     /* fudge nr of steps to nr of atoms */
3125     {
3126         // TODO: Avoid changing inputrec (#3854)
3127         auto* nonConstInputrec   = const_cast<t_inputrec*>(inputrec);
3128         nonConstInputrec->nsteps = atom_index.size() * 2;
3129     }
3130
3131     if (bIsMaster)
3132     {
3133         fprintf(stderr,
3134                 "starting normal mode calculation '%s'\n%" PRId64 " steps.\n\n",
3135                 *(top_global->name),
3136                 inputrec->nsteps);
3137     }
3138
3139     nnodes = cr->nnodes;
3140
3141     /* Make evaluate_energy do a single node force calculation */
3142     cr->nnodes = 1;
3143     EnergyEvaluator energyEvaluator{ fplog,    mdlog,      cr,        ms,   top_global,      &top,
3144                                      inputrec, imdSession, pull_work, nrnb, wcycle,          gstat,
3145                                      vsite,    constr,     mdAtoms,   fr,   runScheduleWork, enerd };
3146     energyEvaluator.run(&state_work, mu_tot, vir, pres, -1, TRUE);
3147     cr->nnodes = nnodes;
3148
3149     /* if forces are not small, warn user */
3150     get_state_f_norm_max(cr, &(inputrec->opts), mdatoms, &state_work);
3151
3152     GMX_LOG(mdlog.warning).appendTextFormatted("Maximum force:%12.5e", state_work.fmax);
3153     if (state_work.fmax > 1.0e-3)
3154     {
3155         GMX_LOG(mdlog.warning)
3156                 .appendText(
3157                         "The force is probably not small enough to "
3158                         "ensure that you are at a minimum.\n"
3159                         "Be aware that negative eigenvalues may occur\n"
3160                         "when the resulting matrix is diagonalized.");
3161     }
3162
3163     /***********************************************************
3164      *
3165      *      Loop over all pairs in matrix
3166      *
3167      *      do_force called twice. Once with positive and
3168      *      once with negative displacement
3169      *
3170      ************************************************************/
3171
3172     /* Steps are divided one by one over the nodes */
3173     bool bNS          = true;
3174     auto state_work_x = makeArrayRef(state_work.s.x);
3175     auto state_work_f = state_work.f.view().force();
3176     for (index aid = cr->nodeid; aid < ssize(atom_index); aid += nnodes)
3177     {
3178         size_t atom = atom_index[aid];
3179         for (size_t d = 0; d < DIM; d++)
3180         {
3181             int64_t step        = 0;
3182             int     force_flags = GMX_FORCE_STATECHANGED | GMX_FORCE_ALLFORCES;
3183             double  t           = 0;
3184
3185             x_min = state_work_x[atom][d];
3186
3187             for (unsigned int dx = 0; (dx < 2); dx++)
3188             {
3189                 if (dx == 0)
3190                 {
3191                     state_work_x[atom][d] = x_min - der_range;
3192                 }
3193                 else
3194                 {
3195                     state_work_x[atom][d] = x_min + der_range;
3196                 }
3197
3198                 /* Make evaluate_energy do a single node force calculation */
3199                 cr->nnodes = 1;
3200                 if (shellfc)
3201                 {
3202                     /* Now is the time to relax the shells */
3203                     relax_shell_flexcon(fplog,
3204                                         cr,
3205                                         ms,
3206                                         mdrunOptions.verbose,
3207                                         nullptr,
3208                                         step,
3209                                         inputrec,
3210                                         imdSession,
3211                                         pull_work,
3212                                         bNS,
3213                                         force_flags,
3214                                         &top,
3215                                         constr,
3216                                         enerd,
3217                                         state_work.s.natoms,
3218                                         state_work.s.x.arrayRefWithPadding(),
3219                                         state_work.s.v.arrayRefWithPadding(),
3220                                         state_work.s.box,
3221                                         state_work.s.lambda,
3222                                         &state_work.s.hist,
3223                                         &state_work.f.view(),
3224                                         vir,
3225                                         mdatoms,
3226                                         nrnb,
3227                                         wcycle,
3228                                         shellfc,
3229                                         fr,
3230                                         runScheduleWork,
3231                                         t,
3232                                         mu_tot,
3233                                         vsite,
3234                                         DDBalanceRegionHandler(nullptr));
3235                     bNS = false;
3236                     step++;
3237                 }
3238                 else
3239                 {
3240                     energyEvaluator.run(&state_work, mu_tot, vir, pres, aid * 2 + dx, FALSE);
3241                 }
3242
3243                 cr->nnodes = nnodes;
3244
3245                 if (dx == 0)
3246                 {
3247                     std::copy(state_work_f.begin(), state_work_f.begin() + atom_index.size(), fneg.begin());
3248                 }
3249             }
3250
3251             /* x is restored to original */
3252             state_work_x[atom][d] = x_min;
3253
3254             for (size_t j = 0; j < atom_index.size(); j++)
3255             {
3256                 for (size_t k = 0; (k < DIM); k++)
3257                 {
3258                     dfdx[j][k] = -(state_work_f[atom_index[j]][k] - fneg[j][k]) / (2 * der_range);
3259                 }
3260             }
3261
3262             if (!bIsMaster)
3263             {
3264 #if GMX_MPI
3265 #    define mpi_type GMX_MPI_REAL
3266                 MPI_Send(dfdx[0], atom_index.size() * DIM, mpi_type, MASTER(cr), cr->nodeid, cr->mpi_comm_mygroup);
3267 #endif
3268             }
3269             else
3270             {
3271                 for (index node = 0; (node < nnodes && aid + node < ssize(atom_index)); node++)
3272                 {
3273                     if (node > 0)
3274                     {
3275 #if GMX_MPI
3276                         MPI_Status stat;
3277                         MPI_Recv(dfdx[0], atom_index.size() * DIM, mpi_type, node, node, cr->mpi_comm_mygroup, &stat);
3278 #    undef mpi_type
3279 #endif
3280                     }
3281
3282                     row = (aid + node) * DIM + d;
3283
3284                     for (size_t j = 0; j < atom_index.size(); j++)
3285                     {
3286                         for (size_t k = 0; k < DIM; k++)
3287                         {
3288                             col = j * DIM + k;
3289
3290                             if (bSparse)
3291                             {
3292                                 if (col >= row && dfdx[j][k] != 0.0)
3293                                 {
3294                                     gmx_sparsematrix_increment_value(sparse_matrix, row, col, dfdx[j][k]);
3295                                 }
3296                             }
3297                             else
3298                             {
3299                                 full_matrix[row * sz + col] = dfdx[j][k];
3300                             }
3301                         }
3302                     }
3303                 }
3304             }
3305
3306             if (mdrunOptions.verbose && fplog)
3307             {
3308                 fflush(fplog);
3309             }
3310         }
3311         /* write progress */
3312         if (bIsMaster && mdrunOptions.verbose)
3313         {
3314             fprintf(stderr,
3315                     "\rFinished step %d out of %td",
3316                     std::min<int>(atom + nnodes, atom_index.size()),
3317                     ssize(atom_index));
3318             fflush(stderr);
3319         }
3320     }
3321
3322     if (bIsMaster)
3323     {
3324         fprintf(stderr, "\n\nWriting Hessian...\n");
3325         gmx_mtxio_write(ftp2fn(efMTX, nfile, fnm), sz, sz, full_matrix, sparse_matrix);
3326     }
3327
3328     finish_em(cr, outf, walltime_accounting, wcycle);
3329
3330     walltime_accounting_set_nsteps_done(walltime_accounting, atom_index.size() * 2);
3331 }
3332
3333 } // namespace gmx