Eliminate mdlib/mdrun.h
[alexxy/gromacs.git] / src / gromacs / mdlib / shellfc.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-2008, The GROMACS development team.
6  * Copyright (c) 2013,2014,2015,2016,2017,2018,2019, by the GROMACS development team, led by
7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
8  * and including many others, as listed in the AUTHORS file in the
9  * top-level source directory and at http://www.gromacs.org.
10  *
11  * GROMACS is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public License
13  * as published by the Free Software Foundation; either version 2.1
14  * of the License, or (at your option) any later version.
15  *
16  * GROMACS is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * Lesser General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public
22  * License along with GROMACS; if not, see
23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
25  *
26  * If you want to redistribute modifications to GROMACS, please
27  * consider that scientific software is very special. Version
28  * control is crucial - bugs must be traceable. We will be happy to
29  * consider code for inclusion in the official distribution, but
30  * derived work must not be called official GROMACS. Details are found
31  * in the README & COPYING files - if they are missing, get the
32  * official version at http://www.gromacs.org.
33  *
34  * To help us fund GROMACS development, we humbly ask that you cite
35  * the research papers on the package. Check out http://www.gromacs.org.
36  */
37 #include "gmxpre.h"
38
39 #include "shellfc.h"
40
41 #include <cmath>
42 #include <cstdint>
43 #include <cstdlib>
44 #include <cstring>
45
46 #include <algorithm>
47 #include <array>
48
49 #include "gromacs/domdec/dlbtiming.h"
50 #include "gromacs/domdec/domdec.h"
51 #include "gromacs/domdec/domdec_struct.h"
52 #include "gromacs/gmxlib/chargegroup.h"
53 #include "gromacs/gmxlib/network.h"
54 #include "gromacs/math/functions.h"
55 #include "gromacs/math/units.h"
56 #include "gromacs/math/vec.h"
57 #include "gromacs/math/vecdump.h"
58 #include "gromacs/mdlib/constr.h"
59 #include "gromacs/mdlib/force.h"
60 #include "gromacs/mdlib/force_flags.h"
61 #include "gromacs/mdlib/sim_util.h"
62 #include "gromacs/mdlib/vsite.h"
63 #include "gromacs/mdtypes/commrec.h"
64 #include "gromacs/mdtypes/enerdata.h"
65 #include "gromacs/mdtypes/forcerec.h"
66 #include "gromacs/mdtypes/inputrec.h"
67 #include "gromacs/mdtypes/md_enums.h"
68 #include "gromacs/mdtypes/state.h"
69 #include "gromacs/pbcutil/mshift.h"
70 #include "gromacs/pbcutil/pbc.h"
71 #include "gromacs/topology/ifunc.h"
72 #include "gromacs/topology/mtop_lookup.h"
73 #include "gromacs/topology/mtop_util.h"
74 #include "gromacs/utility/arrayref.h"
75 #include "gromacs/utility/arraysize.h"
76 #include "gromacs/utility/cstringutil.h"
77 #include "gromacs/utility/fatalerror.h"
78 #include "gromacs/utility/smalloc.h"
79
80 typedef struct {
81     int     nnucl;
82     int     shell;               /* The shell id                                */
83     int     nucl1, nucl2, nucl3; /* The nuclei connected to the shell   */
84     /* gmx_bool    bInterCG; */       /* Coupled to nuclei outside cg?        */
85     real    k;                   /* force constant                      */
86     real    k_1;                 /* 1 over force constant               */
87     rvec    xold;
88     rvec    fold;
89     rvec    step;
90 } t_shell;
91
92 struct gmx_shellfc_t {
93     /* Shell counts, indices, parameters and working data */
94     int          nshell_gl;              /* The number of shells in the system        */
95     t_shell     *shell_gl;               /* All the shells (for DD only)              */
96     int         *shell_index_gl;         /* Global shell index (for DD only)          */
97     gmx_bool     bInterCG;               /* Are there inter charge-group shells?      */
98     int          nshell;                 /* The number of local shells                */
99     t_shell     *shell;                  /* The local shells                          */
100     int          shell_nalloc;           /* The allocation size of shell              */
101     gmx_bool     bPredict;               /* Predict shell positions                   */
102     gmx_bool     bRequireInit;           /* Require initialization of shell positions */
103     int          nflexcon;               /* The number of flexible constraints        */
104
105     /* Temporary arrays, should be fixed size 2 when fully converted to C++ */
106     PaddedVector<gmx::RVec> *x;          /* Array for iterative minimization          */
107     PaddedVector<gmx::RVec> *f;          /* Array for iterative minimization          */
108
109     /* Flexible constraint working data */
110     rvec        *acc_dir;                /* Acceleration direction for flexcon        */
111     rvec        *x_old;                  /* Old coordinates for flexcon               */
112     int          flex_nalloc;            /* The allocation size of acc_dir and x_old  */
113     rvec        *adir_xnold;             /* Work space for init_adir                  */
114     rvec        *adir_xnew;              /* Work space for init_adir                  */
115     int          adir_nalloc;            /* Work space for init_adir                  */
116     std::int64_t numForceEvaluations;    /* Total number of force evaluations         */
117     int          numConvergedIterations; /* Total number of iterations that converged */
118 };
119
120
121 static void pr_shell(FILE *fplog, int ns, t_shell s[])
122 {
123     int i;
124
125     fprintf(fplog, "SHELL DATA\n");
126     fprintf(fplog, "%5s  %8s  %5s  %5s  %5s\n",
127             "Shell", "Force k", "Nucl1", "Nucl2", "Nucl3");
128     for (i = 0; (i < ns); i++)
129     {
130         fprintf(fplog, "%5d  %8.3f  %5d", s[i].shell, 1.0/s[i].k_1, s[i].nucl1);
131         if (s[i].nnucl == 2)
132         {
133             fprintf(fplog, "  %5d\n", s[i].nucl2);
134         }
135         else if (s[i].nnucl == 3)
136         {
137             fprintf(fplog, "  %5d  %5d\n", s[i].nucl2, s[i].nucl3);
138         }
139         else
140         {
141             fprintf(fplog, "\n");
142         }
143     }
144 }
145
146 /* TODO The remain call of this function passes non-NULL mass and NULL
147  * mtop, so this routine can be simplified.
148  *
149  * The other code path supported doing prediction before the MD loop
150  * started, but even when called, the prediction was always
151  * over-written by a subsequent call in the MD loop, so has been
152  * removed. */
153 static void predict_shells(FILE *fplog, rvec x[], rvec v[], real dt,
154                            int ns, t_shell s[],
155                            const real mass[], gmx_mtop_t *mtop, gmx_bool bInit)
156 {
157     int                   i, m, s1, n1, n2, n3;
158     real                  dt_1, fudge, tm, m1, m2, m3;
159     rvec                 *ptr;
160
161     /* We introduce a fudge factor for performance reasons: with this choice
162      * the initial force on the shells is about a factor of two lower than
163      * without
164      */
165     fudge = 1.0;
166
167     if (bInit)
168     {
169         if (fplog)
170         {
171             fprintf(fplog, "RELAX: Using prediction for initial shell placement\n");
172         }
173         ptr  = x;
174         dt_1 = 1;
175     }
176     else
177     {
178         ptr  = v;
179         dt_1 = fudge*dt;
180     }
181
182     int molb = 0;
183     for (i = 0; (i < ns); i++)
184     {
185         s1 = s[i].shell;
186         if (bInit)
187         {
188             clear_rvec(x[s1]);
189         }
190         switch (s[i].nnucl)
191         {
192             case 1:
193                 n1 = s[i].nucl1;
194                 for (m = 0; (m < DIM); m++)
195                 {
196                     x[s1][m] += ptr[n1][m]*dt_1;
197                 }
198                 break;
199             case 2:
200                 n1 = s[i].nucl1;
201                 n2 = s[i].nucl2;
202                 if (mass)
203                 {
204                     m1 = mass[n1];
205                     m2 = mass[n2];
206                 }
207                 else
208                 {
209                     /* Not the correct masses with FE, but it is just a prediction... */
210                     m1 = mtopGetAtomMass(mtop, n1, &molb);
211                     m2 = mtopGetAtomMass(mtop, n2, &molb);
212                 }
213                 tm = dt_1/(m1+m2);
214                 for (m = 0; (m < DIM); m++)
215                 {
216                     x[s1][m] += (m1*ptr[n1][m]+m2*ptr[n2][m])*tm;
217                 }
218                 break;
219             case 3:
220                 n1 = s[i].nucl1;
221                 n2 = s[i].nucl2;
222                 n3 = s[i].nucl3;
223                 if (mass)
224                 {
225                     m1 = mass[n1];
226                     m2 = mass[n2];
227                     m3 = mass[n3];
228                 }
229                 else
230                 {
231                     /* Not the correct masses with FE, but it is just a prediction... */
232                     m1 = mtopGetAtomMass(mtop, n1, &molb);
233                     m2 = mtopGetAtomMass(mtop, n2, &molb);
234                     m3 = mtopGetAtomMass(mtop, n3, &molb);
235                 }
236                 tm = dt_1/(m1+m2+m3);
237                 for (m = 0; (m < DIM); m++)
238                 {
239                     x[s1][m] += (m1*ptr[n1][m]+m2*ptr[n2][m]+m3*ptr[n3][m])*tm;
240                 }
241                 break;
242             default:
243                 gmx_fatal(FARGS, "Shell %d has %d nuclei!", i, s[i].nnucl);
244         }
245     }
246 }
247
248 /*! \brief Count the different particle types in a system
249  *
250  * Routine prints a warning to stderr in case an unknown particle type
251  * is encountered.
252  * \param[in]  fplog Print what we have found if not NULL
253  * \param[in]  mtop  Molecular topology.
254  * \returns Array holding the number of particles of a type
255  */
256 static std::array<int, eptNR> countPtypes(FILE             *fplog,
257                                           const gmx_mtop_t *mtop)
258 {
259     std::array<int, eptNR> nptype = { { 0 } };
260     /* Count number of shells, and find their indices */
261     for (int i = 0; (i < eptNR); i++)
262     {
263         nptype[i] = 0;
264     }
265
266     gmx_mtop_atomloop_block_t  aloopb = gmx_mtop_atomloop_block_init(mtop);
267     int                        nmol;
268     const t_atom              *atom;
269     while (gmx_mtop_atomloop_block_next(aloopb, &atom, &nmol))
270     {
271         switch (atom->ptype)
272         {
273             case eptAtom:
274             case eptVSite:
275             case eptShell:
276                 nptype[atom->ptype] += nmol;
277                 break;
278             default:
279                 fprintf(stderr, "Warning unsupported particle type %d in countPtypes",
280                         static_cast<int>(atom->ptype));
281         }
282     }
283     if (fplog)
284     {
285         /* Print the number of each particle type */
286         int n = 0;
287         for (const auto &i : nptype)
288         {
289             if (i != 0)
290             {
291                 fprintf(fplog, "There are: %d %ss\n", i, ptype_str[n]);
292             }
293             n++;
294         }
295     }
296     return nptype;
297 }
298
299 gmx_shellfc_t *init_shell_flexcon(FILE *fplog,
300                                   const gmx_mtop_t *mtop, int nflexcon,
301                                   int nstcalcenergy,
302                                   bool usingDomainDecomposition)
303 {
304     gmx_shellfc_t            *shfc;
305     t_shell                  *shell;
306     int                      *shell_index = nullptr, *at2cg;
307
308     int                       ns, nshell, nsi;
309     int                       i, j, type, a_offset, cg, mol, ftype, nra;
310     real                      qS, alpha;
311     int                       aS, aN = 0; /* Shell and nucleus */
312     int                       bondtypes[] = { F_BONDS, F_HARMONIC, F_CUBICBONDS, F_POLARIZATION, F_ANHARM_POL, F_WATER_POL };
313 #define NBT asize(bondtypes)
314     const gmx_ffparams_t     *ffparams;
315
316     std::array<int, eptNR>    n = countPtypes(fplog, mtop);
317     nshell = n[eptShell];
318
319     if (nshell == 0 && nflexcon == 0)
320     {
321         /* We're not doing shells or flexible constraints */
322         return nullptr;
323     }
324
325     snew(shfc, 1);
326     shfc->x        = new PaddedVector<gmx::RVec>[2] {};
327     shfc->f        = new PaddedVector<gmx::RVec>[2] {};
328     shfc->nflexcon = nflexcon;
329
330     if (nshell == 0)
331     {
332         /* Only flexible constraints, no shells.
333          * Note that make_local_shells() does not need to be called.
334          */
335         shfc->nshell   = 0;
336         shfc->bPredict = FALSE;
337
338         return shfc;
339     }
340
341     if (nstcalcenergy != 1)
342     {
343         gmx_fatal(FARGS, "You have nstcalcenergy set to a value (%d) that is different from 1.\nThis is not supported in combination with shell particles.\nPlease make a new tpr file.", nstcalcenergy);
344     }
345     if (usingDomainDecomposition)
346     {
347         gmx_fatal(FARGS, "Shell particles are not implemented with domain decomposition, use a single rank");
348     }
349
350     /* We have shells: fill the shell data structure */
351
352     /* Global system sized array, this should be avoided */
353     snew(shell_index, mtop->natoms);
354
355     nshell = 0;
356     for (const AtomProxy atomP : AtomRange(*mtop))
357     {
358         const t_atom &local = atomP.atom();
359         int           i     = atomP.globalAtomNumber();
360         if (local.ptype == eptShell)
361         {
362             shell_index[i] = nshell++;
363         }
364     }
365
366     snew(shell, nshell);
367
368     /* Initiate the shell structures */
369     for (i = 0; (i < nshell); i++)
370     {
371         shell[i].shell = -1;
372         shell[i].nnucl = 0;
373         shell[i].nucl1 = -1;
374         shell[i].nucl2 = -1;
375         shell[i].nucl3 = -1;
376         /* shell[i].bInterCG=FALSE; */
377         shell[i].k_1   = 0;
378         shell[i].k     = 0;
379     }
380
381     ffparams = &mtop->ffparams;
382
383     /* Now fill the structures */
384     shfc->bInterCG = FALSE;
385     ns             = 0;
386     a_offset       = 0;
387     for (size_t mb = 0; mb < mtop->molblock.size(); mb++)
388     {
389         const gmx_molblock_t *molb = &mtop->molblock[mb];
390         const gmx_moltype_t  *molt = &mtop->moltype[molb->type];
391         const t_block        *cgs  = &molt->cgs;
392
393         snew(at2cg, molt->atoms.nr);
394         for (cg = 0; cg < cgs->nr; cg++)
395         {
396             for (i = cgs->index[cg]; i < cgs->index[cg+1]; i++)
397             {
398                 at2cg[i] = cg;
399             }
400         }
401
402         const t_atom *atom = molt->atoms.atom;
403         for (mol = 0; mol < molb->nmol; mol++)
404         {
405             for (j = 0; (j < NBT); j++)
406             {
407                 const int *ia = molt->ilist[bondtypes[j]].iatoms.data();
408                 for (i = 0; (i < molt->ilist[bondtypes[j]].size()); )
409                 {
410                     type  = ia[0];
411                     ftype = ffparams->functype[type];
412                     nra   = interaction_function[ftype].nratoms;
413
414                     /* Check whether we have a bond with a shell */
415                     aS = -1;
416
417                     switch (bondtypes[j])
418                     {
419                         case F_BONDS:
420                         case F_HARMONIC:
421                         case F_CUBICBONDS:
422                         case F_POLARIZATION:
423                         case F_ANHARM_POL:
424                             if (atom[ia[1]].ptype == eptShell)
425                             {
426                                 aS = ia[1];
427                                 aN = ia[2];
428                             }
429                             else if (atom[ia[2]].ptype == eptShell)
430                             {
431                                 aS = ia[2];
432                                 aN = ia[1];
433                             }
434                             break;
435                         case F_WATER_POL:
436                             aN    = ia[4]; /* Dummy */
437                             aS    = ia[5]; /* Shell */
438                             break;
439                         default:
440                             gmx_fatal(FARGS, "Death Horror: %s, %d", __FILE__, __LINE__);
441                     }
442
443                     if (aS != -1)
444                     {
445                         qS = atom[aS].q;
446
447                         /* Check whether one of the particles is a shell... */
448                         nsi = shell_index[a_offset+aS];
449                         if ((nsi < 0) || (nsi >= nshell))
450                         {
451                             gmx_fatal(FARGS, "nsi is %d should be within 0 - %d. aS = %d",
452                                       nsi, nshell, aS);
453                         }
454                         if (shell[nsi].shell == -1)
455                         {
456                             shell[nsi].shell = a_offset + aS;
457                             ns++;
458                         }
459                         else if (shell[nsi].shell != a_offset+aS)
460                         {
461                             gmx_fatal(FARGS, "Weird stuff in %s, %d", __FILE__, __LINE__);
462                         }
463
464                         if      (shell[nsi].nucl1 == -1)
465                         {
466                             shell[nsi].nucl1 = a_offset + aN;
467                         }
468                         else if (shell[nsi].nucl2 == -1)
469                         {
470                             shell[nsi].nucl2 = a_offset + aN;
471                         }
472                         else if (shell[nsi].nucl3 == -1)
473                         {
474                             shell[nsi].nucl3 = a_offset + aN;
475                         }
476                         else
477                         {
478                             if (fplog)
479                             {
480                                 pr_shell(fplog, ns, shell);
481                             }
482                             gmx_fatal(FARGS, "Can not handle more than three bonds per shell\n");
483                         }
484                         if (at2cg[aS] != at2cg[aN])
485                         {
486                             /* shell[nsi].bInterCG = TRUE; */
487                             shfc->bInterCG = TRUE;
488                         }
489
490                         switch (bondtypes[j])
491                         {
492                             case F_BONDS:
493                             case F_HARMONIC:
494                                 shell[nsi].k    += ffparams->iparams[type].harmonic.krA;
495                                 break;
496                             case F_CUBICBONDS:
497                                 shell[nsi].k    += ffparams->iparams[type].cubic.kb;
498                                 break;
499                             case F_POLARIZATION:
500                             case F_ANHARM_POL:
501                                 if (!gmx_within_tol(qS, atom[aS].qB, GMX_REAL_EPS*10))
502                                 {
503                                     gmx_fatal(FARGS, "polarize can not be used with qA(%e) != qB(%e) for atom %d of molecule block %zu", qS, atom[aS].qB, aS+1, mb+1);
504                                 }
505                                 shell[nsi].k    += gmx::square(qS)*ONE_4PI_EPS0/
506                                     ffparams->iparams[type].polarize.alpha;
507                                 break;
508                             case F_WATER_POL:
509                                 if (!gmx_within_tol(qS, atom[aS].qB, GMX_REAL_EPS*10))
510                                 {
511                                     gmx_fatal(FARGS, "water_pol can not be used with qA(%e) != qB(%e) for atom %d of molecule block %zu", qS, atom[aS].qB, aS+1, mb+1);
512                                 }
513                                 alpha          = (ffparams->iparams[type].wpol.al_x+
514                                                   ffparams->iparams[type].wpol.al_y+
515                                                   ffparams->iparams[type].wpol.al_z)/3.0;
516                                 shell[nsi].k  += gmx::square(qS)*ONE_4PI_EPS0/alpha;
517                                 break;
518                             default:
519                                 gmx_fatal(FARGS, "Death Horror: %s, %d", __FILE__, __LINE__);
520                         }
521                         shell[nsi].nnucl++;
522                     }
523                     ia += nra+1;
524                     i  += nra+1;
525                 }
526             }
527             a_offset += molt->atoms.nr;
528         }
529         /* Done with this molecule type */
530         sfree(at2cg);
531     }
532
533     /* Verify whether it's all correct */
534     if (ns != nshell)
535     {
536         gmx_fatal(FARGS, "Something weird with shells. They may not be bonded to something");
537     }
538
539     for (i = 0; (i < ns); i++)
540     {
541         shell[i].k_1 = 1.0/shell[i].k;
542     }
543
544     if (debug)
545     {
546         pr_shell(debug, ns, shell);
547     }
548
549
550     shfc->nshell_gl      = ns;
551     shfc->shell_gl       = shell;
552     shfc->shell_index_gl = shell_index;
553
554     shfc->bPredict     = (getenv("GMX_NOPREDICT") == nullptr);
555     shfc->bRequireInit = FALSE;
556     if (!shfc->bPredict)
557     {
558         if (fplog)
559         {
560             fprintf(fplog, "\nWill never predict shell positions\n");
561         }
562     }
563     else
564     {
565         shfc->bRequireInit = (getenv("GMX_REQUIRE_SHELL_INIT") != nullptr);
566         if (shfc->bRequireInit && fplog)
567         {
568             fprintf(fplog, "\nWill always initiate shell positions\n");
569         }
570     }
571
572     if (shfc->bPredict)
573     {
574         if (shfc->bInterCG)
575         {
576             if (fplog)
577             {
578                 fprintf(fplog, "\nNOTE: there are shells that are connected to particles outside their own charge group, will not predict shells positions during the run\n\n");
579             }
580             /* Prediction improves performance, so we should implement either:
581              * 1. communication for the atoms needed for prediction
582              * 2. prediction using the velocities of shells; currently the
583              *    shell velocities are zeroed, it's a bit tricky to keep
584              *    track of the shell displacements and thus the velocity.
585              */
586             shfc->bPredict = FALSE;
587         }
588     }
589
590     return shfc;
591 }
592
593 void make_local_shells(const t_commrec *cr,
594                        const t_mdatoms *md,
595                        gmx_shellfc_t   *shfc)
596 {
597     t_shell      *shell;
598     int           a0, a1, *ind, nshell, i;
599     gmx_domdec_t *dd = nullptr;
600
601     if (DOMAINDECOMP(cr))
602     {
603         dd = cr->dd;
604         a0 = 0;
605         a1 = dd_numHomeAtoms(*dd);
606     }
607     else
608     {
609         /* Single node: we need all shells, just copy the pointer */
610         shfc->nshell = shfc->nshell_gl;
611         shfc->shell  = shfc->shell_gl;
612
613         return;
614     }
615
616     ind = shfc->shell_index_gl;
617
618     nshell = 0;
619     shell  = shfc->shell;
620     for (i = a0; i < a1; i++)
621     {
622         if (md->ptype[i] == eptShell)
623         {
624             if (nshell+1 > shfc->shell_nalloc)
625             {
626                 shfc->shell_nalloc = over_alloc_dd(nshell+1);
627                 srenew(shell, shfc->shell_nalloc);
628             }
629             if (dd)
630             {
631                 shell[nshell] = shfc->shell_gl[ind[dd->globalAtomIndices[i]]];
632             }
633             else
634             {
635                 shell[nshell] = shfc->shell_gl[ind[i]];
636             }
637
638             /* With inter-cg shells we can no do shell prediction,
639              * so we do not need the nuclei numbers.
640              */
641             if (!shfc->bInterCG)
642             {
643                 shell[nshell].nucl1   = i + shell[nshell].nucl1 - shell[nshell].shell;
644                 if (shell[nshell].nnucl > 1)
645                 {
646                     shell[nshell].nucl2 = i + shell[nshell].nucl2 - shell[nshell].shell;
647                 }
648                 if (shell[nshell].nnucl > 2)
649                 {
650                     shell[nshell].nucl3 = i + shell[nshell].nucl3 - shell[nshell].shell;
651                 }
652             }
653             shell[nshell].shell = i;
654             nshell++;
655         }
656     }
657
658     shfc->nshell = nshell;
659     shfc->shell  = shell;
660 }
661
662 static void do_1pos(rvec xnew, const rvec xold, const rvec f, real step)
663 {
664     real xo, yo, zo;
665     real dx, dy, dz;
666
667     xo = xold[XX];
668     yo = xold[YY];
669     zo = xold[ZZ];
670
671     dx = f[XX]*step;
672     dy = f[YY]*step;
673     dz = f[ZZ]*step;
674
675     xnew[XX] = xo+dx;
676     xnew[YY] = yo+dy;
677     xnew[ZZ] = zo+dz;
678 }
679
680 static void do_1pos3(rvec xnew, const rvec xold, const rvec f, const rvec step)
681 {
682     real xo, yo, zo;
683     real dx, dy, dz;
684
685     xo = xold[XX];
686     yo = xold[YY];
687     zo = xold[ZZ];
688
689     dx = f[XX]*step[XX];
690     dy = f[YY]*step[YY];
691     dz = f[ZZ]*step[ZZ];
692
693     xnew[XX] = xo+dx;
694     xnew[YY] = yo+dy;
695     xnew[ZZ] = zo+dz;
696 }
697
698 static void directional_sd(gmx::ArrayRef<const gmx::RVec> xold,
699                            gmx::ArrayRef<gmx::RVec> xnew,
700                            const rvec acc_dir[], int homenr, real step)
701 {
702     const rvec *xo = as_rvec_array(xold.data());
703     rvec       *xn = as_rvec_array(xnew.data());
704
705     for (int i = 0; i < homenr; i++)
706     {
707         do_1pos(xn[i], xo[i], acc_dir[i], step);
708     }
709 }
710
711 static void shell_pos_sd(gmx::ArrayRef<const gmx::RVec> xcur,
712                          gmx::ArrayRef<gmx::RVec> xnew,
713                          gmx::ArrayRef<const gmx::RVec> f,
714                          int ns, t_shell s[], int count)
715 {
716     const real step_scale_min       = 0.8,
717                step_scale_increment = 0.2,
718                step_scale_max       = 1.2,
719                step_scale_multiple  = (step_scale_max - step_scale_min) / step_scale_increment;
720     int        i, shell, d;
721     real       dx, df, k_est;
722     const real zero = 0;
723 #ifdef PRINT_STEP
724     real       step_min, step_max;
725
726     step_min = 1e30;
727     step_max = 0;
728 #endif
729     for (i = 0; (i < ns); i++)
730     {
731         shell = s[i].shell;
732         if (count == 1)
733         {
734             for (d = 0; d < DIM; d++)
735             {
736                 s[i].step[d] = s[i].k_1;
737 #ifdef PRINT_STEP
738                 step_min = std::min(step_min, s[i].step[d]);
739                 step_max = std::max(step_max, s[i].step[d]);
740 #endif
741             }
742         }
743         else
744         {
745             for (d = 0; d < DIM; d++)
746             {
747                 dx = xcur[shell][d] - s[i].xold[d];
748                 df =    f[shell][d] - s[i].fold[d];
749                 /* -dx/df gets used to generate an interpolated value, but would
750                  * cause a NaN if df were binary-equal to zero. Values close to
751                  * zero won't cause problems (because of the min() and max()), so
752                  * just testing for binary inequality is OK. */
753                 if (zero != df)
754                 {
755                     k_est = -dx/df;
756                     /* Scale the step size by a factor interpolated from
757                      * step_scale_min to step_scale_max, as k_est goes from 0 to
758                      * step_scale_multiple * s[i].step[d] */
759                     s[i].step[d] =
760                         step_scale_min * s[i].step[d] +
761                         step_scale_increment * std::min(step_scale_multiple * s[i].step[d], std::max(k_est, zero));
762                 }
763                 else
764                 {
765                     /* Here 0 == df */
766                     if (gmx_numzero(dx)) /* 0 == dx */
767                     {
768                         /* Likely this will never happen, but if it does just
769                          * don't scale the step. */
770                     }
771                     else /* 0 != dx */
772                     {
773                         s[i].step[d] *= step_scale_max;
774                     }
775                 }
776 #ifdef PRINT_STEP
777                 step_min = std::min(step_min, s[i].step[d]);
778                 step_max = std::max(step_max, s[i].step[d]);
779 #endif
780             }
781         }
782         copy_rvec(xcur [shell], s[i].xold);
783         copy_rvec(f[shell],   s[i].fold);
784
785         do_1pos3(xnew[shell], xcur[shell], f[shell], s[i].step);
786
787         if (gmx_debug_at)
788         {
789             fprintf(debug, "shell[%d] = %d\n", i, shell);
790             pr_rvec(debug, 0, "fshell", f[shell], DIM, TRUE);
791             pr_rvec(debug, 0, "xold", xcur[shell], DIM, TRUE);
792             pr_rvec(debug, 0, "step", s[i].step, DIM, TRUE);
793             pr_rvec(debug, 0, "xnew", xnew[shell], DIM, TRUE);
794         }
795     }
796 #ifdef PRINT_STEP
797     printf("step %.3e %.3e\n", step_min, step_max);
798 #endif
799 }
800
801 static void decrease_step_size(int nshell, t_shell s[])
802 {
803     int i;
804
805     for (i = 0; i < nshell; i++)
806     {
807         svmul(0.8, s[i].step, s[i].step);
808     }
809 }
810
811 static void print_epot(FILE *fp, int64_t mdstep, int count, real epot, real df,
812                        int ndir, real sf_dir)
813 {
814     char buf[22];
815
816     fprintf(fp, "MDStep=%5s/%2d EPot: %12.8e, rmsF: %6.2e",
817             gmx_step_str(mdstep, buf), count, epot, df);
818     if (ndir)
819     {
820         fprintf(fp, ", dir. rmsF: %6.2e\n", std::sqrt(sf_dir/ndir));
821     }
822     else
823     {
824         fprintf(fp, "\n");
825     }
826 }
827
828
829 static real rms_force(const t_commrec *cr, gmx::ArrayRef<const gmx::RVec> force, int ns, t_shell s[],
830                       int ndir, real *sf_dir, real *Epot)
831 {
832     double      buf[4];
833     const rvec *f = as_rvec_array(force.data());
834
835     buf[0] = *sf_dir;
836     for (int i = 0; i < ns; i++)
837     {
838         int shell  = s[i].shell;
839         buf[0]    += norm2(f[shell]);
840     }
841     int ntot = ns;
842
843     if (PAR(cr))
844     {
845         buf[1] = ntot;
846         buf[2] = *sf_dir;
847         buf[3] = *Epot;
848         gmx_sumd(4, buf, cr);
849         ntot    = gmx::roundToInt(buf[1]);
850         *sf_dir = buf[2];
851         *Epot   = buf[3];
852     }
853     ntot += ndir;
854
855     return (ntot ? std::sqrt(buf[0]/ntot) : 0);
856 }
857
858 static void dump_shells(FILE *fp, gmx::ArrayRef<gmx::RVec> f, real ftol, int ns, t_shell s[])
859 {
860     int  i, shell;
861     real ft2, ff2;
862
863     ft2 = gmx::square(ftol);
864
865     for (i = 0; (i < ns); i++)
866     {
867         shell = s[i].shell;
868         ff2   = iprod(f[shell], f[shell]);
869         if (ff2 > ft2)
870         {
871             fprintf(fp, "SHELL %5d, force %10.5f  %10.5f  %10.5f, |f| %10.5f\n",
872                     shell, f[shell][XX], f[shell][YY], f[shell][ZZ], std::sqrt(ff2));
873         }
874     }
875 }
876
877 static void init_adir(gmx_shellfc_t            *shfc,
878                       gmx::Constraints         *constr,
879                       const t_inputrec         *ir,
880                       const t_commrec          *cr,
881                       int                       dd_ac1,
882                       int64_t                   step,
883                       const t_mdatoms          *md,
884                       int                       end,
885                       rvec                     *x_old,
886                       rvec                     *x_init,
887                       rvec                     *x,
888                       rvec                     *f,
889                       rvec                     *acc_dir,
890                       matrix                    box,
891                       gmx::ArrayRef<const real> lambda,
892                       real                     *dvdlambda)
893 {
894     rvec           *xnold, *xnew;
895     double          dt, w_dt;
896     int             n, d;
897     unsigned short *ptype;
898
899     if (DOMAINDECOMP(cr))
900     {
901         n = dd_ac1;
902     }
903     else
904     {
905         n = end;
906     }
907     if (n > shfc->adir_nalloc)
908     {
909         shfc->adir_nalloc = over_alloc_dd(n);
910         srenew(shfc->adir_xnold, shfc->adir_nalloc);
911         srenew(shfc->adir_xnew, shfc->adir_nalloc);
912     }
913     xnold = shfc->adir_xnold;
914     xnew  = shfc->adir_xnew;
915
916     ptype = md->ptype;
917
918     dt = ir->delta_t;
919
920     /* Does NOT work with freeze or acceleration groups (yet) */
921     for (n = 0; n < end; n++)
922     {
923         w_dt = md->invmass[n]*dt;
924
925         for (d = 0; d < DIM; d++)
926         {
927             if ((ptype[n] != eptVSite) && (ptype[n] != eptShell))
928             {
929                 xnold[n][d] = x[n][d] - (x_init[n][d] - x_old[n][d]);
930                 xnew[n][d]  = 2*x[n][d] - x_old[n][d] + f[n][d]*w_dt*dt;
931             }
932             else
933             {
934                 xnold[n][d] = x[n][d];
935                 xnew[n][d]  = x[n][d];
936             }
937         }
938     }
939     constr->apply(FALSE, FALSE, step, 0, 1.0,
940                   x, xnold, nullptr, box,
941                   lambda[efptBONDED], &(dvdlambda[efptBONDED]),
942                   nullptr, nullptr, gmx::ConstraintVariable::Positions);
943     constr->apply(FALSE, FALSE, step, 0, 1.0,
944                   x, xnew, nullptr, box,
945                   lambda[efptBONDED], &(dvdlambda[efptBONDED]),
946                   nullptr, nullptr, gmx::ConstraintVariable::Positions);
947
948     for (n = 0; n < end; n++)
949     {
950         for (d = 0; d < DIM; d++)
951         {
952             xnew[n][d] =
953                 -(2*x[n][d]-xnold[n][d]-xnew[n][d])/gmx::square(dt)
954                 - f[n][d]*md->invmass[n];
955         }
956         clear_rvec(acc_dir[n]);
957     }
958
959     /* Project the acceleration on the old bond directions */
960     constr->apply(FALSE, FALSE, step, 0, 1.0,
961                   x_old, xnew, acc_dir, box,
962                   lambda[efptBONDED], &(dvdlambda[efptBONDED]),
963                   nullptr, nullptr, gmx::ConstraintVariable::Deriv_FlexCon);
964 }
965
966 void relax_shell_flexcon(FILE                                     *fplog,
967                          const t_commrec                          *cr,
968                          const gmx_multisim_t                     *ms,
969                          gmx_bool                                  bVerbose,
970                          gmx_enfrot                               *enforcedRotation,
971                          int64_t                                   mdstep,
972                          const t_inputrec                         *inputrec,
973                          gmx_bool                                  bDoNS,
974                          int                                       force_flags,
975                          gmx_localtop_t                           *top,
976                          gmx::Constraints                         *constr,
977                          gmx_enerdata_t                           *enerd,
978                          t_fcdata                                 *fcd,
979                          t_state                                  *state,
980                          gmx::ArrayRefWithPadding<gmx::RVec>       f,
981                          tensor                                    force_vir,
982                          const t_mdatoms                          *md,
983                          t_nrnb                                   *nrnb,
984                          gmx_wallcycle_t                           wcycle,
985                          t_graph                                  *graph,
986                          const gmx_groups_t                       *groups,
987                          gmx_shellfc_t                            *shfc,
988                          t_forcerec                               *fr,
989                          gmx::PpForceWorkload                     *ppForceWorkload,
990                          double                                    t,
991                          rvec                                      mu_tot,
992                          const gmx_vsite_t                        *vsite,
993                          const DDBalanceRegionHandler             &ddBalanceRegionHandler)
994 {
995     int           nshell;
996     t_shell      *shell;
997     const t_idef *idef;
998     rvec         *acc_dir = nullptr, *x_old = nullptr;
999     real          Epot[2], df[2];
1000     real          sf_dir, invdt;
1001     real          ftol, dum = 0;
1002     char          sbuf[22];
1003     gmx_bool      bCont, bInit, bConverged;
1004     int           nat, dd_ac0, dd_ac1 = 0, i;
1005     int           homenr = md->homenr, end = homenr, cg0, cg1;
1006     int           nflexcon, number_steps, d, Min = 0, count = 0;
1007 #define  Try (1-Min)             /* At start Try = 1 */
1008
1009     bCont        = (mdstep == inputrec->init_step) && inputrec->bContinuation;
1010     bInit        = (mdstep == inputrec->init_step) || shfc->bRequireInit;
1011     ftol         = inputrec->em_tol;
1012     number_steps = inputrec->niter;
1013     nshell       = shfc->nshell;
1014     shell        = shfc->shell;
1015     nflexcon     = shfc->nflexcon;
1016
1017     idef = &top->idef;
1018
1019     if (DOMAINDECOMP(cr))
1020     {
1021         nat = dd_natoms_vsite(cr->dd);
1022         if (nflexcon > 0)
1023         {
1024             dd_get_constraint_range(cr->dd, &dd_ac0, &dd_ac1);
1025             nat = std::max(nat, dd_ac1);
1026         }
1027     }
1028     else
1029     {
1030         nat = state->natoms;
1031     }
1032
1033     for (i = 0; (i < 2); i++)
1034     {
1035         shfc->x[i].resizeWithPadding(nat);
1036         shfc->f[i].resizeWithPadding(nat);
1037     }
1038
1039     /* Create views that we can swap */
1040     gmx::ArrayRefWithPadding<gmx::RVec> posWithPadding[2];
1041     gmx::ArrayRefWithPadding<gmx::RVec> forceWithPadding[2];
1042     gmx::ArrayRef<gmx::RVec>            pos[2];
1043     gmx::ArrayRef<gmx::RVec>            force[2];
1044     for (i = 0; (i < 2); i++)
1045     {
1046         posWithPadding[i]   = shfc->x[i].arrayRefWithPadding();
1047         pos[i]              = posWithPadding[i].paddedArrayRef();
1048         forceWithPadding[i] = shfc->f[i].arrayRefWithPadding();
1049         force[i]            = forceWithPadding[i].paddedArrayRef();
1050     }
1051
1052     if (bDoNS && inputrec->ePBC != epbcNONE && !DOMAINDECOMP(cr))
1053     {
1054         /* This is the only time where the coordinates are used
1055          * before do_force is called, which normally puts all
1056          * charge groups in the box.
1057          */
1058         if (inputrec->cutoff_scheme == ecutsVERLET)
1059         {
1060             auto xRef = state->x.arrayRefWithPadding().paddedArrayRef();
1061             put_atoms_in_box_omp(fr->ePBC, state->box, xRef.subArray(0, md->homenr));
1062         }
1063         else
1064         {
1065             cg0 = 0;
1066             cg1 = top->cgs.nr;
1067             put_charge_groups_in_box(fplog, cg0, cg1, fr->ePBC, state->box,
1068                                      &(top->cgs), state->x.rvec_array(), fr->cg_cm);
1069         }
1070
1071         if (graph)
1072         {
1073             mk_mshift(fplog, graph, fr->ePBC, state->box, state->x.rvec_array());
1074         }
1075     }
1076
1077     /* After this all coordinate arrays will contain whole charge groups */
1078     if (graph)
1079     {
1080         shift_self(graph, state->box, state->x.rvec_array());
1081     }
1082
1083     if (nflexcon)
1084     {
1085         if (nat > shfc->flex_nalloc)
1086         {
1087             shfc->flex_nalloc = over_alloc_dd(nat);
1088             srenew(shfc->acc_dir, shfc->flex_nalloc);
1089             srenew(shfc->x_old, shfc->flex_nalloc);
1090         }
1091         acc_dir = shfc->acc_dir;
1092         x_old   = shfc->x_old;
1093         auto x = makeArrayRef(state->x);
1094         auto v = makeArrayRef(state->v);
1095         for (i = 0; i < homenr; i++)
1096         {
1097             for (d = 0; d < DIM; d++)
1098             {
1099                 shfc->x_old[i][d] =
1100                     x[i][d] - v[i][d]*inputrec->delta_t;
1101             }
1102         }
1103     }
1104
1105     /* Do a prediction of the shell positions, when appropriate.
1106      * Without velocities (EM, NM, BD) we only do initial prediction.
1107      */
1108     if (shfc->bPredict && !bCont && (EI_STATE_VELOCITY(inputrec->eI) || bInit))
1109     {
1110         predict_shells(fplog, state->x.rvec_array(), state->v.rvec_array(), inputrec->delta_t, nshell, shell,
1111                        md->massT, nullptr, bInit);
1112     }
1113
1114     /* do_force expected the charge groups to be in the box */
1115     if (graph)
1116     {
1117         unshift_self(graph, state->box, state->x.rvec_array());
1118     }
1119
1120     /* Calculate the forces first time around */
1121     if (gmx_debug_at)
1122     {
1123         pr_rvecs(debug, 0, "x b4 do_force", state->x.rvec_array(), homenr);
1124     }
1125     int shellfc_flags = force_flags | (bVerbose ? GMX_FORCE_ENERGY : 0);
1126     do_force(fplog, cr, ms, inputrec, nullptr, enforcedRotation,
1127              mdstep, nrnb, wcycle, top, groups,
1128              state->box, state->x.arrayRefWithPadding(), &state->hist,
1129              forceWithPadding[Min], force_vir, md, enerd, fcd,
1130              state->lambda, graph,
1131              fr, ppForceWorkload, vsite, mu_tot, t, nullptr,
1132              (bDoNS ? GMX_FORCE_NS : 0) | shellfc_flags,
1133              ddBalanceRegionHandler);
1134
1135     sf_dir = 0;
1136     if (nflexcon)
1137     {
1138         init_adir(shfc,
1139                   constr, inputrec, cr, dd_ac1, mdstep, md, end,
1140                   shfc->x_old, state->x.rvec_array(), state->x.rvec_array(), as_rvec_array(force[Min].data()),
1141                   shfc->acc_dir,
1142                   state->box, state->lambda, &dum);
1143
1144         for (i = 0; i < end; i++)
1145         {
1146             sf_dir += md->massT[i]*norm2(shfc->acc_dir[i]);
1147         }
1148     }
1149     sum_epot(&(enerd->grpp), enerd->term);
1150     Epot[Min] = enerd->term[F_EPOT];
1151
1152     df[Min] = rms_force(cr, forceWithPadding[Min].paddedArrayRef(), nshell, shell, nflexcon, &sf_dir, &Epot[Min]);
1153     df[Try] = 0;
1154     if (debug)
1155     {
1156         fprintf(debug, "df = %g  %g\n", df[Min], df[Try]);
1157     }
1158
1159     if (gmx_debug_at)
1160     {
1161         pr_rvecs(debug, 0, "force0", as_rvec_array(force[Min].data()), md->nr);
1162     }
1163
1164     if (nshell+nflexcon > 0)
1165     {
1166         /* Copy x to pos[Min] & pos[Try]: during minimization only the
1167          * shell positions are updated, therefore the other particles must
1168          * be set here, in advance.
1169          */
1170         std::copy(state->x.begin(),
1171                   state->x.end(),
1172                   posWithPadding[Min].paddedArrayRef().begin());
1173         std::copy(state->x.begin(),
1174                   state->x.end(),
1175                   posWithPadding[Try].paddedArrayRef().begin());
1176     }
1177
1178     if (bVerbose && MASTER(cr))
1179     {
1180         print_epot(stdout, mdstep, 0, Epot[Min], df[Min], nflexcon, sf_dir);
1181     }
1182
1183     if (debug)
1184     {
1185         fprintf(debug, "%17s: %14.10e\n",
1186                 interaction_function[F_EKIN].longname, enerd->term[F_EKIN]);
1187         fprintf(debug, "%17s: %14.10e\n",
1188                 interaction_function[F_EPOT].longname, enerd->term[F_EPOT]);
1189         fprintf(debug, "%17s: %14.10e\n",
1190                 interaction_function[F_ETOT].longname, enerd->term[F_ETOT]);
1191         fprintf(debug, "SHELLSTEP %s\n", gmx_step_str(mdstep, sbuf));
1192     }
1193
1194     /* First check whether we should do shells, or whether the force is
1195      * low enough even without minimization.
1196      */
1197     bConverged = (df[Min] < ftol);
1198
1199     for (count = 1; (!(bConverged) && (count < number_steps)); count++)
1200     {
1201         if (vsite)
1202         {
1203             construct_vsites(vsite, as_rvec_array(pos[Min].data()),
1204                              inputrec->delta_t, state->v.rvec_array(),
1205                              idef->iparams, idef->il,
1206                              fr->ePBC, fr->bMolPBC, cr, state->box);
1207         }
1208
1209         if (nflexcon)
1210         {
1211             init_adir(shfc,
1212                       constr, inputrec, cr, dd_ac1, mdstep, md, end,
1213                       x_old, state->x.rvec_array(),
1214                       as_rvec_array(pos[Min].data()),
1215                       as_rvec_array(force[Min].data()), acc_dir,
1216                       state->box, state->lambda, &dum);
1217
1218             directional_sd(pos[Min], pos[Try], acc_dir, end, fr->fc_stepsize);
1219         }
1220
1221         /* New positions, Steepest descent */
1222         shell_pos_sd(pos[Min], pos[Try], force[Min], nshell, shell, count);
1223
1224         /* do_force expected the charge groups to be in the box */
1225         if (graph)
1226         {
1227             unshift_self(graph, state->box, as_rvec_array(pos[Try].data()));
1228         }
1229
1230         if (gmx_debug_at)
1231         {
1232             pr_rvecs(debug, 0, "RELAX: pos[Min]  ", as_rvec_array(pos[Min].data()), homenr);
1233             pr_rvecs(debug, 0, "RELAX: pos[Try]  ", as_rvec_array(pos[Try].data()), homenr);
1234         }
1235         /* Try the new positions */
1236         do_force(fplog, cr, ms, inputrec, nullptr, enforcedRotation,
1237                  1, nrnb, wcycle,
1238                  top, groups, state->box, posWithPadding[Try], &state->hist,
1239                  forceWithPadding[Try], force_vir,
1240                  md, enerd, fcd, state->lambda, graph,
1241                  fr, ppForceWorkload, vsite, mu_tot, t, nullptr,
1242                  shellfc_flags,
1243                  ddBalanceRegionHandler);
1244         sum_epot(&(enerd->grpp), enerd->term);
1245         if (gmx_debug_at)
1246         {
1247             pr_rvecs(debug, 0, "RELAX: force[Min]", as_rvec_array(force[Min].data()), homenr);
1248             pr_rvecs(debug, 0, "RELAX: force[Try]", as_rvec_array(force[Try].data()), homenr);
1249         }
1250         sf_dir = 0;
1251         if (nflexcon)
1252         {
1253             init_adir(shfc,
1254                       constr, inputrec, cr, dd_ac1, mdstep, md, end,
1255                       x_old, state->x.rvec_array(),
1256                       as_rvec_array(pos[Try].data()),
1257                       as_rvec_array(force[Try].data()),
1258                       acc_dir, state->box, state->lambda, &dum);
1259
1260             for (i = 0; i < end; i++)
1261             {
1262                 sf_dir += md->massT[i]*norm2(acc_dir[i]);
1263             }
1264         }
1265
1266         Epot[Try] = enerd->term[F_EPOT];
1267
1268         df[Try] = rms_force(cr, force[Try], nshell, shell, nflexcon, &sf_dir, &Epot[Try]);
1269
1270         if (debug)
1271         {
1272             fprintf(debug, "df = %g  %g\n", df[Min], df[Try]);
1273         }
1274
1275         if (debug)
1276         {
1277             if (gmx_debug_at)
1278             {
1279                 pr_rvecs(debug, 0, "F na do_force", as_rvec_array(force[Try].data()), homenr);
1280             }
1281             if (gmx_debug_at)
1282             {
1283                 fprintf(debug, "SHELL ITER %d\n", count);
1284                 dump_shells(debug, force[Try], ftol, nshell, shell);
1285             }
1286         }
1287
1288         if (bVerbose && MASTER(cr))
1289         {
1290             print_epot(stdout, mdstep, count, Epot[Try], df[Try], nflexcon, sf_dir);
1291         }
1292
1293         bConverged = (df[Try] < ftol);
1294
1295         if ((df[Try] < df[Min]))
1296         {
1297             if (debug)
1298             {
1299                 fprintf(debug, "Swapping Min and Try\n");
1300             }
1301             if (nflexcon)
1302             {
1303                 /* Correct the velocities for the flexible constraints */
1304                 invdt = 1/inputrec->delta_t;
1305                 auto v = makeArrayRef(state->v);
1306                 for (i = 0; i < end; i++)
1307                 {
1308                     for (d = 0; d < DIM; d++)
1309                     {
1310                         v[i][d] += (pos[Try][i][d] - pos[Min][i][d])*invdt;
1311                     }
1312                 }
1313             }
1314             Min  = Try;
1315         }
1316         else
1317         {
1318             decrease_step_size(nshell, shell);
1319         }
1320     }
1321     shfc->numForceEvaluations += count;
1322     if (bConverged)
1323     {
1324         shfc->numConvergedIterations++;
1325     }
1326     if (MASTER(cr) && !(bConverged))
1327     {
1328         /* Note that the energies and virial are incorrect when not converged */
1329         if (fplog)
1330         {
1331             fprintf(fplog,
1332                     "step %s: EM did not converge in %d iterations, RMS force %6.2e\n",
1333                     gmx_step_str(mdstep, sbuf), number_steps, df[Min]);
1334         }
1335         fprintf(stderr,
1336                 "step %s: EM did not converge in %d iterations, RMS force %6.2e\n",
1337                 gmx_step_str(mdstep, sbuf), number_steps, df[Min]);
1338     }
1339
1340     /* Copy back the coordinates and the forces */
1341     std::copy(pos[Min].begin(), pos[Min].end(), makeArrayRef(state->x).data());
1342     std::copy(force[Min].begin(), force[Min].end(), f.unpaddedArrayRef().begin());
1343 }
1344
1345 void done_shellfc(FILE *fplog, gmx_shellfc_t *shfc, int64_t numSteps)
1346 {
1347     if (shfc && fplog && numSteps > 0)
1348     {
1349         double numStepsAsDouble = static_cast<double>(numSteps);
1350         fprintf(fplog, "Fraction of iterations that converged:           %.2f %%\n",
1351                 (shfc->numConvergedIterations*100.0)/numStepsAsDouble);
1352         fprintf(fplog, "Average number of force evaluations per MD step: %.2f\n\n",
1353                 shfc->numForceEvaluations/numStepsAsDouble);
1354     }
1355
1356     // TODO Deallocate memory in shfc
1357 }