src/gromacs/mdlib/shellfc.c

   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-2008, The GROMACS development team.
   6  * Copyright (c) 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 #ifdef HAVE_CONFIG_H
  38 #include <config.h>
  39 #endif
  40
  41 #include <string.h>
  42 #include "typedefs.h"
  43 #include "smalloc.h"
  44 #include "gmx_fatal.h"
  45 #include "vec.h"
  46 #include "txtdump.h"
  47 #include "force.h"
  48 #include "mdrun.h"
  49 #include "mdatoms.h"
  50 #include "vsite.h"
  51 #include "network.h"
  52 #include "names.h"
  53 #include "constr.h"
  54 #include "domdec.h"
  55 #include "physics.h"
  56 #include "shellfc.h"
  57 #include "mtop_util.h"
  58 #include "chargegroup.h"
  59 #include "macros.h"
  60
  61
  62 typedef struct {
  63     int     nnucl;
  64     atom_id shell;               /* The shell id                                */
  65     atom_id nucl1, nucl2, nucl3; /* The nuclei connected to the shell   */
  66     /* gmx_bool    bInterCG; */       /* Coupled to nuclei outside cg?        */
  67     real    k;                   /* force constant                      */
  68     real    k_1;                 /* 1 over force constant               */
  69     rvec    xold;
  70     rvec    fold;
  71     rvec    step;
  72 } t_shell;
  73
  74 typedef struct gmx_shellfc {
  75     int         nshell_gl;      /* The number of shells in the system       */
  76     t_shell    *shell_gl;       /* All the shells (for DD only)             */
  77     int        *shell_index_gl; /* Global shell index (for DD only)         */
  78     gmx_bool    bInterCG;       /* Are there inter charge-group shells?     */
  79     int         nshell;         /* The number of local shells               */
  80     t_shell    *shell;          /* The local shells                         */
  81     int         shell_nalloc;   /* The allocation size of shell             */
  82     gmx_bool    bPredict;       /* Predict shell positions                  */
  83     gmx_bool    bRequireInit;   /* Require initialization of shell positions  */
  84     int         nflexcon;       /* The number of flexible constraints       */
  85     rvec       *x[2];           /* Array for iterative minimization         */
  86     rvec       *f[2];           /* Array for iterative minimization         */
  87     int         x_nalloc;       /* The allocation size of x and f           */
  88     rvec       *acc_dir;        /* Acceleration direction for flexcon       */
  89     rvec       *x_old;          /* Old coordinates for flexcon              */
  90     int         flex_nalloc;    /* The allocation size of acc_dir and x_old */
  91     rvec       *adir_xnold;     /* Work space for init_adir                 */
  92     rvec       *adir_xnew;      /* Work space for init_adir                 */
  93     int         adir_nalloc;    /* Work space for init_adir                 */
  94 } t_gmx_shellfc;
  95
  96
  97 static void pr_shell(FILE *fplog, int ns, t_shell s[])
  98 {
  99     int i;
 100
 101     fprintf(fplog, "SHELL DATA\n");
 102     fprintf(fplog, "%5s  %8s  %5s  %5s  %5s\n",
 103             "Shell", "Force k", "Nucl1", "Nucl2", "Nucl3");
 104     for (i = 0; (i < ns); i++)
 105     {
 106         fprintf(fplog, "%5d  %8.3f  %5d", s[i].shell, 1.0/s[i].k_1, s[i].nucl1);
 107         if (s[i].nnucl == 2)
 108         {
 109             fprintf(fplog, "  %5d\n", s[i].nucl2);
 110         }
 111         else if (s[i].nnucl == 3)
 112         {
 113             fprintf(fplog, "  %5d  %5d\n", s[i].nucl2, s[i].nucl3);
 114         }
 115         else
 116         {
 117             fprintf(fplog, "\n");
 118         }
 119     }
 120 }
 121
 122 static void predict_shells(FILE *fplog, rvec x[], rvec v[], real dt,
 123                            int ns, t_shell s[],
 124                            real mass[], gmx_mtop_t *mtop, gmx_bool bInit)
 125 {
 126     int                   i, m, s1, n1, n2, n3;
 127     real                  dt_1, dt_2, dt_3, fudge, tm, m1, m2, m3;
 128     rvec                 *ptr;
 129     gmx_mtop_atomlookup_t alook = NULL;
 130     t_atom               *atom;
 131
 132     if (mass == NULL)
 133     {
 134         alook = gmx_mtop_atomlookup_init(mtop);
 135     }
 136
 137     /* We introduce a fudge factor for performance reasons: with this choice
 138      * the initial force on the shells is about a factor of two lower than
 139      * without
 140      */
 141     fudge = 1.0;
 142
 143     if (bInit)
 144     {
 145         if (fplog)
 146         {
 147             fprintf(fplog, "RELAX: Using prediction for initial shell placement\n");
 148         }
 149         ptr  = x;
 150         dt_1 = 1;
 151     }
 152     else
 153     {
 154         ptr  = v;
 155         dt_1 = fudge*dt;
 156     }
 157
 158     for (i = 0; (i < ns); i++)
 159     {
 160         s1 = s[i].shell;
 161         if (bInit)
 162         {
 163             clear_rvec(x[s1]);
 164         }
 165         switch (s[i].nnucl)
 166         {
 167             case 1:
 168                 n1 = s[i].nucl1;
 169                 for (m = 0; (m < DIM); m++)
 170                 {
 171                     x[s1][m] += ptr[n1][m]*dt_1;
 172                 }
 173                 break;
 174             case 2:
 175                 n1 = s[i].nucl1;
 176                 n2 = s[i].nucl2;
 177                 if (mass)
 178                 {
 179                     m1 = mass[n1];
 180                     m2 = mass[n2];
 181                 }
 182                 else
 183                 {
 184                     /* Not the correct masses with FE, but it is just a prediction... */
 185                     m1 = atom[n1].m;
 186                     m2 = atom[n2].m;
 187                 }
 188                 tm = dt_1/(m1+m2);
 189                 for (m = 0; (m < DIM); m++)
 190                 {
 191                     x[s1][m] += (m1*ptr[n1][m]+m2*ptr[n2][m])*tm;
 192                 }
 193                 break;
 194             case 3:
 195                 n1 = s[i].nucl1;
 196                 n2 = s[i].nucl2;
 197                 n3 = s[i].nucl3;
 198                 if (mass)
 199                 {
 200                     m1 = mass[n1];
 201                     m2 = mass[n2];
 202                     m3 = mass[n3];
 203                 }
 204                 else
 205                 {
 206                     /* Not the correct masses with FE, but it is just a prediction... */
 207                     gmx_mtop_atomnr_to_atom(alook, n1, &atom);
 208                     m1 = atom->m;
 209                     gmx_mtop_atomnr_to_atom(alook, n2, &atom);
 210                     m2 = atom->m;
 211                     gmx_mtop_atomnr_to_atom(alook, n3, &atom);
 212                     m3 = atom->m;
 213                 }
 214                 tm = dt_1/(m1+m2+m3);
 215                 for (m = 0; (m < DIM); m++)
 216                 {
 217                     x[s1][m] += (m1*ptr[n1][m]+m2*ptr[n2][m]+m3*ptr[n3][m])*tm;
 218                 }
 219                 break;
 220             default:
 221                 gmx_fatal(FARGS, "Shell %d has %d nuclei!", i, s[i].nnucl);
 222         }
 223     }
 224
 225     if (mass == NULL)
 226     {
 227         gmx_mtop_atomlookup_destroy(alook);
 228     }
 229 }
 230
 231 gmx_shellfc_t init_shell_flexcon(FILE *fplog,
 232                                  gmx_bool bCutoffSchemeIsVerlet,
 233                                  gmx_mtop_t *mtop, int nflexcon,
 234                                  rvec *x)
 235 {
 236     struct gmx_shellfc       *shfc;
 237     t_shell                  *shell;
 238     int                      *shell_index = NULL, *at2cg;
 239     t_atom                   *atom;
 240     int                       n[eptNR], ns, nshell, nsi;
 241     int                       i, j, nmol, type, mb, mt, a_offset, cg, mol, ftype, nra;
 242     real                      qS, alpha;
 243     int                       aS, aN = 0; /* Shell and nucleus */
 244     int                       bondtypes[] = { F_BONDS, F_HARMONIC, F_CUBICBONDS, F_POLARIZATION, F_ANHARM_POL, F_WATER_POL };
 245 #define NBT asize(bondtypes)
 246     t_iatom                  *ia;
 247     gmx_mtop_atomloop_block_t aloopb;
 248     gmx_mtop_atomloop_all_t   aloop;
 249     gmx_ffparams_t           *ffparams;
 250     gmx_molblock_t           *molb;
 251     gmx_moltype_t            *molt;
 252     t_block                  *cgs;
 253
 254     /* Count number of shells, and find their indices */
 255     for (i = 0; (i < eptNR); i++)
 256     {
 257         n[i] = 0;
 258     }
 259
 260     aloopb = gmx_mtop_atomloop_block_init(mtop);
 261     while (gmx_mtop_atomloop_block_next(aloopb, &atom, &nmol))
 262     {
 263         n[atom->ptype] += nmol;
 264     }
 265
 266     if (fplog)
 267     {
 268         /* Print the number of each particle type */
 269         for (i = 0; (i < eptNR); i++)
 270         {
 271             if (n[i] != 0)
 272             {
 273                 fprintf(fplog, "There are: %d %ss\n", n[i], ptype_str[i]);
 274             }
 275         }
 276     }
 277
 278     nshell = n[eptShell];
 279
 280     if (nshell == 0 && nflexcon == 0)
 281     {
 282         /* We're not doing shells or flexible constraints */
 283         return NULL;
 284     }
 285
 286     if (bCutoffSchemeIsVerlet)
 287     {
 288         gmx_fatal(FARGS, "The shell code does not work with the Verlet cut-off scheme.\n");
 289     }
 290
 291     snew(shfc, 1);
 292     shfc->nflexcon = nflexcon;
 293
 294     if (nshell == 0)
 295     {
 296         return shfc;
 297     }
 298
 299     /* We have shells: fill the shell data structure */
 300
 301     /* Global system sized array, this should be avoided */
 302     snew(shell_index, mtop->natoms);
 303
 304     aloop  = gmx_mtop_atomloop_all_init(mtop);
 305     nshell = 0;
 306     while (gmx_mtop_atomloop_all_next(aloop, &i, &atom))
 307     {
 308         if (atom->ptype == eptShell)
 309         {
 310             shell_index[i] = nshell++;
 311         }
 312     }
 313
 314     snew(shell, nshell);
 315
 316     /* Initiate the shell structures */
 317     for (i = 0; (i < nshell); i++)
 318     {
 319         shell[i].shell = NO_ATID;
 320         shell[i].nnucl = 0;
 321         shell[i].nucl1 = NO_ATID;
 322         shell[i].nucl2 = NO_ATID;
 323         shell[i].nucl3 = NO_ATID;
 324         /* shell[i].bInterCG=FALSE; */
 325         shell[i].k_1   = 0;
 326         shell[i].k     = 0;
 327     }
 328
 329     ffparams = &mtop->ffparams;
 330
 331     /* Now fill the structures */
 332     shfc->bInterCG = FALSE;
 333     ns             = 0;
 334     a_offset       = 0;
 335     for (mb = 0; mb < mtop->nmolblock; mb++)
 336     {
 337         molb = &mtop->molblock[mb];
 338         molt = &mtop->moltype[molb->type];
 339
 340         cgs = &molt->cgs;
 341         snew(at2cg, molt->atoms.nr);
 342         for (cg = 0; cg < cgs->nr; cg++)
 343         {
 344             for (i = cgs->index[cg]; i < cgs->index[cg+1]; i++)
 345             {
 346                 at2cg[i] = cg;
 347             }
 348         }
 349
 350         atom = molt->atoms.atom;
 351         for (mol = 0; mol < molb->nmol; mol++)
 352         {
 353             for (j = 0; (j < NBT); j++)
 354             {
 355                 ia = molt->ilist[bondtypes[j]].iatoms;
 356                 for (i = 0; (i < molt->ilist[bondtypes[j]].nr); )
 357                 {
 358                     type  = ia[0];
 359                     ftype = ffparams->functype[type];
 360                     nra   = interaction_function[ftype].nratoms;
 361
 362                     /* Check whether we have a bond with a shell */
 363                     aS = NO_ATID;
 364
 365                     switch (bondtypes[j])
 366                     {
 367                         case F_BONDS:
 368                         case F_HARMONIC:
 369                         case F_CUBICBONDS:
 370                         case F_POLARIZATION:
 371                         case F_ANHARM_POL:
 372                             if (atom[ia[1]].ptype == eptShell)
 373                             {
 374                                 aS = ia[1];
 375                                 aN = ia[2];
 376                             }
 377                             else if (atom[ia[2]].ptype == eptShell)
 378                             {
 379                                 aS = ia[2];
 380                                 aN = ia[1];
 381                             }
 382                             break;
 383                         case F_WATER_POL:
 384                             aN    = ia[4]; /* Dummy */
 385                             aS    = ia[5]; /* Shell */
 386                             break;
 387                         default:
 388                             gmx_fatal(FARGS, "Death Horror: %s, %d", __FILE__, __LINE__);
 389                     }
 390
 391                     if (aS != NO_ATID)
 392                     {
 393                         qS = atom[aS].q;
 394
 395                         /* Check whether one of the particles is a shell... */
 396                         nsi = shell_index[a_offset+aS];
 397                         if ((nsi < 0) || (nsi >= nshell))
 398                         {
 399                             gmx_fatal(FARGS, "nsi is %d should be within 0 - %d. aS = %d",
 400                                       nsi, nshell, aS);
 401                         }
 402                         if (shell[nsi].shell == NO_ATID)
 403                         {
 404                             shell[nsi].shell = a_offset + aS;
 405                             ns++;
 406                         }
 407                         else if (shell[nsi].shell != a_offset+aS)
 408                         {
 409                             gmx_fatal(FARGS, "Weird stuff in %s, %d", __FILE__, __LINE__);
 410                         }
 411
 412                         if      (shell[nsi].nucl1 == NO_ATID)
 413                         {
 414                             shell[nsi].nucl1 = a_offset + aN;
 415                         }
 416                         else if (shell[nsi].nucl2 == NO_ATID)
 417                         {
 418                             shell[nsi].nucl2 = a_offset + aN;
 419                         }
 420                         else if (shell[nsi].nucl3 == NO_ATID)
 421                         {
 422                             shell[nsi].nucl3 = a_offset + aN;
 423                         }
 424                         else
 425                         {
 426                             if (fplog)
 427                             {
 428                                 pr_shell(fplog, ns, shell);
 429                             }
 430                             gmx_fatal(FARGS, "Can not handle more than three bonds per shell\n");
 431                         }
 432                         if (at2cg[aS] != at2cg[aN])
 433                         {
 434                             /* shell[nsi].bInterCG = TRUE; */
 435                             shfc->bInterCG = TRUE;
 436                         }
 437
 438                         switch (bondtypes[j])
 439                         {
 440                             case F_BONDS:
 441                             case F_HARMONIC:
 442                                 shell[nsi].k    += ffparams->iparams[type].harmonic.krA;
 443                                 break;
 444                             case F_CUBICBONDS:
 445                                 shell[nsi].k    += ffparams->iparams[type].cubic.kb;
 446                                 break;
 447                             case F_POLARIZATION:
 448                             case F_ANHARM_POL:
 449                                 if (!gmx_within_tol(qS, atom[aS].qB, GMX_REAL_EPS*10))
 450                                 {
 451                                     gmx_fatal(FARGS, "polarize can not be used with qA(%e) != qB(%e) for atom %d of molecule block %d", qS, atom[aS].qB, aS+1, mb+1);
 452                                 }
 453                                 shell[nsi].k    += sqr(qS)*ONE_4PI_EPS0/
 454                                     ffparams->iparams[type].polarize.alpha;
 455                                 break;
 456                             case F_WATER_POL:
 457                                 if (!gmx_within_tol(qS, atom[aS].qB, GMX_REAL_EPS*10))
 458                                 {
 459                                     gmx_fatal(FARGS, "water_pol can not be used with qA(%e) != qB(%e) for atom %d of molecule block %d", qS, atom[aS].qB, aS+1, mb+1);
 460                                 }
 461                                 alpha          = (ffparams->iparams[type].wpol.al_x+
 462                                                   ffparams->iparams[type].wpol.al_y+
 463                                                   ffparams->iparams[type].wpol.al_z)/3.0;
 464                                 shell[nsi].k  += sqr(qS)*ONE_4PI_EPS0/alpha;
 465                                 break;
 466                             default:
 467                                 gmx_fatal(FARGS, "Death Horror: %s, %d", __FILE__, __LINE__);
 468                         }
 469                         shell[nsi].nnucl++;
 470                     }
 471                     ia += nra+1;
 472                     i  += nra+1;
 473                 }
 474             }
 475             a_offset += molt->atoms.nr;
 476         }
 477         /* Done with this molecule type */
 478         sfree(at2cg);
 479     }
 480
 481     /* Verify whether it's all correct */
 482     if (ns != nshell)
 483     {
 484         gmx_fatal(FARGS, "Something weird with shells. They may not be bonded to something");
 485     }
 486
 487     for (i = 0; (i < ns); i++)
 488     {
 489         shell[i].k_1 = 1.0/shell[i].k;
 490     }
 491
 492     if (debug)
 493     {
 494         pr_shell(debug, ns, shell);
 495     }
 496
 497
 498     shfc->nshell_gl      = ns;
 499     shfc->shell_gl       = shell;
 500     shfc->shell_index_gl = shell_index;
 501
 502     shfc->bPredict     = (getenv("GMX_NOPREDICT") == NULL);
 503     shfc->bRequireInit = FALSE;
 504     if (!shfc->bPredict)
 505     {
 506         if (fplog)
 507         {
 508             fprintf(fplog, "\nWill never predict shell positions\n");
 509         }
 510     }
 511     else
 512     {
 513         shfc->bRequireInit = (getenv("GMX_REQUIRE_SHELL_INIT") != NULL);
 514         if (shfc->bRequireInit && fplog)
 515         {
 516             fprintf(fplog, "\nWill always initiate shell positions\n");
 517         }
 518     }
 519
 520     if (shfc->bPredict)
 521     {
 522         if (x)
 523         {
 524             predict_shells(fplog, x, NULL, 0, shfc->nshell_gl, shfc->shell_gl,
 525                            NULL, mtop, TRUE);
 526         }
 527
 528         if (shfc->bInterCG)
 529         {
 530             if (fplog)
 531             {
 532                 fprintf(fplog, "\nNOTE: there all shells that are connected to particles outside thier own charge group, will not predict shells positions during the run\n\n");
 533             }
 534             shfc->bPredict = FALSE;
 535         }
 536     }
 537
 538     return shfc;
 539 }
 540
 541 void make_local_shells(t_commrec *cr, t_mdatoms *md,
 542                        struct gmx_shellfc *shfc)
 543 {
 544     t_shell      *shell;
 545     int           a0, a1, *ind, nshell, i;
 546     gmx_domdec_t *dd = NULL;
 547
 548     if (DOMAINDECOMP(cr))
 549     {
 550         dd = cr->dd;
 551         a0 = 0;
 552         a1 = dd->nat_home;
 553     }
 554     else
 555     {
 556         /* Single node: we need all shells, just copy the pointer */
 557         shfc->nshell = shfc->nshell_gl;
 558         shfc->shell  = shfc->shell_gl;
 559
 560         return;
 561     }
 562
 563     ind = shfc->shell_index_gl;
 564
 565     nshell = 0;
 566     shell  = shfc->shell;
 567     for (i = a0; i < a1; i++)
 568     {
 569         if (md->ptype[i] == eptShell)
 570         {
 571             if (nshell+1 > shfc->shell_nalloc)
 572             {
 573                 shfc->shell_nalloc = over_alloc_dd(nshell+1);
 574                 srenew(shell, shfc->shell_nalloc);
 575             }
 576             if (dd)
 577             {
 578                 shell[nshell] = shfc->shell_gl[ind[dd->gatindex[i]]];
 579             }
 580             else
 581             {
 582                 shell[nshell] = shfc->shell_gl[ind[i]];
 583             }
 584
 585             /* With inter-cg shells we can no do shell prediction,
 586              * so we do not need the nuclei numbers.
 587              */
 588             if (!shfc->bInterCG)
 589             {
 590                 shell[nshell].nucl1   = i + shell[nshell].nucl1 - shell[nshell].shell;
 591                 if (shell[nshell].nnucl > 1)
 592                 {
 593                     shell[nshell].nucl2 = i + shell[nshell].nucl2 - shell[nshell].shell;
 594                 }
 595                 if (shell[nshell].nnucl > 2)
 596                 {
 597                     shell[nshell].nucl3 = i + shell[nshell].nucl3 - shell[nshell].shell;
 598                 }
 599             }
 600             shell[nshell].shell = i;
 601             nshell++;
 602         }
 603     }
 604
 605     shfc->nshell = nshell;
 606     shfc->shell  = shell;
 607 }
 608
 609 static void do_1pos(rvec xnew, rvec xold, rvec f, real step)
 610 {
 611     real xo, yo, zo;
 612     real dx, dy, dz;
 613
 614     xo = xold[XX];
 615     yo = xold[YY];
 616     zo = xold[ZZ];
 617
 618     dx = f[XX]*step;
 619     dy = f[YY]*step;
 620     dz = f[ZZ]*step;
 621
 622     xnew[XX] = xo+dx;
 623     xnew[YY] = yo+dy;
 624     xnew[ZZ] = zo+dz;
 625 }
 626
 627 static void do_1pos3(rvec xnew, rvec xold, rvec f, rvec step)
 628 {
 629     real xo, yo, zo;
 630     real dx, dy, dz;
 631
 632     xo = xold[XX];
 633     yo = xold[YY];
 634     zo = xold[ZZ];
 635
 636     dx = f[XX]*step[XX];
 637     dy = f[YY]*step[YY];
 638     dz = f[ZZ]*step[ZZ];
 639
 640     xnew[XX] = xo+dx;
 641     xnew[YY] = yo+dy;
 642     xnew[ZZ] = zo+dz;
 643 }
 644
 645 static void directional_sd(rvec xold[], rvec xnew[], rvec acc_dir[],
 646                            int start, int homenr, real step)
 647 {
 648     int  i;
 649
 650     for (i = start; i < homenr; i++)
 651     {
 652         do_1pos(xnew[i], xold[i], acc_dir[i], step);
 653     }
 654 }
 655
 656 static void shell_pos_sd(rvec xcur[], rvec xnew[], rvec f[],
 657                          int ns, t_shell s[], int count)
 658 {
 659     const real step_scale_min       = 0.8,
 660                step_scale_increment = 0.2,
 661                step_scale_max       = 1.2,
 662                step_scale_multiple  = (step_scale_max - step_scale_min) / step_scale_increment;
 663     int  i, shell, d;
 664     real dx, df, k_est;
 665 #ifdef PRINT_STEP
 666     real step_min, step_max;
 667
 668     step_min = 1e30;
 669     step_max = 0;
 670 #endif
 671     for (i = 0; (i < ns); i++)
 672     {
 673         shell = s[i].shell;
 674         if (count == 1)
 675         {
 676             for (d = 0; d < DIM; d++)
 677             {
 678                 s[i].step[d] = s[i].k_1;
 679 #ifdef PRINT_STEP
 680                 step_min = min(step_min, s[i].step[d]);
 681                 step_max = max(step_max, s[i].step[d]);
 682 #endif
 683             }
 684         }
 685         else
 686         {
 687             for (d = 0; d < DIM; d++)
 688             {
 689                 dx = xcur[shell][d] - s[i].xold[d];
 690                 df =    f[shell][d] - s[i].fold[d];
 691                 /* -dx/df gets used to generate an interpolated value, but would
 692                  * cause a NaN if df were binary-equal to zero. Values close to
 693                  * zero won't cause problems (because of the min() and max()), so
 694                  * just testing for binary inequality is OK. */
 695                 if (0.0 != df)
 696                 {
 697                     k_est = -dx/df;
 698                     /* Scale the step size by a factor interpolated from
 699                      * step_scale_min to step_scale_max, as k_est goes from 0 to
 700                      * step_scale_multiple * s[i].step[d] */
 701                     s[i].step[d] =
 702                         step_scale_min * s[i].step[d] +
 703                         step_scale_increment * min(step_scale_multiple * s[i].step[d], max(k_est, 0));
 704                 }
 705                 else
 706                 {
 707                     /* Here 0 == df */
 708                     if (gmx_numzero(dx)) /* 0 == dx */
 709                     {
 710                         /* Likely this will never happen, but if it does just
 711                          * don't scale the step. */
 712                     }
 713                     else /* 0 != dx */
 714                     {
 715                         s[i].step[d] *= step_scale_max;
 716                     }
 717                 }
 718 #ifdef PRINT_STEP
 719                 step_min = min(step_min, s[i].step[d]);
 720                 step_max = max(step_max, s[i].step[d]);
 721 #endif
 722             }
 723         }
 724         copy_rvec(xcur[shell], s[i].xold);
 725         copy_rvec(f[shell],   s[i].fold);
 726
 727         do_1pos3(xnew[shell], xcur[shell], f[shell], s[i].step);
 728
 729         if (gmx_debug_at)
 730         {
 731             fprintf(debug, "shell[%d] = %d\n", i, shell);
 732             pr_rvec(debug, 0, "fshell", f[shell], DIM, TRUE);
 733             pr_rvec(debug, 0, "xold", xcur[shell], DIM, TRUE);
 734             pr_rvec(debug, 0, "step", s[i].step, DIM, TRUE);
 735             pr_rvec(debug, 0, "xnew", xnew[shell], DIM, TRUE);
 736         }
 737     }
 738 #ifdef PRINT_STEP
 739     printf("step %.3e %.3e\n", step_min, step_max);
 740 #endif
 741 }
 742
 743 static void decrease_step_size(int nshell, t_shell s[])
 744 {
 745     int i;
 746
 747     for (i = 0; i < nshell; i++)
 748     {
 749         svmul(0.8, s[i].step, s[i].step);
 750     }
 751 }
 752
 753 static void print_epot(FILE *fp, gmx_int64_t mdstep, int count, real epot, real df,
 754                        int ndir, real sf_dir)
 755 {
 756     char buf[22];
 757
 758     fprintf(fp, "MDStep=%5s/%2d EPot: %12.8e, rmsF: %6.2e",
 759             gmx_step_str(mdstep, buf), count, epot, df);
 760     if (ndir)
 761     {
 762         fprintf(fp, ", dir. rmsF: %6.2e\n", sqrt(sf_dir/ndir));
 763     }
 764     else
 765     {
 766         fprintf(fp, "\n");
 767     }
 768 }
 769
 770
 771 static real rms_force(t_commrec *cr, rvec f[], int ns, t_shell s[],
 772                       int ndir, real *sf_dir, real *Epot)
 773 {
 774     int    i, shell, ntot;
 775     double buf[4];
 776
 777     buf[0] = *sf_dir;
 778     for (i = 0; i < ns; i++)
 779     {
 780         shell    = s[i].shell;
 781         buf[0]  += norm2(f[shell]);
 782     }
 783     ntot = ns;
 784
 785     if (PAR(cr))
 786     {
 787         buf[1] = ntot;
 788         buf[2] = *sf_dir;
 789         buf[3] = *Epot;
 790         gmx_sumd(4, buf, cr);
 791         ntot    = (int)(buf[1] + 0.5);
 792         *sf_dir = buf[2];
 793         *Epot   = buf[3];
 794     }
 795     ntot += ndir;
 796
 797     return (ntot ? sqrt(buf[0]/ntot) : 0);
 798 }
 799
 800 static void check_pbc(FILE *fp, rvec x[], int shell)
 801 {
 802     int m, now;
 803
 804     now = shell-4;
 805     for (m = 0; (m < DIM); m++)
 806     {
 807         if (fabs(x[shell][m]-x[now][m]) > 0.3)
 808         {
 809             pr_rvecs(fp, 0, "SHELL-X", x+now, 5);
 810             break;
 811         }
 812     }
 813 }
 814
 815 static void dump_shells(FILE *fp, rvec x[], rvec f[], real ftol, int ns, t_shell s[])
 816 {
 817     int  i, shell;
 818     real ft2, ff2;
 819
 820     ft2 = sqr(ftol);
 821
 822     for (i = 0; (i < ns); i++)
 823     {
 824         shell = s[i].shell;
 825         ff2   = iprod(f[shell], f[shell]);
 826         if (ff2 > ft2)
 827         {
 828             fprintf(fp, "SHELL %5d, force %10.5f  %10.5f  %10.5f, |f| %10.5f\n",
 829                     shell, f[shell][XX], f[shell][YY], f[shell][ZZ], sqrt(ff2));
 830         }
 831         check_pbc(fp, x, shell);
 832     }
 833 }
 834
 835 static void init_adir(FILE *log, gmx_shellfc_t shfc,
 836                       gmx_constr_t constr, t_idef *idef, t_inputrec *ir,
 837                       t_commrec *cr, int dd_ac1,
 838                       gmx_int64_t step, t_mdatoms *md, int start, int end,
 839                       rvec *x_old, rvec *x_init, rvec *x,
 840                       rvec *f, rvec *acc_dir,
 841                       gmx_bool bMolPBC, matrix box,
 842                       real *lambda, real *dvdlambda, t_nrnb *nrnb)
 843 {
 844     rvec           *xnold, *xnew;
 845     double          w_dt;
 846     int             gf, ga, gt;
 847     real            dt, scale;
 848     int             n, d;
 849     unsigned short *ptype;
 850     rvec            p, dx;
 851
 852     if (DOMAINDECOMP(cr))
 853     {
 854         n = dd_ac1;
 855     }
 856     else
 857     {
 858         n = end - start;
 859     }
 860     if (n > shfc->adir_nalloc)
 861     {
 862         shfc->adir_nalloc = over_alloc_dd(n);
 863         srenew(shfc->adir_xnold, shfc->adir_nalloc);
 864         srenew(shfc->adir_xnew, shfc->adir_nalloc);
 865     }
 866     xnold = shfc->adir_xnold;
 867     xnew  = shfc->adir_xnew;
 868
 869     ptype = md->ptype;
 870
 871     dt = ir->delta_t;
 872
 873     /* Does NOT work with freeze or acceleration groups (yet) */
 874     for (n = start; n < end; n++)
 875     {
 876         w_dt = md->invmass[n]*dt;
 877
 878         for (d = 0; d < DIM; d++)
 879         {
 880             if ((ptype[n] != eptVSite) && (ptype[n] != eptShell))
 881             {
 882                 xnold[n-start][d] = x[n][d] - (x_init[n][d] - x_old[n][d]);
 883                 xnew[n-start][d]  = 2*x[n][d] - x_old[n][d] + f[n][d]*w_dt*dt;
 884             }
 885             else
 886             {
 887                 xnold[n-start][d] = x[n][d];
 888                 xnew[n-start][d]  = x[n][d];
 889             }
 890         }
 891     }
 892     constrain(log, FALSE, FALSE, constr, idef, ir, NULL, cr, step, 0, md,
 893               x, xnold-start, NULL, bMolPBC, box,
 894               lambda[efptBONDED], &(dvdlambda[efptBONDED]),
 895               NULL, NULL, nrnb, econqCoord, FALSE, 0, 0);
 896     constrain(log, FALSE, FALSE, constr, idef, ir, NULL, cr, step, 0, md,
 897               x, xnew-start, NULL, bMolPBC, box,
 898               lambda[efptBONDED], &(dvdlambda[efptBONDED]),
 899               NULL, NULL, nrnb, econqCoord, FALSE, 0, 0);
 900
 901     for (n = start; n < end; n++)
 902     {
 903         for (d = 0; d < DIM; d++)
 904         {
 905             xnew[n-start][d] =
 906                 -(2*x[n][d]-xnold[n-start][d]-xnew[n-start][d])/sqr(dt)
 907                 - f[n][d]*md->invmass[n];
 908         }
 909         clear_rvec(acc_dir[n]);
 910     }
 911
 912     /* Project the acceleration on the old bond directions */
 913     constrain(log, FALSE, FALSE, constr, idef, ir, NULL, cr, step, 0, md,
 914               x_old, xnew-start, acc_dir, bMolPBC, box,
 915               lambda[efptBONDED], &(dvdlambda[efptBONDED]),
 916               NULL, NULL, nrnb, econqDeriv_FlexCon, FALSE, 0, 0);
 917 }
 918
 919 int relax_shell_flexcon(FILE *fplog, t_commrec *cr, gmx_bool bVerbose,
 920                         gmx_int64_t mdstep, t_inputrec *inputrec,
 921                         gmx_bool bDoNS, int force_flags,
 922                         gmx_localtop_t *top,
 923                         gmx_constr_t constr,
 924                         gmx_enerdata_t *enerd, t_fcdata *fcd,
 925                         t_state *state, rvec f[],
 926                         tensor force_vir,
 927                         t_mdatoms *md,
 928                         t_nrnb *nrnb, gmx_wallcycle_t wcycle,
 929                         t_graph *graph,
 930                         gmx_groups_t *groups,
 931                         struct gmx_shellfc *shfc,
 932                         t_forcerec *fr,
 933                         gmx_bool bBornRadii,
 934                         double t, rvec mu_tot,
 935                         gmx_bool *bConverged,
 936                         gmx_vsite_t *vsite,
 937                         FILE *fp_field)
 938 {
 939     int        nshell;
 940     t_shell   *shell;
 941     t_idef    *idef;
 942     rvec      *pos[2], *force[2], *acc_dir = NULL, *x_old = NULL;
 943     real       Epot[2], df[2];
 944     rvec       dx;
 945     real       sf_dir, invdt;
 946     real       ftol, xiH, xiS, dum = 0;
 947     char       sbuf[22];
 948     gmx_bool   bCont, bInit;
 949     int        nat, dd_ac0, dd_ac1 = 0, i;
 950     int        start = 0, homenr = md->homenr, end = start+homenr, cg0, cg1;
 951     int        nflexcon, g, number_steps, d, Min = 0, count = 0;
 952 #define  Try (1-Min)             /* At start Try = 1 */
 953
 954     bCont        = (mdstep == inputrec->init_step) && inputrec->bContinuation;
 955     bInit        = (mdstep == inputrec->init_step) || shfc->bRequireInit;
 956     ftol         = inputrec->em_tol;
 957     number_steps = inputrec->niter;
 958     nshell       = shfc->nshell;
 959     shell        = shfc->shell;
 960     nflexcon     = shfc->nflexcon;
 961
 962     idef = &top->idef;
 963
 964     if (DOMAINDECOMP(cr))
 965     {
 966         nat = dd_natoms_vsite(cr->dd);
 967         if (nflexcon > 0)
 968         {
 969             dd_get_constraint_range(cr->dd, &dd_ac0, &dd_ac1);
 970             nat = max(nat, dd_ac1);
 971         }
 972     }
 973     else
 974     {
 975         nat = state->natoms;
 976     }
 977
 978     if (nat > shfc->x_nalloc)
 979     {
 980         /* Allocate local arrays */
 981         shfc->x_nalloc = over_alloc_dd(nat);
 982         for (i = 0; (i < 2); i++)
 983         {
 984             srenew(shfc->x[i], shfc->x_nalloc);
 985             srenew(shfc->f[i], shfc->x_nalloc);
 986         }
 987     }
 988     for (i = 0; (i < 2); i++)
 989     {
 990         pos[i]   = shfc->x[i];
 991         force[i] = shfc->f[i];
 992     }
 993
 994     /* When we had particle decomposition, this code only worked with
 995      * PD when all particles involved with each shell were in the same
 996      * charge group. Not sure if this is still relevant. */
 997     if (bDoNS && inputrec->ePBC != epbcNONE && !DOMAINDECOMP(cr))
 998     {
 999         /* This is the only time where the coordinates are used
1000          * before do_force is called, which normally puts all
1001          * charge groups in the box.
1002          */
1003         cg0 = 0;
1004         cg1 = top->cgs.nr;
1005         put_charge_groups_in_box(fplog, cg0, cg1, fr->ePBC, state->box,
1006                                  &(top->cgs), state->x, fr->cg_cm);
1007         if (graph)
1008         {
1009             mk_mshift(fplog, graph, fr->ePBC, state->box, state->x);
1010         }
1011     }
1012
1013     /* After this all coordinate arrays will contain whole molecules */
1014     if (graph)
1015     {
1016         shift_self(graph, state->box, state->x);
1017     }
1018
1019     if (nflexcon)
1020     {
1021         if (nat > shfc->flex_nalloc)
1022         {
1023             shfc->flex_nalloc = over_alloc_dd(nat);
1024             srenew(shfc->acc_dir, shfc->flex_nalloc);
1025             srenew(shfc->x_old, shfc->flex_nalloc);
1026         }
1027         acc_dir = shfc->acc_dir;
1028         x_old   = shfc->x_old;
1029         for (i = 0; i < homenr; i++)
1030         {
1031             for (d = 0; d < DIM; d++)
1032             {
1033                 shfc->x_old[i][d] =
1034                     state->x[start+i][d] - state->v[start+i][d]*inputrec->delta_t;
1035             }
1036         }
1037     }
1038
1039     /* Do a prediction of the shell positions */
1040     if (shfc->bPredict && !bCont)
1041     {
1042         predict_shells(fplog, state->x, state->v, inputrec->delta_t, nshell, shell,
1043                        md->massT, NULL, bInit);
1044     }
1045
1046     /* do_force expected the charge groups to be in the box */
1047     if (graph)
1048     {
1049         unshift_self(graph, state->box, state->x);
1050     }
1051
1052     /* Calculate the forces first time around */
1053     if (gmx_debug_at)
1054     {
1055         pr_rvecs(debug, 0, "x b4 do_force", state->x + start, homenr);
1056     }
1057     do_force(fplog, cr, inputrec, mdstep, nrnb, wcycle, top, groups,
1058              state->box, state->x, &state->hist,
1059              force[Min], force_vir, md, enerd, fcd,
1060              state->lambda, graph,
1061              fr, vsite, mu_tot, t, fp_field, NULL, bBornRadii,
1062              (bDoNS ? GMX_FORCE_NS : 0) | force_flags);
1063
1064     sf_dir = 0;
1065     if (nflexcon)
1066     {
1067         init_adir(fplog, shfc,
1068                   constr, idef, inputrec, cr, dd_ac1, mdstep, md, start, end,
1069                   shfc->x_old-start, state->x, state->x, force[Min],
1070                   shfc->acc_dir-start,
1071                   fr->bMolPBC, state->box, state->lambda, &dum, nrnb);
1072
1073         for (i = start; i < end; i++)
1074         {
1075             sf_dir += md->massT[i]*norm2(shfc->acc_dir[i-start]);
1076         }
1077     }
1078
1079     Epot[Min] = enerd->term[F_EPOT];
1080
1081     df[Min] = rms_force(cr, shfc->f[Min], nshell, shell, nflexcon, &sf_dir, &Epot[Min]);
1082     df[Try] = 0;
1083     if (debug)
1084     {
1085         fprintf(debug, "df = %g  %g\n", df[Min], df[Try]);
1086     }
1087
1088     if (gmx_debug_at)
1089     {
1090         pr_rvecs(debug, 0, "force0", force[Min], md->nr);
1091     }
1092
1093     if (nshell+nflexcon > 0)
1094     {
1095         /* Copy x to pos[Min] & pos[Try]: during minimization only the
1096          * shell positions are updated, therefore the other particles must
1097          * be set here.
1098          */
1099         memcpy(pos[Min], state->x, nat*sizeof(state->x[0]));
1100         memcpy(pos[Try], state->x, nat*sizeof(state->x[0]));
1101     }
1102
1103     if (bVerbose && MASTER(cr))
1104     {
1105         print_epot(stdout, mdstep, 0, Epot[Min], df[Min], nflexcon, sf_dir);
1106     }
1107
1108     if (debug)
1109     {
1110         fprintf(debug, "%17s: %14.10e\n",
1111                 interaction_function[F_EKIN].longname, enerd->term[F_EKIN]);
1112         fprintf(debug, "%17s: %14.10e\n",
1113                 interaction_function[F_EPOT].longname, enerd->term[F_EPOT]);
1114         fprintf(debug, "%17s: %14.10e\n",
1115                 interaction_function[F_ETOT].longname, enerd->term[F_ETOT]);
1116         fprintf(debug, "SHELLSTEP %s\n", gmx_step_str(mdstep, sbuf));
1117     }
1118
1119     /* First check whether we should do shells, or whether the force is
1120      * low enough even without minimization.
1121      */
1122     *bConverged = (df[Min] < ftol);
1123
1124     for (count = 1; (!(*bConverged) && (count < number_steps)); count++)
1125     {
1126         if (vsite)
1127         {
1128             construct_vsites(vsite, pos[Min], inputrec->delta_t, state->v,
1129                              idef->iparams, idef->il,
1130                              fr->ePBC, fr->bMolPBC, cr, state->box);
1131         }
1132
1133         if (nflexcon)
1134         {
1135             init_adir(fplog, shfc,
1136                       constr, idef, inputrec, cr, dd_ac1, mdstep, md, start, end,
1137                       x_old-start, state->x, pos[Min], force[Min], acc_dir-start,
1138                       fr->bMolPBC, state->box, state->lambda, &dum, nrnb);
1139
1140             directional_sd(pos[Min], pos[Try], acc_dir-start, start, end,
1141                            fr->fc_stepsize);
1142         }
1143
1144         /* New positions, Steepest descent */
1145         shell_pos_sd(pos[Min], pos[Try], force[Min], nshell, shell, count);
1146
1147         /* do_force expected the charge groups to be in the box */
1148         if (graph)
1149         {
1150             unshift_self(graph, state->box, pos[Try]);
1151         }
1152
1153         if (gmx_debug_at)
1154         {
1155             pr_rvecs(debug, 0, "RELAX: pos[Min]  ", pos[Min] + start, homenr);
1156             pr_rvecs(debug, 0, "RELAX: pos[Try]  ", pos[Try] + start, homenr);
1157         }
1158         /* Try the new positions */
1159         do_force(fplog, cr, inputrec, 1, nrnb, wcycle,
1160                  top, groups, state->box, pos[Try], &state->hist,
1161                  force[Try], force_vir,
1162                  md, enerd, fcd, state->lambda, graph,
1163                  fr, vsite, mu_tot, t, fp_field, NULL, bBornRadii,
1164                  force_flags);
1165
1166         if (gmx_debug_at)
1167         {
1168             pr_rvecs(debug, 0, "RELAX: force[Min]", force[Min] + start, homenr);
1169             pr_rvecs(debug, 0, "RELAX: force[Try]", force[Try] + start, homenr);
1170         }
1171         sf_dir = 0;
1172         if (nflexcon)
1173         {
1174             init_adir(fplog, shfc,
1175                       constr, idef, inputrec, cr, dd_ac1, mdstep, md, start, end,
1176                       x_old-start, state->x, pos[Try], force[Try], acc_dir-start,
1177                       fr->bMolPBC, state->box, state->lambda, &dum, nrnb);
1178
1179             for (i = start; i < end; i++)
1180             {
1181                 sf_dir += md->massT[i]*norm2(acc_dir[i-start]);
1182             }
1183         }
1184
1185         Epot[Try] = enerd->term[F_EPOT];
1186
1187         df[Try] = rms_force(cr, force[Try], nshell, shell, nflexcon, &sf_dir, &Epot[Try]);
1188
1189         if (debug)
1190         {
1191             fprintf(debug, "df = %g  %g\n", df[Min], df[Try]);
1192         }
1193
1194         if (debug)
1195         {
1196             if (gmx_debug_at)
1197             {
1198                 pr_rvecs(debug, 0, "F na do_force", force[Try] + start, homenr);
1199             }
1200             if (gmx_debug_at)
1201             {
1202                 fprintf(debug, "SHELL ITER %d\n", count);
1203                 dump_shells(debug, pos[Try], force[Try], ftol, nshell, shell);
1204             }
1205         }
1206
1207         if (bVerbose && MASTER(cr))
1208         {
1209             print_epot(stdout, mdstep, count, Epot[Try], df[Try], nflexcon, sf_dir);
1210         }
1211
1212         *bConverged = (df[Try] < ftol);
1213
1214         if ((df[Try] < df[Min]))
1215         {
1216             if (debug)
1217             {
1218                 fprintf(debug, "Swapping Min and Try\n");
1219             }
1220             if (nflexcon)
1221             {
1222                 /* Correct the velocities for the flexible constraints */
1223                 invdt = 1/inputrec->delta_t;
1224                 for (i = start; i < end; i++)
1225                 {
1226                     for (d = 0; d < DIM; d++)
1227                     {
1228                         state->v[i][d] += (pos[Try][i][d] - pos[Min][i][d])*invdt;
1229                     }
1230                 }
1231             }
1232             Min  = Try;
1233         }
1234         else
1235         {
1236             decrease_step_size(nshell, shell);
1237         }
1238     }
1239     if (MASTER(cr) && !(*bConverged))
1240     {
1241         /* Note that the energies and virial are incorrect when not converged */
1242         if (fplog)
1243         {
1244             fprintf(fplog,
1245                     "step %s: EM did not converge in %d iterations, RMS force %.3f\n",
1246                     gmx_step_str(mdstep, sbuf), number_steps, df[Min]);
1247         }
1248         fprintf(stderr,
1249                 "step %s: EM did not converge in %d iterations, RMS force %.3f\n",
1250                 gmx_step_str(mdstep, sbuf), number_steps, df[Min]);
1251     }
1252
1253     /* Copy back the coordinates and the forces */
1254     memcpy(state->x, pos[Min], nat*sizeof(state->x[0]));
1255     memcpy(f, force[Min], nat*sizeof(f[0]));
1256
1257     return count;
1258 }