src/mdlib/shellfc.c

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