Merge branch 'release-4-6'
[alexxy/gromacs.git] / src / gromacs / gmxana / gmx_nmens.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
39 #include <math.h>
40 #include <string.h>
41
42 #include "statutil.h"
43 #include "sysstuff.h"
44 #include "typedefs.h"
45 #include "smalloc.h"
46 #include "macros.h"
47 #include "gmx_fatal.h"
48 #include "vec.h"
49 #include "gromacs/fileio/futil.h"
50 #include "statutil.h"
51 #include "index.h"
52 #include "gromacs/fileio/pdbio.h"
53 #include "gromacs/fileio/tpxio.h"
54 #include "gromacs/fileio/trxio.h"
55 #include "txtdump.h"
56 #include "physics.h"
57 #include "random.h"
58 #include "eigio.h"
59 #include "gmx_ana.h"
60
61
62 int gmx_nmens(int argc, char *argv[])
63 {
64     const char *desc[] = {
65         "[THISMODULE] generates an ensemble around an average structure",
66         "in a subspace that is defined by a set of normal modes (eigenvectors).",
67         "The eigenvectors are assumed to be mass-weighted.",
68         "The position along each eigenvector is randomly taken from a Gaussian",
69         "distribution with variance kT/eigenvalue.[PAR]",
70         "By default the starting eigenvector is set to 7, since the first six",
71         "normal modes are the translational and rotational degrees of freedom."
72     };
73     static int  nstruct = 100, first = 7, last = -1, seed = -1;
74     static real temp    = 300.0;
75     t_pargs     pa[]    = {
76         { "-temp",  FALSE, etREAL, {&temp},
77           "Temperature in Kelvin" },
78         { "-seed", FALSE, etINT, {&seed},
79           "Random seed, -1 generates a seed from time and pid" },
80         { "-num", FALSE, etINT, {&nstruct},
81           "Number of structures to generate" },
82         { "-first", FALSE, etINT, {&first},
83           "First eigenvector to use (-1 is select)" },
84         { "-last",  FALSE, etINT, {&last},
85           "Last eigenvector to use (-1 is till the last)" }
86     };
87 #define NPA asize(pa)
88
89     t_trxstatus        *out;
90     int                 status, trjout;
91     t_topology          top;
92     int                 ePBC;
93     t_atoms            *atoms;
94     rvec               *xtop, *xref, *xav, *xout1, *xout2;
95     gmx_bool            bDMR, bDMA, bFit;
96     int                 nvec, *eignr = NULL;
97     rvec              **eigvec = NULL;
98     matrix              box;
99     real               *eigval, totmass, *invsqrtm, t, disp;
100     int                 natoms, neigval;
101     char               *grpname, title[STRLEN];
102     const char         *indexfile;
103     int                 i, j, d, s, v;
104     int                 nout, *iout, noutvec, *outvec;
105     atom_id            *index;
106     real                rfac, invfr, rhalf, jr;
107     int          *      eigvalnr;
108     output_env_t        oenv;
109
110     unsigned long       jran;
111     const unsigned long im = 0xffff;
112     const unsigned long ia = 1093;
113     const unsigned long ic = 18257;
114
115
116     t_filenm fnm[] = {
117         { efTRN, "-v",    "eigenvec",    ffREAD  },
118         { efXVG, "-e",    "eigenval",    ffREAD  },
119         { efTPS, NULL,    NULL,          ffREAD },
120         { efNDX, NULL,    NULL,          ffOPTRD },
121         { efTRO, "-o",    "ensemble",    ffWRITE }
122     };
123 #define NFILE asize(fnm)
124
125     if (!parse_common_args(&argc, argv, PCA_BE_NICE,
126                            NFILE, fnm, NPA, pa, asize(desc), desc, 0, NULL, &oenv))
127     {
128         return 0;
129     }
130
131     indexfile = ftp2fn_null(efNDX, NFILE, fnm);
132
133     read_eigenvectors(opt2fn("-v", NFILE, fnm), &natoms, &bFit,
134                       &xref, &bDMR, &xav, &bDMA, &nvec, &eignr, &eigvec, &eigval);
135
136     read_tps_conf(ftp2fn(efTPS, NFILE, fnm), title, &top, &ePBC, &xtop, NULL, box, bDMA);
137     atoms = &top.atoms;
138
139     printf("\nSelect an index group of %d elements that corresponds to the eigenvectors\n", natoms);
140     get_index(atoms, indexfile, 1, &i, &index, &grpname);
141     if (i != natoms)
142     {
143         gmx_fatal(FARGS, "you selected a group with %d elements instead of %d",
144                   i, natoms);
145     }
146     printf("\n");
147
148     snew(invsqrtm, natoms);
149     if (bDMA)
150     {
151         for (i = 0; (i < natoms); i++)
152         {
153             invsqrtm[i] = gmx_invsqrt(atoms->atom[index[i]].m);
154         }
155     }
156     else
157     {
158         for (i = 0; (i < natoms); i++)
159         {
160             invsqrtm[i] = 1.0;
161         }
162     }
163
164     if (last == -1)
165     {
166         last = natoms*DIM;
167     }
168     if (first > -1)
169     {
170         /* make an index from first to last */
171         nout = last-first+1;
172         snew(iout, nout);
173         for (i = 0; i < nout; i++)
174         {
175             iout[i] = first-1+i;
176         }
177     }
178     else
179     {
180         printf("Select eigenvectors for output, end your selection with 0\n");
181         nout = -1;
182         iout = NULL;
183         do
184         {
185             nout++;
186             srenew(iout, nout+1);
187             if (1 != scanf("%d", &iout[nout]))
188             {
189                 gmx_fatal(FARGS, "Error reading user input");
190             }
191             iout[nout]--;
192         }
193         while (iout[nout] >= 0);
194         printf("\n");
195     }
196
197     /* make an index of the eigenvectors which are present */
198     snew(outvec, nout);
199     noutvec = 0;
200     for (i = 0; i < nout; i++)
201     {
202         j = 0;
203         while ((j < nvec) && (eignr[j] != iout[i]))
204         {
205             j++;
206         }
207         if ((j < nvec) && (eignr[j] == iout[i]))
208         {
209             outvec[noutvec] = j;
210             iout[noutvec]   = iout[i];
211             noutvec++;
212         }
213     }
214
215     fprintf(stderr, "%d eigenvectors selected for output\n", noutvec);
216
217     if (seed == -1)
218     {
219         seed = make_seed();
220     }
221     fprintf(stderr, "Using seed %d and a temperature of %g K\n", seed, temp);
222
223     snew(xout1, natoms);
224     snew(xout2, atoms->nr);
225     out  = open_trx(ftp2fn(efTRO, NFILE, fnm), "w");
226     jran = (unsigned long)((real)im*rando(&seed));
227     for (s = 0; s < nstruct; s++)
228     {
229         for (i = 0; i < natoms; i++)
230         {
231             copy_rvec(xav[i], xout1[i]);
232         }
233         for (j = 0; j < noutvec; j++)
234         {
235             v = outvec[j];
236             /* (r-0.5) n times:  var_n = n * var_1 = n/12
237                n=4:  var_n = 1/3, so multiply with 3 */
238
239             rfac  = sqrt(3.0 * BOLTZ*temp/eigval[iout[j]]);
240             rhalf = 2.0*rfac;
241             rfac  = rfac/(real)im;
242
243             jran = (jran*ia+ic) & im;
244             jr   = (real)jran;
245             jran = (jran*ia+ic) & im;
246             jr  += (real)jran;
247             jran = (jran*ia+ic) & im;
248             jr  += (real)jran;
249             jran = (jran*ia+ic) & im;
250             jr  += (real)jran;
251             disp = rfac * jr - rhalf;
252
253             for (i = 0; i < natoms; i++)
254             {
255                 for (d = 0; d < DIM; d++)
256                 {
257                     xout1[i][d] += disp*eigvec[v][i][d]*invsqrtm[i];
258                 }
259             }
260         }
261         for (i = 0; i < natoms; i++)
262         {
263             copy_rvec(xout1[i], xout2[index[i]]);
264         }
265         t = s+1;
266         write_trx(out, natoms, index, atoms, 0, t, box, xout2, NULL, NULL);
267         fprintf(stderr, "\rGenerated %d structures", s+1);
268     }
269     fprintf(stderr, "\n");
270     close_trx(out);
271
272     return 0;
273 }