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