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