src/gromacs/gmxana/gmx_velacc.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  *                        VERSION 3.2.0
  10  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  11  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  12  * Copyright (c) 2001-2004, The GROMACS development team,
  13  * check out http://www.gromacs.org for more information.
  14
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * If you want to redistribute modifications, please consider that
  21  * scientific software is very special. Version control is crucial -
  22  * bugs must be traceable. We will be happy to consider code for
  23  * inclusion in the official distribution, but derived work must not
  24  * be called official GROMACS. Details are found in the README & COPYING
  25  * files - if they are missing, get the official version at www.gromacs.org.
  26  *
  27  * To help us fund GROMACS development, we humbly ask that you cite
  28  * the papers on the package - you can find them in the top README file.
  29  *
  30  * For more info, check our website at http://www.gromacs.org
  31  *
  32  * And Hey:
  33  * Green Red Orange Magenta Azure Cyan Skyblue
  34  */
  35 #ifdef HAVE_CONFIG_H
  36 #include <config.h>
  37 #endif
  38 #include <stdio.h>
  39 #include <math.h>
  40
  41 #include "confio.h"
  42 #include "copyrite.h"
  43 #include "gmx_fatal.h"
  44 #include "futil.h"
  45 #include "gstat.h"
  46 #include "macros.h"
  47 #include "maths.h"
  48 #include "physics.h"
  49 #include "index.h"
  50 #include "smalloc.h"
  51 #include "statutil.h"
  52 #include <string.h>
  53 #include "sysstuff.h"
  54 #include "txtdump.h"
  55 #include "typedefs.h"
  56 #include "vec.h"
  57 #include "strdb.h"
  58 #include "xvgr.h"
  59 #include "gmx_ana.h"
  60 #include "gromacs/fft/fft.h"
  61
  62 static void index_atom2mol(int *n, atom_id *index, t_block *mols)
  63 {
  64     int nat, i, nmol, mol, j;
  65
  66     nat  = *n;
  67     i    = 0;
  68     nmol = 0;
  69     mol  = 0;
  70     while (i < nat)
  71     {
  72         while (index[i] > mols->index[mol])
  73         {
  74             mol++;
  75             if (mol >= mols->nr)
  76             {
  77                 gmx_fatal(FARGS, "Atom index out of range: %d", index[i]+1);
  78             }
  79         }
  80         for (j = mols->index[mol]; j < mols->index[mol+1]; j++)
  81         {
  82             if (i >= nat || index[i] != j)
  83             {
  84                 gmx_fatal(FARGS, "The index group does not consist of whole molecules");
  85             }
  86             i++;
  87         }
  88         index[nmol++] = mol;
  89     }
  90
  91     fprintf(stderr, "\nSplit group of %d atoms into %d molecules\n", nat, nmol);
  92
  93     *n = nmol;
  94 }
  95
  96 static void precalc(t_topology top, real normm[])
  97 {
  98
  99     real mtot;
 100     int  i, j, k, l;
 101
 102     for (i = 0; i < top.mols.nr; i++)
 103     {
 104         k    = top.mols.index[i];
 105         l    = top.mols.index[i+1];
 106         mtot = 0.0;
 107
 108         for (j = k; j < l; j++)
 109         {
 110             mtot += top.atoms.atom[j].m;
 111         }
 112
 113         for (j = k; j < l; j++)
 114         {
 115             normm[j] = top.atoms.atom[j].m/mtot;
 116         }
 117
 118     }
 119
 120 }
 121
 122 static void calc_spectrum(int n, real c[], real dt, const char *fn,
 123                           output_env_t oenv, gmx_bool bRecip)
 124 {
 125     FILE     *fp;
 126     gmx_fft_t fft;
 127     int       i, status;
 128     real     *data;
 129     real      nu, omega, recip_fac;
 130
 131     snew(data, n*2);
 132     for (i = 0; (i < n); i++)
 133     {
 134         data[i] = c[i];
 135     }
 136
 137     if ((status = gmx_fft_init_1d_real(&fft, n, GMX_FFT_FLAG_NONE)) != 0)
 138     {
 139         gmx_fatal(FARGS, "Invalid fft return status %d", status);
 140     }
 141     if ((status = gmx_fft_1d_real(fft, GMX_FFT_REAL_TO_COMPLEX, data, data)) != 0)
 142     {
 143         gmx_fatal(FARGS, "Invalid fft return status %d", status);
 144     }
 145     fp = xvgropen(fn, "Vibrational Power Spectrum",
 146                   bRecip ? "\\f{12}w\\f{4} (cm\\S-1\\N)" :
 147                   "\\f{12}n\\f{4} (ps\\S-1\\N)",
 148                   "a.u.", oenv);
 149     /* This is difficult.
 150      * The length of the ACF is dt (as passed to this routine).
 151      * We pass the vacf with N time steps from 0 to dt.
 152      * That means that after FFT we have lowest frequency = 1/dt
 153      * then 1/(2 dt) etc. (this is the X-axis of the data after FFT).
 154      * To convert to 1/cm we need to have to realize that
 155      * E = hbar w = h nu = h c/lambda. We want to have reciprokal cm
 156      * on the x-axis, that is 1/lambda, so we then have
 157      * 1/lambda = nu/c. Since nu has units of 1/ps and c has gromacs units
 158      * of nm/ps, we need to multiply by 1e7.
 159      * The timestep between saving the trajectory is
 160      * 1e7 is to convert nanometer to cm
 161      */
 162     recip_fac = bRecip ? (1e7/SPEED_OF_LIGHT) : 1.0;
 163     for (i = 0; (i < n); i += 2)
 164     {
 165         nu    = i/(2*dt);
 166         omega = nu*recip_fac;
 167         /* Computing the square magnitude of a complex number, since this is a power
 168          * spectrum.
 169          */
 170         fprintf(fp, "%10g  %10g\n", omega, sqr(data[i])+sqr(data[i+1]));
 171     }
 172     xvgrclose(fp);
 173     gmx_fft_destroy(fft);
 174     sfree(data);
 175 }
 176
 177 int gmx_velacc(int argc, char *argv[])
 178 {
 179     const char     *desc[] = {
 180         "[TT]g_velacc[tt] computes the velocity autocorrelation function.",
 181         "When the [TT]-m[tt] option is used, the momentum autocorrelation",
 182         "function is calculated.[PAR]",
 183         "With option [TT]-mol[tt] the velocity autocorrelation function of",
 184         "molecules is calculated. In this case the index group should consist",
 185         "of molecule numbers instead of atom numbers.[PAR]",
 186         "Be sure that your trajectory contains frames with velocity information",
 187         "(i.e. [TT]nstvout[tt] was set in your original [TT].mdp[tt] file),",
 188         "and that the time interval between data collection points is",
 189         "much shorter than the time scale of the autocorrelation."
 190     };
 191
 192     static gmx_bool bMass = FALSE, bMol = FALSE, bRecip = TRUE;
 193     t_pargs         pa[]  = {
 194         { "-m", FALSE, etBOOL, {&bMass},
 195           "Calculate the momentum autocorrelation function" },
 196         { "-recip", FALSE, etBOOL, {&bRecip},
 197           "Use cm^-1 on X-axis instead of 1/ps for spectra." },
 198         { "-mol", FALSE, etBOOL, {&bMol},
 199           "Calculate the velocity acf of molecules" }
 200     };
 201
 202     t_topology      top;
 203     int             ePBC = -1;
 204     t_trxframe      fr;
 205     matrix          box;
 206     gmx_bool        bTPS = FALSE, bTop = FALSE;
 207     int             gnx;
 208     atom_id        *index;
 209     char           *grpname;
 210     char            title[256];
 211     /* t0, t1 are the beginning and end time respectively.
 212      * dt is the time step, mass is temp variable for atomic mass.
 213      */
 214     real              t0, t1, dt, mass;
 215     t_trxstatus      *status;
 216     int               counter, n_alloc, i, j, counter_dim, k, l;
 217     rvec              mv_mol;
 218     /* Array for the correlation function */
 219     real            **c1;
 220     real             *normm = NULL;
 221     output_env_t      oenv;
 222
 223 #define NHISTO 360
 224
 225     t_filenm  fnm[] = {
 226         { efTRN, "-f",    NULL,   ffREAD  },
 227         { efTPS, NULL,    NULL,   ffOPTRD },
 228         { efNDX, NULL,    NULL,   ffOPTRD },
 229         { efXVG, "-o",    "vac",  ffWRITE },
 230         { efXVG, "-os",   "spectrum", ffOPTWR }
 231     };
 232 #define NFILE asize(fnm)
 233     int       npargs;
 234     t_pargs  *ppa;
 235
 236     npargs = asize(pa);
 237     ppa    = add_acf_pargs(&npargs, pa);
 238     parse_common_args(&argc, argv, PCA_CAN_VIEW | PCA_CAN_TIME | PCA_BE_NICE,
 239                       NFILE, fnm, npargs, ppa, asize(desc), desc, 0, NULL, &oenv);
 240
 241     if (bMol || bMass)
 242     {
 243         bTPS = ftp2bSet(efTPS, NFILE, fnm) || !ftp2bSet(efNDX, NFILE, fnm);
 244     }
 245
 246     if (bTPS)
 247     {
 248         bTop = read_tps_conf(ftp2fn(efTPS, NFILE, fnm), title, &top, &ePBC, NULL, NULL, box,
 249                              TRUE);
 250         get_index(&top.atoms, ftp2fn_null(efNDX, NFILE, fnm), 1, &gnx, &index, &grpname);
 251     }
 252     else
 253     {
 254         rd_index(ftp2fn(efNDX, NFILE, fnm), 1, &gnx, &index, &grpname);
 255     }
 256
 257     if (bMol)
 258     {
 259         if (!bTop)
 260         {
 261             gmx_fatal(FARGS, "Need a topology to determine the molecules");
 262         }
 263         snew(normm, top.atoms.nr);
 264         precalc(top, normm);
 265         index_atom2mol(&gnx, index, &top.mols);
 266     }
 267
 268     /* Correlation stuff */
 269     snew(c1, gnx);
 270     for (i = 0; (i < gnx); i++)
 271     {
 272         c1[i] = NULL;
 273     }
 274
 275     read_first_frame(oenv, &status, ftp2fn(efTRN, NFILE, fnm), &fr, TRX_NEED_V);
 276     t0 = fr.time;
 277
 278     n_alloc = 0;
 279     counter = 0;
 280     do
 281     {
 282         if (counter >= n_alloc)
 283         {
 284             n_alloc += 100;
 285             for (i = 0; i < gnx; i++)
 286             {
 287                 srenew(c1[i], DIM*n_alloc);
 288             }
 289         }
 290         counter_dim = DIM*counter;
 291         if (bMol)
 292         {
 293             for (i = 0; i < gnx; i++)
 294             {
 295                 clear_rvec(mv_mol);
 296                 k = top.mols.index[index[i]];
 297                 l = top.mols.index[index[i]+1];
 298                 for (j = k; j < l; j++)
 299                 {
 300                     if (bMass)
 301                     {
 302                         mass = top.atoms.atom[j].m;
 303                     }
 304                     else
 305                     {
 306                         mass = normm[j];
 307                     }
 308                     mv_mol[XX] += mass*fr.v[j][XX];
 309                     mv_mol[YY] += mass*fr.v[j][YY];
 310                     mv_mol[ZZ] += mass*fr.v[j][ZZ];
 311                 }
 312                 c1[i][counter_dim+XX] = mv_mol[XX];
 313                 c1[i][counter_dim+YY] = mv_mol[YY];
 314                 c1[i][counter_dim+ZZ] = mv_mol[ZZ];
 315             }
 316         }
 317         else
 318         {
 319             for (i = 0; i < gnx; i++)
 320             {
 321                 if (bMass)
 322                 {
 323                     mass = top.atoms.atom[index[i]].m;
 324                 }
 325                 else
 326                 {
 327                     mass = 1;
 328                 }
 329                 c1[i][counter_dim+XX] = mass*fr.v[index[i]][XX];
 330                 c1[i][counter_dim+YY] = mass*fr.v[index[i]][YY];
 331                 c1[i][counter_dim+ZZ] = mass*fr.v[index[i]][ZZ];
 332             }
 333         }
 334
 335         t1 = fr.time;
 336
 337         counter++;
 338     }
 339     while (read_next_frame(oenv, status, &fr));
 340
 341     close_trj(status);
 342
 343     if (counter >= 4)
 344     {
 345         /* Compute time step between frames */
 346         dt = (t1-t0)/(counter-1);
 347         do_autocorr(opt2fn("-o", NFILE, fnm), oenv,
 348                     bMass ?
 349                     "Momentum Autocorrelation Function" :
 350                     "Velocity Autocorrelation Function",
 351                     counter, gnx, c1, dt, eacVector, TRUE);
 352
 353         do_view(oenv, opt2fn("-o", NFILE, fnm), "-nxy");
 354
 355         if (opt2bSet("-os", NFILE, fnm))
 356         {
 357             calc_spectrum(counter/2, (real *) (c1[0]), (t1-t0)/2, opt2fn("-os", NFILE, fnm),
 358                           oenv, bRecip);
 359             do_view(oenv, opt2fn("-os", NFILE, fnm), "-nxy");
 360         }
 361     }
 362     else
 363     {
 364         fprintf(stderr, "Not enough frames in trajectory - no output generated.\n");
 365     }
 366
 367     thanx(stderr);
 368
 369     return 0;
 370 }