Merge release-5-0 into release-5-1
[alexxy/gromacs.git] / src / gromacs / mdlib / tpi.cpp
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5  * Copyright (c) 2001-2004, The GROMACS development team.
6  * Copyright (c) 2013,2014,2015, 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 <math.h>
40 #include <stdlib.h>
41 #include <string.h>
42 #include <time.h>
43
44 #include <algorithm>
45
46 #include "gromacs/domdec/domdec.h"
47 #include "gromacs/ewald/pme.h"
48 #include "gromacs/fileio/confio.h"
49 #include "gromacs/fileio/gmxfio.h"
50 #include "gromacs/fileio/trxio.h"
51 #include "gromacs/fileio/xvgr.h"
52 #include "gromacs/gmxlib/conformation-utilities.h"
53 #include "gromacs/legacyheaders/chargegroup.h"
54 #include "gromacs/legacyheaders/constr.h"
55 #include "gromacs/legacyheaders/force.h"
56 #include "gromacs/legacyheaders/macros.h"
57 #include "gromacs/legacyheaders/mdatoms.h"
58 #include "gromacs/legacyheaders/mdebin.h"
59 #include "gromacs/legacyheaders/mdrun.h"
60 #include "gromacs/legacyheaders/names.h"
61 #include "gromacs/legacyheaders/network.h"
62 #include "gromacs/legacyheaders/nrnb.h"
63 #include "gromacs/legacyheaders/ns.h"
64 #include "gromacs/legacyheaders/tgroup.h"
65 #include "gromacs/legacyheaders/txtdump.h"
66 #include "gromacs/legacyheaders/typedefs.h"
67 #include "gromacs/legacyheaders/update.h"
68 #include "gromacs/legacyheaders/vsite.h"
69 #include "gromacs/legacyheaders/types/commrec.h"
70 #include "gromacs/math/units.h"
71 #include "gromacs/math/vec.h"
72 #include "gromacs/random/random.h"
73 #include "gromacs/timing/wallcycle.h"
74 #include "gromacs/timing/walltime_accounting.h"
75 #include "gromacs/topology/mtop_util.h"
76 #include "gromacs/utility/fatalerror.h"
77 #include "gromacs/utility/smalloc.h"
78
79 static void global_max(t_commrec *cr, int *n)
80 {
81     int *sum, i;
82
83     snew(sum, cr->nnodes);
84     sum[cr->nodeid] = *n;
85     gmx_sumi(cr->nnodes, sum, cr);
86     for (i = 0; i < cr->nnodes; i++)
87     {
88         *n = std::max(*n, sum[i]);
89     }
90
91     sfree(sum);
92 }
93
94 static void realloc_bins(double **bin, int *nbin, int nbin_new)
95 {
96     int i;
97
98     if (nbin_new != *nbin)
99     {
100         srenew(*bin, nbin_new);
101         for (i = *nbin; i < nbin_new; i++)
102         {
103             (*bin)[i] = 0;
104         }
105         *nbin = nbin_new;
106     }
107 }
108
109 double do_tpi(FILE *fplog, t_commrec *cr,
110               int nfile, const t_filenm fnm[],
111               const output_env_t oenv, gmx_bool bVerbose, gmx_bool gmx_unused bCompact,
112               int gmx_unused nstglobalcomm,
113               gmx_vsite_t gmx_unused *vsite, gmx_constr_t gmx_unused constr,
114               int gmx_unused stepout,
115               t_inputrec *inputrec,
116               gmx_mtop_t *top_global, t_fcdata *fcd,
117               t_state *state,
118               t_mdatoms *mdatoms,
119               t_nrnb *nrnb, gmx_wallcycle_t wcycle,
120               gmx_edsam_t gmx_unused ed,
121               t_forcerec *fr,
122               int gmx_unused repl_ex_nst, int gmx_unused repl_ex_nex, int gmx_unused repl_ex_seed,
123               gmx_membed_t gmx_unused membed,
124               real gmx_unused cpt_period, real gmx_unused max_hours,
125               int gmx_unused imdport,
126               unsigned long gmx_unused Flags,
127               gmx_walltime_accounting_t walltime_accounting)
128 {
129     gmx_localtop_t *top;
130     gmx_groups_t   *groups;
131     gmx_enerdata_t *enerd;
132     rvec           *f;
133     real            lambda, t, temp, beta, drmax, epot;
134     double          embU, sum_embU, *sum_UgembU, V, V_all, VembU_all;
135     t_trxstatus    *status;
136     t_trxframe      rerun_fr;
137     gmx_bool        bDispCorr, bCharge, bRFExcl, bNotLastFrame, bStateChanged, bNS;
138     tensor          force_vir, shake_vir, vir, pres;
139     int             cg_tp, a_tp0, a_tp1, ngid, gid_tp, nener, e;
140     rvec           *x_mol;
141     rvec            mu_tot, x_init, dx, x_tp;
142     int             nnodes, frame;
143     gmx_int64_t     frame_step_prev, frame_step;
144     gmx_int64_t     nsteps, stepblocksize = 0, step;
145     gmx_int64_t     rnd_count_stride, rnd_count;
146     gmx_int64_t     seed;
147     double          rnd[4];
148     int             i;
149     FILE           *fp_tpi = NULL;
150     char           *ptr, *dump_pdb, **leg, str[STRLEN], str2[STRLEN];
151     double          dbl, dump_ener;
152     gmx_bool        bCavity;
153     int             nat_cavity  = 0, d;
154     real           *mass_cavity = NULL, mass_tot;
155     int             nbin;
156     double          invbinw, *bin, refvolshift, logV, bUlogV;
157     real            prescorr, enercorr, dvdlcorr;
158     gmx_bool        bEnergyOutOfBounds;
159     const char     *tpid_leg[2] = {"direct", "reweighted"};
160
161     /* Since there is no upper limit to the insertion energies,
162      * we need to set an upper limit for the distribution output.
163      */
164     real bU_bin_limit      = 50;
165     real bU_logV_bin_limit = bU_bin_limit + 10;
166
167     if (inputrec->cutoff_scheme == ecutsVERLET)
168     {
169         gmx_fatal(FARGS, "TPI does not work (yet) with the Verlet cut-off scheme");
170     }
171
172     nnodes = cr->nnodes;
173
174     top = gmx_mtop_generate_local_top(top_global, inputrec);
175
176     groups = &top_global->groups;
177
178     bCavity = (inputrec->eI == eiTPIC);
179     if (bCavity)
180     {
181         ptr = getenv("GMX_TPIC_MASSES");
182         if (ptr == NULL)
183         {
184             nat_cavity = 1;
185         }
186         else
187         {
188             /* Read (multiple) masses from env var GMX_TPIC_MASSES,
189              * The center of mass of the last atoms is then used for TPIC.
190              */
191             nat_cavity = 0;
192             while (sscanf(ptr, "%20lf%n", &dbl, &i) > 0)
193             {
194                 srenew(mass_cavity, nat_cavity+1);
195                 mass_cavity[nat_cavity] = dbl;
196                 fprintf(fplog, "mass[%d] = %f\n",
197                         nat_cavity+1, mass_cavity[nat_cavity]);
198                 nat_cavity++;
199                 ptr += i;
200             }
201             if (nat_cavity == 0)
202             {
203                 gmx_fatal(FARGS, "Found %d masses in GMX_TPIC_MASSES", nat_cavity);
204             }
205         }
206     }
207
208     /*
209        init_em(fplog,TPI,inputrec,&lambda,nrnb,mu_tot,
210        state->box,fr,mdatoms,top,cr,nfile,fnm,NULL,NULL);*/
211     /* We never need full pbc for TPI */
212     fr->ePBC = epbcXYZ;
213     /* Determine the temperature for the Boltzmann weighting */
214     temp = inputrec->opts.ref_t[0];
215     if (fplog)
216     {
217         for (i = 1; (i < inputrec->opts.ngtc); i++)
218         {
219             if (inputrec->opts.ref_t[i] != temp)
220             {
221                 fprintf(fplog, "\nWARNING: The temperatures of the different temperature coupling groups are not identical\n\n");
222                 fprintf(stderr, "\nWARNING: The temperatures of the different temperature coupling groups are not identical\n\n");
223             }
224         }
225         fprintf(fplog,
226                 "\n  The temperature for test particle insertion is %.3f K\n\n",
227                 temp);
228     }
229     beta = 1.0/(BOLTZ*temp);
230
231     /* Number of insertions per frame */
232     nsteps = inputrec->nsteps;
233
234     /* Use the same neighborlist with more insertions points
235      * in a sphere of radius drmax around the initial point
236      */
237     /* This should be a proper mdp parameter */
238     drmax = inputrec->rtpi;
239
240     /* An environment variable can be set to dump all configurations
241      * to pdb with an insertion energy <= this value.
242      */
243     dump_pdb  = getenv("GMX_TPI_DUMP");
244     dump_ener = 0;
245     if (dump_pdb)
246     {
247         sscanf(dump_pdb, "%20lf", &dump_ener);
248     }
249
250     atoms2md(top_global, inputrec, 0, NULL, top_global->natoms, mdatoms);
251     update_mdatoms(mdatoms, inputrec->fepvals->init_lambda);
252
253     snew(enerd, 1);
254     init_enerdata(groups->grps[egcENER].nr, inputrec->fepvals->n_lambda, enerd);
255     snew(f, top_global->natoms);
256
257     /* Print to log file  */
258     walltime_accounting_start(walltime_accounting);
259     wallcycle_start(wcycle, ewcRUN);
260     print_start(fplog, cr, walltime_accounting, "Test Particle Insertion");
261
262     /* The last charge group is the group to be inserted */
263     cg_tp = top->cgs.nr - 1;
264     a_tp0 = top->cgs.index[cg_tp];
265     a_tp1 = top->cgs.index[cg_tp+1];
266     if (debug)
267     {
268         fprintf(debug, "TPI cg %d, atoms %d-%d\n", cg_tp, a_tp0, a_tp1);
269     }
270     if (a_tp1 - a_tp0 > 1 &&
271         (inputrec->rlist < inputrec->rcoulomb ||
272          inputrec->rlist < inputrec->rvdw))
273     {
274         gmx_fatal(FARGS, "Can not do TPI for multi-atom molecule with a twin-range cut-off");
275     }
276     snew(x_mol, a_tp1-a_tp0);
277
278     bDispCorr = (inputrec->eDispCorr != edispcNO);
279     bCharge   = FALSE;
280     for (i = a_tp0; i < a_tp1; i++)
281     {
282         /* Copy the coordinates of the molecule to be insterted */
283         copy_rvec(state->x[i], x_mol[i-a_tp0]);
284         /* Check if we need to print electrostatic energies */
285         bCharge |= (mdatoms->chargeA[i] != 0 ||
286                     (mdatoms->chargeB && mdatoms->chargeB[i] != 0));
287     }
288     bRFExcl = (bCharge && EEL_RF(fr->eeltype) && fr->eeltype != eelRF_NEC);
289
290     calc_cgcm(fplog, cg_tp, cg_tp+1, &(top->cgs), state->x, fr->cg_cm);
291     if (bCavity)
292     {
293         if (norm(fr->cg_cm[cg_tp]) > 0.5*inputrec->rlist && fplog)
294         {
295             fprintf(fplog, "WARNING: Your TPI molecule is not centered at 0,0,0\n");
296             fprintf(stderr, "WARNING: Your TPI molecule is not centered at 0,0,0\n");
297         }
298     }
299     else
300     {
301         /* Center the molecule to be inserted at zero */
302         for (i = 0; i < a_tp1-a_tp0; i++)
303         {
304             rvec_dec(x_mol[i], fr->cg_cm[cg_tp]);
305         }
306     }
307
308     if (fplog)
309     {
310         fprintf(fplog, "\nWill insert %d atoms %s partial charges\n",
311                 a_tp1-a_tp0, bCharge ? "with" : "without");
312
313         fprintf(fplog, "\nWill insert %d times in each frame of %s\n",
314                 (int)nsteps, opt2fn("-rerun", nfile, fnm));
315     }
316
317     if (!bCavity)
318     {
319         if (inputrec->nstlist > 1)
320         {
321             if (drmax == 0 && a_tp1-a_tp0 == 1)
322             {
323                 gmx_fatal(FARGS, "Re-using the neighborlist %d times for insertions of a single atom in a sphere of radius %f does not make sense", inputrec->nstlist, drmax);
324             }
325             if (fplog)
326             {
327                 fprintf(fplog, "Will use the same neighborlist for %d insertions in a sphere of radius %f\n", inputrec->nstlist, drmax);
328             }
329         }
330     }
331     else
332     {
333         if (fplog)
334         {
335             fprintf(fplog, "Will insert randomly in a sphere of radius %f around the center of the cavity\n", drmax);
336         }
337     }
338
339     ngid   = groups->grps[egcENER].nr;
340     gid_tp = GET_CGINFO_GID(fr->cginfo[cg_tp]);
341     nener  = 1 + ngid;
342     if (bDispCorr)
343     {
344         nener += 1;
345     }
346     if (bCharge)
347     {
348         nener += ngid;
349         if (bRFExcl)
350         {
351             nener += 1;
352         }
353         if (EEL_FULL(fr->eeltype))
354         {
355             nener += 1;
356         }
357     }
358     snew(sum_UgembU, nener);
359
360     /* Copy the random seed set by the user */
361     seed = inputrec->ld_seed;
362     /* We use the frame step number as one random counter.
363      * The second counter use the insertion (step) count. But we
364      * need multiple random numbers per insertion. This number is
365      * not fixed, since we generate random locations in a sphere
366      * by putting locations in a cube and some of these fail.
367      * A count of 20 is already extremely unlikely, so 10000 is
368      * a safe margin for random numbers per insertion.
369      */
370     rnd_count_stride = 10000;
371
372     if (MASTER(cr))
373     {
374         fp_tpi = xvgropen(opt2fn("-tpi", nfile, fnm),
375                           "TPI energies", "Time (ps)",
376                           "(kJ mol\\S-1\\N) / (nm\\S3\\N)", oenv);
377         xvgr_subtitle(fp_tpi, "f. are averages over one frame", oenv);
378         snew(leg, 4+nener);
379         e = 0;
380         sprintf(str, "-kT log(<Ve\\S-\\betaU\\N>/<V>)");
381         leg[e++] = gmx_strdup(str);
382         sprintf(str, "f. -kT log<e\\S-\\betaU\\N>");
383         leg[e++] = gmx_strdup(str);
384         sprintf(str, "f. <e\\S-\\betaU\\N>");
385         leg[e++] = gmx_strdup(str);
386         sprintf(str, "f. V");
387         leg[e++] = gmx_strdup(str);
388         sprintf(str, "f. <Ue\\S-\\betaU\\N>");
389         leg[e++] = gmx_strdup(str);
390         for (i = 0; i < ngid; i++)
391         {
392             sprintf(str, "f. <U\\sVdW %s\\Ne\\S-\\betaU\\N>",
393                     *(groups->grpname[groups->grps[egcENER].nm_ind[i]]));
394             leg[e++] = gmx_strdup(str);
395         }
396         if (bDispCorr)
397         {
398             sprintf(str, "f. <U\\sdisp c\\Ne\\S-\\betaU\\N>");
399             leg[e++] = gmx_strdup(str);
400         }
401         if (bCharge)
402         {
403             for (i = 0; i < ngid; i++)
404             {
405                 sprintf(str, "f. <U\\sCoul %s\\Ne\\S-\\betaU\\N>",
406                         *(groups->grpname[groups->grps[egcENER].nm_ind[i]]));
407                 leg[e++] = gmx_strdup(str);
408             }
409             if (bRFExcl)
410             {
411                 sprintf(str, "f. <U\\sRF excl\\Ne\\S-\\betaU\\N>");
412                 leg[e++] = gmx_strdup(str);
413             }
414             if (EEL_FULL(fr->eeltype))
415             {
416                 sprintf(str, "f. <U\\sCoul recip\\Ne\\S-\\betaU\\N>");
417                 leg[e++] = gmx_strdup(str);
418             }
419         }
420         xvgr_legend(fp_tpi, 4+nener, (const char**)leg, oenv);
421         for (i = 0; i < 4+nener; i++)
422         {
423             sfree(leg[i]);
424         }
425         sfree(leg);
426     }
427     clear_rvec(x_init);
428     V_all     = 0;
429     VembU_all = 0;
430
431     invbinw = 10;
432     nbin    = 10;
433     snew(bin, nbin);
434
435     /* Avoid frame step numbers <= -1 */
436     frame_step_prev = -1;
437
438     bNotLastFrame = read_first_frame(oenv, &status, opt2fn("-rerun", nfile, fnm),
439                                      &rerun_fr, TRX_NEED_X);
440     frame = 0;
441
442     if (rerun_fr.natoms - (bCavity ? nat_cavity : 0) !=
443         mdatoms->nr - (a_tp1 - a_tp0))
444     {
445         gmx_fatal(FARGS, "Number of atoms in trajectory (%d)%s "
446                   "is not equal the number in the run input file (%d) "
447                   "minus the number of atoms to insert (%d)\n",
448                   rerun_fr.natoms, bCavity ? " minus one" : "",
449                   mdatoms->nr, a_tp1-a_tp0);
450     }
451
452     refvolshift = log(det(rerun_fr.box));
453
454     switch (inputrec->eI)
455     {
456         case eiTPI:
457             stepblocksize = inputrec->nstlist;
458             break;
459         case eiTPIC:
460             stepblocksize = 1;
461             break;
462         default:
463             gmx_fatal(FARGS, "Unknown integrator %s", ei_names[inputrec->eI]);
464     }
465
466     while (bNotLastFrame)
467     {
468         frame_step      = rerun_fr.step;
469         if (frame_step <= frame_step_prev)
470         {
471             /* We don't have step number in the trajectory file,
472              * or we have constant or decreasing step numbers.
473              * Ensure we have increasing step numbers, since we use
474              * the step numbers as a counter for random numbers.
475              */
476             frame_step  = frame_step_prev + 1;
477         }
478         frame_step_prev = frame_step;
479
480         lambda = rerun_fr.lambda;
481         t      = rerun_fr.time;
482
483         sum_embU = 0;
484         for (e = 0; e < nener; e++)
485         {
486             sum_UgembU[e] = 0;
487         }
488
489         /* Copy the coordinates from the input trajectory */
490         for (i = 0; i < rerun_fr.natoms; i++)
491         {
492             copy_rvec(rerun_fr.x[i], state->x[i]);
493         }
494         copy_mat(rerun_fr.box, state->box);
495
496         V    = det(state->box);
497         logV = log(V);
498
499         bStateChanged = TRUE;
500         bNS           = TRUE;
501
502         step = cr->nodeid*stepblocksize;
503         while (step < nsteps)
504         {
505             /* Initialize the second counter for random numbers using
506              * the insertion step index. This ensures that we get
507              * the same random numbers independently of how many
508              * MPI ranks we use. Also for the same seed, we get
509              * the same initial random sequence for different nsteps.
510              */
511             rnd_count = step*rnd_count_stride;
512
513             if (!bCavity)
514             {
515                 /* Random insertion in the whole volume */
516                 bNS = (step % inputrec->nstlist == 0);
517                 if (bNS)
518                 {
519                     /* Generate a random position in the box */
520                     gmx_rng_cycle_2uniform(frame_step, rnd_count++, seed, RND_SEED_TPI, rnd);
521                     gmx_rng_cycle_2uniform(frame_step, rnd_count++, seed, RND_SEED_TPI, rnd+2);
522                     for (d = 0; d < DIM; d++)
523                     {
524                         x_init[d] = rnd[d]*state->box[d][d];
525                     }
526                 }
527                 if (inputrec->nstlist == 1)
528                 {
529                     copy_rvec(x_init, x_tp);
530                 }
531                 else
532                 {
533                     /* Generate coordinates within |dx|=drmax of x_init */
534                     do
535                     {
536                         gmx_rng_cycle_2uniform(frame_step, rnd_count++, seed, RND_SEED_TPI, rnd);
537                         gmx_rng_cycle_2uniform(frame_step, rnd_count++, seed, RND_SEED_TPI, rnd+2);
538                         for (d = 0; d < DIM; d++)
539                         {
540                             dx[d] = (2*rnd[d] - 1)*drmax;
541                         }
542                     }
543                     while (norm2(dx) > drmax*drmax);
544                     rvec_add(x_init, dx, x_tp);
545                 }
546             }
547             else
548             {
549                 /* Random insertion around a cavity location
550                  * given by the last coordinate of the trajectory.
551                  */
552                 if (step == 0)
553                 {
554                     if (nat_cavity == 1)
555                     {
556                         /* Copy the location of the cavity */
557                         copy_rvec(rerun_fr.x[rerun_fr.natoms-1], x_init);
558                     }
559                     else
560                     {
561                         /* Determine the center of mass of the last molecule */
562                         clear_rvec(x_init);
563                         mass_tot = 0;
564                         for (i = 0; i < nat_cavity; i++)
565                         {
566                             for (d = 0; d < DIM; d++)
567                             {
568                                 x_init[d] +=
569                                     mass_cavity[i]*rerun_fr.x[rerun_fr.natoms-nat_cavity+i][d];
570                             }
571                             mass_tot += mass_cavity[i];
572                         }
573                         for (d = 0; d < DIM; d++)
574                         {
575                             x_init[d] /= mass_tot;
576                         }
577                     }
578                 }
579                 /* Generate coordinates within |dx|=drmax of x_init */
580                 do
581                 {
582                     gmx_rng_cycle_2uniform(frame_step, rnd_count++, seed, RND_SEED_TPI, rnd);
583                     gmx_rng_cycle_2uniform(frame_step, rnd_count++, seed, RND_SEED_TPI, rnd+2);
584                     for (d = 0; d < DIM; d++)
585                     {
586                         dx[d] = (2*rnd[d] - 1)*drmax;
587                     }
588                 }
589                 while (norm2(dx) > drmax*drmax);
590                 rvec_add(x_init, dx, x_tp);
591             }
592
593             if (a_tp1 - a_tp0 == 1)
594             {
595                 /* Insert a single atom, just copy the insertion location */
596                 copy_rvec(x_tp, state->x[a_tp0]);
597             }
598             else
599             {
600                 /* Copy the coordinates from the top file */
601                 for (i = a_tp0; i < a_tp1; i++)
602                 {
603                     copy_rvec(x_mol[i-a_tp0], state->x[i]);
604                 }
605                 /* Rotate the molecule randomly */
606                 gmx_rng_cycle_2uniform(frame_step, rnd_count++, seed, RND_SEED_TPI, rnd);
607                 gmx_rng_cycle_2uniform(frame_step, rnd_count++, seed, RND_SEED_TPI, rnd+2);
608                 rotate_conf(a_tp1-a_tp0, state->x+a_tp0, NULL,
609                             2*M_PI*rnd[0],
610                             2*M_PI*rnd[1],
611                             2*M_PI*rnd[2]);
612                 /* Shift to the insertion location */
613                 for (i = a_tp0; i < a_tp1; i++)
614                 {
615                     rvec_inc(state->x[i], x_tp);
616                 }
617             }
618
619             /* Clear some matrix variables  */
620             clear_mat(force_vir);
621             clear_mat(shake_vir);
622             clear_mat(vir);
623             clear_mat(pres);
624
625             /* Set the charge group center of mass of the test particle */
626             copy_rvec(x_init, fr->cg_cm[top->cgs.nr-1]);
627
628             /* Calc energy (no forces) on new positions.
629              * Since we only need the intermolecular energy
630              * and the RF exclusion terms of the inserted molecule occur
631              * within a single charge group we can pass NULL for the graph.
632              * This also avoids shifts that would move charge groups
633              * out of the box.
634              *
635              * Some checks above ensure than we can not have
636              * twin-range interactions together with nstlist > 1,
637              * therefore we do not need to remember the LR energies.
638              */
639             /* Make do_force do a single node force calculation */
640             cr->nnodes = 1;
641             do_force(fplog, cr, inputrec,
642                      step, nrnb, wcycle, top, &top_global->groups,
643                      state->box, state->x, &state->hist,
644                      f, force_vir, mdatoms, enerd, fcd,
645                      state->lambda,
646                      NULL, fr, NULL, mu_tot, t, NULL, NULL, FALSE,
647                      GMX_FORCE_NONBONDED | GMX_FORCE_ENERGY |
648                      (bNS ? GMX_FORCE_DYNAMICBOX | GMX_FORCE_NS | GMX_FORCE_DO_LR : 0) |
649                      (bStateChanged ? GMX_FORCE_STATECHANGED : 0));
650             cr->nnodes    = nnodes;
651             bStateChanged = FALSE;
652             bNS           = FALSE;
653
654             /* Calculate long range corrections to pressure and energy */
655             calc_dispcorr(inputrec, fr, top_global->natoms, state->box,
656                           lambda, pres, vir, &prescorr, &enercorr, &dvdlcorr);
657             /* figure out how to rearrange the next 4 lines MRS 8/4/2009 */
658             enerd->term[F_DISPCORR]  = enercorr;
659             enerd->term[F_EPOT]     += enercorr;
660             enerd->term[F_PRES]     += prescorr;
661             enerd->term[F_DVDL_VDW] += dvdlcorr;
662
663             epot               = enerd->term[F_EPOT];
664             bEnergyOutOfBounds = FALSE;
665
666             /* If the compiler doesn't optimize this check away
667              * we catch the NAN energies.
668              * The epot>GMX_REAL_MAX check catches inf values,
669              * which should nicely result in embU=0 through the exp below,
670              * but it does not hurt to check anyhow.
671              */
672             /* Non-bonded Interaction usually diverge at r=0.
673              * With tabulated interaction functions the first few entries
674              * should be capped in a consistent fashion between
675              * repulsion, dispersion and Coulomb to avoid accidental
676              * negative values in the total energy.
677              * The table generation code in tables.c does this.
678              * With user tbales the user should take care of this.
679              */
680             if (epot != epot || epot > GMX_REAL_MAX)
681             {
682                 bEnergyOutOfBounds = TRUE;
683             }
684             if (bEnergyOutOfBounds)
685             {
686                 if (debug)
687                 {
688                     fprintf(debug, "\n  time %.3f, step %d: non-finite energy %f, using exp(-bU)=0\n", t, (int)step, epot);
689                 }
690                 embU = 0;
691             }
692             else
693             {
694                 embU      = exp(-beta*epot);
695                 sum_embU += embU;
696                 /* Determine the weighted energy contributions of each energy group */
697                 e                = 0;
698                 sum_UgembU[e++] += epot*embU;
699                 if (fr->bBHAM)
700                 {
701                     for (i = 0; i < ngid; i++)
702                     {
703                         sum_UgembU[e++] +=
704                             (enerd->grpp.ener[egBHAMSR][GID(i, gid_tp, ngid)] +
705                              enerd->grpp.ener[egBHAMLR][GID(i, gid_tp, ngid)])*embU;
706                     }
707                 }
708                 else
709                 {
710                     for (i = 0; i < ngid; i++)
711                     {
712                         sum_UgembU[e++] +=
713                             (enerd->grpp.ener[egLJSR][GID(i, gid_tp, ngid)] +
714                              enerd->grpp.ener[egLJLR][GID(i, gid_tp, ngid)])*embU;
715                     }
716                 }
717                 if (bDispCorr)
718                 {
719                     sum_UgembU[e++] += enerd->term[F_DISPCORR]*embU;
720                 }
721                 if (bCharge)
722                 {
723                     for (i = 0; i < ngid; i++)
724                     {
725                         sum_UgembU[e++] +=
726                             (enerd->grpp.ener[egCOULSR][GID(i, gid_tp, ngid)] +
727                              enerd->grpp.ener[egCOULLR][GID(i, gid_tp, ngid)])*embU;
728                     }
729                     if (bRFExcl)
730                     {
731                         sum_UgembU[e++] += enerd->term[F_RF_EXCL]*embU;
732                     }
733                     if (EEL_FULL(fr->eeltype))
734                     {
735                         sum_UgembU[e++] += enerd->term[F_COUL_RECIP]*embU;
736                     }
737                 }
738             }
739
740             if (embU == 0 || beta*epot > bU_bin_limit)
741             {
742                 bin[0]++;
743             }
744             else
745             {
746                 i = (int)((bU_logV_bin_limit
747                            - (beta*epot - logV + refvolshift))*invbinw
748                           + 0.5);
749                 if (i < 0)
750                 {
751                     i = 0;
752                 }
753                 if (i >= nbin)
754                 {
755                     realloc_bins(&bin, &nbin, i+10);
756                 }
757                 bin[i]++;
758             }
759
760             if (debug)
761             {
762                 fprintf(debug, "TPI %7d %12.5e %12.5f %12.5f %12.5f\n",
763                         (int)step, epot, x_tp[XX], x_tp[YY], x_tp[ZZ]);
764             }
765
766             if (dump_pdb && epot <= dump_ener)
767             {
768                 sprintf(str, "t%g_step%d.pdb", t, (int)step);
769                 sprintf(str2, "t: %f step %d ener: %f", t, (int)step, epot);
770                 write_sto_conf_mtop(str, str2, top_global, state->x, state->v,
771                                     inputrec->ePBC, state->box);
772             }
773
774             step++;
775             if ((step/stepblocksize) % cr->nnodes != cr->nodeid)
776             {
777                 /* Skip all steps assigned to the other MPI ranks */
778                 step += (cr->nnodes - 1)*stepblocksize;
779             }
780         }
781
782         if (PAR(cr))
783         {
784             /* When running in parallel sum the energies over the processes */
785             gmx_sumd(1,    &sum_embU, cr);
786             gmx_sumd(nener, sum_UgembU, cr);
787         }
788
789         frame++;
790         V_all     += V;
791         VembU_all += V*sum_embU/nsteps;
792
793         if (fp_tpi)
794         {
795             if (bVerbose || frame%10 == 0 || frame < 10)
796             {
797                 fprintf(stderr, "mu %10.3e <mu> %10.3e\n",
798                         -log(sum_embU/nsteps)/beta, -log(VembU_all/V_all)/beta);
799             }
800
801             fprintf(fp_tpi, "%10.3f %12.5e %12.5e %12.5e %12.5e",
802                     t,
803                     VembU_all == 0 ? 20/beta : -log(VembU_all/V_all)/beta,
804                     sum_embU == 0  ? 20/beta : -log(sum_embU/nsteps)/beta,
805                     sum_embU/nsteps, V);
806             for (e = 0; e < nener; e++)
807             {
808                 fprintf(fp_tpi, " %12.5e", sum_UgembU[e]/nsteps);
809             }
810             fprintf(fp_tpi, "\n");
811             fflush(fp_tpi);
812         }
813
814         bNotLastFrame = read_next_frame(oenv, status, &rerun_fr);
815     } /* End of the loop  */
816     walltime_accounting_end(walltime_accounting);
817
818     close_trj(status);
819
820     if (fp_tpi != NULL)
821     {
822         xvgrclose(fp_tpi);
823     }
824
825     if (fplog != NULL)
826     {
827         fprintf(fplog, "\n");
828         fprintf(fplog, "  <V>  = %12.5e nm^3\n", V_all/frame);
829         fprintf(fplog, "  <mu> = %12.5e kJ/mol\n", -log(VembU_all/V_all)/beta);
830     }
831
832     /* Write the Boltzmann factor histogram */
833     if (PAR(cr))
834     {
835         /* When running in parallel sum the bins over the processes */
836         i = nbin;
837         global_max(cr, &i);
838         realloc_bins(&bin, &nbin, i);
839         gmx_sumd(nbin, bin, cr);
840     }
841     if (MASTER(cr))
842     {
843         fp_tpi = xvgropen(opt2fn("-tpid", nfile, fnm),
844                           "TPI energy distribution",
845                           "\\betaU - log(V/<V>)", "count", oenv);
846         sprintf(str, "number \\betaU > %g: %9.3e", bU_bin_limit, bin[0]);
847         xvgr_subtitle(fp_tpi, str, oenv);
848         xvgr_legend(fp_tpi, 2, (const char **)tpid_leg, oenv);
849         for (i = nbin-1; i > 0; i--)
850         {
851             bUlogV = -i/invbinw + bU_logV_bin_limit - refvolshift + log(V_all/frame);
852             fprintf(fp_tpi, "%6.2f %10d %12.5e\n",
853                     bUlogV,
854                     (int)(bin[i]+0.5),
855                     bin[i]*exp(-bUlogV)*V_all/VembU_all);
856         }
857         xvgrclose(fp_tpi);
858     }
859     sfree(bin);
860
861     sfree(sum_UgembU);
862
863     walltime_accounting_set_nsteps_done(walltime_accounting, frame*inputrec->nsteps);
864
865     return 0;
866 }