Almost working now! not vv for average kinetic energy, but about to try something.
[gromacs.git] / man / man1 / g_rdf.1
blob125280a899d3e2a2aadd0ecd4d410ad500625534
1 .TH g_rdf 1 "Thu 16 Oct 2008"
2 .SH NAME
3 g_rdf - calculates radial distribution functions
5 .B VERSION 4.0
6 .SH SYNOPSIS
7 \f3g_rdf\fP
8 .BI "-f" " traj.xtc "
9 .BI "-s" " topol.tpr "
10 .BI "-n" " index.ndx "
11 .BI "-o" " rdf.xvg "
12 .BI "-sq" " sq.xvg "
13 .BI "-cn" " rdf_cn.xvg "
14 .BI "-hq" " hq.xvg "
15 .BI "-[no]h" ""
16 .BI "-nice" " int "
17 .BI "-b" " time "
18 .BI "-e" " time "
19 .BI "-dt" " time "
20 .BI "-[no]w" ""
21 .BI "-[no]xvgr" ""
22 .BI "-bin" " real "
23 .BI "-[no]com" ""
24 .BI "-rdf" " enum "
25 .BI "-[no]pbc" ""
26 .BI "-[no]norm" ""
27 .BI "-[no]xy" ""
28 .BI "-cut" " real "
29 .BI "-ng" " int "
30 .BI "-fade" " real "
31 .BI "-nlevel" " int "
32 .BI "-startq" " real "
33 .BI "-endq" " real "
34 .BI "-energy" " real "
35 .SH DESCRIPTION
36 The structure of liquids can be studied by either neutron or X-ray
37 scattering. The most common way to describe liquid structure is by a
38 radial distribution function. However, this is not easy to obtain from
39 a scattering experiment.
42 g_rdf calculates radial distribution functions in different ways.
43 The normal method is around a (set of) particle(s), the other method
44 is around the center of mass of a set of particles.
45 With both methods rdf's can also be calculated around axes parallel
46 to the z-axis with option 
47 .B -xy
51 The option 
52 .B -rdf
53 sets the type of rdf to be computed.
54 Default is for atoms or particles, but one can also select center
55 of mass or geometry of molecules or residues. In all cases only
56 the atoms in the index groups are taken into account.
57 For molecules and/or the center of mass option a run input file
58 is required.
59 Other weighting than COM or COG can currently only be achieved
60 by providing a run input file with different masses.
61 Option 
62 .B -com
63 also works in conjunction with 
64 .B -rdf
67 If a run input file is supplied (
68 .B -s
69 ) and 
70 .B -rdf
71 is set
72 to 
73 .B atom
74 , exclusions defined
75 in that file are taken into account when calculating the rdf.
76 The option 
77 .B -cut
78 is meant as an alternative way to avoid
79 intramolecular peaks in the rdf plot.
80 It is however better to supply a run input file with a higher number of
81 exclusions. For eg. benzene a topology with nrexcl set to 5
82 would eliminate all intramolecular contributions to the rdf.
83 Note that all atoms in the selected groups are used, also the ones
84 that don't have Lennard-Jones interactions.
87 Option 
88 .B -cn
89 produces the cumulative number rdf,
90 i.e. the average number of particles within a distance r.
93 To bridge the gap between theory and experiment structure factors can
94 be computed (option 
95 .B -sq
96 ). The algorithm uses FFT, the gridspacing of which is determined by option 
97 .B -grid
99 .SH FILES
100 .BI "-f" " traj.xtc" 
101 .B Input
102  Trajectory: xtc trr trj gro g96 pdb cpt 
104 .BI "-s" " topol.tpr" 
105 .B Input, Opt.
106  Structure+mass(db): tpr tpb tpa gro g96 pdb 
108 .BI "-n" " index.ndx" 
109 .B Input, Opt.
110  Index file 
112 .BI "-o" " rdf.xvg" 
113 .B Output, Opt.
114  xvgr/xmgr file 
116 .BI "-sq" " sq.xvg" 
117 .B Output, Opt.
118  xvgr/xmgr file 
120 .BI "-cn" " rdf_cn.xvg" 
121 .B Output, Opt.
122  xvgr/xmgr file 
124 .BI "-hq" " hq.xvg" 
125 .B Output, Opt.
126  xvgr/xmgr file 
128 .SH OTHER OPTIONS
129 .BI "-[no]h"  "no    "
130  Print help info and quit
132 .BI "-nice"  " int" " 19" 
133  Set the nicelevel
135 .BI "-b"  " time" " 0     " 
136  First frame (ps) to read from trajectory
138 .BI "-e"  " time" " 0     " 
139  Last frame (ps) to read from trajectory
141 .BI "-dt"  " time" " 0     " 
142  Only use frame when t MOD dt = first time (ps)
144 .BI "-[no]w"  "no    "
145  View output xvg, xpm, eps and pdb files
147 .BI "-[no]xvgr"  "yes   "
148  Add specific codes (legends etc.) in the output xvg files for the xmgrace program
150 .BI "-bin"  " real" " 0.002 " 
151  Binwidth (nm)
153 .BI "-[no]com"  "no    "
154  RDF with respect to the center of mass of first group
156 .BI "-rdf"  " enum" " atom" 
157  RDF type: 
158 .B atom
160 .B mol_com
162 .B mol_cog
164 .B res_com
165 or 
166 .B res_cog
169 .BI "-[no]pbc"  "yes   "
170  Use periodic boundary conditions for computing distances. Without PBC the maximum range will be three times the larges box edge.
172 .BI "-[no]norm"  "yes   "
173  Normalize for volume and density
175 .BI "-[no]xy"  "no    "
176  Use only the x and y components of the distance
178 .BI "-cut"  " real" " 0     " 
179  Shortest distance (nm) to be considered
181 .BI "-ng"  " int" " 1" 
182  Number of secondary groups to compute RDFs around a central group
184 .BI "-fade"  " real" " 0     " 
185  From this distance onwards the RDF is tranformed by g'(r) = 1 + [g(r)-1] exp(-(r/fade-1)2 to make it go to 1 smoothly. If fade is 0.0 nothing is done.
187 .BI "-nlevel"  " int" " 20" 
188  Number of different colors in the diffraction image
190 .BI "-startq"  " real" " 0     " 
191  Starting q (1/nm) 
193 .BI "-endq"  " real" " 60    " 
194  Ending q (1/nm)
196 .BI "-energy"  " real" " 12    " 
197  Energy of the incoming X-ray (keV)