src/gromacs/mdrun/minimize.cpp

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