src/gromacs/mdrun/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,2016,2017,2018,2019, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 /*! \internal \file
  38  *
  39  * \brief This file defines the integrator for test particle insertion
  40  *
  41  * \author Berk Hess <hess@kth.se>
  42  * \ingroup module_mdrun
  43  */
  44 #include "gmxpre.h"
  45
  46 #include <cmath>
  47 #include <cstdlib>
  48 #include <cstring>
  49 #include <ctime>
  50
  51 #include <algorithm>
  52
  53 #include <cfenv>
  54
  55 #include "gromacs/commandline/filenm.h"
  56 #include "gromacs/domdec/dlbtiming.h"
  57 #include "gromacs/domdec/domdec.h"
  58 #include "gromacs/ewald/pme.h"
  59 #include "gromacs/fileio/confio.h"
  60 #include "gromacs/fileio/trxio.h"
  61 #include "gromacs/fileio/xvgr.h"
  62 #include "gromacs/gmxlib/chargegroup.h"
  63 #include "gromacs/gmxlib/conformation_utilities.h"
  64 #include "gromacs/gmxlib/network.h"
  65 #include "gromacs/gmxlib/nrnb.h"
  66 #include "gromacs/math/units.h"
  67 #include "gromacs/math/vec.h"
  68 #include "gromacs/mdlib/constr.h"
  69 #include "gromacs/mdlib/dispersioncorrection.h"
  70 #include "gromacs/mdlib/energyoutput.h"
  71 #include "gromacs/mdlib/force.h"
  72 #include "gromacs/mdlib/force_flags.h"
  73 #include "gromacs/mdlib/mdatoms.h"
  74 #include "gromacs/mdlib/ns.h"
  75 #include "gromacs/mdlib/tgroup.h"
  76 #include "gromacs/mdlib/update.h"
  77 #include "gromacs/mdlib/vsite.h"
  78 #include "gromacs/mdrunutility/printtime.h"
  79 #include "gromacs/mdtypes/commrec.h"
  80 #include "gromacs/mdtypes/forcerec.h"
  81 #include "gromacs/mdtypes/group.h"
  82 #include "gromacs/mdtypes/inputrec.h"
  83 #include "gromacs/mdtypes/md_enums.h"
  84 #include "gromacs/mdtypes/mdrunoptions.h"
  85 #include "gromacs/mdtypes/state.h"
  86 #include "gromacs/pbcutil/pbc.h"
  87 #include "gromacs/random/threefry.h"
  88 #include "gromacs/random/uniformrealdistribution.h"
  89 #include "gromacs/timing/wallcycle.h"
  90 #include "gromacs/timing/walltime_accounting.h"
  91 #include "gromacs/topology/mtop_util.h"
  92 #include "gromacs/trajectory/trajectoryframe.h"
  93 #include "gromacs/utility/cstringutil.h"
  94 #include "gromacs/utility/fatalerror.h"
  95 #include "gromacs/utility/gmxassert.h"
  96 #include "gromacs/utility/logger.h"
  97 #include "gromacs/utility/smalloc.h"
  98
  99 #include "integrator.h"
 100
 101 //! Global max algorithm
 102 static void global_max(t_commrec *cr, int *n)
 103 {
 104     int *sum, i;
 105
 106     snew(sum, cr->nnodes);
 107     sum[cr->nodeid] = *n;
 108     gmx_sumi(cr->nnodes, sum, cr);
 109     for (i = 0; i < cr->nnodes; i++)
 110     {
 111         *n = std::max(*n, sum[i]);
 112     }
 113
 114     sfree(sum);
 115 }
 116
 117 //! Reallocate arrays.
 118 static void realloc_bins(double **bin, int *nbin, int nbin_new)
 119 {
 120     int i;
 121
 122     if (nbin_new != *nbin)
 123     {
 124         srenew(*bin, nbin_new);
 125         for (i = *nbin; i < nbin_new; i++)
 126         {
 127             (*bin)[i] = 0;
 128         }
 129         *nbin = nbin_new;
 130     }
 131 }
 132
 133 namespace gmx
 134 {
 135
 136 void
 137 Integrator::do_tpi()
 138 {
 139     gmx_localtop_t          top;
 140     gmx_groups_t           *groups;
 141     gmx_enerdata_t         *enerd;
 142     PaddedVector<gmx::RVec> f {};
 143     real                    lambda, t, temp, beta, drmax, epot;
 144     double                  embU, sum_embU, *sum_UgembU, V, V_all, VembU_all;
 145     t_trxstatus            *status;
 146     t_trxframe              rerun_fr;
 147     gmx_bool                bDispCorr, bCharge, bRFExcl, bNotLastFrame, bStateChanged, bNS;
 148     tensor                  force_vir, shake_vir, vir, pres;
 149     int                     cg_tp, a_tp0, a_tp1, ngid, gid_tp, nener, e;
 150     rvec                   *x_mol;
 151     rvec                    mu_tot, x_init, dx, x_tp;
 152     int                     nnodes, frame;
 153     int64_t                 frame_step_prev, frame_step;
 154     int64_t                 nsteps, stepblocksize = 0, step;
 155     int64_t                 seed;
 156     int                     i;
 157     FILE                   *fp_tpi = nullptr;
 158     char                   *ptr, *dump_pdb, **leg, str[STRLEN], str2[STRLEN];
 159     double                  dbl, dump_ener;
 160     gmx_bool                bCavity;
 161     int                     nat_cavity  = 0, d;
 162     real                   *mass_cavity = nullptr, mass_tot;
 163     int                     nbin;
 164     double                  invbinw, *bin, refvolshift, logV, bUlogV;
 165     real                    prescorr, enercorr, dvdlcorr;
 166     gmx_bool                bEnergyOutOfBounds;
 167     const char             *tpid_leg[2] = {"direct", "reweighted"};
 168     auto                    mdatoms     = mdAtoms->mdatoms();
 169
 170     GMX_UNUSED_VALUE(outputProvider);
 171
 172     GMX_LOG(mdlog.info).asParagraph().
 173         appendText("Note that it is planned to change the command gmx mdrun -tpi "
 174                    "(and -tpic) to make the functionality available in a different "
 175                    "form in a future version of GROMACS, e.g. gmx test-particle-insertion.");
 176
 177     /* Since there is no upper limit to the insertion energies,
 178      * we need to set an upper limit for the distribution output.
 179      */
 180     real bU_bin_limit      = 50;
 181     real bU_logV_bin_limit = bU_bin_limit + 10;
 182
 183     if (inputrec->cutoff_scheme == ecutsVERLET)
 184     {
 185         gmx_fatal(FARGS, "TPI does not work (yet) with the Verlet cut-off scheme");
 186     }
 187
 188     nnodes = cr->nnodes;
 189
 190     gmx_mtop_generate_local_top(*top_global, &top, inputrec->efep != efepNO);
 191
 192     groups = &top_global->groups;
 193
 194     bCavity = (inputrec->eI == eiTPIC);
 195     if (bCavity)
 196     {
 197         ptr = getenv("GMX_TPIC_MASSES");
 198         if (ptr == nullptr)
 199         {
 200             nat_cavity = 1;
 201         }
 202         else
 203         {
 204             /* Read (multiple) masses from env var GMX_TPIC_MASSES,
 205              * The center of mass of the last atoms is then used for TPIC.
 206              */
 207             nat_cavity = 0;
 208             while (sscanf(ptr, "%20lf%n", &dbl, &i) > 0)
 209             {
 210                 srenew(mass_cavity, nat_cavity+1);
 211                 mass_cavity[nat_cavity] = dbl;
 212                 fprintf(fplog, "mass[%d] = %f\n",
 213                         nat_cavity+1, mass_cavity[nat_cavity]);
 214                 nat_cavity++;
 215                 ptr += i;
 216             }
 217             if (nat_cavity == 0)
 218             {
 219                 gmx_fatal(FARGS, "Found %d masses in GMX_TPIC_MASSES", nat_cavity);
 220             }
 221         }
 222     }
 223
 224     /*
 225        init_em(fplog,TPI,inputrec,&lambda,nrnb,mu_tot,
 226        state_global->box,fr,mdatoms,top,cr,nfile,fnm,NULL,NULL);*/
 227     /* We never need full pbc for TPI */
 228     fr->ePBC = epbcXYZ;
 229     /* Determine the temperature for the Boltzmann weighting */
 230     temp = inputrec->opts.ref_t[0];
 231     if (fplog)
 232     {
 233         for (i = 1; (i < inputrec->opts.ngtc); i++)
 234         {
 235             if (inputrec->opts.ref_t[i] != temp)
 236             {
 237                 fprintf(fplog, "\nWARNING: The temperatures of the different temperature coupling groups are not identical\n\n");
 238                 fprintf(stderr, "\nWARNING: The temperatures of the different temperature coupling groups are not identical\n\n");
 239             }
 240         }
 241         fprintf(fplog,
 242                 "\n  The temperature for test particle insertion is %.3f K\n\n",
 243                 temp);
 244     }
 245     beta = 1.0/(BOLTZ*temp);
 246
 247     /* Number of insertions per frame */
 248     nsteps = inputrec->nsteps;
 249
 250     /* Use the same neighborlist with more insertions points
 251      * in a sphere of radius drmax around the initial point
 252      */
 253     /* This should be a proper mdp parameter */
 254     drmax = inputrec->rtpi;
 255
 256     /* An environment variable can be set to dump all configurations
 257      * to pdb with an insertion energy <= this value.
 258      */
 259     dump_pdb  = getenv("GMX_TPI_DUMP");
 260     dump_ener = 0;
 261     if (dump_pdb)
 262     {
 263         sscanf(dump_pdb, "%20lf", &dump_ener);
 264     }
 265
 266     atoms2md(top_global, inputrec, -1, nullptr, top_global->natoms, mdAtoms);
 267     update_mdatoms(mdatoms, inputrec->fepvals->init_lambda);
 268
 269     snew(enerd, 1);
 270     init_enerdata(groups->grps[egcENER].nr, inputrec->fepvals->n_lambda, enerd);
 271     f.resizeWithPadding(top_global->natoms);
 272
 273     /* Print to log file  */
 274     walltime_accounting_start_time(walltime_accounting);
 275     wallcycle_start(wcycle, ewcRUN);
 276     print_start(fplog, cr, walltime_accounting, "Test Particle Insertion");
 277
 278     /* The last charge group is the group to be inserted */
 279     cg_tp = top.cgs.nr - 1;
 280     a_tp0 = top.cgs.index[cg_tp];
 281     a_tp1 = top.cgs.index[cg_tp+1];
 282     if (debug)
 283     {
 284         fprintf(debug, "TPI cg %d, atoms %d-%d\n", cg_tp, a_tp0, a_tp1);
 285     }
 286
 287     GMX_RELEASE_ASSERT(inputrec->rcoulomb <= inputrec->rlist && inputrec->rvdw <= inputrec->rlist, "Twin-range interactions are not supported with TPI");
 288
 289     snew(x_mol, a_tp1-a_tp0);
 290
 291     bDispCorr = (inputrec->eDispCorr != edispcNO);
 292     bCharge   = FALSE;
 293     auto x = makeArrayRef(state_global->x);
 294     for (i = a_tp0; i < a_tp1; i++)
 295     {
 296         /* Copy the coordinates of the molecule to be insterted */
 297         copy_rvec(x[i], x_mol[i-a_tp0]);
 298         /* Check if we need to print electrostatic energies */
 299         bCharge |= (mdatoms->chargeA[i] != 0 ||
 300                     ((mdatoms->chargeB != nullptr) && mdatoms->chargeB[i] != 0));
 301     }
 302     bRFExcl = (bCharge && EEL_RF(fr->ic->eeltype));
 303
 304     calc_cgcm(fplog, cg_tp, cg_tp+1, &(top.cgs), state_global->x.rvec_array(), fr->cg_cm);
 305     if (bCavity)
 306     {
 307         if (norm(fr->cg_cm[cg_tp]) > 0.5*inputrec->rlist && fplog)
 308         {
 309             fprintf(fplog, "WARNING: Your TPI molecule is not centered at 0,0,0\n");
 310             fprintf(stderr, "WARNING: Your TPI molecule is not centered at 0,0,0\n");
 311         }
 312     }
 313     else
 314     {
 315         /* Center the molecule to be inserted at zero */
 316         for (i = 0; i < a_tp1-a_tp0; i++)
 317         {
 318             rvec_dec(x_mol[i], fr->cg_cm[cg_tp]);
 319         }
 320     }
 321
 322     if (fplog)
 323     {
 324         fprintf(fplog, "\nWill insert %d atoms %s partial charges\n",
 325                 a_tp1-a_tp0, bCharge ? "with" : "without");
 326
 327         fprintf(fplog, "\nWill insert %" PRId64 " times in each frame of %s\n",
 328                 nsteps, opt2fn("-rerun", nfile, fnm));
 329     }
 330
 331     if (!bCavity)
 332     {
 333         if (inputrec->nstlist > 1)
 334         {
 335             if (drmax == 0 && a_tp1-a_tp0 == 1)
 336             {
 337                 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);
 338             }
 339             if (fplog)
 340             {
 341                 fprintf(fplog, "Will use the same neighborlist for %d insertions in a sphere of radius %f\n", inputrec->nstlist, drmax);
 342             }
 343         }
 344     }
 345     else
 346     {
 347         if (fplog)
 348         {
 349             fprintf(fplog, "Will insert randomly in a sphere of radius %f around the center of the cavity\n", drmax);
 350         }
 351     }
 352
 353     ngid   = groups->grps[egcENER].nr;
 354     gid_tp = GET_CGINFO_GID(fr->cginfo[cg_tp]);
 355     nener  = 1 + ngid;
 356     if (bDispCorr)
 357     {
 358         nener += 1;
 359     }
 360     if (bCharge)
 361     {
 362         nener += ngid;
 363         if (bRFExcl)
 364         {
 365             nener += 1;
 366         }
 367         if (EEL_FULL(fr->ic->eeltype))
 368         {
 369             nener += 1;
 370         }
 371     }
 372     snew(sum_UgembU, nener);
 373
 374     /* Copy the random seed set by the user */
 375     seed = inputrec->ld_seed;
 376
 377     gmx::ThreeFry2x64<16>                rng(seed, gmx::RandomDomain::TestParticleInsertion); // 16 bits internal counter => 2^16 * 2 = 131072 values per stream
 378     gmx::UniformRealDistribution<real>   dist;
 379
 380     if (MASTER(cr))
 381     {
 382         fp_tpi = xvgropen(opt2fn("-tpi", nfile, fnm),
 383                           "TPI energies", "Time (ps)",
 384                           "(kJ mol\\S-1\\N) / (nm\\S3\\N)", oenv);
 385         xvgr_subtitle(fp_tpi, "f. are averages over one frame", oenv);
 386         snew(leg, 4+nener);
 387         e = 0;
 388         sprintf(str, "-kT log(<Ve\\S-\\betaU\\N>/<V>)");
 389         leg[e++] = gmx_strdup(str);
 390         sprintf(str, "f. -kT log<e\\S-\\betaU\\N>");
 391         leg[e++] = gmx_strdup(str);
 392         sprintf(str, "f. <e\\S-\\betaU\\N>");
 393         leg[e++] = gmx_strdup(str);
 394         sprintf(str, "f. V");
 395         leg[e++] = gmx_strdup(str);
 396         sprintf(str, "f. <Ue\\S-\\betaU\\N>");
 397         leg[e++] = gmx_strdup(str);
 398         for (i = 0; i < ngid; i++)
 399         {
 400             sprintf(str, "f. <U\\sVdW %s\\Ne\\S-\\betaU\\N>",
 401                     *(groups->grpname[groups->grps[egcENER].nm_ind[i]]));
 402             leg[e++] = gmx_strdup(str);
 403         }
 404         if (bDispCorr)
 405         {
 406             sprintf(str, "f. <U\\sdisp c\\Ne\\S-\\betaU\\N>");
 407             leg[e++] = gmx_strdup(str);
 408         }
 409         if (bCharge)
 410         {
 411             for (i = 0; i < ngid; i++)
 412             {
 413                 sprintf(str, "f. <U\\sCoul %s\\Ne\\S-\\betaU\\N>",
 414                         *(groups->grpname[groups->grps[egcENER].nm_ind[i]]));
 415                 leg[e++] = gmx_strdup(str);
 416             }
 417             if (bRFExcl)
 418             {
 419                 sprintf(str, "f. <U\\sRF excl\\Ne\\S-\\betaU\\N>");
 420                 leg[e++] = gmx_strdup(str);
 421             }
 422             if (EEL_FULL(fr->ic->eeltype))
 423             {
 424                 sprintf(str, "f. <U\\sCoul recip\\Ne\\S-\\betaU\\N>");
 425                 leg[e++] = gmx_strdup(str);
 426             }
 427         }
 428         xvgr_legend(fp_tpi, 4+nener, leg, oenv);
 429         for (i = 0; i < 4+nener; i++)
 430         {
 431             sfree(leg[i]);
 432         }
 433         sfree(leg);
 434     }
 435     clear_rvec(x_init);
 436     V_all     = 0;
 437     VembU_all = 0;
 438
 439     invbinw = 10;
 440     nbin    = 10;
 441     snew(bin, nbin);
 442
 443     /* Avoid frame step numbers <= -1 */
 444     frame_step_prev = -1;
 445
 446     bNotLastFrame = read_first_frame(oenv, &status, opt2fn("-rerun", nfile, fnm),
 447                                      &rerun_fr, TRX_NEED_X);
 448     frame = 0;
 449
 450     if (rerun_fr.natoms - (bCavity ? nat_cavity : 0) !=
 451         mdatoms->nr - (a_tp1 - a_tp0))
 452     {
 453         gmx_fatal(FARGS, "Number of atoms in trajectory (%d)%s "
 454                   "is not equal the number in the run input file (%d) "
 455                   "minus the number of atoms to insert (%d)\n",
 456                   rerun_fr.natoms, bCavity ? " minus one" : "",
 457                   mdatoms->nr, a_tp1-a_tp0);
 458     }
 459
 460     refvolshift = log(det(rerun_fr.box));
 461
 462     switch (inputrec->eI)
 463     {
 464         case eiTPI:
 465             stepblocksize = inputrec->nstlist;
 466             break;
 467         case eiTPIC:
 468             stepblocksize = 1;
 469             break;
 470         default:
 471             gmx_fatal(FARGS, "Unknown integrator %s", ei_names[inputrec->eI]);
 472     }
 473
 474     while (bNotLastFrame)
 475     {
 476         frame_step      = rerun_fr.step;
 477         if (frame_step <= frame_step_prev)
 478         {
 479             /* We don't have step number in the trajectory file,
 480              * or we have constant or decreasing step numbers.
 481              * Ensure we have increasing step numbers, since we use
 482              * the step numbers as a counter for random numbers.
 483              */
 484             frame_step  = frame_step_prev + 1;
 485         }
 486         frame_step_prev = frame_step;
 487
 488         lambda = rerun_fr.lambda;
 489         t      = rerun_fr.time;
 490
 491         sum_embU = 0;
 492         for (e = 0; e < nener; e++)
 493         {
 494             sum_UgembU[e] = 0;
 495         }
 496
 497         /* Copy the coordinates from the input trajectory */
 498         auto x = makeArrayRef(state_global->x);
 499         for (i = 0; i < rerun_fr.natoms; i++)
 500         {
 501             copy_rvec(rerun_fr.x[i], x[i]);
 502         }
 503         copy_mat(rerun_fr.box, state_global->box);
 504
 505         V    = det(state_global->box);
 506         logV = log(V);
 507
 508         bStateChanged = TRUE;
 509         bNS           = TRUE;
 510
 511         step = cr->nodeid*stepblocksize;
 512         while (step < nsteps)
 513         {
 514             /* Restart random engine using the frame and insertion step
 515              * as counters.
 516              * Note that we need to draw several random values per iteration,
 517              * but by using the internal subcounter functionality of ThreeFry2x64
 518              * we can draw 131072 unique 64-bit values before exhausting
 519              * the stream. This is a huge margin, and if something still goes
 520              * wrong you will get an exception when the stream is exhausted.
 521              */
 522             rng.restart(frame_step, step);
 523             dist.reset();  // erase any memory in the distribution
 524
 525             if (!bCavity)
 526             {
 527                 /* Random insertion in the whole volume */
 528                 bNS = (step % inputrec->nstlist == 0);
 529                 if (bNS)
 530                 {
 531                     /* Generate a random position in the box */
 532                     for (d = 0; d < DIM; d++)
 533                     {
 534                         x_init[d] = dist(rng)*state_global->box[d][d];
 535                     }
 536                 }
 537
 538                 if (inputrec->nstlist == 1)
 539                 {
 540                     copy_rvec(x_init, x_tp);
 541                 }
 542                 else
 543                 {
 544                     /* Generate coordinates within |dx|=drmax of x_init */
 545                     do
 546                     {
 547                         for (d = 0; d < DIM; d++)
 548                         {
 549                             dx[d] = (2*dist(rng) - 1)*drmax;
 550                         }
 551                     }
 552                     while (norm2(dx) > drmax*drmax);
 553                     rvec_add(x_init, dx, x_tp);
 554                 }
 555             }
 556             else
 557             {
 558                 /* Random insertion around a cavity location
 559                  * given by the last coordinate of the trajectory.
 560                  */
 561                 if (step == 0)
 562                 {
 563                     if (nat_cavity == 1)
 564                     {
 565                         /* Copy the location of the cavity */
 566                         copy_rvec(rerun_fr.x[rerun_fr.natoms-1], x_init);
 567                     }
 568                     else
 569                     {
 570                         /* Determine the center of mass of the last molecule */
 571                         clear_rvec(x_init);
 572                         mass_tot = 0;
 573                         for (i = 0; i < nat_cavity; i++)
 574                         {
 575                             for (d = 0; d < DIM; d++)
 576                             {
 577                                 x_init[d] +=
 578                                     mass_cavity[i]*rerun_fr.x[rerun_fr.natoms-nat_cavity+i][d];
 579                             }
 580                             mass_tot += mass_cavity[i];
 581                         }
 582                         for (d = 0; d < DIM; d++)
 583                         {
 584                             x_init[d] /= mass_tot;
 585                         }
 586                     }
 587                 }
 588                 /* Generate coordinates within |dx|=drmax of x_init */
 589                 do
 590                 {
 591                     for (d = 0; d < DIM; d++)
 592                     {
 593                         dx[d] = (2*dist(rng) - 1)*drmax;
 594                     }
 595                 }
 596                 while (norm2(dx) > drmax*drmax);
 597                 rvec_add(x_init, dx, x_tp);
 598             }
 599
 600             if (a_tp1 - a_tp0 == 1)
 601             {
 602                 /* Insert a single atom, just copy the insertion location */
 603                 copy_rvec(x_tp, x[a_tp0]);
 604             }
 605             else
 606             {
 607                 /* Copy the coordinates from the top file */
 608                 for (i = a_tp0; i < a_tp1; i++)
 609                 {
 610                     copy_rvec(x_mol[i-a_tp0], x[i]);
 611                 }
 612                 /* Rotate the molecule randomly */
 613                 real angleX = 2*M_PI*dist(rng);
 614                 real angleY = 2*M_PI*dist(rng);
 615                 real angleZ = 2*M_PI*dist(rng);
 616                 rotate_conf(a_tp1-a_tp0, state_global->x.rvec_array()+a_tp0, nullptr,
 617                             angleX, angleY, angleZ);
 618                 /* Shift to the insertion location */
 619                 for (i = a_tp0; i < a_tp1; i++)
 620                 {
 621                     rvec_inc(x[i], x_tp);
 622                 }
 623             }
 624
 625             /* Clear some matrix variables  */
 626             clear_mat(force_vir);
 627             clear_mat(shake_vir);
 628             clear_mat(vir);
 629             clear_mat(pres);
 630
 631             /* Set the charge group center of mass of the test particle */
 632             copy_rvec(x_init, fr->cg_cm[top.cgs.nr-1]);
 633
 634             /* Calc energy (no forces) on new positions.
 635              * Since we only need the intermolecular energy
 636              * and the RF exclusion terms of the inserted molecule occur
 637              * within a single charge group we can pass NULL for the graph.
 638              * This also avoids shifts that would move charge groups
 639              * out of the box. */
 640             /* Make do_force do a single node force calculation */
 641             cr->nnodes = 1;
 642
 643             // TPI might place a particle so close that the potential
 644             // is infinite. Since this is intended to happen, we
 645             // temporarily suppress any exceptions that the processor
 646             // might raise, then restore the old behaviour.
 647             std::fenv_t floatingPointEnvironment;
 648             std::feholdexcept(&floatingPointEnvironment);
 649             do_force(fplog, cr, ms, inputrec, nullptr, nullptr,
 650                      step, nrnb, wcycle, &top, &top_global->groups,
 651                      state_global->box, state_global->x.arrayRefWithPadding(), &state_global->hist,
 652                      f.arrayRefWithPadding(), force_vir, mdatoms, enerd, fcd,
 653                      state_global->lambda,
 654                      nullptr, fr, ppForceWorkload, nullptr, mu_tot, t, nullptr,
 655                      GMX_FORCE_NONBONDED | GMX_FORCE_ENERGY |
 656                      (bNS ? GMX_FORCE_DYNAMICBOX | GMX_FORCE_NS : 0) |
 657                      (bStateChanged ? GMX_FORCE_STATECHANGED : 0),
 658                      DDBalanceRegionHandler(nullptr));
 659             std::feclearexcept(FE_DIVBYZERO | FE_INVALID | FE_OVERFLOW);
 660             std::feupdateenv(&floatingPointEnvironment);
 661
 662             cr->nnodes    = nnodes;
 663             bStateChanged = FALSE;
 664             bNS           = FALSE;
 665
 666             /* Calculate long range corrections to pressure and energy */
 667             calc_dispcorr(inputrec, fr, state_global->box,
 668                           lambda, pres, vir, &prescorr, &enercorr, &dvdlcorr);
 669             /* figure out how to rearrange the next 4 lines MRS 8/4/2009 */
 670             enerd->term[F_DISPCORR]  = enercorr;
 671             enerd->term[F_EPOT]     += enercorr;
 672             enerd->term[F_PRES]     += prescorr;
 673             enerd->term[F_DVDL_VDW] += dvdlcorr;
 674
 675             epot               = enerd->term[F_EPOT];
 676             bEnergyOutOfBounds = FALSE;
 677
 678             /* If the compiler doesn't optimize this check away
 679              * we catch the NAN energies.
 680              * The epot>GMX_REAL_MAX check catches inf values,
 681              * which should nicely result in embU=0 through the exp below,
 682              * but it does not hurt to check anyhow.
 683              */
 684             /* Non-bonded Interaction usually diverge at r=0.
 685              * With tabulated interaction functions the first few entries
 686              * should be capped in a consistent fashion between
 687              * repulsion, dispersion and Coulomb to avoid accidental
 688              * negative values in the total energy.
 689              * The table generation code in tables.c does this.
 690              * With user tbales the user should take care of this.
 691              */
 692             if (epot != epot || epot > GMX_REAL_MAX)
 693             {
 694                 bEnergyOutOfBounds = TRUE;
 695             }
 696             if (bEnergyOutOfBounds)
 697             {
 698                 if (debug)
 699                 {
 700                     fprintf(debug, "\n  time %.3f, step %d: non-finite energy %f, using exp(-bU)=0\n", t, static_cast<int>(step), epot);
 701                 }
 702                 embU = 0;
 703             }
 704             else
 705             {
 706                 // Exponent argument is fine in SP range, but output can be in DP range
 707                 embU      = exp(static_cast<double>(-beta*epot));
 708                 sum_embU += embU;
 709                 /* Determine the weighted energy contributions of each energy group */
 710                 e                = 0;
 711                 sum_UgembU[e++] += epot*embU;
 712                 if (fr->bBHAM)
 713                 {
 714                     for (i = 0; i < ngid; i++)
 715                     {
 716                         sum_UgembU[e++] +=
 717                             enerd->grpp.ener[egBHAMSR][GID(i, gid_tp, ngid)]*embU;
 718                     }
 719                 }
 720                 else
 721                 {
 722                     for (i = 0; i < ngid; i++)
 723                     {
 724                         sum_UgembU[e++] +=
 725                             enerd->grpp.ener[egLJSR][GID(i, gid_tp, ngid)]*embU;
 726                     }
 727                 }
 728                 if (bDispCorr)
 729                 {
 730                     sum_UgembU[e++] += enerd->term[F_DISPCORR]*embU;
 731                 }
 732                 if (bCharge)
 733                 {
 734                     for (i = 0; i < ngid; i++)
 735                     {
 736                         sum_UgembU[e++] += enerd->grpp.ener[egCOULSR][GID(i, gid_tp, ngid)] * embU;
 737                     }
 738                     if (bRFExcl)
 739                     {
 740                         sum_UgembU[e++] += enerd->term[F_RF_EXCL]*embU;
 741                     }
 742                     if (EEL_FULL(fr->ic->eeltype))
 743                     {
 744                         sum_UgembU[e++] += enerd->term[F_COUL_RECIP]*embU;
 745                     }
 746                 }
 747             }
 748
 749             if (embU == 0 || beta*epot > bU_bin_limit)
 750             {
 751                 bin[0]++;
 752             }
 753             else
 754             {
 755                 i = gmx::roundToInt((bU_logV_bin_limit
 756                                      - (beta*epot - logV + refvolshift))*invbinw);
 757                 if (i < 0)
 758                 {
 759                     i = 0;
 760                 }
 761                 if (i >= nbin)
 762                 {
 763                     realloc_bins(&bin, &nbin, i+10);
 764                 }
 765                 bin[i]++;
 766             }
 767
 768             if (debug)
 769             {
 770                 fprintf(debug, "TPI %7d %12.5e %12.5f %12.5f %12.5f\n",
 771                         static_cast<int>(step), epot, x_tp[XX], x_tp[YY], x_tp[ZZ]);
 772             }
 773
 774             if (dump_pdb && epot <= dump_ener)
 775             {
 776                 sprintf(str, "t%g_step%d.pdb", t, static_cast<int>(step));
 777                 sprintf(str2, "t: %f step %d ener: %f", t, static_cast<int>(step), epot);
 778                 write_sto_conf_mtop(str, str2, top_global, state_global->x.rvec_array(), state_global->v.rvec_array(),
 779                                     inputrec->ePBC, state_global->box);
 780             }
 781
 782             step++;
 783             if ((step/stepblocksize) % cr->nnodes != cr->nodeid)
 784             {
 785                 /* Skip all steps assigned to the other MPI ranks */
 786                 step += (cr->nnodes - 1)*stepblocksize;
 787             }
 788         }
 789
 790         if (PAR(cr))
 791         {
 792             /* When running in parallel sum the energies over the processes */
 793             gmx_sumd(1,    &sum_embU, cr);
 794             gmx_sumd(nener, sum_UgembU, cr);
 795         }
 796
 797         frame++;
 798         V_all     += V;
 799         VembU_all += V*sum_embU/nsteps;
 800
 801         if (fp_tpi)
 802         {
 803             if (mdrunOptions.verbose || frame%10 == 0 || frame < 10)
 804             {
 805                 fprintf(stderr, "mu %10.3e <mu> %10.3e\n",
 806                         -log(sum_embU/nsteps)/beta, -log(VembU_all/V_all)/beta);
 807             }
 808
 809             fprintf(fp_tpi, "%10.3f %12.5e %12.5e %12.5e %12.5e",
 810                     t,
 811                     VembU_all == 0 ? 20/beta : -log(VembU_all/V_all)/beta,
 812                     sum_embU == 0  ? 20/beta : -log(sum_embU/nsteps)/beta,
 813                     sum_embU/nsteps, V);
 814             for (e = 0; e < nener; e++)
 815             {
 816                 fprintf(fp_tpi, " %12.5e", sum_UgembU[e]/nsteps);
 817             }
 818             fprintf(fp_tpi, "\n");
 819             fflush(fp_tpi);
 820         }
 821
 822         bNotLastFrame = read_next_frame(oenv, status, &rerun_fr);
 823     }   /* End of the loop  */
 824     walltime_accounting_end_time(walltime_accounting);
 825
 826     close_trx(status);
 827
 828     if (fp_tpi != nullptr)
 829     {
 830         xvgrclose(fp_tpi);
 831     }
 832
 833     if (fplog != nullptr)
 834     {
 835         fprintf(fplog, "\n");
 836         fprintf(fplog, "  <V>  = %12.5e nm^3\n", V_all/frame);
 837         const double mu = -log(VembU_all/V_all)/beta;
 838         fprintf(fplog, "  <mu> = %12.5e kJ/mol\n", mu);
 839
 840         if (!std::isfinite(mu))
 841         {
 842             fprintf(fplog, "\nThe computed chemical potential is not finite - consider increasing the number of steps and/or the number of frames to insert into.\n");
 843         }
 844     }
 845
 846     /* Write the Boltzmann factor histogram */
 847     if (PAR(cr))
 848     {
 849         /* When running in parallel sum the bins over the processes */
 850         i = nbin;
 851         global_max(cr, &i);
 852         realloc_bins(&bin, &nbin, i);
 853         gmx_sumd(nbin, bin, cr);
 854     }
 855     if (MASTER(cr))
 856     {
 857         fp_tpi = xvgropen(opt2fn("-tpid", nfile, fnm),
 858                           "TPI energy distribution",
 859                           "\\betaU - log(V/<V>)", "count", oenv);
 860         sprintf(str, "number \\betaU > %g: %9.3e", bU_bin_limit, bin[0]);
 861         xvgr_subtitle(fp_tpi, str, oenv);
 862         xvgr_legend(fp_tpi, 2, tpid_leg, oenv);
 863         for (i = nbin-1; i > 0; i--)
 864         {
 865             bUlogV = -i/invbinw + bU_logV_bin_limit - refvolshift + log(V_all/frame);
 866             fprintf(fp_tpi, "%6.2f %10d %12.5e\n",
 867                     bUlogV,
 868                     roundToInt(bin[i]),
 869                     bin[i]*exp(-bUlogV)*V_all/VembU_all);
 870         }
 871         xvgrclose(fp_tpi);
 872     }
 873     sfree(bin);
 874
 875     sfree(sum_UgembU);
 876
 877     walltime_accounting_set_nsteps_done(walltime_accounting, frame*inputrec->nsteps);
 878 }
 879
 880 } // namespace gmx