src/gromacs/gmxana/gmx_rotacf.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 #include "gmxpre.h"
  38
  39 #include <math.h>
  40 #include <string.h>
  41
  42 #include "gromacs/commandline/pargs.h"
  43 #include "gromacs/fileio/trxio.h"
  44 #include "gromacs/gmxana/gmx_ana.h"
  45 #include "gromacs/gmxana/gstat.h"
  46 #include "gromacs/legacyheaders/macros.h"
  47 #include "gromacs/legacyheaders/typedefs.h"
  48 #include "gromacs/legacyheaders/viewit.h"
  49 #include "gromacs/math/vec.h"
  50 #include "gromacs/pbcutil/rmpbc.h"
  51 #include "gromacs/topology/index.h"
  52 #include "gromacs/utility/fatalerror.h"
  53 #include "gromacs/utility/futil.h"
  54 #include "gromacs/utility/smalloc.h"
  55
  56 int gmx_rotacf(int argc, char *argv[])
  57 {
  58     const char     *desc[] = {
  59         "[THISMODULE] calculates the rotational correlation function",
  60         "for molecules. Atom triplets (i,j,k) must be given in the index",
  61         "file, defining two vectors ij and jk. The rotational ACF",
  62         "is calculated as the autocorrelation function of the vector",
  63         "n = ij x jk, i.e. the cross product of the two vectors.",
  64         "Since three atoms span a plane, the order of the three atoms",
  65         "does not matter. Optionally, by invoking the [TT]-d[tt] switch, you can",
  66         "calculate the rotational correlation function for linear molecules",
  67         "by specifying atom pairs (i,j) in the index file.",
  68         "[PAR]",
  69         "EXAMPLES[PAR]",
  70         "[TT]gmx rotacf -P 1 -nparm 2 -fft -n index -o rotacf-x-P1",
  71         "-fa expfit-x-P1 -beginfit 2.5 -endfit 20.0[tt][PAR]",
  72         "This will calculate the rotational correlation function using a first",
  73         "order Legendre polynomial of the angle of a vector defined by the index",
  74         "file. The correlation function will be fitted from 2.5 ps until 20.0 ps",
  75         "to a two-parameter exponential."
  76     };
  77     static gmx_bool bVec    = FALSE, bAver = TRUE;
  78
  79     t_pargs         pa[] = {
  80         { "-d",   FALSE, etBOOL, {&bVec},
  81           "Use index doublets (vectors) for correlation function instead of triplets (planes)" },
  82         { "-aver", FALSE, etBOOL, {&bAver},
  83           "Average over molecules" }
  84     };
  85
  86     t_trxstatus    *status;
  87     int             isize;
  88     atom_id        *index;
  89     char           *grpname;
  90     rvec           *x, *x_s;
  91     matrix          box;
  92     real          **c1;
  93     rvec            xij, xjk, n;
  94     int             i, m, teller, n_alloc, natoms, nvec, ai, aj, ak;
  95     unsigned long   mode;
  96     real            t, t0, t1, dt;
  97     gmx_rmpbc_t     gpbc = NULL;
  98     t_topology     *top;
  99     int             ePBC;
 100     t_filenm        fnm[] = {
 101         { efTRX, "-f", NULL,  ffREAD  },
 102         { efTPR, NULL, NULL,  ffREAD },
 103         { efNDX, NULL, NULL,  ffREAD  },
 104         { efXVG, "-o", "rotacf",  ffWRITE }
 105     };
 106 #define NFILE asize(fnm)
 107     int             npargs;
 108     t_pargs        *ppa;
 109
 110     output_env_t    oenv;
 111
 112     npargs = asize(pa);
 113     ppa    = add_acf_pargs(&npargs, pa);
 114
 115     if (!parse_common_args(&argc, argv, PCA_CAN_VIEW | PCA_CAN_TIME,
 116                            NFILE, fnm, npargs, ppa, asize(desc), desc, 0, NULL, &oenv))
 117     {
 118         return 0;
 119     }
 120
 121     rd_index(ftp2fn(efNDX, NFILE, fnm), 1, &isize, &index, &grpname);
 122
 123     if (bVec)
 124     {
 125         nvec = isize/2;
 126     }
 127     else
 128     {
 129         nvec = isize/3;
 130     }
 131
 132     if (((isize % 3) != 0) && !bVec)
 133     {
 134         gmx_fatal(FARGS, "number of index elements not multiple of 3, "
 135                   "these can not be atom triplets\n");
 136     }
 137     if (((isize % 2) != 0) && bVec)
 138     {
 139         gmx_fatal(FARGS, "number of index elements not multiple of 2, "
 140                   "these can not be atom doublets\n");
 141     }
 142
 143     top = read_top(ftp2fn(efTPR, NFILE, fnm), &ePBC);
 144
 145     snew(c1, nvec);
 146     for (i = 0; (i < nvec); i++)
 147     {
 148         c1[i] = NULL;
 149     }
 150     n_alloc = 0;
 151
 152     natoms = read_first_x(oenv, &status, ftp2fn(efTRX, NFILE, fnm), &t, &x, box);
 153     snew(x_s, natoms);
 154
 155     gpbc = gmx_rmpbc_init(&(top->idef), ePBC, natoms);
 156
 157     /* Start the loop over frames */
 158     t1      = t0 = t;
 159     teller  = 0;
 160     do
 161     {
 162         if (teller >= n_alloc)
 163         {
 164             n_alloc += 100;
 165             for (i = 0; (i < nvec); i++)
 166             {
 167                 srenew(c1[i], DIM*n_alloc);
 168             }
 169         }
 170         t1 = t;
 171
 172         /* Remove periodicity */
 173         gmx_rmpbc_copy(gpbc, natoms, box, x, x_s);
 174
 175         /* Compute crossproducts for all vectors, if triplets.
 176          * else, just get the vectors in case of doublets.
 177          */
 178         if (bVec == FALSE)
 179         {
 180             for (i = 0; (i < nvec); i++)
 181             {
 182                 ai = index[3*i];
 183                 aj = index[3*i+1];
 184                 ak = index[3*i+2];
 185                 rvec_sub(x_s[ai], x_s[aj], xij);
 186                 rvec_sub(x_s[aj], x_s[ak], xjk);
 187                 cprod(xij, xjk, n);
 188                 for (m = 0; (m < DIM); m++)
 189                 {
 190                     c1[i][DIM*teller+m] = n[m];
 191                 }
 192             }
 193         }
 194         else
 195         {
 196             for (i = 0; (i < nvec); i++)
 197             {
 198                 ai = index[2*i];
 199                 aj = index[2*i+1];
 200                 rvec_sub(x_s[ai], x_s[aj], n);
 201                 for (m = 0; (m < DIM); m++)
 202                 {
 203                     c1[i][DIM*teller+m] = n[m];
 204                 }
 205             }
 206         }
 207         /* Increment loop counter */
 208         teller++;
 209     }
 210     while (read_next_x(oenv, status, &t, x, box));
 211     close_trj(status);
 212     fprintf(stderr, "\nDone with trajectory\n");
 213
 214     gmx_rmpbc_done(gpbc);
 215
 216
 217     /* Autocorrelation function */
 218     if (teller < 2)
 219     {
 220         fprintf(stderr, "Not enough frames for correlation function\n");
 221     }
 222     else
 223     {
 224         dt = (t1 - t0)/(teller-1);
 225
 226         mode = eacVector;
 227
 228         do_autocorr(ftp2fn(efXVG, NFILE, fnm), oenv, "Rotational Correlation Function",
 229                     teller, nvec, c1, dt, mode, bAver);
 230     }
 231
 232     do_view(oenv, ftp2fn(efXVG, NFILE, fnm), NULL);
 233
 234     return 0;
 235 }