Add C++ version of t_ilist
[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, 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/mdrun.h"
62 #include "gromacs/mdlib/sim_util.h"
63 #include "gromacs/mdlib/vsite.h"
64 #include "gromacs/mdtypes/commrec.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     PaddedRVecVector *x;                 /* Array for iterative minimization          */
107     PaddedRVecVector *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     const t_atom             *atom;
308
309     int                       ns, nshell, nsi;
310     int                       i, j, type, a_offset, cg, mol, ftype, nra;
311     real                      qS, alpha;
312     int                       aS, aN = 0; /* Shell and nucleus */
313     int                       bondtypes[] = { F_BONDS, F_HARMONIC, F_CUBICBONDS, F_POLARIZATION, F_ANHARM_POL, F_WATER_POL };
314 #define NBT asize(bondtypes)
315     gmx_mtop_atomloop_all_t   aloop;
316     const gmx_ffparams_t     *ffparams;
317
318     std::array<int, eptNR>    n = countPtypes(fplog, mtop);
319     nshell = n[eptShell];
320
321     if (nshell == 0 && nflexcon == 0)
322     {
323         /* We're not doing shells or flexible constraints */
324         return nullptr;
325     }
326
327     snew(shfc, 1);
328     shfc->x        = new PaddedRVecVector[2] {};
329     shfc->f        = new PaddedRVecVector[2] {};
330     shfc->nflexcon = nflexcon;
331
332     if (nshell == 0)
333     {
334         /* Only flexible constraints, no shells.
335          * Note that make_local_shells() does not need to be called.
336          */
337         shfc->nshell   = 0;
338         shfc->bPredict = FALSE;
339
340         return shfc;
341     }
342
343     if (nstcalcenergy != 1)
344     {
345         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);
346     }
347     if (usingDomainDecomposition)
348     {
349         gmx_fatal(FARGS, "Shell particles are not implemented with domain decomposition, use a single rank");
350     }
351
352     /* We have shells: fill the shell data structure */
353
354     /* Global system sized array, this should be avoided */
355     snew(shell_index, mtop->natoms);
356
357     aloop  = gmx_mtop_atomloop_all_init(mtop);
358     nshell = 0;
359     while (gmx_mtop_atomloop_all_next(aloop, &i, &atom))
360     {
361         if (atom->ptype == eptShell)
362         {
363             shell_index[i] = nshell++;
364         }
365     }
366
367     snew(shell, nshell);
368
369     /* Initiate the shell structures */
370     for (i = 0; (i < nshell); i++)
371     {
372         shell[i].shell = -1;
373         shell[i].nnucl = 0;
374         shell[i].nucl1 = -1;
375         shell[i].nucl2 = -1;
376         shell[i].nucl3 = -1;
377         /* shell[i].bInterCG=FALSE; */
378         shell[i].k_1   = 0;
379         shell[i].k     = 0;
380     }
381
382     ffparams = &mtop->ffparams;
383
384     /* Now fill the structures */
385     shfc->bInterCG = FALSE;
386     ns             = 0;
387     a_offset       = 0;
388     for (size_t mb = 0; mb < mtop->molblock.size(); mb++)
389     {
390         const gmx_molblock_t *molb = &mtop->molblock[mb];
391         const gmx_moltype_t  *molt = &mtop->moltype[molb->type];
392         const t_block        *cgs  = &molt->cgs;
393
394         snew(at2cg, molt->atoms.nr);
395         for (cg = 0; cg < cgs->nr; cg++)
396         {
397             for (i = cgs->index[cg]; i < cgs->index[cg+1]; i++)
398             {
399                 at2cg[i] = cg;
400             }
401         }
402
403         atom = molt->atoms.atom;
404         for (mol = 0; mol < molb->nmol; mol++)
405         {
406             for (j = 0; (j < NBT); j++)
407             {
408                 const int *ia = molt->ilist[bondtypes[j]].iatoms.data();
409                 for (i = 0; (i < molt->ilist[bondtypes[j]].size()); )
410                 {
411                     type  = ia[0];
412                     ftype = ffparams->functype[type];
413                     nra   = interaction_function[ftype].nratoms;
414
415                     /* Check whether we have a bond with a shell */
416                     aS = -1;
417
418                     switch (bondtypes[j])
419                     {
420                         case F_BONDS:
421                         case F_HARMONIC:
422                         case F_CUBICBONDS:
423                         case F_POLARIZATION:
424                         case F_ANHARM_POL:
425                             if (atom[ia[1]].ptype == eptShell)
426                             {
427                                 aS = ia[1];
428                                 aN = ia[2];
429                             }
430                             else if (atom[ia[2]].ptype == eptShell)
431                             {
432                                 aS = ia[2];
433                                 aN = ia[1];
434                             }
435                             break;
436                         case F_WATER_POL:
437                             aN    = ia[4]; /* Dummy */
438                             aS    = ia[5]; /* Shell */
439                             break;
440                         default:
441                             gmx_fatal(FARGS, "Death Horror: %s, %d", __FILE__, __LINE__);
442                     }
443
444                     if (aS != -1)
445                     {
446                         qS = atom[aS].q;
447
448                         /* Check whether one of the particles is a shell... */
449                         nsi = shell_index[a_offset+aS];
450                         if ((nsi < 0) || (nsi >= nshell))
451                         {
452                             gmx_fatal(FARGS, "nsi is %d should be within 0 - %d. aS = %d",
453                                       nsi, nshell, aS);
454                         }
455                         if (shell[nsi].shell == -1)
456                         {
457                             shell[nsi].shell = a_offset + aS;
458                             ns++;
459                         }
460                         else if (shell[nsi].shell != a_offset+aS)
461                         {
462                             gmx_fatal(FARGS, "Weird stuff in %s, %d", __FILE__, __LINE__);
463                         }
464
465                         if      (shell[nsi].nucl1 == -1)
466                         {
467                             shell[nsi].nucl1 = a_offset + aN;
468                         }
469                         else if (shell[nsi].nucl2 == -1)
470                         {
471                             shell[nsi].nucl2 = a_offset + aN;
472                         }
473                         else if (shell[nsi].nucl3 == -1)
474                         {
475                             shell[nsi].nucl3 = a_offset + aN;
476                         }
477                         else
478                         {
479                             if (fplog)
480                             {
481                                 pr_shell(fplog, ns, shell);
482                             }
483                             gmx_fatal(FARGS, "Can not handle more than three bonds per shell\n");
484                         }
485                         if (at2cg[aS] != at2cg[aN])
486                         {
487                             /* shell[nsi].bInterCG = TRUE; */
488                             shfc->bInterCG = TRUE;
489                         }
490
491                         switch (bondtypes[j])
492                         {
493                             case F_BONDS:
494                             case F_HARMONIC:
495                                 shell[nsi].k    += ffparams->iparams[type].harmonic.krA;
496                                 break;
497                             case F_CUBICBONDS:
498                                 shell[nsi].k    += ffparams->iparams[type].cubic.kb;
499                                 break;
500                             case F_POLARIZATION:
501                             case F_ANHARM_POL:
502                                 if (!gmx_within_tol(qS, atom[aS].qB, GMX_REAL_EPS*10))
503                                 {
504                                     gmx_fatal(FARGS, "polarize can not be used with qA(%e) != qB(%e) for atom %d of molecule block %lu", qS, atom[aS].qB, aS+1, mb+1);
505                                 }
506                                 shell[nsi].k    += gmx::square(qS)*ONE_4PI_EPS0/
507                                     ffparams->iparams[type].polarize.alpha;
508                                 break;
509                             case F_WATER_POL:
510                                 if (!gmx_within_tol(qS, atom[aS].qB, GMX_REAL_EPS*10))
511                                 {
512                                     gmx_fatal(FARGS, "water_pol can not be used with qA(%e) != qB(%e) for atom %d of molecule block %lu", qS, atom[aS].qB, aS+1, mb+1);
513                                 }
514                                 alpha          = (ffparams->iparams[type].wpol.al_x+
515                                                   ffparams->iparams[type].wpol.al_y+
516                                                   ffparams->iparams[type].wpol.al_z)/3.0;
517                                 shell[nsi].k  += gmx::square(qS)*ONE_4PI_EPS0/alpha;
518                                 break;
519                             default:
520                                 gmx_fatal(FARGS, "Death Horror: %s, %d", __FILE__, __LINE__);
521                         }
522                         shell[nsi].nnucl++;
523                     }
524                     ia += nra+1;
525                     i  += nra+1;
526                 }
527             }
528             a_offset += molt->atoms.nr;
529         }
530         /* Done with this molecule type */
531         sfree(at2cg);
532     }
533
534     /* Verify whether it's all correct */
535     if (ns != nshell)
536     {
537         gmx_fatal(FARGS, "Something weird with shells. They may not be bonded to something");
538     }
539
540     for (i = 0; (i < ns); i++)
541     {
542         shell[i].k_1 = 1.0/shell[i].k;
543     }
544
545     if (debug)
546     {
547         pr_shell(debug, ns, shell);
548     }
549
550
551     shfc->nshell_gl      = ns;
552     shfc->shell_gl       = shell;
553     shfc->shell_index_gl = shell_index;
554
555     shfc->bPredict     = (getenv("GMX_NOPREDICT") == nullptr);
556     shfc->bRequireInit = FALSE;
557     if (!shfc->bPredict)
558     {
559         if (fplog)
560         {
561             fprintf(fplog, "\nWill never predict shell positions\n");
562         }
563     }
564     else
565     {
566         shfc->bRequireInit = (getenv("GMX_REQUIRE_SHELL_INIT") != nullptr);
567         if (shfc->bRequireInit && fplog)
568         {
569             fprintf(fplog, "\nWill always initiate shell positions\n");
570         }
571     }
572
573     if (shfc->bPredict)
574     {
575         if (shfc->bInterCG)
576         {
577             if (fplog)
578             {
579                 fprintf(fplog, "\nNOTE: there all shells that are connected to particles outside thier own charge group, will not predict shells positions during the run\n\n");
580             }
581             /* Prediction improves performance, so we should implement either:
582              * 1. communication for the atoms needed for prediction
583              * 2. prediction using the velocities of shells; currently the
584              *    shell velocities are zeroed, it's a bit tricky to keep
585              *    track of the shell displacements and thus the velocity.
586              */
587             shfc->bPredict = FALSE;
588         }
589     }
590
591     return shfc;
592 }
593
594 void make_local_shells(const t_commrec *cr,
595                        const t_mdatoms *md,
596                        gmx_shellfc_t   *shfc)
597 {
598     t_shell      *shell;
599     int           a0, a1, *ind, nshell, i;
600     gmx_domdec_t *dd = nullptr;
601
602     if (DOMAINDECOMP(cr))
603     {
604         dd = cr->dd;
605         a0 = 0;
606         a1 = dd_numHomeAtoms(*dd);
607     }
608     else
609     {
610         /* Single node: we need all shells, just copy the pointer */
611         shfc->nshell = shfc->nshell_gl;
612         shfc->shell  = shfc->shell_gl;
613
614         return;
615     }
616
617     ind = shfc->shell_index_gl;
618
619     nshell = 0;
620     shell  = shfc->shell;
621     for (i = a0; i < a1; i++)
622     {
623         if (md->ptype[i] == eptShell)
624         {
625             if (nshell+1 > shfc->shell_nalloc)
626             {
627                 shfc->shell_nalloc = over_alloc_dd(nshell+1);
628                 srenew(shell, shfc->shell_nalloc);
629             }
630             if (dd)
631             {
632                 shell[nshell] = shfc->shell_gl[ind[dd->globalAtomIndices[i]]];
633             }
634             else
635             {
636                 shell[nshell] = shfc->shell_gl[ind[i]];
637             }
638
639             /* With inter-cg shells we can no do shell prediction,
640              * so we do not need the nuclei numbers.
641              */
642             if (!shfc->bInterCG)
643             {
644                 shell[nshell].nucl1   = i + shell[nshell].nucl1 - shell[nshell].shell;
645                 if (shell[nshell].nnucl > 1)
646                 {
647                     shell[nshell].nucl2 = i + shell[nshell].nucl2 - shell[nshell].shell;
648                 }
649                 if (shell[nshell].nnucl > 2)
650                 {
651                     shell[nshell].nucl3 = i + shell[nshell].nucl3 - shell[nshell].shell;
652                 }
653             }
654             shell[nshell].shell = i;
655             nshell++;
656         }
657     }
658
659     shfc->nshell = nshell;
660     shfc->shell  = shell;
661 }
662
663 static void do_1pos(rvec xnew, const rvec xold, const rvec f, real step)
664 {
665     real xo, yo, zo;
666     real dx, dy, dz;
667
668     xo = xold[XX];
669     yo = xold[YY];
670     zo = xold[ZZ];
671
672     dx = f[XX]*step;
673     dy = f[YY]*step;
674     dz = f[ZZ]*step;
675
676     xnew[XX] = xo+dx;
677     xnew[YY] = yo+dy;
678     xnew[ZZ] = zo+dz;
679 }
680
681 static void do_1pos3(rvec xnew, const rvec xold, const rvec f, const rvec step)
682 {
683     real xo, yo, zo;
684     real dx, dy, dz;
685
686     xo = xold[XX];
687     yo = xold[YY];
688     zo = xold[ZZ];
689
690     dx = f[XX]*step[XX];
691     dy = f[YY]*step[YY];
692     dz = f[ZZ]*step[ZZ];
693
694     xnew[XX] = xo+dx;
695     xnew[YY] = yo+dy;
696     xnew[ZZ] = zo+dz;
697 }
698
699 static void directional_sd(gmx::ArrayRef<const gmx::RVec> xold,
700                            gmx::ArrayRef<gmx::RVec> xnew,
701                            const rvec acc_dir[], int homenr, real step)
702 {
703     const rvec *xo = as_rvec_array(xold.data());
704     rvec       *xn = as_rvec_array(xnew.data());
705
706     for (int i = 0; i < homenr; i++)
707     {
708         do_1pos(xn[i], xo[i], acc_dir[i], step);
709     }
710 }
711
712 static void shell_pos_sd(gmx::ArrayRef<const gmx::RVec> xcur,
713                          gmx::ArrayRef<gmx::RVec> xnew,
714                          gmx::ArrayRef<const gmx::RVec> f,
715                          int ns, t_shell s[], int count)
716 {
717     const real step_scale_min       = 0.8,
718                step_scale_increment = 0.2,
719                step_scale_max       = 1.2,
720                step_scale_multiple  = (step_scale_max - step_scale_min) / step_scale_increment;
721     int        i, shell, d;
722     real       dx, df, k_est;
723     const real zero = 0;
724 #ifdef PRINT_STEP
725     real       step_min, step_max;
726
727     step_min = 1e30;
728     step_max = 0;
729 #endif
730     for (i = 0; (i < ns); i++)
731     {
732         shell = s[i].shell;
733         if (count == 1)
734         {
735             for (d = 0; d < DIM; d++)
736             {
737                 s[i].step[d] = s[i].k_1;
738 #ifdef PRINT_STEP
739                 step_min = std::min(step_min, s[i].step[d]);
740                 step_max = std::max(step_max, s[i].step[d]);
741 #endif
742             }
743         }
744         else
745         {
746             for (d = 0; d < DIM; d++)
747             {
748                 dx = xcur[shell][d] - s[i].xold[d];
749                 df =    f[shell][d] - s[i].fold[d];
750                 /* -dx/df gets used to generate an interpolated value, but would
751                  * cause a NaN if df were binary-equal to zero. Values close to
752                  * zero won't cause problems (because of the min() and max()), so
753                  * just testing for binary inequality is OK. */
754                 if (zero != df)
755                 {
756                     k_est = -dx/df;
757                     /* Scale the step size by a factor interpolated from
758                      * step_scale_min to step_scale_max, as k_est goes from 0 to
759                      * step_scale_multiple * s[i].step[d] */
760                     s[i].step[d] =
761                         step_scale_min * s[i].step[d] +
762                         step_scale_increment * std::min(step_scale_multiple * s[i].step[d], std::max(k_est, zero));
763                 }
764                 else
765                 {
766                     /* Here 0 == df */
767                     if (gmx_numzero(dx)) /* 0 == dx */
768                     {
769                         /* Likely this will never happen, but if it does just
770                          * don't scale the step. */
771                     }
772                     else /* 0 != dx */
773                     {
774                         s[i].step[d] *= step_scale_max;
775                     }
776                 }
777 #ifdef PRINT_STEP
778                 step_min = std::min(step_min, s[i].step[d]);
779                 step_max = std::max(step_max, s[i].step[d]);
780 #endif
781             }
782         }
783         copy_rvec(xcur [shell], s[i].xold);
784         copy_rvec(f[shell],   s[i].fold);
785
786         do_1pos3(xnew[shell], xcur[shell], f[shell], s[i].step);
787
788         if (gmx_debug_at)
789         {
790             fprintf(debug, "shell[%d] = %d\n", i, shell);
791             pr_rvec(debug, 0, "fshell", f[shell], DIM, TRUE);
792             pr_rvec(debug, 0, "xold", xcur[shell], DIM, TRUE);
793             pr_rvec(debug, 0, "step", s[i].step, DIM, TRUE);
794             pr_rvec(debug, 0, "xnew", xnew[shell], DIM, TRUE);
795         }
796     }
797 #ifdef PRINT_STEP
798     printf("step %.3e %.3e\n", step_min, step_max);
799 #endif
800 }
801
802 static void decrease_step_size(int nshell, t_shell s[])
803 {
804     int i;
805
806     for (i = 0; i < nshell; i++)
807     {
808         svmul(0.8, s[i].step, s[i].step);
809     }
810 }
811
812 static void print_epot(FILE *fp, int64_t mdstep, int count, real epot, real df,
813                        int ndir, real sf_dir)
814 {
815     char buf[22];
816
817     fprintf(fp, "MDStep=%5s/%2d EPot: %12.8e, rmsF: %6.2e",
818             gmx_step_str(mdstep, buf), count, epot, df);
819     if (ndir)
820     {
821         fprintf(fp, ", dir. rmsF: %6.2e\n", std::sqrt(sf_dir/ndir));
822     }
823     else
824     {
825         fprintf(fp, "\n");
826     }
827 }
828
829
830 static real rms_force(const t_commrec *cr, gmx::ArrayRef<const gmx::RVec> force, int ns, t_shell s[],
831                       int ndir, real *sf_dir, real *Epot)
832 {
833     double      buf[4];
834     const rvec *f = as_rvec_array(force.data());
835
836     buf[0] = *sf_dir;
837     for (int i = 0; i < ns; i++)
838     {
839         int shell  = s[i].shell;
840         buf[0]    += norm2(f[shell]);
841     }
842     int ntot = ns;
843
844     if (PAR(cr))
845     {
846         buf[1] = ntot;
847         buf[2] = *sf_dir;
848         buf[3] = *Epot;
849         gmx_sumd(4, buf, cr);
850         ntot    = gmx::roundToInt(buf[1]);
851         *sf_dir = buf[2];
852         *Epot   = buf[3];
853     }
854     ntot += ndir;
855
856     return (ntot ? std::sqrt(buf[0]/ntot) : 0);
857 }
858
859 static void check_pbc(FILE *fp, gmx::ArrayRef<gmx::RVec> x, int shell)
860 {
861     int m, now;
862
863     now = shell-4;
864     for (m = 0; (m < DIM); m++)
865     {
866         if (std::fabs(x[shell][m]-x[now][m]) > 0.3)
867         {
868             pr_rvecs(fp, 0, "SHELL-X", as_rvec_array(x.data())+now, 5);
869             break;
870         }
871     }
872 }
873
874 static void dump_shells(FILE *fp, gmx::ArrayRef<gmx::RVec> x, gmx::ArrayRef<gmx::RVec> f, real ftol, int ns, t_shell s[])
875 {
876     int  i, shell;
877     real ft2, ff2;
878
879     ft2 = gmx::square(ftol);
880
881     for (i = 0; (i < ns); i++)
882     {
883         shell = s[i].shell;
884         ff2   = iprod(f[shell], f[shell]);
885         if (ff2 > ft2)
886         {
887             fprintf(fp, "SHELL %5d, force %10.5f  %10.5f  %10.5f, |f| %10.5f\n",
888                     shell, f[shell][XX], f[shell][YY], f[shell][ZZ], std::sqrt(ff2));
889         }
890         check_pbc(fp, x, shell);
891     }
892 }
893
894 static void init_adir(gmx_shellfc_t            *shfc,
895                       gmx::Constraints         *constr,
896                       const t_inputrec         *ir,
897                       const t_commrec          *cr,
898                       int                       dd_ac1,
899                       int64_t                   step,
900                       const t_mdatoms          *md,
901                       int                       end,
902                       rvec                     *x_old,
903                       rvec                     *x_init,
904                       rvec                     *x,
905                       rvec                     *f,
906                       rvec                     *acc_dir,
907                       matrix                    box,
908                       gmx::ArrayRef<const real> lambda,
909                       real                     *dvdlambda)
910 {
911     rvec           *xnold, *xnew;
912     double          dt, w_dt;
913     int             n, d;
914     unsigned short *ptype;
915
916     if (DOMAINDECOMP(cr))
917     {
918         n = dd_ac1;
919     }
920     else
921     {
922         n = end;
923     }
924     if (n > shfc->adir_nalloc)
925     {
926         shfc->adir_nalloc = over_alloc_dd(n);
927         srenew(shfc->adir_xnold, shfc->adir_nalloc);
928         srenew(shfc->adir_xnew, shfc->adir_nalloc);
929     }
930     xnold = shfc->adir_xnold;
931     xnew  = shfc->adir_xnew;
932
933     ptype = md->ptype;
934
935     dt = ir->delta_t;
936
937     /* Does NOT work with freeze or acceleration groups (yet) */
938     for (n = 0; n < end; n++)
939     {
940         w_dt = md->invmass[n]*dt;
941
942         for (d = 0; d < DIM; d++)
943         {
944             if ((ptype[n] != eptVSite) && (ptype[n] != eptShell))
945             {
946                 xnold[n][d] = x[n][d] - (x_init[n][d] - x_old[n][d]);
947                 xnew[n][d]  = 2*x[n][d] - x_old[n][d] + f[n][d]*w_dt*dt;
948             }
949             else
950             {
951                 xnold[n][d] = x[n][d];
952                 xnew[n][d]  = x[n][d];
953             }
954         }
955     }
956     constr->apply(FALSE, FALSE, step, 0, 1.0,
957                   x, xnold, nullptr, box,
958                   lambda[efptBONDED], &(dvdlambda[efptBONDED]),
959                   nullptr, nullptr, gmx::ConstraintVariable::Positions);
960     constr->apply(FALSE, FALSE, step, 0, 1.0,
961                   x, xnew, nullptr, box,
962                   lambda[efptBONDED], &(dvdlambda[efptBONDED]),
963                   nullptr, nullptr, gmx::ConstraintVariable::Positions);
964
965     for (n = 0; n < end; n++)
966     {
967         for (d = 0; d < DIM; d++)
968         {
969             xnew[n][d] =
970                 -(2*x[n][d]-xnold[n][d]-xnew[n][d])/gmx::square(dt)
971                 - f[n][d]*md->invmass[n];
972         }
973         clear_rvec(acc_dir[n]);
974     }
975
976     /* Project the acceleration on the old bond directions */
977     constr->apply(FALSE, FALSE, step, 0, 1.0,
978                   x_old, xnew, acc_dir, box,
979                   lambda[efptBONDED], &(dvdlambda[efptBONDED]),
980                   nullptr, nullptr, gmx::ConstraintVariable::Deriv_FlexCon);
981 }
982
983 void relax_shell_flexcon(FILE                                     *fplog,
984                          const t_commrec                          *cr,
985                          const gmx_multisim_t                     *ms,
986                          gmx_bool                                  bVerbose,
987                          gmx_enfrot                               *enforcedRotation,
988                          int64_t                                   mdstep,
989                          const t_inputrec                         *inputrec,
990                          gmx_bool                                  bDoNS,
991                          int                                       force_flags,
992                          gmx_localtop_t                           *top,
993                          gmx::Constraints                         *constr,
994                          gmx_enerdata_t                           *enerd,
995                          t_fcdata                                 *fcd,
996                          t_state                                  *state,
997                          gmx::PaddedArrayRef<gmx::RVec>            f,
998                          tensor                                    force_vir,
999                          const t_mdatoms                          *md,
1000                          t_nrnb                                   *nrnb,
1001                          gmx_wallcycle_t                           wcycle,
1002                          t_graph                                  *graph,
1003                          const gmx_groups_t                       *groups,
1004                          gmx_shellfc_t                            *shfc,
1005                          t_forcerec                               *fr,
1006                          double                                    t,
1007                          rvec                                      mu_tot,
1008                          const gmx_vsite_t                        *vsite,
1009                          DdOpenBalanceRegionBeforeForceComputation ddOpenBalanceRegion,
1010                          DdCloseBalanceRegionAfterForceComputation ddCloseBalanceRegion)
1011 {
1012     int           nshell;
1013     t_shell      *shell;
1014     const t_idef *idef;
1015     rvec         *acc_dir = nullptr, *x_old = nullptr;
1016     real          Epot[2], df[2];
1017     real          sf_dir, invdt;
1018     real          ftol, dum = 0;
1019     char          sbuf[22];
1020     gmx_bool      bCont, bInit, bConverged;
1021     int           nat, dd_ac0, dd_ac1 = 0, i;
1022     int           homenr = md->homenr, end = homenr, cg0, cg1;
1023     int           nflexcon, number_steps, d, Min = 0, count = 0;
1024 #define  Try (1-Min)             /* At start Try = 1 */
1025
1026     bCont        = (mdstep == inputrec->init_step) && inputrec->bContinuation;
1027     bInit        = (mdstep == inputrec->init_step) || shfc->bRequireInit;
1028     ftol         = inputrec->em_tol;
1029     number_steps = inputrec->niter;
1030     nshell       = shfc->nshell;
1031     shell        = shfc->shell;
1032     nflexcon     = shfc->nflexcon;
1033
1034     idef = &top->idef;
1035
1036     if (DOMAINDECOMP(cr))
1037     {
1038         nat = dd_natoms_vsite(cr->dd);
1039         if (nflexcon > 0)
1040         {
1041             dd_get_constraint_range(cr->dd, &dd_ac0, &dd_ac1);
1042             nat = std::max(nat, dd_ac1);
1043         }
1044     }
1045     else
1046     {
1047         nat = state->natoms;
1048     }
1049
1050     for (i = 0; (i < 2); i++)
1051     {
1052         shfc->x[i].resize(gmx::paddedRVecVectorSize(nat));
1053         shfc->f[i].resize(gmx::paddedRVecVectorSize(nat));
1054     }
1055
1056     /* Create views that we can swap */
1057     gmx::PaddedArrayRef<gmx::RVec> pos[2];
1058     gmx::PaddedArrayRef<gmx::RVec> force[2];
1059     for (i = 0; (i < 2); i++)
1060     {
1061         pos[i]   = shfc->x[i];
1062         force[i] = shfc->f[i];
1063     }
1064
1065     if (bDoNS && inputrec->ePBC != epbcNONE && !DOMAINDECOMP(cr))
1066     {
1067         /* This is the only time where the coordinates are used
1068          * before do_force is called, which normally puts all
1069          * charge groups in the box.
1070          */
1071         if (inputrec->cutoff_scheme == ecutsVERLET)
1072         {
1073             auto xRef = makeArrayRef(state->x);
1074             put_atoms_in_box_omp(fr->ePBC, state->box, xRef.subArray(0, md->homenr));
1075         }
1076         else
1077         {
1078             cg0 = 0;
1079             cg1 = top->cgs.nr;
1080             put_charge_groups_in_box(fplog, cg0, cg1, fr->ePBC, state->box,
1081                                      &(top->cgs), as_rvec_array(state->x.data()), fr->cg_cm);
1082         }
1083
1084         if (graph)
1085         {
1086             mk_mshift(fplog, graph, fr->ePBC, state->box, as_rvec_array(state->x.data()));
1087         }
1088     }
1089
1090     /* After this all coordinate arrays will contain whole charge groups */
1091     if (graph)
1092     {
1093         shift_self(graph, state->box, as_rvec_array(state->x.data()));
1094     }
1095
1096     if (nflexcon)
1097     {
1098         if (nat > shfc->flex_nalloc)
1099         {
1100             shfc->flex_nalloc = over_alloc_dd(nat);
1101             srenew(shfc->acc_dir, shfc->flex_nalloc);
1102             srenew(shfc->x_old, shfc->flex_nalloc);
1103         }
1104         acc_dir = shfc->acc_dir;
1105         x_old   = shfc->x_old;
1106         for (i = 0; i < homenr; i++)
1107         {
1108             for (d = 0; d < DIM; d++)
1109             {
1110                 shfc->x_old[i][d] =
1111                     state->x[i][d] - state->v[i][d]*inputrec->delta_t;
1112             }
1113         }
1114     }
1115
1116     /* Do a prediction of the shell positions, when appropriate.
1117      * Without velocities (EM, NM, BD) we only do initial prediction.
1118      */
1119     if (shfc->bPredict && !bCont && (EI_STATE_VELOCITY(inputrec->eI) || bInit))
1120     {
1121         predict_shells(fplog, as_rvec_array(state->x.data()), as_rvec_array(state->v.data()), inputrec->delta_t, nshell, shell,
1122                        md->massT, nullptr, bInit);
1123     }
1124
1125     /* do_force expected the charge groups to be in the box */
1126     if (graph)
1127     {
1128         unshift_self(graph, state->box, as_rvec_array(state->x.data()));
1129     }
1130
1131     /* Calculate the forces first time around */
1132     if (gmx_debug_at)
1133     {
1134         pr_rvecs(debug, 0, "x b4 do_force", as_rvec_array(state->x.data()), homenr);
1135     }
1136     do_force(fplog, cr, ms, inputrec, nullptr, enforcedRotation,
1137              mdstep, nrnb, wcycle, top, groups,
1138              state->box, state->x, &state->hist,
1139              force[Min], force_vir, md, enerd, fcd,
1140              state->lambda, graph,
1141              fr, vsite, mu_tot, t, nullptr,
1142              (bDoNS ? GMX_FORCE_NS : 0) | force_flags,
1143              ddOpenBalanceRegion, ddCloseBalanceRegion);
1144
1145     sf_dir = 0;
1146     if (nflexcon)
1147     {
1148         init_adir(shfc,
1149                   constr, inputrec, cr, dd_ac1, mdstep, md, end,
1150                   shfc->x_old, as_rvec_array(state->x.data()), as_rvec_array(state->x.data()), as_rvec_array(force[Min].data()),
1151                   shfc->acc_dir,
1152                   state->box, state->lambda, &dum);
1153
1154         for (i = 0; i < end; i++)
1155         {
1156             sf_dir += md->massT[i]*norm2(shfc->acc_dir[i]);
1157         }
1158     }
1159
1160     Epot[Min] = enerd->term[F_EPOT];
1161
1162     df[Min] = rms_force(cr, shfc->f[Min], nshell, shell, nflexcon, &sf_dir, &Epot[Min]);
1163     df[Try] = 0;
1164     if (debug)
1165     {
1166         fprintf(debug, "df = %g  %g\n", df[Min], df[Try]);
1167     }
1168
1169     if (gmx_debug_at)
1170     {
1171         pr_rvecs(debug, 0, "force0", as_rvec_array(force[Min].data()), md->nr);
1172     }
1173
1174     if (nshell+nflexcon > 0)
1175     {
1176         /* Copy x to pos[Min] & pos[Try]: during minimization only the
1177          * shell positions are updated, therefore the other particles must
1178          * be set here.
1179          */
1180         pos[Min] = state->x;
1181         pos[Try] = state->x;
1182     }
1183
1184     if (bVerbose && MASTER(cr))
1185     {
1186         print_epot(stdout, mdstep, 0, Epot[Min], df[Min], nflexcon, sf_dir);
1187     }
1188
1189     if (debug)
1190     {
1191         fprintf(debug, "%17s: %14.10e\n",
1192                 interaction_function[F_EKIN].longname, enerd->term[F_EKIN]);
1193         fprintf(debug, "%17s: %14.10e\n",
1194                 interaction_function[F_EPOT].longname, enerd->term[F_EPOT]);
1195         fprintf(debug, "%17s: %14.10e\n",
1196                 interaction_function[F_ETOT].longname, enerd->term[F_ETOT]);
1197         fprintf(debug, "SHELLSTEP %s\n", gmx_step_str(mdstep, sbuf));
1198     }
1199
1200     /* First check whether we should do shells, or whether the force is
1201      * low enough even without minimization.
1202      */
1203     bConverged = (df[Min] < ftol);
1204
1205     for (count = 1; (!(bConverged) && (count < number_steps)); count++)
1206     {
1207         if (vsite)
1208         {
1209             construct_vsites(vsite, as_rvec_array(pos[Min].data()),
1210                              inputrec->delta_t, as_rvec_array(state->v.data()),
1211                              idef->iparams, idef->il,
1212                              fr->ePBC, fr->bMolPBC, cr, state->box);
1213         }
1214
1215         if (nflexcon)
1216         {
1217             init_adir(shfc,
1218                       constr, inputrec, cr, dd_ac1, mdstep, md, end,
1219                       x_old, as_rvec_array(state->x.data()), as_rvec_array(pos[Min].data()), as_rvec_array(force[Min].data()), acc_dir,
1220                       state->box, state->lambda, &dum);
1221
1222             directional_sd(pos[Min], pos[Try], acc_dir, end, fr->fc_stepsize);
1223         }
1224
1225         /* New positions, Steepest descent */
1226         shell_pos_sd(pos[Min], pos[Try], force[Min], nshell, shell, count);
1227
1228         /* do_force expected the charge groups to be in the box */
1229         if (graph)
1230         {
1231             unshift_self(graph, state->box, as_rvec_array(pos[Try].data()));
1232         }
1233
1234         if (gmx_debug_at)
1235         {
1236             pr_rvecs(debug, 0, "RELAX: pos[Min]  ", as_rvec_array(pos[Min].data()), homenr);
1237             pr_rvecs(debug, 0, "RELAX: pos[Try]  ", as_rvec_array(pos[Try].data()), homenr);
1238         }
1239         /* Try the new positions */
1240         do_force(fplog, cr, ms, inputrec, nullptr, enforcedRotation,
1241                  1, nrnb, wcycle,
1242                  top, groups, state->box, pos[Try], &state->hist,
1243                  force[Try], force_vir,
1244                  md, enerd, fcd, state->lambda, graph,
1245                  fr, vsite, mu_tot, t, nullptr,
1246                  force_flags,
1247                  ddOpenBalanceRegion, ddCloseBalanceRegion);
1248
1249         if (gmx_debug_at)
1250         {
1251             pr_rvecs(debug, 0, "RELAX: force[Min]", as_rvec_array(force[Min].data()), homenr);
1252             pr_rvecs(debug, 0, "RELAX: force[Try]", as_rvec_array(force[Try].data()), homenr);
1253         }
1254         sf_dir = 0;
1255         if (nflexcon)
1256         {
1257             init_adir(shfc,
1258                       constr, inputrec, cr, dd_ac1, mdstep, md, end,
1259                       x_old, as_rvec_array(state->x.data()), as_rvec_array(pos[Try].data()), as_rvec_array(force[Try].data()), acc_dir,
1260                       state->box, state->lambda, &dum);
1261
1262             for (i = 0; i < end; i++)
1263             {
1264                 sf_dir += md->massT[i]*norm2(acc_dir[i]);
1265             }
1266         }
1267
1268         Epot[Try] = enerd->term[F_EPOT];
1269
1270         df[Try] = rms_force(cr, force[Try], nshell, shell, nflexcon, &sf_dir, &Epot[Try]);
1271
1272         if (debug)
1273         {
1274             fprintf(debug, "df = %g  %g\n", df[Min], df[Try]);
1275         }
1276
1277         if (debug)
1278         {
1279             if (gmx_debug_at)
1280             {
1281                 pr_rvecs(debug, 0, "F na do_force", as_rvec_array(force[Try].data()), homenr);
1282             }
1283             if (gmx_debug_at)
1284             {
1285                 fprintf(debug, "SHELL ITER %d\n", count);
1286                 dump_shells(debug, pos[Try], force[Try], ftol, nshell, shell);
1287             }
1288         }
1289
1290         if (bVerbose && MASTER(cr))
1291         {
1292             print_epot(stdout, mdstep, count, Epot[Try], df[Try], nflexcon, sf_dir);
1293         }
1294
1295         bConverged = (df[Try] < ftol);
1296
1297         if ((df[Try] < df[Min]))
1298         {
1299             if (debug)
1300             {
1301                 fprintf(debug, "Swapping Min and Try\n");
1302             }
1303             if (nflexcon)
1304             {
1305                 /* Correct the velocities for the flexible constraints */
1306                 invdt = 1/inputrec->delta_t;
1307                 for (i = 0; i < end; i++)
1308                 {
1309                     for (d = 0; d < DIM; d++)
1310                     {
1311                         state->v[i][d] += (pos[Try][i][d] - pos[Min][i][d])*invdt;
1312                     }
1313                 }
1314             }
1315             Min  = Try;
1316         }
1317         else
1318         {
1319             decrease_step_size(nshell, shell);
1320         }
1321     }
1322     shfc->numForceEvaluations += count;
1323     if (bConverged)
1324     {
1325         shfc->numConvergedIterations++;
1326     }
1327     if (MASTER(cr) && !(bConverged))
1328     {
1329         /* Note that the energies and virial are incorrect when not converged */
1330         if (fplog)
1331         {
1332             fprintf(fplog,
1333                     "step %s: EM did not converge in %d iterations, RMS force %.3f\n",
1334                     gmx_step_str(mdstep, sbuf), number_steps, df[Min]);
1335         }
1336         fprintf(stderr,
1337                 "step %s: EM did not converge in %d iterations, RMS force %.3f\n",
1338                 gmx_step_str(mdstep, sbuf), number_steps, df[Min]);
1339     }
1340
1341     /* Copy back the coordinates and the forces */
1342     std::copy(pos[Min].begin(), pos[Min].end(), state->x.begin());
1343     std::copy(force[Min].begin(), force[Min].end(), f.begin());
1344 }
1345
1346 void done_shellfc(FILE *fplog, gmx_shellfc_t *shfc, int64_t numSteps)
1347 {
1348     if (shfc && fplog && numSteps > 0)
1349     {
1350         double numStepsAsDouble = static_cast<double>(numSteps);
1351         fprintf(fplog, "Fraction of iterations that converged:           %.2f %%\n",
1352                 (shfc->numConvergedIterations*100.0)/numStepsAsDouble);
1353         fprintf(fplog, "Average number of force evaluations per MD step: %.2f\n\n",
1354                 shfc->numForceEvaluations/numStepsAsDouble);
1355     }
1356
1357     // TODO Deallocate memory in shfc
1358 }