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