src/gromacs/gmxpreprocess/readpull.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-2004, 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 <stdlib.h>
  43
  44 #include "gromacs/utility/cstringutil.h"
  45 #include "sysstuff.h"
  46 #include "princ.h"
  47 #include "gromacs/fileio/futil.h"
  48 #include "vec.h"
  49 #include "gromacs/utility/smalloc.h"
  50 #include "typedefs.h"
  51 #include "names.h"
  52 #include "gmx_fatal.h"
  53 #include "macros.h"
  54 #include "index.h"
  55 #include "symtab.h"
  56 #include "readinp.h"
  57 #include "readir.h"
  58 #include "mdatoms.h"
  59 #include "pbc.h"
  60 #include "gromacs/pulling/pull.h"
  61
  62
  63 static char pulldim[STRLEN];
  64
  65 static void string2dvec(const char buf[], dvec nums)
  66 {
  67     double dum;
  68
  69     if (sscanf(buf, "%lf%lf%lf%lf", &nums[0], &nums[1], &nums[2], &dum) != 3)
  70     {
  71         gmx_fatal(FARGS, "Expected three numbers at input line %s", buf);
  72     }
  73 }
  74
  75 static void init_pull_group(t_pull_group *pg,
  76                             const char   *wbuf)
  77 {
  78     double d;
  79     int    n, m;
  80
  81     pg->nweight = 0;
  82     while (sscanf(wbuf, "%lf %n", &d, &n) == 1)
  83     {
  84         if (pg->nweight % 100 == 0)
  85         {
  86             srenew(pg->weight, pg->nweight+100);
  87         }
  88         pg->weight[pg->nweight++] = d;
  89         wbuf += n;
  90     }
  91 }
  92
  93 static void init_pull_coord(t_pull_coord *pcrd, int eGeom,
  94                             const char *origin_buf, const char *vec_buf)
  95 {
  96     int    m;
  97     dvec   origin, vec;
  98
  99     string2dvec(origin_buf, origin);
 100     if (pcrd->group[0] != 0 && dnorm(origin) > 0)
 101     {
 102         gmx_fatal(FARGS, "The pull origin can only be set with an absolute reference");
 103     }
 104
 105     if (eGeom == epullgDIST)
 106     {
 107         clear_dvec(vec);
 108     }
 109     else
 110     {
 111         string2dvec(vec_buf, vec);
 112         if (eGeom == epullgDIR || eGeom == epullgCYL)
 113         {
 114             /* Normalize the direction vector */
 115             dsvmul(1/dnorm(vec), vec, vec);
 116         }
 117     }
 118     for (m = 0; m < DIM; m++)
 119     {
 120         pcrd->origin[m] = origin[m];
 121         pcrd->vec[m]    = vec[m];
 122     }
 123 }
 124
 125 char **read_pullparams(int *ninp_p, t_inpfile **inp_p,
 126                        t_pull *pull, gmx_bool *bStart,
 127                        warninp_t wi)
 128 {
 129     int           ninp, nerror = 0, i, nchar, nscan, m, idum;
 130     t_inpfile    *inp;
 131     const char   *tmp;
 132     char        **grpbuf;
 133     char          dummy[STRLEN], buf[STRLEN], groups[STRLEN], init[STRLEN];
 134     const char   *init_def1 = "0.0", *init_def3 = "0.0 0.0 0.0";
 135     char          wbuf[STRLEN], origin_buf[STRLEN], vec_buf[STRLEN];
 136
 137     t_pull_group *pgrp;
 138     t_pull_coord *pcrd;
 139
 140     ninp   = *ninp_p;
 141     inp    = *inp_p;
 142
 143     /* read pull parameters */
 144     CTYPE("Pull geometry: distance, direction, direction-periodic or cylinder");
 145     EETYPE("pull-geometry",   pull->eGeom, epullg_names);
 146     CTYPE("Select components for the pull vector. default: Y Y Y");
 147     STYPE("pull-dim",         pulldim, "Y Y Y");
 148     CTYPE("Cylinder radius for dynamic reaction force groups (nm)");
 149     RTYPE("pull-r1",          pull->cyl_r1, 1.0);
 150     CTYPE("Switch from r1 to r0 in case of dynamic reaction force");
 151     RTYPE("pull-r0",          pull->cyl_r0, 1.5);
 152     RTYPE("pull-constr-tol",  pull->constr_tol, 1E-6);
 153     EETYPE("pull-start",      *bStart, yesno_names);
 154     EETYPE("pull-print-reference", pull->bPrintRef, yesno_names);
 155     ITYPE("pull-nstxout",     pull->nstxout, 10);
 156     ITYPE("pull-nstfout",     pull->nstfout,  1);
 157     CTYPE("Number of pull groups");
 158     ITYPE("pull-ngroups",     pull->ngroup, 1);
 159     CTYPE("Number of pull coordinates");
 160     ITYPE("pull-ncoords",     pull->ncoord, 1);
 161
 162     if (pull->cyl_r1 > pull->cyl_r0)
 163     {
 164         warning_error(wi, "pull-r1 > pull_r0");
 165     }
 166
 167     if (pull->ngroup < 1)
 168     {
 169         gmx_fatal(FARGS, "pull-ngroups should be >= 1");
 170     }
 171     /* We always add an absolute reference group (index 0), even if not used */
 172     pull->ngroup += 1;
 173
 174     if (pull->ncoord < 1)
 175     {
 176         gmx_fatal(FARGS, "pull-ncoords should be >= 1");
 177     }
 178
 179     snew(pull->group, pull->ngroup);
 180
 181     snew(pull->coord, pull->ncoord);
 182
 183     /* pull group options */
 184     CTYPE("Group name, weight (default all 1), vector, init, rate (nm/ps), kJ/(mol*nm^2)");
 185
 186     /* Read the pull groups */
 187     snew(grpbuf, pull->ngroup);
 188     /* Group 0 is the absolute reference, we don't read anything for 0 */
 189     for (i = 1; i < pull->ngroup; i++)
 190     {
 191         pgrp = &pull->group[i];
 192         snew(grpbuf[i], STRLEN);
 193         sprintf(buf, "pull-group%d-name", i);
 194         STYPE(buf,              grpbuf[i], "");
 195         sprintf(buf, "pull-group%d-weights", i);
 196         STYPE(buf,              wbuf, "");
 197         sprintf(buf, "pull-group%d-pbcatom", i);
 198         ITYPE(buf,              pgrp->pbcatom, 0);
 199
 200         /* Initialize the pull group */
 201         init_pull_group(pgrp, wbuf);
 202     }
 203
 204     /* Read the pull coordinates */
 205     for (i = 1; i < pull->ncoord + 1; i++)
 206     {
 207         pcrd = &pull->coord[i-1];
 208         sprintf(buf, "pull-coord%d-groups", i);
 209         STYPE(buf,              groups, "");
 210         nscan = sscanf(groups, "%d %d %d", &pcrd->group[0], &pcrd->group[1], &idum);
 211         if (nscan != 2)
 212         {
 213             fprintf(stderr, "ERROR: %s should contain %d pull group indices\n",
 214                     buf, 2);
 215             nerror++;
 216         }
 217         sprintf(buf, "pull-coord%d-origin", i);
 218         STYPE(buf,              origin_buf, "0.0 0.0 0.0");
 219         sprintf(buf, "pull-coord%d-vec", i);
 220         STYPE(buf,              vec_buf,    "0.0 0.0 0.0");
 221         sprintf(buf, "pull-coord%d-init", i);
 222         RTYPE(buf,              pcrd->init, 0.0);
 223         sprintf(buf, "pull-coord%d-rate", i);
 224         RTYPE(buf,              pcrd->rate, 0.0);
 225         sprintf(buf, "pull-coord%d-k", i);
 226         RTYPE(buf,              pcrd->k, 0.0);
 227         sprintf(buf, "pull-coord%d-kB", i);
 228         RTYPE(buf,              pcrd->kB, pcrd->k);
 229
 230         /* Initialize the pull coordinate */
 231         init_pull_coord(pcrd, pull->eGeom, origin_buf, vec_buf);
 232     }
 233
 234     *ninp_p   = ninp;
 235     *inp_p    = inp;
 236
 237     return grpbuf;
 238 }
 239
 240 void make_pull_groups(t_pull *pull,
 241                       char **pgnames,
 242                       const t_blocka *grps, char **gnames)
 243 {
 244     int           g, ig = -1, i;
 245     t_pull_group *pgrp;
 246
 247     /* Absolute reference group (might not be used) is special */
 248     pgrp          = &pull->group[0];
 249     pgrp->nat     = 0;
 250     pgrp->pbcatom = -1;
 251
 252     for (g = 1; g < pull->ngroup; g++)
 253     {
 254         pgrp = &pull->group[g];
 255
 256         if (strcmp(pgnames[g], "") == 0)
 257         {
 258             gmx_fatal(FARGS, "Pull option pull_group%d required by grompp has not been set.", g);
 259         }
 260
 261         ig        = search_string(pgnames[g], grps->nr, gnames);
 262         pgrp->nat = grps->index[ig+1] - grps->index[ig];
 263
 264         fprintf(stderr, "Pull group %d '%s' has %d atoms\n",
 265                 g, pgnames[g], pgrp->nat);
 266
 267         if (pgrp->nat == 0)
 268         {
 269             gmx_fatal(FARGS, "Pull group %d '%s' is empty", g, pgnames[g]);
 270         }
 271
 272         snew(pgrp->ind, pgrp->nat);
 273         for (i = 0; i < pgrp->nat; i++)
 274         {
 275             pgrp->ind[i] = grps->a[grps->index[ig]+i];
 276         }
 277
 278         if (pull->eGeom == epullgCYL && g == 1 && pgrp->nweight > 0)
 279         {
 280             gmx_fatal(FARGS, "Weights are not supported for the reference group with cylinder pulling");
 281         }
 282         if (pgrp->nweight > 0 && pgrp->nweight != pgrp->nat)
 283         {
 284             gmx_fatal(FARGS, "Number of weights (%d) for pull group %d '%s' does not match the number of atoms (%d)",
 285                       pgrp->nweight, g, pgnames[g], pgrp->nat);
 286         }
 287
 288         if (pgrp->nat == 1)
 289         {
 290             /* No pbc is required for this group */
 291             pgrp->pbcatom = -1;
 292         }
 293         else
 294         {
 295             if (pgrp->pbcatom > 0)
 296             {
 297                 pgrp->pbcatom -= 1;
 298             }
 299             else if (pgrp->pbcatom == 0)
 300             {
 301                 pgrp->pbcatom = pgrp->ind[(pgrp->nat-1)/2];
 302             }
 303             else
 304             {
 305                 /* Use cosine weighting */
 306                 pgrp->pbcatom = -1;
 307             }
 308         }
 309     }
 310 }
 311
 312 void make_pull_coords(t_pull *pull)
 313 {
 314     int           ndim, d, nchar, c;
 315     char         *ptr, pulldim1[STRLEN];
 316     t_pull_coord *pcrd;
 317
 318     ptr  = pulldim;
 319     ndim = 0;
 320     for (d = 0; d < DIM; d++)
 321     {
 322         if (sscanf(ptr, "%s%n", pulldim1, &nchar) != 1)
 323         {
 324             gmx_fatal(FARGS, "Less than 3 pull dimensions given in pull_dim: '%s'",
 325                       pulldim);
 326         }
 327
 328         if (gmx_strncasecmp(pulldim1, "N", 1) == 0)
 329         {
 330             pull->dim[d] = 0;
 331         }
 332         else if (gmx_strncasecmp(pulldim1, "Y", 1) == 0)
 333         {
 334             pull->dim[d] = 1;
 335             ndim++;
 336         }
 337         else
 338         {
 339             gmx_fatal(FARGS, "Please use Y(ES) or N(O) for pull_dim only (not %s)",
 340                       pulldim1);
 341         }
 342         ptr += nchar;
 343     }
 344     if (ndim == 0)
 345     {
 346         gmx_fatal(FARGS, "All entries in pull_dim are N");
 347     }
 348
 349     for (c = 0; c < pull->ncoord; c++)
 350     {
 351         pcrd = &pull->coord[c];
 352
 353         if (pcrd->group[0] < 0 || pcrd->group[0] >= pull->ngroup ||
 354             pcrd->group[1] < 0 || pcrd->group[1] >= pull->ngroup)
 355         {
 356             gmx_fatal(FARGS, "Pull group index in pull-coord%d-groups out of range, should be between %d and %d", c+1, 0, pull->ngroup+1);
 357         }
 358
 359         if (pcrd->group[0] == pcrd->group[1])
 360         {
 361             gmx_fatal(FARGS, "Identical pull group indices in pull-coord%d-groups", c+1);
 362         }
 363
 364         if (pull->eGeom == epullgCYL && pcrd->group[0] != 1)
 365         {
 366             gmx_fatal(FARGS, "With pull geometry %s, the first pull group should always be 1", EPULLGEOM(pull->eGeom));
 367         }
 368
 369         if (pull->eGeom != epullgDIST)
 370         {
 371             for (d = 0; d < DIM; d++)
 372             {
 373                 if (pcrd->vec[d] != 0 && pull->dim[d] == 0)
 374                 {
 375                     gmx_fatal(FARGS, "ERROR: pull-group%d-vec has non-zero %c-component while pull_dim for the %c-dimension is N\n", c+1, 'x'+d, 'x'+d);
 376                 }
 377             }
 378         }
 379
 380         if ((pull->eGeom == epullgDIR || pull->eGeom == epullgCYL) &&
 381             norm2(pcrd->vec) == 0)
 382         {
 383             gmx_fatal(FARGS, "pull-group%d-vec can not be zero with geometry %s",
 384                       c+1, EPULLGEOM(pull->eGeom));
 385         }
 386     }
 387 }
 388
 389 void set_pull_init(t_inputrec *ir, gmx_mtop_t *mtop, rvec *x, matrix box, real lambda,
 390                    const output_env_t oenv, gmx_bool bStart)
 391 {
 392     t_mdatoms    *md;
 393     t_pull       *pull;
 394     t_pull_coord *pcrd;
 395     t_pull_group *pgrp0, *pgrp1;
 396     t_pbc         pbc;
 397     int           c, m;
 398     double        t_start;
 399     real          init = 0;
 400     dvec          dr;
 401     double        dev, value;
 402
 403     init_pull(NULL, ir, 0, NULL, mtop, NULL, oenv, lambda, FALSE, 0);
 404     md = init_mdatoms(NULL, mtop, ir->efep);
 405     atoms2md(mtop, ir, 0, NULL, mtop->natoms, md);
 406     if (ir->efep)
 407     {
 408         update_mdatoms(md, lambda);
 409     }
 410     pull = ir->pull;
 411
 412     set_pbc(&pbc, ir->ePBC, box);
 413
 414     t_start = ir->init_t + ir->init_step*ir->delta_t;
 415
 416     pull_calc_coms(NULL, pull, md, &pbc, t_start, x, NULL);
 417
 418     fprintf(stderr, "Pull group  natoms  pbc atom  distance at start  reference at t=0\n");
 419     for (c = 0; c < pull->ncoord; c++)
 420     {
 421         pcrd  = &pull->coord[c];
 422
 423         pgrp0 = &pull->group[pcrd->group[0]];
 424         pgrp1 = &pull->group[pcrd->group[1]];
 425         fprintf(stderr, "%8d  %8d  %8d\n",
 426                 pcrd->group[0], pgrp0->nat, pgrp0->pbcatom+1);
 427         fprintf(stderr, "%8d  %8d  %8d ",
 428                 pcrd->group[1], pgrp1->nat, pgrp1->pbcatom+1);
 429
 430         if (bStart)
 431         {
 432             init       = pcrd->init;
 433             pcrd->init = 0;
 434         }
 435
 436         get_pull_coord_distance(pull, c, &pbc, t_start, dr, &dev);
 437         /* Calculate the value of the coordinate at t_start */
 438         value = pcrd->init + t_start*pcrd->rate + dev;
 439         fprintf(stderr, " %10.3f nm", value);
 440
 441         if (bStart)
 442         {
 443             pcrd->init = value + init;
 444         }
 445         fprintf(stderr, "     %10.3f nm\n", pcrd->init);
 446     }
 447 }