src/gromacs/gmxlib/disre.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 /* This file is completely threadsafe - keep it that way! */
  38 #include "gmxpre.h"
  39
  40 #include "gromacs/legacyheaders/disre.h"
  41
  42 #include "config.h"
  43
  44 #include <cmath>
  45 #include <cstdlib>
  46 #include <cstring>
  47
  48 #include <algorithm>
  49
  50 #include "gromacs/legacyheaders/copyrite.h"
  51 #include "gromacs/legacyheaders/macros.h"
  52 #include "gromacs/legacyheaders/main.h"
  53 #include "gromacs/legacyheaders/typedefs.h"
  54 #include "gromacs/legacyheaders/types/commrec.h"
  55 #include "gromacs/math/vec.h"
  56 #include "gromacs/pbcutil/ishift.h"
  57 #include "gromacs/pbcutil/mshift.h"
  58 #include "gromacs/pbcutil/pbc.h"
  59 #include "gromacs/topology/mtop_util.h"
  60 #include "gromacs/utility/fatalerror.h"
  61 #include "gromacs/utility/futil.h"
  62 #include "gromacs/utility/smalloc.h"
  63
  64 void init_disres(FILE *fplog, const gmx_mtop_t *mtop,
  65                  t_inputrec *ir, const t_commrec *cr,
  66                  t_fcdata *fcd, t_state *state, gmx_bool bIsREMD)
  67 {
  68     int                  fa, nmol, npair, np;
  69     t_disresdata        *dd;
  70     history_t           *hist;
  71     gmx_mtop_ilistloop_t iloop;
  72     t_ilist             *il;
  73     char                *ptr;
  74
  75     dd = &(fcd->disres);
  76
  77     if (gmx_mtop_ftype_count(mtop, F_DISRES) == 0)
  78     {
  79         dd->nres = 0;
  80
  81         return;
  82     }
  83
  84     if (fplog)
  85     {
  86         fprintf(fplog, "Initializing the distance restraints\n");
  87     }
  88
  89
  90     if (ir->eDisre == edrEnsemble)
  91     {
  92         gmx_fatal(FARGS, "Sorry, distance restraints with ensemble averaging over multiple molecules in one system are not functional in this version of GROMACS");
  93     }
  94
  95     dd->dr_weighting = ir->eDisreWeighting;
  96     dd->dr_fc        = ir->dr_fc;
  97     if (EI_DYNAMICS(ir->eI))
  98     {
  99         dd->dr_tau   = ir->dr_tau;
 100     }
 101     else
 102     {
 103         dd->dr_tau   = 0.0;
 104     }
 105     if (dd->dr_tau == 0.0)
 106     {
 107         dd->dr_bMixed = FALSE;
 108         dd->ETerm     = 0.0;
 109     }
 110     else
 111     {
 112         dd->dr_bMixed = ir->bDisreMixed;
 113         dd->ETerm     = std::exp(-(ir->delta_t/ir->dr_tau));
 114     }
 115     dd->ETerm1        = 1.0 - dd->ETerm;
 116
 117     dd->nres  = 0;
 118     dd->npair = 0;
 119     iloop     = gmx_mtop_ilistloop_init(mtop);
 120     while (gmx_mtop_ilistloop_next(iloop, &il, &nmol))
 121     {
 122         np = 0;
 123         for (fa = 0; fa < il[F_DISRES].nr; fa += 3)
 124         {
 125             np++;
 126             npair = mtop->ffparams.iparams[il[F_DISRES].iatoms[fa]].disres.npair;
 127             if (np == npair)
 128             {
 129                 dd->nres  += (ir->eDisre == edrEnsemble ? 1 : nmol)*npair;
 130                 dd->npair += nmol*npair;
 131                 np         = 0;
 132             }
 133         }
 134     }
 135
 136     if (cr && PAR(cr))
 137     {
 138         /* Temporary check, will be removed when disre is implemented with DD */
 139         const char *notestr = "NOTE: atoms involved in distance restraints should be within the same domain. If this is not the case mdrun generates a fatal error. If you encounter this, use a single MPI rank (Verlet+OpenMP+GPUs work fine).";
 140
 141         if (MASTER(cr))
 142         {
 143             fprintf(stderr, "\n%s\n\n", notestr);
 144         }
 145         if (fplog)
 146         {
 147             fprintf(fplog, "%s\n", notestr);
 148         }
 149
 150         if (dd->dr_tau != 0 || ir->eDisre == edrEnsemble || cr->ms != NULL ||
 151             dd->nres != dd->npair)
 152         {
 153             gmx_fatal(FARGS, "Time or ensemble averaged or multiple pair distance restraints do not work (yet) with domain decomposition, use a single MPI rank%s", cr->ms ? " per simulation" : "");
 154         }
 155         if (ir->nstdisreout != 0)
 156         {
 157             if (fplog)
 158             {
 159                 fprintf(fplog, "\nWARNING: Can not write distance restraint data to energy file with domain decomposition\n\n");
 160             }
 161             if (MASTER(cr))
 162             {
 163                 fprintf(stderr, "\nWARNING: Can not write distance restraint data to energy file with domain decomposition\n");
 164             }
 165             ir->nstdisreout = 0;
 166         }
 167     }
 168
 169     snew(dd->rt, dd->npair);
 170
 171     if (dd->dr_tau != 0.0)
 172     {
 173         hist = &state->hist;
 174         /* Set the "history lack" factor to 1 */
 175         state->flags     |= (1<<estDISRE_INITF);
 176         hist->disre_initf = 1.0;
 177         /* Allocate space for the r^-3 time averages */
 178         state->flags     |= (1<<estDISRE_RM3TAV);
 179         hist->ndisrepairs = dd->npair;
 180         snew(hist->disre_rm3tav, hist->ndisrepairs);
 181     }
 182     /* Allocate space for a copy of rm3tav,
 183      * so we can call do_force without modifying the state.
 184      */
 185     snew(dd->rm3tav, dd->npair);
 186
 187     /* Allocate Rt_6 and Rtav_6 consecutively in memory so they can be
 188      * averaged over the processors in one call (in calc_disre_R_6)
 189      */
 190     snew(dd->Rt_6, 2*dd->nres);
 191     dd->Rtav_6 = &(dd->Rt_6[dd->nres]);
 192
 193     ptr = getenv("GMX_DISRE_ENSEMBLE_SIZE");
 194     if (cr && cr->ms != NULL && ptr != NULL && !bIsREMD)
 195     {
 196 #ifdef GMX_MPI
 197         dd->nsystems = 0;
 198         sscanf(ptr, "%d", &dd->nsystems);
 199         if (fplog)
 200         {
 201             fprintf(fplog, "Found GMX_DISRE_ENSEMBLE_SIZE set to %d systems per ensemble\n", dd->nsystems);
 202         }
 203         /* This check is only valid on MASTER(cr), so probably
 204          * ensemble-averaged distance restraints are broken on more
 205          * than one processor per simulation system. */
 206         if (MASTER(cr))
 207         {
 208             check_multi_int(fplog, cr->ms, dd->nsystems,
 209                             "the number of systems per ensemble",
 210                             FALSE);
 211         }
 212         gmx_bcast_sim(sizeof(int), &dd->nsystems, cr);
 213
 214         /* We use to allow any value of nsystems which was a divisor
 215          * of ms->nsim. But this required an extra communicator which
 216          * was stored in t_fcdata. This pulled in mpi.h in nearly all C files.
 217          */
 218         if (!(cr->ms->nsim == 1 || cr->ms->nsim == dd->nsystems))
 219         {
 220             gmx_fatal(FARGS, "GMX_DISRE_ENSEMBLE_SIZE (%d) is not equal to 1 or the number of systems (option -multi) %d", dd->nsystems, cr->ms->nsim);
 221         }
 222         if (fplog)
 223         {
 224             fprintf(fplog, "Our ensemble consists of systems:");
 225             for (int i = 0; i < dd->nsystems; i++)
 226             {
 227                 fprintf(fplog, " %d",
 228                         (cr->ms->sim/dd->nsystems)*dd->nsystems+i);
 229             }
 230             fprintf(fplog, "\n");
 231         }
 232         snew(dd->Rtl_6, dd->nres);
 233 #endif
 234     }
 235     else
 236     {
 237         dd->nsystems = 1;
 238         dd->Rtl_6    = dd->Rt_6;
 239     }
 240
 241     if (dd->npair > 0)
 242     {
 243         if (fplog)
 244         {
 245             fprintf(fplog, "There are %d distance restraints involving %d atom pairs\n", dd->nres, dd->npair);
 246         }
 247         /* Have to avoid g_disre de-referencing cr blindly, mdrun not
 248          * doing consistency checks for ensemble-averaged distance
 249          * restraints when that's not happening, and only doing those
 250          * checks from appropriate processes (since check_multi_int is
 251          * too broken to check whether the communication will
 252          * succeed...) */
 253         if (cr && cr->ms && dd->nsystems > 1 && MASTER(cr))
 254         {
 255             check_multi_int(fplog, cr->ms, fcd->disres.nres,
 256                             "the number of distance restraints",
 257                             FALSE);
 258         }
 259         please_cite(fplog, "Tropp80a");
 260         please_cite(fplog, "Torda89a");
 261     }
 262 }
 263
 264 void calc_disres_R_6(int nfa, const t_iatom forceatoms[], const t_iparams ip[],
 265                      const rvec x[], const t_pbc *pbc,
 266                      t_fcdata *fcd, history_t *hist)
 267 {
 268     atom_id         ai, aj;
 269     int             fa, res, pair;
 270     int             type, npair, np;
 271     rvec            dx;
 272     real           *rt, *rm3tav, *Rtl_6, *Rt_6, *Rtav_6;
 273     real            rt_1, rt_3, rt2;
 274     t_disresdata   *dd;
 275     real            ETerm, ETerm1, cf1 = 0, cf2 = 0, invn = 0;
 276     gmx_bool        bTav;
 277
 278     dd           = &(fcd->disres);
 279     bTav         = (dd->dr_tau != 0);
 280     ETerm        = dd->ETerm;
 281     ETerm1       = dd->ETerm1;
 282     rt           = dd->rt;
 283     rm3tav       = dd->rm3tav;
 284     Rtl_6        = dd->Rtl_6;
 285     Rt_6         = dd->Rt_6;
 286     Rtav_6       = dd->Rtav_6;
 287
 288     if (bTav)
 289     {
 290         /* scaling factor to smoothly turn on the restraint forces *
 291          * when using time averaging                               */
 292         dd->exp_min_t_tau = hist->disre_initf*ETerm;
 293
 294         cf1 = dd->exp_min_t_tau;
 295         cf2 = 1.0/(1.0 - dd->exp_min_t_tau);
 296     }
 297
 298     if (dd->nsystems > 1)
 299     {
 300         invn = 1.0/dd->nsystems;
 301     }
 302
 303     /* 'loop' over all atom pairs (pair_nr=fa/3) involved in restraints, *
 304      * the total number of atoms pairs is nfa/3                          */
 305     res = 0;
 306     fa  = 0;
 307     while (fa < nfa)
 308     {
 309         type  = forceatoms[fa];
 310         npair = ip[type].disres.npair;
 311
 312         Rtav_6[res] = 0.0;
 313         Rt_6[res]   = 0.0;
 314
 315         /* Loop over the atom pairs of 'this' restraint */
 316         np = 0;
 317         while (fa < nfa && np < npair)
 318         {
 319             pair = fa/3;
 320             ai   = forceatoms[fa+1];
 321             aj   = forceatoms[fa+2];
 322
 323             if (pbc)
 324             {
 325                 pbc_dx_aiuc(pbc, x[ai], x[aj], dx);
 326             }
 327             else
 328             {
 329                 rvec_sub(x[ai], x[aj], dx);
 330             }
 331             rt2  = iprod(dx, dx);
 332             rt_1 = gmx_invsqrt(rt2);
 333             rt_3 = rt_1*rt_1*rt_1;
 334
 335             rt[pair]         = std::sqrt(rt2);
 336             if (bTav)
 337             {
 338                 /* Here we update rm3tav in t_fcdata using the data
 339                  * in history_t.
 340                  * Thus the results stay correct when this routine
 341                  * is called multiple times.
 342                  */
 343                 rm3tav[pair] = cf2*((ETerm - cf1)*hist->disre_rm3tav[pair] +
 344                                     ETerm1*rt_3);
 345             }
 346             else
 347             {
 348                 rm3tav[pair] = rt_3;
 349             }
 350
 351             Rt_6[res]       += rt_3*rt_3;
 352             Rtav_6[res]     += rm3tav[pair]*rm3tav[pair];
 353
 354             fa += 3;
 355             np++;
 356         }
 357         if (dd->nsystems > 1)
 358         {
 359             Rtl_6[res]   = Rt_6[res];
 360             Rt_6[res]   *= invn;
 361             Rtav_6[res] *= invn;
 362         }
 363
 364         res++;
 365     }
 366 }
 367
 368 real ta_disres(int nfa, const t_iatom forceatoms[], const t_iparams ip[],
 369                const rvec x[], rvec f[], rvec fshift[],
 370                const t_pbc *pbc, const t_graph *g,
 371                real gmx_unused lambda, real gmx_unused *dvdlambda,
 372                const t_mdatoms gmx_unused *md, t_fcdata *fcd,
 373                int gmx_unused *global_atom_index)
 374 {
 375     const real      sixth       = 1.0/6.0;
 376     const real      seven_three = 7.0/3.0;
 377
 378     atom_id         ai, aj;
 379     int             fa, res, npair, p, pair, ki = CENTRAL, m;
 380     int             type;
 381     rvec            dx;
 382     real            weight_rt_1;
 383     real            smooth_fc, Rt, Rtav, rt2, *Rtl_6, *Rt_6, *Rtav_6;
 384     real            k0, f_scal = 0, fmax_scal, fk_scal, fij;
 385     real            tav_viol, instant_viol, mixed_viol, violtot, vtot;
 386     real            tav_viol_Rtav7, instant_viol_Rtav7;
 387     real            up1, up2, low;
 388     gmx_bool        bConservative, bMixed, bViolation;
 389     ivec            dt;
 390     t_disresdata   *dd;
 391     int             dr_weighting;
 392     gmx_bool        dr_bMixed;
 393
 394     dd           = &(fcd->disres);
 395     dr_weighting = dd->dr_weighting;
 396     dr_bMixed    = dd->dr_bMixed;
 397     Rtl_6        = dd->Rtl_6;
 398     Rt_6         = dd->Rt_6;
 399     Rtav_6       = dd->Rtav_6;
 400
 401     tav_viol = instant_viol = mixed_viol = tav_viol_Rtav7 = instant_viol_Rtav7 = 0;
 402
 403     smooth_fc = dd->dr_fc;
 404     if (dd->dr_tau != 0)
 405     {
 406         /* scaling factor to smoothly turn on the restraint forces *
 407          * when using time averaging                               */
 408         smooth_fc *= (1.0 - dd->exp_min_t_tau);
 409     }
 410
 411     violtot = 0;
 412     vtot    = 0;
 413
 414     /* 'loop' over all atom pairs (pair_nr=fa/3) involved in restraints, *
 415      * the total number of atoms pairs is nfa/3                          */
 416     res  = 0;
 417     fa   = 0;
 418     while (fa < nfa)
 419     {
 420         type  = forceatoms[fa];
 421         /* Take action depending on restraint, calculate scalar force */
 422         npair = ip[type].disres.npair;
 423         up1   = ip[type].disres.up1;
 424         up2   = ip[type].disres.up2;
 425         low   = ip[type].disres.low;
 426         k0    = smooth_fc*ip[type].disres.kfac;
 427
 428         /* save some flops when there is only one pair */
 429         if (ip[type].disres.type != 2)
 430         {
 431             bConservative = (dr_weighting == edrwConservative) && (npair > 1);
 432             bMixed        = dr_bMixed;
 433             Rt            = std::pow(Rt_6[res], -sixth);
 434             Rtav          = std::pow(Rtav_6[res], -sixth);
 435         }
 436         else
 437         {
 438             /* When rtype=2 use instantaneous not ensemble avereged distance */
 439             bConservative = (npair > 1);
 440             bMixed        = FALSE;
 441             Rt            = std::pow(Rtl_6[res], -sixth);
 442             Rtav          = Rt;
 443         }
 444
 445         if (Rtav > up1)
 446         {
 447             bViolation = TRUE;
 448             tav_viol   = Rtav - up1;
 449         }
 450         else if (Rtav < low)
 451         {
 452             bViolation = TRUE;
 453             tav_viol   = Rtav - low;
 454         }
 455         else
 456         {
 457             bViolation = FALSE;
 458         }
 459
 460         if (bViolation)
 461         {
 462             /* NOTE:
 463              * there is no real potential when time averaging is applied
 464              */
 465             vtot += 0.5*k0*sqr(tav_viol);
 466             if (1/vtot == 0)
 467             {
 468                 printf("vtot is inf: %f\n", vtot);
 469             }
 470             if (!bMixed)
 471             {
 472                 f_scal   = -k0*tav_viol;
 473                 violtot += fabs(tav_viol);
 474             }
 475             else
 476             {
 477                 if (Rt > up1)
 478                 {
 479                     if (tav_viol > 0)
 480                     {
 481                         instant_viol = Rt - up1;
 482                     }
 483                     else
 484                     {
 485                         bViolation = FALSE;
 486                     }
 487                 }
 488                 else if (Rt < low)
 489                 {
 490                     if (tav_viol < 0)
 491                     {
 492                         instant_viol = Rt - low;
 493                     }
 494                     else
 495                     {
 496                         bViolation = FALSE;
 497                     }
 498                 }
 499                 else
 500                 {
 501                     bViolation = FALSE;
 502                 }
 503                 if (bViolation)
 504                 {
 505                     mixed_viol = std::sqrt(tav_viol*instant_viol);
 506                     f_scal     = -k0*mixed_viol;
 507                     violtot   += mixed_viol;
 508                 }
 509             }
 510         }
 511
 512         if (bViolation)
 513         {
 514             fmax_scal = -k0*(up2-up1);
 515             /* Correct the force for the number of restraints */
 516             if (bConservative)
 517             {
 518                 f_scal  = std::max(f_scal, fmax_scal);
 519                 if (!bMixed)
 520                 {
 521                     f_scal *= Rtav/Rtav_6[res];
 522                 }
 523                 else
 524                 {
 525                     f_scal            /= 2*mixed_viol;
 526                     tav_viol_Rtav7     = tav_viol*Rtav/Rtav_6[res];
 527                     instant_viol_Rtav7 = instant_viol*Rt/Rt_6[res];
 528                 }
 529             }
 530             else
 531             {
 532                 f_scal /= npair;
 533                 f_scal  = std::max(f_scal, fmax_scal);
 534             }
 535
 536             /* Exert the force ... */
 537
 538             /* Loop over the atom pairs of 'this' restraint */
 539             for (p = 0; p < npair; p++)
 540             {
 541                 pair = fa/3;
 542                 ai   = forceatoms[fa+1];
 543                 aj   = forceatoms[fa+2];
 544
 545                 if (pbc)
 546                 {
 547                     ki = pbc_dx_aiuc(pbc, x[ai], x[aj], dx);
 548                 }
 549                 else
 550                 {
 551                     rvec_sub(x[ai], x[aj], dx);
 552                 }
 553                 rt2 = iprod(dx, dx);
 554
 555                 weight_rt_1 = gmx_invsqrt(rt2);
 556
 557                 if (bConservative)
 558                 {
 559                     if (!dr_bMixed)
 560                     {
 561                         weight_rt_1 *= std::pow(dd->rm3tav[pair], seven_three);
 562                     }
 563                     else
 564                     {
 565                         weight_rt_1 *= tav_viol_Rtav7*std::pow(dd->rm3tav[pair], seven_three)+
 566                             instant_viol_Rtav7*std::pow(dd->rt[pair], static_cast<real>(-7));
 567                     }
 568                 }
 569
 570                 fk_scal  = f_scal*weight_rt_1;
 571
 572                 if (g)
 573                 {
 574                     ivec_sub(SHIFT_IVEC(g, ai), SHIFT_IVEC(g, aj), dt);
 575                     ki = IVEC2IS(dt);
 576                 }
 577
 578                 for (m = 0; m < DIM; m++)
 579                 {
 580                     fij            = fk_scal*dx[m];
 581
 582                     f[ai][m]           += fij;
 583                     f[aj][m]           -= fij;
 584                     fshift[ki][m]      += fij;
 585                     fshift[CENTRAL][m] -= fij;
 586                 }
 587                 fa += 3;
 588             }
 589         }
 590         else
 591         {
 592             /* No violation so force and potential contributions */
 593             fa += 3*npair;
 594         }
 595         res++;
 596     }
 597
 598     dd->sumviol = violtot;
 599
 600     /* Return energy */
 601     return vtot;
 602 }
 603
 604 void update_disres_history(t_fcdata *fcd, history_t *hist)
 605 {
 606     t_disresdata *dd;
 607     int           pair;
 608
 609     dd = &(fcd->disres);
 610     if (dd->dr_tau != 0)
 611     {
 612         /* Copy the new time averages that have been calculated
 613          * in calc_disres_R_6.
 614          */
 615         hist->disre_initf = dd->exp_min_t_tau;
 616         for (pair = 0; pair < dd->npair; pair++)
 617         {
 618             hist->disre_rm3tav[pair] = dd->rm3tav[pair];
 619         }
 620     }
 621 }