minor fixes in ditribution files
[gromacs/qmmm-gamess-us.git] / man / man1 / g_vanhove.1
blob29deb25d6840030f8bc981f58f8fe69d329e0fe9
1 .TH g_vanhove 1 "Thu 16 Oct 2008"
2 .SH NAME
3 g_vanhove - calculates Van Hove displacement functions
5 .B VERSION 4.0
6 .SH SYNOPSIS
7 \f3g_vanhove\fP
8 .BI "-f" " traj.xtc "
9 .BI "-s" " topol.tpr "
10 .BI "-n" " index.ndx "
11 .BI "-om" " vanhove.xpm "
12 .BI "-or" " vanhove_r.xvg "
13 .BI "-ot" " vanhove_t.xvg "
14 .BI "-[no]h" ""
15 .BI "-nice" " int "
16 .BI "-b" " time "
17 .BI "-e" " time "
18 .BI "-dt" " time "
19 .BI "-[no]w" ""
20 .BI "-[no]xvgr" ""
21 .BI "-sqrt" " real "
22 .BI "-fm" " int "
23 .BI "-rmax" " real "
24 .BI "-rbin" " real "
25 .BI "-mmax" " real "
26 .BI "-nlevels" " int "
27 .BI "-nr" " int "
28 .BI "-fr" " int "
29 .BI "-rt" " real "
30 .BI "-ft" " int "
31 .SH DESCRIPTION
32 g_vanhove computes the Van Hove correlation function.
33 The Van Hove G(r,t) is the probability that a particle that is at r0
34 at time zero can be found at position r0+r at time t.
35 g_vanhove determines G not for a vector r, but for the length of r.
36 Thus it gives the probability that a particle moves a distance of r
37 in time t.
38 Jumps across the periodic boundaries are removed.
39 Corrections are made for scaling due to isotropic
40 or anisotropic pressure coupling.
44 With option 
45 .B -om
46 the whole matrix can be written as a function
47 of t and r or as a function of sqrt(t) and r (option 
48 .B -sqrt
53 With option 
54 .B -or
55 the Van Hove function is plotted for one
56 or more values of t. Option 
57 .B -nr
58 sets the number of times,
59 option 
60 .B -fr
61 the number spacing between the times.
62 The binwidth is set with option 
63 .B -rbin
64 . The number of bins
65 is determined automatically.
69 With option 
70 .B -ot
71 the integral up to a certain distance
72 (option 
73 .B -rt
74 ) is plotted as a function of time.
78 For all frames that are read the coordinates of the selected particles
79 are stored in memory. Therefore the program may use a lot of memory.
80 For options 
81 .B -om
82 and 
83 .B -ot
84 the program may be slow.
85 This is because the calculation scales as the number of frames times
87 .B -fm
88 or 
89 .B -ft
91 Note that with the 
92 .B -dt
93 option the memory usage and calculation
94 time can be reduced.
95 .SH FILES
96 .BI "-f" " traj.xtc" 
97 .B Input
98  Trajectory: xtc trr trj gro g96 pdb cpt 
100 .BI "-s" " topol.tpr" 
101 .B Input
102  Structure+mass(db): tpr tpb tpa gro g96 pdb 
104 .BI "-n" " index.ndx" 
105 .B Input, Opt.
106  Index file 
108 .BI "-om" " vanhove.xpm" 
109 .B Output, Opt.
110  X PixMap compatible matrix file 
112 .BI "-or" " vanhove_r.xvg" 
113 .B Output, Opt.
114  xvgr/xmgr file 
116 .BI "-ot" " vanhove_t.xvg" 
117 .B Output, Opt.
118  xvgr/xmgr file 
120 .SH OTHER OPTIONS
121 .BI "-[no]h"  "no    "
122  Print help info and quit
124 .BI "-nice"  " int" " 19" 
125  Set the nicelevel
127 .BI "-b"  " time" " 0     " 
128  First frame (ps) to read from trajectory
130 .BI "-e"  " time" " 0     " 
131  Last frame (ps) to read from trajectory
133 .BI "-dt"  " time" " 0     " 
134  Only use frame when t MOD dt = first time (ps)
136 .BI "-[no]w"  "no    "
137  View output xvg, xpm, eps and pdb files
139 .BI "-[no]xvgr"  "yes   "
140  Add specific codes (legends etc.) in the output xvg files for the xmgrace program
142 .BI "-sqrt"  " real" " 0     " 
143  Use sqrt(t) on the matrix axis which binspacing  in sqrt(ps)
145 .BI "-fm"  " int" " 0" 
146  Number of frames in the matrix, 0 is plot all
148 .BI "-rmax"  " real" " 2     " 
149  Maximum r in the matrix (nm)
151 .BI "-rbin"  " real" " 0.01  " 
152  Binwidth in the matrix and for -or (nm)
154 .BI "-mmax"  " real" " 0     " 
155  Maximum density in the matrix, 0 is calculate (1/nm)
157 .BI "-nlevels"  " int" " 81" 
158  Number of levels in the matrix
160 .BI "-nr"  " int" " 1" 
161  Number of curves for the -or output
163 .BI "-fr"  " int" " 0" 
164  Frame spacing for the -or output
166 .BI "-rt"  " real" " 0     " 
167  Integration limit for the -ot output (nm)
169 .BI "-ft"  " int" " 0" 
170  Number of frames in the -ot output, 0 is plot all