src/tools/gmx_tcaf.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 #include <stdio.h>
  42
  43 #include <math.h>
  44 #include "confio.h"
  45 #include "copyrite.h"
  46 #include "gmx_fatal.h"
  47 #include "futil.h"
  48 #include "gstat.h"
  49 #include "macros.h"
  50 #include "maths.h"
  51 #include "physics.h"
  52 #include "index.h"
  53 #include "smalloc.h"
  54 #include "statutil.h"
  55 #include <string.h>
  56 #include "sysstuff.h"
  57 #include "txtdump.h"
  58 #include "typedefs.h"
  59 #include "vec.h"
  60 #include "strdb.h"
  61 #include "xvgr.h"
  62 #include "pbc.h"
  63 #include "gmx_ana.h"
  64
  65
  66 #define NK  24
  67 #define NPK 4
  68
  69 #define NKC  6
  70 #define NKC0 4
  71 int  kset_c[NKC+1] = { 0, 3, 9, 13, 16, 19, NK };
  72
  73 rvec v0[NK] = {{1, 0, 0}, {0, 1, 0}, {0, 0, 1}, {1, 1, 0}, {1, -1, 0}, {1, 0, 1}, {1, 0, -1}, {0, 1, 1}, {0, 1, -1}, {1, 1, 1}, {1, 1, -1}, {1, -1, 1}, {-1, 1, 1}, {2, 0, 0}, {0, 2, 0}, {0, 0, 2}, {3, 0, 0}, {0, 3, 0}, {0, 0, 3}, {4, 0, 0}, {0, 4, 0}, {0, 0, 4}};
  74 rvec v1[NK] = {{0, 1, 0}, {0, 0, 1}, {1, 0, 0}, {0, 0, 1}, {0, 0, 1}, {0, 1, 0}, {0, 1, 0}, {1, 0, 0}, {1, 0, 0}, {1, -1, 0}, {1, -1, 0}, {1, 0, -1}, { 0, 1, -1}, {0, 1, 0}, {0, 0, 1}, {1, 0, 0}, {0, 1, 0}, {0, 0, 1}, {1, 0, 0}, {0, 1, 0}, {0, 0, 1}, {1, 0, 0}};
  75 rvec v2[NK] = {{0, 0, 1}, {1, 0, 0}, {0, 1, 0}, {1, -1, 0}, {1, 1, 0}, {1, 0, -1}, {1, 0, 1}, {0, 1, -1}, {0, 1, 1}, {1, 1, -2}, {1, 1, 2}, {1, 2, 1}, { 2, 1, 1}, {0, 0, 1}, {1, 0, 0}, {0, 1, 0}, {0, 0, 1}, {1, 0, 0}, {0, 1, 0}, {0, 0, 1}, {1, 0, 0}, {0, 1, 0}};
  76
  77 static void process_tcaf(int nframes, real dt, int nkc, real **tc, rvec *kfac,
  78                          real rho, real wt, const char *fn_trans,
  79                          const char *fn_tca, const char *fn_tc,
  80                          const char *fn_tcf, const char *fn_cub,
  81                          const char *fn_vk, const output_env_t oenv)
  82 {
  83     FILE  *fp, *fp_vk, *fp_cub = NULL;
  84     int    nk, ntc;
  85     real **tcaf, **tcafc = NULL, eta;
  86     int    i, j, k, kc;
  87     int    ncorr;
  88     real   fitparms[3], *sig;
  89
  90     nk  = kset_c[nkc];
  91     ntc = nk*NPK;
  92
  93     if (fn_trans)
  94     {
  95         fp = xvgropen(fn_trans, "Transverse Current", "Time (ps)", "TC (nm/ps)",
  96                       oenv);
  97         for (i = 0; i < nframes; i++)
  98         {
  99             fprintf(fp, "%g", i*dt);
 100             for (j = 0; j < ntc; j++)
 101             {
 102                 fprintf(fp, " %g", tc[j][i]);
 103             }
 104             fprintf(fp, "\n");
 105         }
 106         ffclose(fp);
 107         do_view(oenv, fn_trans, "-nxy");
 108     }
 109
 110     ncorr = (nframes+1)/2;
 111     if (ncorr > (int)(5*wt/dt+0.5))
 112     {
 113         ncorr = (int)(5*wt/dt+0.5)+1;
 114     }
 115     snew(tcaf, nk);
 116     for (k = 0; k < nk; k++)
 117     {
 118         snew(tcaf[k], ncorr);
 119     }
 120     if (fn_cub)
 121     {
 122         snew(tcafc, nkc);
 123         for (k = 0; k < nkc; k++)
 124         {
 125             snew(tcafc[k], ncorr);
 126         }
 127     }
 128     snew(sig, ncorr);
 129     for (i = 0; i < ncorr; i++)
 130     {
 131         sig[i] = exp(0.5*i*dt/wt);
 132     }
 133
 134     low_do_autocorr(fn_tca, oenv, "Transverse Current Autocorrelation Functions",
 135                     nframes, ntc, ncorr, tc, dt, eacNormal,
 136                     1, FALSE, FALSE, FALSE, 0, 0, 0, 0);
 137     do_view(oenv, fn_tca, "-nxy");
 138
 139     fp = xvgropen(fn_tc, "Transverse Current Autocorrelation Functions",
 140                   "Time (ps)", "TCAF", oenv);
 141     for (i = 0; i < ncorr; i++)
 142     {
 143         kc = 0;
 144         fprintf(fp, "%g", i*dt);
 145         for (k = 0; k < nk; k++)
 146         {
 147             for (j = 0; j < NPK; j++)
 148             {
 149                 tcaf[k][i] += tc[NPK*k+j][i];
 150             }
 151             if (fn_cub)
 152             {
 153                 for (j = 0; j < NPK; j++)
 154                 {
 155                     tcafc[kc][i] += tc[NPK*k+j][i];
 156                 }
 157             }
 158             if (i == 0)
 159             {
 160                 fprintf(fp, " %g", 1.0);
 161             }
 162             else
 163             {
 164                 tcaf[k][i] /= tcaf[k][0];
 165                 fprintf(fp, " %g", tcaf[k][i]);
 166             }
 167             if (k+1 == kset_c[kc+1])
 168             {
 169                 kc++;
 170             }
 171         }
 172         fprintf(fp, "\n");
 173     }
 174     ffclose(fp);
 175     do_view(oenv, fn_tc, "-nxy");
 176
 177     if (fn_cub)
 178     {
 179         fp_cub = xvgropen(fn_cub, "TCAFs and fits", "Time (ps)", "TCAF", oenv);
 180         for (kc = 0; kc < nkc; kc++)
 181         {
 182             fprintf(fp_cub, "%g %g\n", 0.0, 1.0);
 183             for (i = 1; i < ncorr; i++)
 184             {
 185                 tcafc[kc][i] /= tcafc[kc][0];
 186                 fprintf(fp_cub, "%g %g\n", i*dt, tcafc[kc][i]);
 187             }
 188             fprintf(fp_cub, "&\n");
 189             tcafc[kc][0] = 1.0;
 190         }
 191     }
 192
 193     fp_vk = xvgropen(fn_vk, "Fits", "k (nm\\S-1\\N)",
 194                      "\\8h\\4 (10\\S-3\\N kg m\\S-1\\N s\\S-1\\N)", oenv);
 195     fprintf(fp_vk, "@    s0 symbol 2\n");
 196     fprintf(fp_vk, "@    s0 symbol color 1\n");
 197     fprintf(fp_vk, "@    s0 linestyle 0\n");
 198     if (fn_cub)
 199     {
 200         fprintf(fp_vk, "@    s1 symbol 3\n");
 201         fprintf(fp_vk, "@    s1 symbol color 2\n");
 202     }
 203     fp = xvgropen(fn_tcf, "TCAF Fits", "Time (ps)", "", oenv);
 204     for (k = 0; k < nk; k++)
 205     {
 206         tcaf[k][0]   = 1.0;
 207         fitparms[0]  = 1;
 208         fitparms[1]  = 1;
 209         do_lmfit(ncorr, tcaf[k], sig, dt, 0, 0, ncorr*dt,
 210                  oenv, bDebugMode(), effnVAC, fitparms, 0);
 211         eta = 1000*fitparms[1]*rho/
 212             (4*fitparms[0]*PICO*norm2(kfac[k])/(NANO*NANO));
 213         fprintf(stdout, "k %6.3f  tau %6.3f  eta %8.5f 10^-3 kg/(m s)\n",
 214                 norm(kfac[k]), fitparms[0], eta);
 215         fprintf(fp_vk, "%6.3f %g\n", norm(kfac[k]), eta);
 216         for (i = 0; i < ncorr; i++)
 217         {
 218             fprintf(fp, "%g %g\n", i*dt, fit_function(effnVAC, fitparms, i*dt));
 219         }
 220         fprintf(fp, "&\n");
 221     }
 222     ffclose(fp);
 223     do_view(oenv, fn_tcf, "-nxy");
 224
 225     if (fn_cub)
 226     {
 227         fprintf(stdout, "Averaged over k-vectors:\n");
 228         fprintf(fp_vk, "&\n");
 229         for (k = 0; k < nkc; k++)
 230         {
 231             tcafc[k][0]  = 1.0;
 232             fitparms[0]  = 1;
 233             fitparms[1]  = 1;
 234             do_lmfit(ncorr, tcafc[k], sig, dt, 0, 0, ncorr*dt,
 235                      oenv, bDebugMode(), effnVAC, fitparms, 0);
 236             eta = 1000*fitparms[1]*rho/
 237                 (4*fitparms[0]*PICO*norm2(kfac[kset_c[k]])/(NANO*NANO));
 238             fprintf(stdout,
 239                     "k %6.3f  tau %6.3f  Omega %6.3f  eta %8.5f 10^-3 kg/(m s)\n",
 240                     norm(kfac[kset_c[k]]), fitparms[0], fitparms[1], eta);
 241             fprintf(fp_vk, "%6.3f %g\n", norm(kfac[kset_c[k]]), eta);
 242             for (i = 0; i < ncorr; i++)
 243             {
 244                 fprintf(fp_cub, "%g %g\n", i*dt, fit_function(effnVAC, fitparms, i*dt));
 245             }
 246             fprintf(fp_cub, "&\n");
 247         }
 248         fprintf(fp_vk, "&\n");
 249         ffclose(fp_cub);
 250         do_view(oenv, fn_cub, "-nxy");
 251     }
 252     ffclose(fp_vk);
 253     do_view(oenv, fn_vk, "-nxy");
 254 }
 255
 256
 257 int gmx_tcaf(int argc, char *argv[])
 258 {
 259     const char     *desc[] = {
 260         "[TT]g_tcaf[tt] computes tranverse current autocorrelations.",
 261         "These are used to estimate the shear viscosity, [GRK]eta[grk].",
 262         "For details see: Palmer, Phys. Rev. E 49 (1994) pp 359-366.[PAR]",
 263         "Transverse currents are calculated using the",
 264         "k-vectors (1,0,0) and (2,0,0) each also in the [IT]y[it]- and [IT]z[it]-direction,",
 265         "(1,1,0) and (1,-1,0) each also in the 2 other planes (these vectors",
 266         "are not independent) and (1,1,1) and the 3 other box diagonals (also",
 267         "not independent). For each k-vector the sine and cosine are used, in",
 268         "combination with the velocity in 2 perpendicular directions. This gives",
 269         "a total of 16*2*2=64 transverse currents. One autocorrelation is",
 270         "calculated fitted for each k-vector, which gives 16 TCAFs. Each of",
 271         "these TCAFs is fitted to [MATH]f(t) = [EXP]-v[exp]([COSH]Wv[cosh] + 1/W [SINH]Wv[sinh])[math],",
 272         "[MATH]v = -t/(2 [GRK]tau[grk])[math], [MATH]W = [SQRT]1 - 4 [GRK]tau[grk] [GRK]eta[grk]/[GRK]rho[grk] k^2[sqrt][math], which gives 16 values of [GRK]tau[grk]",
 273         "and [GRK]eta[grk]. The fit weights decay exponentially with time constant [MATH]w[math] (given with [TT]-wt[tt]) as [MATH][EXP]-t/w[exp][math], and the TCAF and",
 274         "fit are calculated up to time [MATH]5*w[math].",
 275         "The [GRK]eta[grk] values should be fitted to [MATH]1 - a [GRK]eta[grk](k) k^2[math], from which",
 276         "one can estimate the shear viscosity at k=0.[PAR]",
 277         "When the box is cubic, one can use the option [TT]-oc[tt], which",
 278         "averages the TCAFs over all k-vectors with the same length.",
 279         "This results in more accurate TCAFs.",
 280         "Both the cubic TCAFs and fits are written to [TT]-oc[tt]",
 281         "The cubic [GRK]eta[grk] estimates are also written to [TT]-ov[tt].[PAR]",
 282         "With option [TT]-mol[tt], the transverse current is determined of",
 283         "molecules instead of atoms. In this case, the index group should",
 284         "consist of molecule numbers instead of atom numbers.[PAR]",
 285         "The k-dependent viscosities in the [TT]-ov[tt] file should be",
 286         "fitted to [MATH][GRK]eta[grk](k) = [GRK]eta[grk][SUB]0[sub] (1 - a k^2)[math] to obtain the viscosity at",
 287         "infinite wavelength.[PAR]",
 288         "[BB]Note:[bb] make sure you write coordinates and velocities often enough.",
 289         "The initial, non-exponential, part of the autocorrelation function",
 290         "is very important for obtaining a good fit."
 291     };
 292
 293     static gmx_bool bMol = FALSE, bK34 = FALSE;
 294     static real     wt   = 5;
 295     t_pargs         pa[] = {
 296         { "-mol", FALSE, etBOOL, {&bMol},
 297           "Calculate TCAF of molecules" },
 298         { "-k34", FALSE, etBOOL, {&bK34},
 299           "Also use k=(3,0,0) and k=(4,0,0)" },
 300         { "-wt", FALSE, etREAL, {&wt},
 301           "Exponential decay time for the TCAF fit weights" }
 302     };
 303
 304     t_topology      top;
 305     int             ePBC;
 306     t_trxframe      fr;
 307     matrix          box;
 308     gmx_bool        bTPS, bTop; /* ,bCubic; */
 309     int             gnx;
 310     atom_id        *index, *atndx = NULL, at;
 311     char           *grpname;
 312     char            title[256];
 313     real            t0, t1, dt, m, mtot, sysmass, rho, sx, cx;
 314     t_trxstatus    *status;
 315     int             nframes, n_alloc, i, j, k, d;
 316     rvec            mv_mol, cm_mol, kfac[NK];
 317     int             nkc, nk, ntc;
 318     real          **c1, **tc;
 319     output_env_t    oenv;
 320
 321 #define NHISTO 360
 322
 323     t_filenm  fnm[] = {
 324         { efTRN, "-f",    NULL,      ffREAD  },
 325         { efTPS, NULL,    NULL,      ffOPTRD },
 326         { efNDX, NULL,    NULL,      ffOPTRD },
 327         { efXVG, "-ot",  "transcur", ffOPTWR },
 328         { efXVG, "-oa",  "tcaf_all", ffWRITE },
 329         { efXVG, "-o",   "tcaf",     ffWRITE },
 330         { efXVG, "-of",  "tcaf_fit", ffWRITE },
 331         { efXVG, "-oc",  "tcaf_cub", ffOPTWR },
 332         { efXVG, "-ov",  "visc_k",   ffWRITE }
 333     };
 334 #define NFILE asize(fnm)
 335     int       npargs;
 336     t_pargs  *ppa;
 337
 338     CopyRight(stderr, argv[0]);
 339     npargs = asize(pa);
 340     ppa    = add_acf_pargs(&npargs, pa);
 341
 342     parse_common_args(&argc, argv, PCA_CAN_VIEW | PCA_CAN_TIME | PCA_BE_NICE,
 343                       NFILE, fnm, npargs, ppa, asize(desc), desc, 0, NULL, &oenv);
 344
 345     bTop = read_tps_conf(ftp2fn(efTPS, NFILE, fnm), title, &top, &ePBC, NULL, NULL, box,
 346                          TRUE);
 347     get_index(&top.atoms, ftp2fn_null(efNDX, NFILE, fnm), 1, &gnx, &index, &grpname);
 348
 349     if (bMol)
 350     {
 351         if (!bTop)
 352         {
 353             gmx_fatal(FARGS, "Need a topology to determine the molecules");
 354         }
 355         atndx = top.mols.index;
 356     }
 357
 358     if (bK34)
 359     {
 360         nkc = NKC;
 361     }
 362     else
 363     {
 364         nkc = NKC0;
 365     }
 366     nk  = kset_c[nkc];
 367     ntc = nk*NPK;
 368
 369     sprintf(title, "Velocity Autocorrelation Function for %s", grpname);
 370
 371     sysmass = 0;
 372     for (i = 0; i < nk; i++)
 373     {
 374         if (iprod(v0[i], v1[i]) != 0)
 375         {
 376             gmx_fatal(FARGS, "DEATH HORROR: vectors not orthogonal");
 377         }
 378         if (iprod(v0[i], v2[i]) != 0)
 379         {
 380             gmx_fatal(FARGS, "DEATH HORROR: vectors not orthogonal");
 381         }
 382         if (iprod(v1[i], v2[i]) != 0)
 383         {
 384             gmx_fatal(FARGS, "DEATH HORROR: vectors not orthogonal");
 385         }
 386         unitv(v1[i], v1[i]);
 387         unitv(v2[i], v2[i]);
 388     }
 389     snew(tc, ntc);
 390     for (i = 0; i < top.atoms.nr; i++)
 391     {
 392         sysmass += top.atoms.atom[i].m;
 393     }
 394
 395     read_first_frame(oenv, &status, ftp2fn(efTRN, NFILE, fnm), &fr,
 396                      TRX_NEED_X | TRX_NEED_V);
 397     t0 = fr.time;
 398
 399     n_alloc = 0;
 400     nframes = 0;
 401     rho     = 0;
 402     /* bCubic = TRUE; */
 403     do
 404     {
 405         /*
 406            bCubic = bCubic && !TRICLINIC(fr.box) &&
 407            fabs(fr.box[XX][XX]-fr.box[YY][YY]) < 0.001*fr.box[XX][XX] &&
 408            fabs(fr.box[XX][XX]-fr.box[ZZ][ZZ]) < 0.001*fr.box[XX][XX];
 409          */
 410
 411         if (nframes >= n_alloc)
 412         {
 413             n_alloc += 100;
 414             for (i = 0; i < ntc; i++)
 415             {
 416                 srenew(tc[i], n_alloc);
 417             }
 418         }
 419
 420         rho += 1/det(fr.box);
 421         for (k = 0; k < nk; k++)
 422         {
 423             for (d = 0; d < DIM; d++)
 424             {
 425                 kfac[k][d] = 2*M_PI*v0[k][d]/fr.box[d][d];
 426             }
 427         }
 428         for (i = 0; i < ntc; i++)
 429         {
 430             tc[i][nframes] = 0;
 431         }
 432
 433         for (i = 0; i < gnx; i++)
 434         {
 435             if (bMol)
 436             {
 437                 clear_rvec(mv_mol);
 438                 clear_rvec(cm_mol);
 439                 mtot = 0;
 440                 for (j = 0; j < atndx[index[i]+1] - atndx[index[i]]; j++)
 441                 {
 442                     at          = atndx[index[i]] + j;
 443                     m           = top.atoms.atom[at].m;
 444                     mv_mol[XX] += m*fr.v[at][XX];
 445                     mv_mol[YY] += m*fr.v[at][YY];
 446                     mv_mol[ZZ] += m*fr.v[at][ZZ];
 447                     cm_mol[XX] += m*fr.x[at][XX];
 448                     cm_mol[YY] += m*fr.x[at][YY];
 449                     cm_mol[ZZ] += m*fr.x[at][ZZ];
 450                     mtot       += m;
 451                 }
 452                 svmul(1.0/mtot, cm_mol, cm_mol);
 453             }
 454             else
 455             {
 456                 svmul(top.atoms.atom[index[i]].m, fr.v[index[i]], mv_mol);
 457             }
 458
 459             if (!bMol)
 460             {
 461                 copy_rvec(fr.x[index[i]], cm_mol);
 462             }
 463             j = 0;
 464             for (k = 0; k < nk; k++)
 465             {
 466                 sx              = sin(iprod(kfac[k], cm_mol));
 467                 cx              = cos(iprod(kfac[k], cm_mol));
 468                 tc[j][nframes] += sx*iprod(v1[k], mv_mol);
 469                 j++;
 470                 tc[j][nframes] += cx*iprod(v1[k], mv_mol);
 471                 j++;
 472                 tc[j][nframes] += sx*iprod(v2[k], mv_mol);
 473                 j++;
 474                 tc[j][nframes] += cx*iprod(v2[k], mv_mol);
 475                 j++;
 476             }
 477         }
 478
 479         t1 = fr.time;
 480         nframes++;
 481     }
 482     while (read_next_frame(oenv, status, &fr));
 483     close_trj(status);
 484
 485     dt = (t1-t0)/(nframes-1);
 486
 487     rho *= sysmass/nframes*AMU/(NANO*NANO*NANO);
 488     fprintf(stdout, "Density = %g (kg/m^3)\n", rho);
 489     process_tcaf(nframes, dt, nkc, tc, kfac, rho, wt,
 490                  opt2fn_null("-ot", NFILE, fnm),
 491                  opt2fn("-oa", NFILE, fnm), opt2fn("-o", NFILE, fnm),
 492                  opt2fn("-of", NFILE, fnm), opt2fn_null("-oc", NFILE, fnm),
 493                  opt2fn("-ov", NFILE, fnm), oenv);
 494
 495     thanx(stderr);
 496
 497     return 0;
 498 }