src/tools/gmx_vanhove.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  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012,2013, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 #ifdef HAVE_CONFIG_H
  39 #include <config.h>
  40 #endif
  41
  42 #include <string.h>
  43 #include <ctype.h>
  44 #include <math.h>
  45
  46 #include "sysstuff.h"
  47 #include "smalloc.h"
  48 #include "macros.h"
  49 #include "statutil.h"
  50 #include "maths.h"
  51 #include "futil.h"
  52 #include "index.h"
  53 #include "copyrite.h"
  54 #include "typedefs.h"
  55 #include "xvgr.h"
  56 #include "gstat.h"
  57 #include "tpxio.h"
  58 #include "vec.h"
  59 #include "matio.h"
  60 #include "gmx_ana.h"
  61
  62
  63 int gmx_vanhove(int argc, char *argv[])
  64 {
  65     const char *desc[] = {
  66         "[TT]g_vanhove[tt] computes the Van Hove correlation function.",
  67         "The Van Hove G(r,t) is the probability that a particle that is at r[SUB]0[sub]",
  68         "at time zero can be found at position r[SUB]0[sub]+r at time t.",
  69         "[TT]g_vanhove[tt] determines G not for a vector r, but for the length of r.",
  70         "Thus it gives the probability that a particle moves a distance of r",
  71         "in time t.",
  72         "Jumps across the periodic boundaries are removed.",
  73         "Corrections are made for scaling due to isotropic",
  74         "or anisotropic pressure coupling.",
  75         "[PAR]",
  76         "With option [TT]-om[tt] the whole matrix can be written as a function",
  77         "of t and r or as a function of [SQRT]t[sqrt] and r (option [TT]-sqrt[tt]).",
  78         "[PAR]",
  79         "With option [TT]-or[tt] the Van Hove function is plotted for one",
  80         "or more values of t. Option [TT]-nr[tt] sets the number of times,",
  81         "option [TT]-fr[tt] the number spacing between the times.",
  82         "The binwidth is set with option [TT]-rbin[tt]. The number of bins",
  83         "is determined automatically.",
  84         "[PAR]",
  85         "With option [TT]-ot[tt] the integral up to a certain distance",
  86         "(option [TT]-rt[tt]) is plotted as a function of time.",
  87         "[PAR]",
  88         "For all frames that are read the coordinates of the selected particles",
  89         "are stored in memory. Therefore the program may use a lot of memory.",
  90         "For options [TT]-om[tt] and [TT]-ot[tt] the program may be slow.",
  91         "This is because the calculation scales as the number of frames times",
  92         "[TT]-fm[tt] or [TT]-ft[tt].",
  93         "Note that with the [TT]-dt[tt] option the memory usage and calculation",
  94         "time can be reduced."
  95     };
  96     static int  fmmax = 0, ftmax = 0, nlev = 81, nr = 1, fshift = 0;
  97     static real sbin  = 0, rmax = 2, rbin = 0.01, mmax = 0, rint = 0;
  98     t_pargs     pa[]  = {
  99         { "-sqrt",    FALSE, etREAL, {&sbin},
 100           "Use [SQRT]t[sqrt] on the matrix axis which binspacing # in [SQRT]ps[sqrt]" },
 101         { "-fm",      FALSE, etINT, {&fmmax},
 102           "Number of frames in the matrix, 0 is plot all" },
 103         { "-rmax",    FALSE, etREAL, {&rmax},
 104           "Maximum r in the matrix (nm)" },
 105         { "-rbin",    FALSE, etREAL, {&rbin},
 106           "Binwidth in the matrix and for [TT]-or[tt] (nm)" },
 107         { "-mmax",    FALSE, etREAL, {&mmax},
 108           "Maximum density in the matrix, 0 is calculate (1/nm)" },
 109         { "-nlevels", FALSE, etINT,  {&nlev},
 110           "Number of levels in the matrix" },
 111         { "-nr",      FALSE, etINT, {&nr},
 112           "Number of curves for the [TT]-or[tt] output" },
 113         { "-fr",      FALSE, etINT, {&fshift},
 114           "Frame spacing for the [TT]-or[tt] output" },
 115         { "-rt",      FALSE, etREAL, {&rint},
 116           "Integration limit for the [TT]-ot[tt] output (nm)" },
 117         { "-ft",      FALSE, etINT, {&ftmax},
 118           "Number of frames in the [TT]-ot[tt] output, 0 is plot all" }
 119     };
 120 #define NPA asize(pa)
 121
 122     t_filenm fnm[] = {
 123         { efTRX, NULL, NULL,  ffREAD },
 124         { efTPS, NULL, NULL,  ffREAD },
 125         { efNDX, NULL, NULL,  ffOPTRD },
 126         { efXPM, "-om", "vanhove", ffOPTWR },
 127         { efXVG, "-or", "vanhove_r", ffOPTWR },
 128         { efXVG, "-ot", "vanhove_t", ffOPTWR }
 129     };
 130 #define NFILE asize(fnm)
 131
 132     output_env_t oenv;
 133     const char  *matfile, *otfile, *orfile;
 134     char         title[256];
 135     t_topology   top;
 136     int          ePBC;
 137     matrix       boxtop, box, *sbox, avbox, corr;
 138     rvec        *xtop, *x, **sx;
 139     int          isize, nalloc, nallocn, natom;
 140     t_trxstatus *status;
 141     atom_id     *index;
 142     char        *grpname;
 143     int          nfr, f, ff, i, m, mat_nx = 0, nbin = 0, bin, mbin, fbin;
 144     real        *time, t, invbin = 0, rmax2 = 0, rint2 = 0, d2;
 145     real         invsbin = 0, matmax, normfac, dt, *tickx, *ticky;
 146     char         buf[STRLEN], **legend;
 147     real       **mat = NULL;
 148     int         *pt  = NULL, **pr = NULL, *mcount = NULL, *tcount = NULL, *rcount = NULL;
 149     FILE        *fp;
 150     t_rgb        rlo = {1, 1, 1}, rhi = {0, 0, 0};
 151
 152     CopyRight(stderr, argv[0]);
 153
 154     parse_common_args(&argc, argv, PCA_CAN_VIEW | PCA_CAN_TIME | PCA_BE_NICE,
 155                       NFILE, fnm, asize(pa), pa, asize(desc), desc, 0, NULL, &oenv);
 156
 157     matfile = opt2fn_null("-om", NFILE, fnm);
 158     if (opt2parg_bSet("-fr", NPA, pa))
 159     {
 160         orfile  = opt2fn("-or", NFILE, fnm);
 161     }
 162     else
 163     {
 164         orfile  = opt2fn_null("-or", NFILE, fnm);
 165     }
 166     if (opt2parg_bSet("-rt", NPA, pa))
 167     {
 168         otfile  = opt2fn("-ot", NFILE, fnm);
 169     }
 170     else
 171     {
 172         otfile  = opt2fn_null("-ot", NFILE, fnm);
 173     }
 174
 175     if (!matfile && !otfile && !orfile)
 176     {
 177         fprintf(stderr,
 178                 "For output set one (or more) of the output file options\n");
 179         exit(0);
 180     }
 181
 182     read_tps_conf(ftp2fn(efTPS, NFILE, fnm), title, &top, &ePBC, &xtop, NULL, boxtop,
 183                   FALSE);
 184     get_index(&top.atoms, ftp2fn_null(efNDX, NFILE, fnm), 1, &isize, &index, &grpname);
 185
 186     nalloc = 0;
 187     time   = NULL;
 188     sbox   = NULL;
 189     sx     = NULL;
 190     clear_mat(avbox);
 191
 192     natom = read_first_x(oenv, &status, ftp2fn(efTRX, NFILE, fnm), &t, &x, box);
 193     nfr   = 0;
 194     do
 195     {
 196         if (nfr >= nalloc)
 197         {
 198             nalloc += 100;
 199             srenew(time, nalloc);
 200             srenew(sbox, nalloc);
 201             srenew(sx, nalloc);
 202         }
 203
 204         time[nfr] = t;
 205         copy_mat(box, sbox[nfr]);
 206         /* This assumes that the off-diagonal box elements
 207          * are not affected by jumps across the periodic boundaries.
 208          */
 209         m_add(avbox, box, avbox);
 210         snew(sx[nfr], isize);
 211         for (i = 0; i < isize; i++)
 212         {
 213             copy_rvec(x[index[i]], sx[nfr][i]);
 214         }
 215
 216         nfr++;
 217     }
 218     while (read_next_x(oenv, status, &t, natom, x, box));
 219
 220     /* clean up */
 221     sfree(x);
 222     close_trj(status);
 223
 224     fprintf(stderr, "Read %d frames\n", nfr);
 225
 226     dt = (time[nfr-1] - time[0])/(nfr - 1);
 227     /* Some ugly rounding to get nice nice times in the output */
 228     dt = (int)(10000.0*dt + 0.5)/10000.0;
 229
 230     invbin = 1.0/rbin;
 231
 232     if (matfile)
 233     {
 234         if (fmmax <= 0 || fmmax >= nfr)
 235         {
 236             fmmax = nfr - 1;
 237         }
 238         snew(mcount, fmmax);
 239         nbin = (int)(rmax*invbin + 0.5);
 240         if (sbin == 0)
 241         {
 242             mat_nx = fmmax + 1;
 243         }
 244         else
 245         {
 246             invsbin = 1.0/sbin;
 247             mat_nx  = sqrt(fmmax*dt)*invsbin + 1;
 248         }
 249         snew(mat, mat_nx);
 250         for (f = 0; f < mat_nx; f++)
 251         {
 252             snew(mat[f], nbin);
 253         }
 254         rmax2 = sqr(nbin*rbin);
 255         /* Initialize time zero */
 256         mat[0][0]  = nfr*isize;
 257         mcount[0] += nfr;
 258     }
 259     else
 260     {
 261         fmmax = 0;
 262     }
 263
 264     if (orfile)
 265     {
 266         snew(pr, nr);
 267         nalloc = 0;
 268         snew(rcount, nr);
 269     }
 270
 271     if (otfile)
 272     {
 273         if (ftmax <= 0)
 274         {
 275             ftmax = nfr - 1;
 276         }
 277         snew(tcount, ftmax);
 278         snew(pt, nfr);
 279         rint2 = rint*rint;
 280         /* Initialize time zero */
 281         pt[0]      = nfr*isize;
 282         tcount[0] += nfr;
 283     }
 284     else
 285     {
 286         ftmax = 0;
 287     }
 288
 289     msmul(avbox, 1.0/nfr, avbox);
 290     for (f = 0; f < nfr; f++)
 291     {
 292         if (f % 100 == 0)
 293         {
 294             fprintf(stderr, "\rProcessing frame %d", f);
 295         }
 296         /* Scale all the configuration to the average box */
 297         m_inv_ur0(sbox[f], corr);
 298         mmul_ur0(avbox, corr, corr);
 299         for (i = 0; i < isize; i++)
 300         {
 301             mvmul_ur0(corr, sx[f][i], sx[f][i]);
 302             if (f > 0)
 303             {
 304                 /* Correct for periodic jumps */
 305                 for (m = DIM-1; m >= 0; m--)
 306                 {
 307                     while (sx[f][i][m] - sx[f-1][i][m] > 0.5*avbox[m][m])
 308                     {
 309                         rvec_dec(sx[f][i], avbox[m]);
 310                     }
 311                     while (sx[f][i][m] - sx[f-1][i][m] <= -0.5*avbox[m][m])
 312                     {
 313                         rvec_inc(sx[f][i], avbox[m]);
 314                     }
 315                 }
 316             }
 317         }
 318         for (ff = 0; ff < f; ff++)
 319         {
 320             fbin = f - ff;
 321             if (fbin <= fmmax || fbin <= ftmax)
 322             {
 323                 if (sbin == 0)
 324                 {
 325                     mbin = fbin;
 326                 }
 327                 else
 328                 {
 329                     mbin = (int)(sqrt(fbin*dt)*invsbin + 0.5);
 330                 }
 331                 for (i = 0; i < isize; i++)
 332                 {
 333                     d2 = distance2(sx[f][i], sx[ff][i]);
 334                     if (mbin < mat_nx && d2 < rmax2)
 335                     {
 336                         bin = (int)(sqrt(d2)*invbin + 0.5);
 337                         if (bin < nbin)
 338                         {
 339                             mat[mbin][bin] += 1;
 340                         }
 341                     }
 342                     if (fbin <= ftmax && d2 <= rint2)
 343                     {
 344                         pt[fbin]++;
 345                     }
 346                 }
 347                 if (matfile)
 348                 {
 349                     mcount[mbin]++;
 350                 }
 351                 if (otfile)
 352                 {
 353                     tcount[fbin]++;
 354                 }
 355             }
 356         }
 357         if (orfile)
 358         {
 359             for (fbin = 0; fbin < nr; fbin++)
 360             {
 361                 ff = f - (fbin + 1)*fshift;
 362                 if (ff >= 0)
 363                 {
 364                     for (i = 0; i < isize; i++)
 365                     {
 366                         d2  = distance2(sx[f][i], sx[ff][i]);
 367                         bin = (int)(sqrt(d2)*invbin + 0.5);
 368                         if (bin >= nalloc)
 369                         {
 370                             nallocn = 10*(bin/10) + 11;
 371                             for (m = 0; m < nr; m++)
 372                             {
 373                                 srenew(pr[m], nallocn);
 374                                 for (i = nalloc; i < nallocn; i++)
 375                                 {
 376                                     pr[m][i] = 0;
 377                                 }
 378                             }
 379                             nalloc = nallocn;
 380                         }
 381                         pr[fbin][bin]++;
 382                     }
 383                     rcount[fbin]++;
 384                 }
 385             }
 386         }
 387     }
 388     fprintf(stderr, "\n");
 389
 390     if (matfile)
 391     {
 392         matmax = 0;
 393         for (f = 0; f < mat_nx; f++)
 394         {
 395             normfac = 1.0/(mcount[f]*isize*rbin);
 396             for (i = 0; i < nbin; i++)
 397             {
 398                 mat[f][i] *= normfac;
 399                 if (mat[f][i] > matmax && (f != 0 || i != 0))
 400                 {
 401                     matmax = mat[f][i];
 402                 }
 403             }
 404         }
 405         fprintf(stdout, "Value at (0,0): %.3f, maximum of the rest %.3f\n",
 406                 mat[0][0], matmax);
 407         if (mmax > 0)
 408         {
 409             matmax = mmax;
 410         }
 411         snew(tickx, mat_nx);
 412         for (f = 0; f < mat_nx; f++)
 413         {
 414             if (sbin == 0)
 415             {
 416                 tickx[f] = f*dt;
 417             }
 418             else
 419             {
 420                 tickx[f] = f*sbin;
 421             }
 422         }
 423         snew(ticky, nbin+1);
 424         for (i = 0; i <= nbin; i++)
 425         {
 426             ticky[i] = i*rbin;
 427         }
 428         fp = ffopen(matfile, "w");
 429         write_xpm(fp, MAT_SPATIAL_Y, "Van Hove function", "G (1/nm)",
 430                   sbin == 0 ? "time (ps)" : "sqrt(time) (ps^1/2)", "r (nm)",
 431                   mat_nx, nbin, tickx, ticky, mat, 0, matmax, rlo, rhi, &nlev);
 432         ffclose(fp);
 433     }
 434
 435     if (orfile)
 436     {
 437         fp = xvgropen(orfile, "Van Hove function", "r (nm)", "G (nm\\S-1\\N)", oenv);
 438         if(output_env_get_print_xvgr_codes(oenv))
 439         {
 440             fprintf(fp, "@ subtitle \"for particles in group %s\"\n", grpname);
 441         }
 442         snew(legend, nr);
 443         for (fbin = 0; fbin < nr; fbin++)
 444         {
 445             sprintf(buf, "%g ps", (fbin + 1)*fshift*dt);
 446             legend[fbin] = strdup(buf);
 447         }
 448         xvgr_legend(fp, nr, (const char**)legend, oenv);
 449         for (i = 0; i < nalloc; i++)
 450         {
 451             fprintf(fp, "%g", i*rbin);
 452             for (fbin = 0; fbin < nr; fbin++)
 453             {
 454                 fprintf(fp, " %g",
 455                         (real)pr[fbin][i]/(rcount[fbin]*isize*rbin*(i == 0 ? 0.5 : 1)));
 456             }
 457             fprintf(fp, "\n");
 458         }
 459         ffclose(fp);
 460     }
 461
 462     if (otfile)
 463     {
 464         sprintf(buf, "Probability of moving less than %g nm", rint);
 465         fp = xvgropen(otfile, buf, "t (ps)", "", oenv);
 466         if(output_env_get_print_xvgr_codes(oenv))
 467         {
 468             fprintf(fp, "@ subtitle \"for particles in group %s\"\n", grpname);
 469         }
 470         for (f = 0; f <= ftmax; f++)
 471         {
 472             fprintf(fp, "%g %g\n", f*dt, (real)pt[f]/(tcount[f]*isize));
 473         }
 474         ffclose(fp);
 475     }
 476
 477     do_view(oenv, matfile, NULL);
 478     do_view(oenv, orfile, NULL);
 479     do_view(oenv, otfile, NULL);
 480
 481     thanx(stderr);
 482
 483     return 0;
 484 }