src/programs/mdrun/repl_ex.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) 2011,2012,2013,2014, 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
  38 #include "repl_ex.h"
  39
  40 #include "config.h"
  41
  42 #include <math.h>
  43
  44 #include "network.h"
  45 #include "gromacs/random/random.h"
  46 #include "gromacs/utility/smalloc.h"
  47 #include "gromacs/math/units.h"
  48 #include "copyrite.h"
  49 #include "gromacs/math/vec.h"
  50 #include "names.h"
  51 #include "domdec.h"
  52 #include "main.h"
  53 #include "gromacs/random/random.h"
  54
  55 #define PROBABILITYCUTOFF 100
  56 /* we don't bother evaluating if events are more rare than exp(-100) = 3.7x10^-44 */
  57
  58 enum {
  59     ereTEMP, ereLAMBDA, ereENDSINGLE, ereTL, ereNR
  60 };
  61 const char *erename[ereNR] = { "temperature", "lambda", "end_single_marker", "temperature and lambda"};
  62 /* end_single_marker merely notes the end of single variable replica exchange. All types higher than
  63    it are multiple replica exchange methods */
  64 /* Eventually, should add 'pressure', 'temperature and pressure', 'lambda_and_pressure', 'temperature_lambda_pressure'?;
  65    Let's wait until we feel better about the pressure control methods giving exact ensembles.  Right now, we assume constant pressure  */
  66
  67 typedef struct gmx_repl_ex
  68 {
  69     int       repl;
  70     int       nrepl;
  71     real      temp;
  72     int       type;
  73     real    **q;
  74     gmx_bool  bNPT;
  75     real     *pres;
  76     int      *ind;
  77     int      *allswaps;
  78     int       nst;
  79     int       nex;
  80     int       seed;
  81     int       nattempt[2];
  82     real     *prob_sum;
  83     int     **nmoves;
  84     int      *nexchange;
  85     gmx_rng_t rng;
  86
  87     /* these are helper arrays for replica exchange; allocated here so they
  88        don't have to be allocated each time */
  89     int      *destinations;
  90     int     **cyclic;
  91     int     **order;
  92     int      *tmpswap;
  93     gmx_bool *incycle;
  94     gmx_bool *bEx;
  95
  96     /* helper arrays to hold the quantities that are exchanged */
  97     real  *prob;
  98     real  *Epot;
  99     real  *beta;
 100     real  *Vol;
 101     real **de;
 102
 103 } t_gmx_repl_ex;
 104
 105 static gmx_bool repl_quantity(const gmx_multisim_t *ms,
 106                               struct gmx_repl_ex *re, int ere, real q)
 107 {
 108     real    *qall;
 109     gmx_bool bDiff;
 110     int      s;
 111
 112     snew(qall, ms->nsim);
 113     qall[re->repl] = q;
 114     gmx_sum_sim(ms->nsim, qall, ms);
 115
 116     bDiff = FALSE;
 117     for (s = 1; s < ms->nsim; s++)
 118     {
 119         if (qall[s] != qall[0])
 120         {
 121             bDiff = TRUE;
 122         }
 123     }
 124
 125     if (bDiff)
 126     {
 127         /* Set the replica exchange type and quantities */
 128         re->type = ere;
 129
 130         snew(re->q[ere], re->nrepl);
 131         for (s = 0; s < ms->nsim; s++)
 132         {
 133             re->q[ere][s] = qall[s];
 134         }
 135     }
 136     sfree(qall);
 137     return bDiff;
 138 }
 139
 140 gmx_repl_ex_t init_replica_exchange(FILE *fplog,
 141                                     const gmx_multisim_t *ms,
 142                                     const t_state *state,
 143                                     const t_inputrec *ir,
 144                                     int nst, int nex, int init_seed)
 145 {
 146     real                pres;
 147     int                 i, j, k;
 148     struct gmx_repl_ex *re;
 149     gmx_bool            bTemp;
 150     gmx_bool            bLambda = FALSE;
 151
 152     fprintf(fplog, "\nInitializing Replica Exchange\n");
 153
 154     if (ms == NULL || ms->nsim == 1)
 155     {
 156         gmx_fatal(FARGS, "Nothing to exchange with only one replica, maybe you forgot to set the -multi option of mdrun?");
 157     }
 158     if (!EI_DYNAMICS(ir->eI))
 159     {
 160         gmx_fatal(FARGS, "Replica exchange is only supported by dynamical simulations");
 161         /* Note that PAR(cr) is defined by cr->nnodes > 1, which is
 162          * distinct from MULTISIM(cr). A multi-simulation only runs
 163          * with real MPI parallelism, but this does not imply PAR(cr)
 164          * is true!
 165          *
 166          * Since we are using a dynamical integrator, the only
 167          * decomposition is DD, so PAR(cr) and DOMAINDECOMP(cr) are
 168          * synonymous. The only way for cr->nnodes > 1 to be true is
 169          * if we are using DD. */
 170     }
 171
 172     snew(re, 1);
 173
 174     re->repl     = ms->sim;
 175     re->nrepl    = ms->nsim;
 176     snew(re->q, ereENDSINGLE);
 177
 178     fprintf(fplog, "Repl  There are %d replicas:\n", re->nrepl);
 179
 180     check_multi_int(fplog, ms, state->natoms, "the number of atoms", FALSE);
 181     check_multi_int(fplog, ms, ir->eI, "the integrator", FALSE);
 182     check_multi_int64(fplog, ms, ir->init_step+ir->nsteps, "init_step+nsteps", FALSE);
 183     check_multi_int64(fplog, ms, (ir->init_step+nst-1)/nst,
 184                       "first exchange step: init_step/-replex", FALSE);
 185     check_multi_int(fplog, ms, ir->etc, "the temperature coupling", FALSE);
 186     check_multi_int(fplog, ms, ir->opts.ngtc,
 187                     "the number of temperature coupling groups", FALSE);
 188     check_multi_int(fplog, ms, ir->epc, "the pressure coupling", FALSE);
 189     check_multi_int(fplog, ms, ir->efep, "free energy", FALSE);
 190     check_multi_int(fplog, ms, ir->fepvals->n_lambda, "number of lambda states", FALSE);
 191
 192     re->temp = ir->opts.ref_t[0];
 193     for (i = 1; (i < ir->opts.ngtc); i++)
 194     {
 195         if (ir->opts.ref_t[i] != re->temp)
 196         {
 197             fprintf(fplog, "\nWARNING: The temperatures of the different temperature coupling groups are not identical\n\n");
 198             fprintf(stderr, "\nWARNING: The temperatures of the different temperature coupling groups are not identical\n\n");
 199         }
 200     }
 201
 202     re->type = -1;
 203     bTemp    = repl_quantity(ms, re, ereTEMP, re->temp);
 204     if (ir->efep != efepNO)
 205     {
 206         bLambda = repl_quantity(ms, re, ereLAMBDA, (real)ir->fepvals->init_fep_state);
 207     }
 208     if (re->type == -1)  /* nothing was assigned */
 209     {
 210         gmx_fatal(FARGS, "The properties of the %d systems are all the same, there is nothing to exchange", re->nrepl);
 211     }
 212     if (bLambda && bTemp)
 213     {
 214         re->type = ereTL;
 215     }
 216
 217     if (bTemp)
 218     {
 219         please_cite(fplog, "Sugita1999a");
 220         if (ir->epc != epcNO)
 221         {
 222             re->bNPT = TRUE;
 223             fprintf(fplog, "Repl  Using Constant Pressure REMD.\n");
 224             please_cite(fplog, "Okabe2001a");
 225         }
 226         if (ir->etc == etcBERENDSEN)
 227         {
 228             gmx_fatal(FARGS, "REMD with the %s thermostat does not produce correct potential energy distributions, consider using the %s thermostat instead",
 229                       ETCOUPLTYPE(ir->etc), ETCOUPLTYPE(etcVRESCALE));
 230         }
 231     }
 232     if (bLambda)
 233     {
 234         if (ir->fepvals->delta_lambda != 0)   /* check this? */
 235         {
 236             gmx_fatal(FARGS, "delta_lambda is not zero");
 237         }
 238     }
 239     if (re->bNPT)
 240     {
 241         snew(re->pres, re->nrepl);
 242         if (ir->epct == epctSURFACETENSION)
 243         {
 244             pres = ir->ref_p[ZZ][ZZ];
 245         }
 246         else
 247         {
 248             pres = 0;
 249             j    = 0;
 250             for (i = 0; i < DIM; i++)
 251             {
 252                 if (ir->compress[i][i] != 0)
 253                 {
 254                     pres += ir->ref_p[i][i];
 255                     j++;
 256                 }
 257             }
 258             pres /= j;
 259         }
 260         re->pres[re->repl] = pres;
 261         gmx_sum_sim(re->nrepl, re->pres, ms);
 262     }
 263
 264     /* Make an index for increasing replica order */
 265     /* only makes sense if one or the other is varying, not both!
 266        if both are varying, we trust the order the person gave. */
 267     snew(re->ind, re->nrepl);
 268     for (i = 0; i < re->nrepl; i++)
 269     {
 270         re->ind[i] = i;
 271     }
 272
 273     if (re->type < ereENDSINGLE)
 274     {
 275
 276         for (i = 0; i < re->nrepl; i++)
 277         {
 278             for (j = i+1; j < re->nrepl; j++)
 279             {
 280                 if (re->q[re->type][re->ind[j]] < re->q[re->type][re->ind[i]])
 281                 {
 282                     /* Unordered replicas are supposed to work, but there
 283                      * is still an issues somewhere.
 284                      * Note that at this point still re->ind[i]=i.
 285                      */
 286                     gmx_fatal(FARGS, "Replicas with indices %d < %d have %ss %g > %g, please order your replicas on increasing %s",
 287                               i, j,
 288                               erename[re->type],
 289                               re->q[re->type][i], re->q[re->type][j],
 290                               erename[re->type]);
 291
 292                     k          = re->ind[i];
 293                     re->ind[i] = re->ind[j];
 294                     re->ind[j] = k;
 295                 }
 296                 else if (re->q[re->type][re->ind[j]] == re->q[re->type][re->ind[i]])
 297                 {
 298                     gmx_fatal(FARGS, "Two replicas have identical %ss", erename[re->type]);
 299                 }
 300             }
 301         }
 302     }
 303
 304     /* keep track of all the swaps, starting with the initial placement. */
 305     snew(re->allswaps, re->nrepl);
 306     for (i = 0; i < re->nrepl; i++)
 307     {
 308         re->allswaps[i] = re->ind[i];
 309     }
 310
 311     switch (re->type)
 312     {
 313         case ereTEMP:
 314             fprintf(fplog, "\nReplica exchange in temperature\n");
 315             for (i = 0; i < re->nrepl; i++)
 316             {
 317                 fprintf(fplog, " %5.1f", re->q[re->type][re->ind[i]]);
 318             }
 319             fprintf(fplog, "\n");
 320             break;
 321         case ereLAMBDA:
 322             fprintf(fplog, "\nReplica exchange in lambda\n");
 323             for (i = 0; i < re->nrepl; i++)
 324             {
 325                 fprintf(fplog, " %3d", (int)re->q[re->type][re->ind[i]]);
 326             }
 327             fprintf(fplog, "\n");
 328             break;
 329         case ereTL:
 330             fprintf(fplog, "\nReplica exchange in temperature and lambda state\n");
 331             for (i = 0; i < re->nrepl; i++)
 332             {
 333                 fprintf(fplog, " %5.1f", re->q[ereTEMP][re->ind[i]]);
 334             }
 335             fprintf(fplog, "\n");
 336             for (i = 0; i < re->nrepl; i++)
 337             {
 338                 fprintf(fplog, " %5d", (int)re->q[ereLAMBDA][re->ind[i]]);
 339             }
 340             fprintf(fplog, "\n");
 341             break;
 342         default:
 343             gmx_incons("Unknown replica exchange quantity");
 344     }
 345     if (re->bNPT)
 346     {
 347         fprintf(fplog, "\nRepl  p");
 348         for (i = 0; i < re->nrepl; i++)
 349         {
 350             fprintf(fplog, " %5.2f", re->pres[re->ind[i]]);
 351         }
 352
 353         for (i = 0; i < re->nrepl; i++)
 354         {
 355             if ((i > 0) && (re->pres[re->ind[i]] < re->pres[re->ind[i-1]]))
 356             {
 357                 fprintf(fplog, "\nWARNING: The reference pressures decrease with increasing temperatures\n\n");
 358                 fprintf(stderr, "\nWARNING: The reference pressures decrease with increasing temperatures\n\n");
 359             }
 360         }
 361     }
 362     re->nst = nst;
 363     if (init_seed == -1)
 364     {
 365         if (MASTERSIM(ms))
 366         {
 367             re->seed = (int)gmx_rng_make_seed();
 368         }
 369         else
 370         {
 371             re->seed = 0;
 372         }
 373         gmx_sumi_sim(1, &(re->seed), ms);
 374     }
 375     else
 376     {
 377         re->seed = init_seed;
 378     }
 379     fprintf(fplog, "\nReplica exchange interval: %d\n", re->nst);
 380     fprintf(fplog, "\nReplica random seed: %d\n", re->seed);
 381     re->rng = gmx_rng_init(re->seed);
 382
 383     re->nattempt[0] = 0;
 384     re->nattempt[1] = 0;
 385
 386     snew(re->prob_sum, re->nrepl);
 387     snew(re->nexchange, re->nrepl);
 388     snew(re->nmoves, re->nrepl);
 389     for (i = 0; i < re->nrepl; i++)
 390     {
 391         snew(re->nmoves[i], re->nrepl);
 392     }
 393     fprintf(fplog, "Replica exchange information below: x=exchange, pr=probability\n");
 394
 395     /* generate space for the helper functions so we don't have to snew each time */
 396
 397     snew(re->destinations, re->nrepl);
 398     snew(re->incycle, re->nrepl);
 399     snew(re->tmpswap, re->nrepl);
 400     snew(re->cyclic, re->nrepl);
 401     snew(re->order, re->nrepl);
 402     for (i = 0; i < re->nrepl; i++)
 403     {
 404         snew(re->cyclic[i], re->nrepl);
 405         snew(re->order[i], re->nrepl);
 406     }
 407     /* allocate space for the functions storing the data for the replicas */
 408     /* not all of these arrays needed in all cases, but they don't take
 409        up much space, since the max size is nrepl**2 */
 410     snew(re->prob, re->nrepl);
 411     snew(re->bEx, re->nrepl);
 412     snew(re->beta, re->nrepl);
 413     snew(re->Vol, re->nrepl);
 414     snew(re->Epot, re->nrepl);
 415     snew(re->de, re->nrepl);
 416     for (i = 0; i < re->nrepl; i++)
 417     {
 418         snew(re->de[i], re->nrepl);
 419     }
 420     re->nex = nex;
 421     return re;
 422 }
 423
 424 static void exchange_reals(const gmx_multisim_t gmx_unused *ms, int gmx_unused b, real *v, int n)
 425 {
 426     real *buf;
 427     int   i;
 428
 429     if (v)
 430     {
 431         snew(buf, n);
 432 #ifdef GMX_MPI
 433         /*
 434            MPI_Sendrecv(v,  n*sizeof(real),MPI_BYTE,MSRANK(ms,b),0,
 435            buf,n*sizeof(real),MPI_BYTE,MSRANK(ms,b),0,
 436            ms->mpi_comm_masters,MPI_STATUS_IGNORE);
 437          */
 438         {
 439             MPI_Request mpi_req;
 440
 441             MPI_Isend(v, n*sizeof(real), MPI_BYTE, MSRANK(ms, b), 0,
 442                       ms->mpi_comm_masters, &mpi_req);
 443             MPI_Recv(buf, n*sizeof(real), MPI_BYTE, MSRANK(ms, b), 0,
 444                      ms->mpi_comm_masters, MPI_STATUS_IGNORE);
 445             MPI_Wait(&mpi_req, MPI_STATUS_IGNORE);
 446         }
 447 #endif
 448         for (i = 0; i < n; i++)
 449         {
 450             v[i] = buf[i];
 451         }
 452         sfree(buf);
 453     }
 454 }
 455
 456
 457 static void exchange_ints(const gmx_multisim_t gmx_unused *ms, int gmx_unused b, int *v, int n)
 458 {
 459     int *buf;
 460     int  i;
 461
 462     if (v)
 463     {
 464         snew(buf, n);
 465 #ifdef GMX_MPI
 466         /*
 467            MPI_Sendrecv(v,  n*sizeof(int),MPI_BYTE,MSRANK(ms,b),0,
 468              buf,n*sizeof(int),MPI_BYTE,MSRANK(ms,b),0,
 469              ms->mpi_comm_masters,MPI_STATUS_IGNORE);
 470          */
 471         {
 472             MPI_Request mpi_req;
 473
 474             MPI_Isend(v, n*sizeof(int), MPI_BYTE, MSRANK(ms, b), 0,
 475                       ms->mpi_comm_masters, &mpi_req);
 476             MPI_Recv(buf, n*sizeof(int), MPI_BYTE, MSRANK(ms, b), 0,
 477                      ms->mpi_comm_masters, MPI_STATUS_IGNORE);
 478             MPI_Wait(&mpi_req, MPI_STATUS_IGNORE);
 479         }
 480 #endif
 481         for (i = 0; i < n; i++)
 482         {
 483             v[i] = buf[i];
 484         }
 485         sfree(buf);
 486     }
 487 }
 488
 489 static void exchange_doubles(const gmx_multisim_t gmx_unused *ms, int gmx_unused b, double *v, int n)
 490 {
 491     double *buf;
 492     int     i;
 493
 494     if (v)
 495     {
 496         snew(buf, n);
 497 #ifdef GMX_MPI
 498         /*
 499            MPI_Sendrecv(v,  n*sizeof(double),MPI_BYTE,MSRANK(ms,b),0,
 500            buf,n*sizeof(double),MPI_BYTE,MSRANK(ms,b),0,
 501            ms->mpi_comm_masters,MPI_STATUS_IGNORE);
 502          */
 503         {
 504             MPI_Request mpi_req;
 505
 506             MPI_Isend(v, n*sizeof(double), MPI_BYTE, MSRANK(ms, b), 0,
 507                       ms->mpi_comm_masters, &mpi_req);
 508             MPI_Recv(buf, n*sizeof(double), MPI_BYTE, MSRANK(ms, b), 0,
 509                      ms->mpi_comm_masters, MPI_STATUS_IGNORE);
 510             MPI_Wait(&mpi_req, MPI_STATUS_IGNORE);
 511         }
 512 #endif
 513         for (i = 0; i < n; i++)
 514         {
 515             v[i] = buf[i];
 516         }
 517         sfree(buf);
 518     }
 519 }
 520
 521 static void exchange_rvecs(const gmx_multisim_t gmx_unused *ms, int gmx_unused b, rvec *v, int n)
 522 {
 523     rvec *buf;
 524     int   i;
 525
 526     if (v)
 527     {
 528         snew(buf, n);
 529 #ifdef GMX_MPI
 530         /*
 531            MPI_Sendrecv(v[0],  n*sizeof(rvec),MPI_BYTE,MSRANK(ms,b),0,
 532            buf[0],n*sizeof(rvec),MPI_BYTE,MSRANK(ms,b),0,
 533            ms->mpi_comm_masters,MPI_STATUS_IGNORE);
 534          */
 535         {
 536             MPI_Request mpi_req;
 537
 538             MPI_Isend(v[0], n*sizeof(rvec), MPI_BYTE, MSRANK(ms, b), 0,
 539                       ms->mpi_comm_masters, &mpi_req);
 540             MPI_Recv(buf[0], n*sizeof(rvec), MPI_BYTE, MSRANK(ms, b), 0,
 541                      ms->mpi_comm_masters, MPI_STATUS_IGNORE);
 542             MPI_Wait(&mpi_req, MPI_STATUS_IGNORE);
 543         }
 544 #endif
 545         for (i = 0; i < n; i++)
 546         {
 547             copy_rvec(buf[i], v[i]);
 548         }
 549         sfree(buf);
 550     }
 551 }
 552
 553 static void exchange_state(const gmx_multisim_t *ms, int b, t_state *state)
 554 {
 555     /* When t_state changes, this code should be updated. */
 556     int ngtc, nnhpres;
 557     ngtc    = state->ngtc * state->nhchainlength;
 558     nnhpres = state->nnhpres* state->nhchainlength;
 559     exchange_rvecs(ms, b, state->box, DIM);
 560     exchange_rvecs(ms, b, state->box_rel, DIM);
 561     exchange_rvecs(ms, b, state->boxv, DIM);
 562     exchange_reals(ms, b, &(state->veta), 1);
 563     exchange_reals(ms, b, &(state->vol0), 1);
 564     exchange_rvecs(ms, b, state->svir_prev, DIM);
 565     exchange_rvecs(ms, b, state->fvir_prev, DIM);
 566     exchange_rvecs(ms, b, state->pres_prev, DIM);
 567     exchange_doubles(ms, b, state->nosehoover_xi, ngtc);
 568     exchange_doubles(ms, b, state->nosehoover_vxi, ngtc);
 569     exchange_doubles(ms, b, state->nhpres_xi, nnhpres);
 570     exchange_doubles(ms, b, state->nhpres_vxi, nnhpres);
 571     exchange_doubles(ms, b, state->therm_integral, state->ngtc);
 572     exchange_rvecs(ms, b, state->x, state->natoms);
 573     exchange_rvecs(ms, b, state->v, state->natoms);
 574     exchange_rvecs(ms, b, state->sd_X, state->natoms);
 575 }
 576
 577 static void copy_rvecs(rvec *s, rvec *d, int n)
 578 {
 579     int i;
 580
 581     if (d != NULL)
 582     {
 583         for (i = 0; i < n; i++)
 584         {
 585             copy_rvec(s[i], d[i]);
 586         }
 587     }
 588 }
 589
 590 static void copy_doubles(const double *s, double *d, int n)
 591 {
 592     int i;
 593
 594     if (d != NULL)
 595     {
 596         for (i = 0; i < n; i++)
 597         {
 598             d[i] = s[i];
 599         }
 600     }
 601 }
 602
 603 static void copy_reals(const real *s, real *d, int n)
 604 {
 605     int i;
 606
 607     if (d != NULL)
 608     {
 609         for (i = 0; i < n; i++)
 610         {
 611             d[i] = s[i];
 612         }
 613     }
 614 }
 615
 616 static void copy_ints(const int *s, int *d, int n)
 617 {
 618     int i;
 619
 620     if (d != NULL)
 621     {
 622         for (i = 0; i < n; i++)
 623         {
 624             d[i] = s[i];
 625         }
 626     }
 627 }
 628
 629 #define scopy_rvecs(v, n)   copy_rvecs(state->v, state_local->v, n);
 630 #define scopy_doubles(v, n) copy_doubles(state->v, state_local->v, n);
 631 #define scopy_reals(v, n) copy_reals(state->v, state_local->v, n);
 632 #define scopy_ints(v, n)   copy_ints(state->v, state_local->v, n);
 633
 634 static void copy_state_nonatomdata(t_state *state, t_state *state_local)
 635 {
 636     /* When t_state changes, this code should be updated. */
 637     int ngtc, nnhpres;
 638     ngtc    = state->ngtc * state->nhchainlength;
 639     nnhpres = state->nnhpres* state->nhchainlength;
 640     scopy_rvecs(box, DIM);
 641     scopy_rvecs(box_rel, DIM);
 642     scopy_rvecs(boxv, DIM);
 643     state_local->veta = state->veta;
 644     state_local->vol0 = state->vol0;
 645     scopy_rvecs(svir_prev, DIM);
 646     scopy_rvecs(fvir_prev, DIM);
 647     scopy_rvecs(pres_prev, DIM);
 648     scopy_doubles(nosehoover_xi, ngtc);
 649     scopy_doubles(nosehoover_vxi, ngtc);
 650     scopy_doubles(nhpres_xi, nnhpres);
 651     scopy_doubles(nhpres_vxi, nnhpres);
 652     scopy_doubles(therm_integral, state->ngtc);
 653     scopy_rvecs(x, state->natoms);
 654     scopy_rvecs(v, state->natoms);
 655     scopy_rvecs(sd_X, state->natoms);
 656     copy_ints(&(state->fep_state), &(state_local->fep_state), 1);
 657     scopy_reals(lambda, efptNR);
 658 }
 659
 660 static void scale_velocities(t_state *state, real fac)
 661 {
 662     int i;
 663
 664     if (state->v)
 665     {
 666         for (i = 0; i < state->natoms; i++)
 667         {
 668             svmul(fac, state->v[i], state->v[i]);
 669         }
 670     }
 671 }
 672
 673 static void print_transition_matrix(FILE *fplog, int n, int **nmoves, int *nattempt)
 674 {
 675     int   i, j, ntot;
 676     float Tprint;
 677
 678     ntot = nattempt[0] + nattempt[1];
 679     fprintf(fplog, "\n");
 680     fprintf(fplog, "Repl");
 681     for (i = 0; i < n; i++)
 682     {
 683         fprintf(fplog, "    ");  /* put the title closer to the center */
 684     }
 685     fprintf(fplog, "Empirical Transition Matrix\n");
 686
 687     fprintf(fplog, "Repl");
 688     for (i = 0; i < n; i++)
 689     {
 690         fprintf(fplog, "%8d", (i+1));
 691     }
 692     fprintf(fplog, "\n");
 693
 694     for (i = 0; i < n; i++)
 695     {
 696         fprintf(fplog, "Repl");
 697         for (j = 0; j < n; j++)
 698         {
 699             Tprint = 0.0;
 700             if (nmoves[i][j] > 0)
 701             {
 702                 Tprint = nmoves[i][j]/(2.0*ntot);
 703             }
 704             fprintf(fplog, "%8.4f", Tprint);
 705         }
 706         fprintf(fplog, "%3d\n", i);
 707     }
 708 }
 709
 710 static void print_ind(FILE *fplog, const char *leg, int n, int *ind, gmx_bool *bEx)
 711 {
 712     int i;
 713
 714     fprintf(fplog, "Repl %2s %2d", leg, ind[0]);
 715     for (i = 1; i < n; i++)
 716     {
 717         fprintf(fplog, " %c %2d", (bEx != 0 && bEx[i]) ? 'x' : ' ', ind[i]);
 718     }
 719     fprintf(fplog, "\n");
 720 }
 721
 722 static void print_allswitchind(FILE *fplog, int n, int *pind, int *allswaps, int *tmpswap)
 723 {
 724     int i;
 725
 726     for (i = 0; i < n; i++)
 727     {
 728         tmpswap[i] = allswaps[i];
 729     }
 730     for (i = 0; i < n; i++)
 731     {
 732         allswaps[i] = tmpswap[pind[i]];
 733     }
 734
 735     fprintf(fplog, "\nAccepted Exchanges:   ");
 736     for (i = 0; i < n; i++)
 737     {
 738         fprintf(fplog, "%d ", pind[i]);
 739     }
 740     fprintf(fplog, "\n");
 741
 742     /* the "Order After Exchange" is the state label corresponding to the configuration that
 743        started in state listed in order, i.e.
 744
 745        3 0 1 2
 746
 747        means that the:
 748        configuration starting in simulation 3 is now in simulation 0,
 749        configuration starting in simulation 0 is now in simulation 1,
 750        configuration starting in simulation 1 is now in simulation 2,
 751        configuration starting in simulation 2 is now in simulation 3
 752      */
 753     fprintf(fplog, "Order After Exchange: ");
 754     for (i = 0; i < n; i++)
 755     {
 756         fprintf(fplog, "%d ", allswaps[i]);
 757     }
 758     fprintf(fplog, "\n\n");
 759 }
 760
 761 static void print_prob(FILE *fplog, const char *leg, int n, real *prob)
 762 {
 763     int  i;
 764     char buf[8];
 765
 766     fprintf(fplog, "Repl %2s ", leg);
 767     for (i = 1; i < n; i++)
 768     {
 769         if (prob[i] >= 0)
 770         {
 771             sprintf(buf, "%4.2f", prob[i]);
 772             fprintf(fplog, "  %3s", buf[0] == '1' ? "1.0" : buf+1);
 773         }
 774         else
 775         {
 776             fprintf(fplog, "     ");
 777         }
 778     }
 779     fprintf(fplog, "\n");
 780 }
 781
 782 static void print_count(FILE *fplog, const char *leg, int n, int *count)
 783 {
 784     int i;
 785
 786     fprintf(fplog, "Repl %2s ", leg);
 787     for (i = 1; i < n; i++)
 788     {
 789         fprintf(fplog, " %4d", count[i]);
 790     }
 791     fprintf(fplog, "\n");
 792 }
 793
 794 static real calc_delta(FILE *fplog, gmx_bool bPrint, struct gmx_repl_ex *re, int a, int b, int ap, int bp)
 795 {
 796
 797     real   ediff, dpV, delta = 0;
 798     real  *Epot = re->Epot;
 799     real  *Vol  = re->Vol;
 800     real **de   = re->de;
 801     real  *beta = re->beta;
 802
 803     /* Two cases; we are permuted and not.  In all cases, setting ap = a and bp = b will reduce
 804        to the non permuted case */
 805
 806     switch (re->type)
 807     {
 808         case ereTEMP:
 809             /*
 810              * Okabe et. al. Chem. Phys. Lett. 335 (2001) 435-439
 811              */
 812             ediff = Epot[b] - Epot[a];
 813             delta = -(beta[bp] - beta[ap])*ediff;
 814             break;
 815         case ereLAMBDA:
 816             /* two cases:  when we are permuted, and not.  */
 817             /* non-permuted:
 818                ediff =  E_new - E_old
 819                      =  [H_b(x_a) + H_a(x_b)] - [H_b(x_b) + H_a(x_a)]
 820                      =  [H_b(x_a) - H_a(x_a)] + [H_a(x_b) - H_b(x_b)]
 821                      =  de[b][a] + de[a][b] */
 822
 823             /* permuted:
 824                ediff =  E_new - E_old
 825                      =  [H_bp(x_a) + H_ap(x_b)] - [H_bp(x_b) + H_ap(x_a)]
 826                      =  [H_bp(x_a) - H_ap(x_a)] + [H_ap(x_b) - H_bp(x_b)]
 827                      =  [H_bp(x_a) - H_a(x_a) + H_a(x_a) - H_ap(x_a)] + [H_ap(x_b) - H_b(x_b) + H_b(x_b) - H_bp(x_b)]
 828                      =  [H_bp(x_a) - H_a(x_a)] - [H_ap(x_a) - H_a(x_a)] + [H_ap(x_b) - H_b(x_b)] - H_bp(x_b) - H_b(x_b)]
 829                      =  (de[bp][a] - de[ap][a]) + (de[ap][b] - de[bp][b])    */
 830             /* but, in the current code implementation, we flip configurations, not indices . . .
 831                So let's examine that.
 832                      =  [H_b(x_ap) - H_a(x_a)] - [H_a(x_ap) - H_a(x_a)] + [H_a(x_bp) - H_b(x_b)] - H_b(x_bp) - H_b(x_b)]
 833                      =  [H_b(x_ap) - H_a(x_ap)]  + [H_a(x_bp) - H_b(x_pb)]
 834                      = (de[b][ap] - de[a][ap]) + (de[a][bp] - de[b][bp]
 835                      So, if we exchange b<=> bp and a<=> ap, we return to the same result.
 836                      So the simple solution is to flip the
 837                      position of perturbed and original indices in the tests.
 838              */
 839
 840             ediff = (de[bp][a] - de[ap][a]) + (de[ap][b] - de[bp][b]);
 841             delta = ediff*beta[a]; /* assume all same temperature in this case */
 842             break;
 843         case ereTL:
 844             /* not permuted:  */
 845             /* delta =  reduced E_new - reduced E_old
 846                      =  [beta_b H_b(x_a) + beta_a H_a(x_b)] - [beta_b H_b(x_b) + beta_a H_a(x_a)]
 847                      =  [beta_b H_b(x_a) - beta_a H_a(x_a)] + [beta_a H_a(x_b) - beta_b H_b(x_b)]
 848                      =  [beta_b dH_b(x_a) + beta_b H_a(x_a) - beta_a H_a(x_a)] +
 849                         [beta_a dH_a(x_b) + beta_a H_b(x_b) - beta_b H_b(x_b)]
 850                      =  [beta_b dH_b(x_a) + [beta_a dH_a(x_b) +
 851                         beta_b (H_a(x_a) - H_b(x_b)]) - beta_a (H_a(x_a) - H_b(x_b))
 852                      =  beta_b dH_b(x_a) + beta_a dH_a(x_b) - (beta_b - beta_a)(H_b(x_b) - H_a(x_a) */
 853             /* delta = beta[b]*de[b][a] + beta[a]*de[a][b] - (beta[b] - beta[a])*(Epot[b] - Epot[a]; */
 854             /* permuted (big breath!) */
 855             /*   delta =  reduced E_new - reduced E_old
 856                      =  [beta_bp H_bp(x_a) + beta_ap H_ap(x_b)] - [beta_bp H_bp(x_b) + beta_ap H_ap(x_a)]
 857                      =  [beta_bp H_bp(x_a) - beta_ap H_ap(x_a)] + [beta_ap H_ap(x_b) - beta_bp H_bp(x_b)]
 858                      =  [beta_bp H_bp(x_a) - beta_ap H_ap(x_a)] + [beta_ap H_ap(x_b) - beta_bp H_bp(x_b)]
 859                         - beta_pb H_a(x_a) + beta_ap H_a(x_a) + beta_pb H_a(x_a) - beta_ap H_a(x_a)
 860                         - beta_ap H_b(x_b) + beta_bp H_b(x_b) + beta_ap H_b(x_b) - beta_bp H_b(x_b)
 861                      =  [(beta_bp H_bp(x_a) - beta_bp H_a(x_a)) - (beta_ap H_ap(x_a) - beta_ap H_a(x_a))] +
 862                         [(beta_ap H_ap(x_b)  - beta_ap H_b(x_b)) - (beta_bp H_bp(x_b) - beta_bp H_b(x_b))]
 863              + beta_pb H_a(x_a) - beta_ap H_a(x_a) + beta_ap H_b(x_b) - beta_bp H_b(x_b)
 864                      =  [beta_bp (H_bp(x_a) - H_a(x_a)) - beta_ap (H_ap(x_a) - H_a(x_a))] +
 865                         [beta_ap (H_ap(x_b) - H_b(x_b)) - beta_bp (H_bp(x_b) - H_b(x_b))]
 866              + beta_pb (H_a(x_a) - H_b(x_b))  - beta_ap (H_a(x_a) - H_b(x_b))
 867                      =  ([beta_bp de[bp][a] - beta_ap de[ap][a]) + beta_ap de[ap][b]  - beta_bp de[bp][b])
 868              + (beta_pb-beta_ap)(H_a(x_a) - H_b(x_b))  */
 869             delta = beta[bp]*(de[bp][a] - de[bp][b]) + beta[ap]*(de[ap][b] - de[ap][a]) - (beta[bp]-beta[ap])*(Epot[b]-Epot[a]);
 870             break;
 871         default:
 872             gmx_incons("Unknown replica exchange quantity");
 873     }
 874     if (bPrint)
 875     {
 876         fprintf(fplog, "Repl %d <-> %d  dE_term = %10.3e (kT)\n", a, b, delta);
 877     }
 878     if (re->bNPT)
 879     {
 880         /* revist the calculation for 5.0.  Might be some improvements. */
 881         dpV = (beta[ap]*re->pres[ap]-beta[bp]*re->pres[bp])*(Vol[b]-Vol[a])/PRESFAC;
 882         if (bPrint)
 883         {
 884             fprintf(fplog, "  dpV = %10.3e  d = %10.3e\n", dpV, delta + dpV);
 885         }
 886         delta += dpV;
 887     }
 888     return delta;
 889 }
 890
 891 static void
 892 test_for_replica_exchange(FILE                 *fplog,
 893                           const gmx_multisim_t *ms,
 894                           struct gmx_repl_ex   *re,
 895                           gmx_enerdata_t       *enerd,
 896                           real                  vol,
 897                           gmx_int64_t           step,
 898                           real                  time)
 899 {
 900     int       m, i, j, a, b, ap, bp, i0, i1, tmp;
 901     real      delta = 0;
 902     gmx_bool  bPrint, bMultiEx;
 903     gmx_bool *bEx      = re->bEx;
 904     real     *prob     = re->prob;
 905     int      *pind     = re->destinations; /* permuted index */
 906     gmx_bool  bEpot    = FALSE;
 907     gmx_bool  bDLambda = FALSE;
 908     gmx_bool  bVol     = FALSE;
 909
 910     bMultiEx = (re->nex > 1);  /* multiple exchanges at each state */
 911     fprintf(fplog, "Replica exchange at step %" GMX_PRId64 " time %.5f\n", step, time);
 912
 913     if (re->bNPT)
 914     {
 915         for (i = 0; i < re->nrepl; i++)
 916         {
 917             re->Vol[i] = 0;
 918         }
 919         bVol               = TRUE;
 920         re->Vol[re->repl]  = vol;
 921     }
 922     if ((re->type == ereTEMP || re->type == ereTL))
 923     {
 924         for (i = 0; i < re->nrepl; i++)
 925         {
 926             re->Epot[i] = 0;
 927         }
 928         bEpot              = TRUE;
 929         re->Epot[re->repl] = enerd->term[F_EPOT];
 930         /* temperatures of different states*/
 931         for (i = 0; i < re->nrepl; i++)
 932         {
 933             re->beta[i] = 1.0/(re->q[ereTEMP][i]*BOLTZ);
 934         }
 935     }
 936     else
 937     {
 938         for (i = 0; i < re->nrepl; i++)
 939         {
 940             re->beta[i] = 1.0/(re->temp*BOLTZ);  /* we have a single temperature */
 941         }
 942     }
 943     if (re->type == ereLAMBDA || re->type == ereTL)
 944     {
 945         bDLambda = TRUE;
 946         /* lambda differences. */
 947         /* de[i][j] is the energy of the jth simulation in the ith Hamiltonian
 948            minus the energy of the jth simulation in the jth Hamiltonian */
 949         for (i = 0; i < re->nrepl; i++)
 950         {
 951             for (j = 0; j < re->nrepl; j++)
 952             {
 953                 re->de[i][j] = 0;
 954             }
 955         }
 956         for (i = 0; i < re->nrepl; i++)
 957         {
 958             re->de[i][re->repl] = (enerd->enerpart_lambda[(int)re->q[ereLAMBDA][i]+1]-enerd->enerpart_lambda[0]);
 959         }
 960     }
 961
 962     /* now actually do the communication */
 963     if (bVol)
 964     {
 965         gmx_sum_sim(re->nrepl, re->Vol, ms);
 966     }
 967     if (bEpot)
 968     {
 969         gmx_sum_sim(re->nrepl, re->Epot, ms);
 970     }
 971     if (bDLambda)
 972     {
 973         for (i = 0; i < re->nrepl; i++)
 974         {
 975             gmx_sum_sim(re->nrepl, re->de[i], ms);
 976         }
 977     }
 978
 979     /* make a duplicate set of indices for shuffling */
 980     for (i = 0; i < re->nrepl; i++)
 981     {
 982         pind[i] = re->ind[i];
 983     }
 984
 985     if (bMultiEx)
 986     {
 987         /* multiple random switch exchange */
 988         int nself = 0;
 989         for (i = 0; i < re->nex + nself; i++)
 990         {
 991             double rnd[2];
 992
 993             gmx_rng_cycle_2uniform(step, i*2, re->seed, RND_SEED_REPLEX, rnd);
 994             /* randomly select a pair  */
 995             /* in theory, could reduce this by identifying only which switches had a nonneglibible
 996                probability of occurring (log p > -100) and only operate on those switches */
 997             /* find out which state it is from, and what label that state currently has. Likely
 998                more work that useful. */
 999             i0 = (int)(re->nrepl*rnd[0]);
1000             i1 = (int)(re->nrepl*rnd[1]);
1001             if (i0 == i1)
1002             {
1003                 nself++;
1004                 continue;  /* self-exchange, back up and do it again */
1005             }
1006
1007             a  = re->ind[i0]; /* what are the indices of these states? */
1008             b  = re->ind[i1];
1009             ap = pind[i0];
1010             bp = pind[i1];
1011
1012             bPrint = FALSE; /* too noisy */
1013             /* calculate the energy difference */
1014             /* if the code changes to flip the STATES, rather than the configurations,
1015                use the commented version of the code */
1016             /* delta = calc_delta(fplog,bPrint,re,a,b,ap,bp); */
1017             delta = calc_delta(fplog, bPrint, re, ap, bp, a, b);
1018
1019             /* we actually only use the first space in the prob and bEx array,
1020                since there are actually many switches between pairs. */
1021
1022             if (delta <= 0)
1023             {
1024                 /* accepted */
1025                 prob[0] = 1;
1026                 bEx[0]  = TRUE;
1027             }
1028             else
1029             {
1030                 if (delta > PROBABILITYCUTOFF)
1031                 {
1032                     prob[0] = 0;
1033                 }
1034                 else
1035                 {
1036                     prob[0] = exp(-delta);
1037                 }
1038                 /* roll a number to determine if accepted */
1039                 gmx_rng_cycle_2uniform(step, i*2+1, re->seed, RND_SEED_REPLEX, rnd);
1040                 bEx[0] = rnd[0] < prob[0];
1041             }
1042             re->prob_sum[0] += prob[0];
1043
1044             if (bEx[0])
1045             {
1046                 /* swap the states */
1047                 tmp      = pind[i0];
1048                 pind[i0] = pind[i1];
1049                 pind[i1] = tmp;
1050             }
1051         }
1052         re->nattempt[0]++;  /* keep track of total permutation trials here */
1053         print_allswitchind(fplog, re->nrepl, pind, re->allswaps, re->tmpswap);
1054     }
1055     else
1056     {
1057         /* standard nearest neighbor replica exchange */
1058
1059         m = (step / re->nst) % 2;
1060         for (i = 1; i < re->nrepl; i++)
1061         {
1062             a = re->ind[i-1];
1063             b = re->ind[i];
1064
1065             bPrint = (re->repl == a || re->repl == b);
1066             if (i % 2 == m)
1067             {
1068                 delta = calc_delta(fplog, bPrint, re, a, b, a, b);
1069                 if (delta <= 0)
1070                 {
1071                     /* accepted */
1072                     prob[i] = 1;
1073                     bEx[i]  = TRUE;
1074                 }
1075                 else
1076                 {
1077                     double rnd[2];
1078
1079                     if (delta > PROBABILITYCUTOFF)
1080                     {
1081                         prob[i] = 0;
1082                     }
1083                     else
1084                     {
1085                         prob[i] = exp(-delta);
1086                     }
1087                     /* roll a number to determine if accepted */
1088                     gmx_rng_cycle_2uniform(step, i, re->seed, RND_SEED_REPLEX, rnd);
1089                     bEx[i] = rnd[0] < prob[i];
1090                 }
1091                 re->prob_sum[i] += prob[i];
1092
1093                 if (bEx[i])
1094                 {
1095                     /* swap these two */
1096                     tmp       = pind[i-1];
1097                     pind[i-1] = pind[i];
1098                     pind[i]   = tmp;
1099                     re->nexchange[i]++;  /* statistics for back compatibility */
1100                 }
1101             }
1102             else
1103             {
1104                 prob[i] = -1;
1105                 bEx[i]  = FALSE;
1106             }
1107         }
1108         /* print some statistics */
1109         print_ind(fplog, "ex", re->nrepl, re->ind, bEx);
1110         print_prob(fplog, "pr", re->nrepl, prob);
1111         fprintf(fplog, "\n");
1112         re->nattempt[m]++;
1113     }
1114
1115     /* record which moves were made and accepted */
1116     for (i = 0; i < re->nrepl; i++)
1117     {
1118         re->nmoves[re->ind[i]][pind[i]] += 1;
1119         re->nmoves[pind[i]][re->ind[i]] += 1;
1120     }
1121     fflush(fplog); /* make sure we can see what the last exchange was */
1122 }
1123
1124 static void write_debug_x(t_state *state)
1125 {
1126     int i;
1127
1128     if (debug)
1129     {
1130         for (i = 0; i < state->natoms; i += 10)
1131         {
1132             fprintf(debug, "dx %5d %10.5f %10.5f %10.5f\n", i, state->x[i][XX], state->x[i][YY], state->x[i][ZZ]);
1133         }
1134     }
1135 }
1136
1137 static void
1138 cyclic_decomposition(const int *destinations,
1139                      int      **cyclic,
1140                      gmx_bool  *incycle,
1141                      const int  nrepl,
1142                      int       *nswap)
1143 {
1144
1145     int i, j, c, p;
1146     int maxlen = 1;
1147     for (i = 0; i < nrepl; i++)
1148     {
1149         incycle[i] = FALSE;
1150     }
1151     for (i = 0; i < nrepl; i++)  /* one cycle for each replica */
1152     {
1153         if (incycle[i])
1154         {
1155             cyclic[i][0] = -1;
1156             continue;
1157         }
1158         cyclic[i][0] = i;
1159         incycle[i]   = TRUE;
1160         c            = 1;
1161         p            = i;
1162         for (j = 0; j < nrepl; j++) /* potentially all cycles are part, but we will break first */
1163         {
1164             p = destinations[p];    /* start permuting */
1165             if (p == i)
1166             {
1167                 cyclic[i][c] = -1;
1168                 if (c > maxlen)
1169                 {
1170                     maxlen = c;
1171                 }
1172                 break; /* we've reached the original element, the cycle is complete, and we marked the end. */
1173             }
1174             else
1175             {
1176                 cyclic[i][c] = p;  /* each permutation gives a new member of the cycle */
1177                 incycle[p]   = TRUE;
1178                 c++;
1179             }
1180         }
1181     }
1182     *nswap = maxlen - 1;
1183
1184     if (debug)
1185     {
1186         for (i = 0; i < nrepl; i++)
1187         {
1188             fprintf(debug, "Cycle %d:", i);
1189             for (j = 0; j < nrepl; j++)
1190             {
1191                 if (cyclic[i][j] < 0)
1192                 {
1193                     break;
1194                 }
1195                 fprintf(debug, "%2d", cyclic[i][j]);
1196             }
1197             fprintf(debug, "\n");
1198         }
1199         fflush(debug);
1200     }
1201 }
1202
1203 static void
1204 compute_exchange_order(FILE     *fplog,
1205                        int     **cyclic,
1206                        int     **order,
1207                        const int nrepl,
1208                        const int maxswap)
1209 {
1210     int i, j;
1211
1212     for (j = 0; j < maxswap; j++)
1213     {
1214         for (i = 0; i < nrepl; i++)
1215         {
1216             if (cyclic[i][j+1] >= 0)
1217             {
1218                 order[cyclic[i][j+1]][j] = cyclic[i][j];
1219                 order[cyclic[i][j]][j]   = cyclic[i][j+1];
1220             }
1221         }
1222         for (i = 0; i < nrepl; i++)
1223         {
1224             if (order[i][j] < 0)
1225             {
1226                 order[i][j] = i; /* if it's not exchanging, it should stay this round*/
1227             }
1228         }
1229     }
1230
1231     if (debug)
1232     {
1233         fprintf(fplog, "Replica Exchange Order\n");
1234         for (i = 0; i < nrepl; i++)
1235         {
1236             fprintf(fplog, "Replica %d:", i);
1237             for (j = 0; j < maxswap; j++)
1238             {
1239                 if (order[i][j] < 0)
1240                 {
1241                     break;
1242                 }
1243                 fprintf(debug, "%2d", order[i][j]);
1244             }
1245             fprintf(fplog, "\n");
1246         }
1247         fflush(fplog);
1248     }
1249 }
1250
1251 static void
1252 prepare_to_do_exchange(FILE               *fplog,
1253                        struct gmx_repl_ex *re,
1254                        const int           replica_id,
1255                        int                *maxswap,
1256                        gmx_bool           *bThisReplicaExchanged)
1257 {
1258     int i, j;
1259     /* Hold the cyclic decomposition of the (multiple) replica
1260      * exchange. */
1261     gmx_bool bAnyReplicaExchanged = FALSE;
1262     *bThisReplicaExchanged = FALSE;
1263
1264     for (i = 0; i < re->nrepl; i++)
1265     {
1266         if (re->destinations[i] != re->ind[i])
1267         {
1268             /* only mark as exchanged if the index has been shuffled */
1269             bAnyReplicaExchanged = TRUE;
1270             break;
1271         }
1272     }
1273     if (bAnyReplicaExchanged)
1274     {
1275         /* reinitialize the placeholder arrays */
1276         for (i = 0; i < re->nrepl; i++)
1277         {
1278             for (j = 0; j < re->nrepl; j++)
1279             {
1280                 re->cyclic[i][j] = -1;
1281                 re->order[i][j]  = -1;
1282             }
1283         }
1284
1285         /* Identify the cyclic decomposition of the permutation (very
1286          * fast if neighbor replica exchange). */
1287         cyclic_decomposition(re->destinations, re->cyclic, re->incycle, re->nrepl, maxswap);
1288
1289         /* Now translate the decomposition into a replica exchange
1290          * order at each step. */
1291         compute_exchange_order(fplog, re->cyclic, re->order, re->nrepl, *maxswap);
1292
1293         /* Did this replica do any exchange at any point? */
1294         for (j = 0; j < *maxswap; j++)
1295         {
1296             if (replica_id != re->order[replica_id][j])
1297             {
1298                 *bThisReplicaExchanged = TRUE;
1299                 break;
1300             }
1301         }
1302     }
1303 }
1304
1305 gmx_bool replica_exchange(FILE *fplog, const t_commrec *cr, struct gmx_repl_ex *re,
1306                           t_state *state, gmx_enerdata_t *enerd,
1307                           t_state *state_local, gmx_int64_t step, real time)
1308 {
1309     int j;
1310     int replica_id = 0;
1311     int exchange_partner;
1312     int maxswap = 0;
1313     /* Number of rounds of exchanges needed to deal with any multiple
1314      * exchanges. */
1315     /* Where each replica ends up after the exchange attempt(s). */
1316     /* The order in which multiple exchanges will occur. */
1317     gmx_bool bThisReplicaExchanged = FALSE;
1318
1319     if (MASTER(cr))
1320     {
1321         replica_id  = re->repl;
1322         test_for_replica_exchange(fplog, cr->ms, re, enerd, det(state_local->box), step, time);
1323         prepare_to_do_exchange(fplog, re, replica_id, &maxswap, &bThisReplicaExchanged);
1324     }
1325     /* Do intra-simulation broadcast so all processors belonging to
1326      * each simulation know whether they need to participate in
1327      * collecting the state. Otherwise, they might as well get on with
1328      * the next thing to do. */
1329     if (DOMAINDECOMP(cr))
1330     {
1331 #ifdef GMX_MPI
1332         MPI_Bcast(&bThisReplicaExchanged, sizeof(gmx_bool), MPI_BYTE, MASTERRANK(cr),
1333                   cr->mpi_comm_mygroup);
1334 #endif
1335     }
1336
1337     if (bThisReplicaExchanged)
1338     {
1339         /* Exchange the states */
1340         /* Collect the global state on the master node */
1341         if (DOMAINDECOMP(cr))
1342         {
1343             dd_collect_state(cr->dd, state_local, state);
1344         }
1345         else
1346         {
1347             copy_state_nonatomdata(state_local, state);
1348         }
1349
1350         if (MASTER(cr))
1351         {
1352             /* There will be only one swap cycle with standard replica
1353              * exchange, but there may be multiple swap cycles if we
1354              * allow multiple swaps. */
1355
1356             for (j = 0; j < maxswap; j++)
1357             {
1358                 exchange_partner = re->order[replica_id][j];
1359
1360                 if (exchange_partner != replica_id)
1361                 {
1362                     /* Exchange the global states between the master nodes */
1363                     if (debug)
1364                     {
1365                         fprintf(debug, "Exchanging %d with %d\n", replica_id, exchange_partner);
1366                     }
1367                     exchange_state(cr->ms, exchange_partner, state);
1368                 }
1369             }
1370             /* For temperature-type replica exchange, we need to scale
1371              * the velocities. */
1372             if (re->type == ereTEMP || re->type == ereTL)
1373             {
1374                 scale_velocities(state, sqrt(re->q[ereTEMP][replica_id]/re->q[ereTEMP][re->destinations[replica_id]]));
1375             }
1376
1377         }
1378
1379         /* With domain decomposition the global state is distributed later */
1380         if (!DOMAINDECOMP(cr))
1381         {
1382             /* Copy the global state to the local state data structure */
1383             copy_state_nonatomdata(state, state_local);
1384         }
1385     }
1386
1387     return bThisReplicaExchanged;
1388 }
1389
1390 void print_replica_exchange_statistics(FILE *fplog, struct gmx_repl_ex *re)
1391 {
1392     int  i;
1393
1394     fprintf(fplog, "\nReplica exchange statistics\n");
1395
1396     if (re->nex == 0)
1397     {
1398         fprintf(fplog, "Repl  %d attempts, %d odd, %d even\n",
1399                 re->nattempt[0]+re->nattempt[1], re->nattempt[1], re->nattempt[0]);
1400
1401         fprintf(fplog, "Repl  average probabilities:\n");
1402         for (i = 1; i < re->nrepl; i++)
1403         {
1404             if (re->nattempt[i%2] == 0)
1405             {
1406                 re->prob[i] = 0;
1407             }
1408             else
1409             {
1410                 re->prob[i] =  re->prob_sum[i]/re->nattempt[i%2];
1411             }
1412         }
1413         print_ind(fplog, "", re->nrepl, re->ind, NULL);
1414         print_prob(fplog, "", re->nrepl, re->prob);
1415
1416         fprintf(fplog, "Repl  number of exchanges:\n");
1417         print_ind(fplog, "", re->nrepl, re->ind, NULL);
1418         print_count(fplog, "", re->nrepl, re->nexchange);
1419
1420         fprintf(fplog, "Repl  average number of exchanges:\n");
1421         for (i = 1; i < re->nrepl; i++)
1422         {
1423             if (re->nattempt[i%2] == 0)
1424             {
1425                 re->prob[i] = 0;
1426             }
1427             else
1428             {
1429                 re->prob[i] =  ((real)re->nexchange[i])/re->nattempt[i%2];
1430             }
1431         }
1432         print_ind(fplog, "", re->nrepl, re->ind, NULL);
1433         print_prob(fplog, "", re->nrepl, re->prob);
1434
1435         fprintf(fplog, "\n");
1436     }
1437     /* print the transition matrix */
1438     print_transition_matrix(fplog, re->nrepl, re->nmoves, re->nattempt);
1439 }