src/gromacs/mdrun/minimize.cpp

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