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