Merge branch 'release-4-5-patches' of git@git.gromacs.org:gromacs into release-4...
[gromacs/rigid-bodies.git] / man / man1 / g_dipoles.1
blobea960c9a4346a94def011a33578ae40cabc1a3ec
1 .TH g_dipoles 1 "Thu 26 Aug 2010" "" "GROMACS suite, VERSION 4.5"
2 .SH NAME
3 g_dipoles - computes the total dipole plus fluctuations
5 .B VERSION 4.5
6 .SH SYNOPSIS
7 \f3g_dipoles\fP
8 .BI "\-en" " ener.edr "
9 .BI "\-f" " traj.xtc "
10 .BI "\-s" " topol.tpr "
11 .BI "\-n" " index.ndx "
12 .BI "\-o" " Mtot.xvg "
13 .BI "\-eps" " epsilon.xvg "
14 .BI "\-a" " aver.xvg "
15 .BI "\-d" " dipdist.xvg "
16 .BI "\-c" " dipcorr.xvg "
17 .BI "\-g" " gkr.xvg "
18 .BI "\-adip" " adip.xvg "
19 .BI "\-dip3d" " dip3d.xvg "
20 .BI "\-cos" " cosaver.xvg "
21 .BI "\-cmap" " cmap.xpm "
22 .BI "\-q" " quadrupole.xvg "
23 .BI "\-slab" " slab.xvg "
24 .BI "\-[no]h" ""
25 .BI "\-[no]version" ""
26 .BI "\-nice" " int "
27 .BI "\-b" " time "
28 .BI "\-e" " time "
29 .BI "\-dt" " time "
30 .BI "\-[no]w" ""
31 .BI "\-xvg" " enum "
32 .BI "\-mu" " real "
33 .BI "\-mumax" " real "
34 .BI "\-epsilonRF" " real "
35 .BI "\-skip" " int "
36 .BI "\-temp" " real "
37 .BI "\-corr" " enum "
38 .BI "\-[no]pairs" ""
39 .BI "\-ncos" " int "
40 .BI "\-axis" " string "
41 .BI "\-sl" " int "
42 .BI "\-gkratom" " int "
43 .BI "\-gkratom2" " int "
44 .BI "\-rcmax" " real "
45 .BI "\-[no]phi" ""
46 .BI "\-nlevels" " int "
47 .BI "\-ndegrees" " int "
48 .BI "\-acflen" " int "
49 .BI "\-[no]normalize" ""
50 .BI "\-P" " enum "
51 .BI "\-fitfn" " enum "
52 .BI "\-ncskip" " int "
53 .BI "\-beginfit" " real "
54 .BI "\-endfit" " real "
55 .SH DESCRIPTION
56 \&g_dipoles computes the total dipole plus fluctuations of a simulation
57 \&system. From this you can compute e.g. the dielectric constant for
58 \&low dielectric media.
59 \&For molecules with a net charge, the net charge is subtracted at
60 \&center of mass of the molecule.
63 \&The file Mtot.xvg contains the total dipole moment of a frame, the
64 \&components as well as the norm of the vector.
65 \&The file aver.xvg contains  |Mu|2  and | Mu |2 during the
66 \&simulation.
67 \&The file dipdist.xvg contains the distribution of dipole moments during
68 \&the simulation
69 \&The mu_max is used as the highest value in the distribution graph.
72 \&Furthermore the dipole autocorrelation function will be computed when
73 \&option \-corr is used. The output file name is given with the \fB \-c\fR
74 \&option.
75 \&The correlation functions can be averaged over all molecules
76 \&(\fB mol\fR), plotted per molecule separately (\fB molsep\fR)
77 \&or it can be computed over the total dipole moment of the simulation box
78 \&(\fB total\fR).
81 \&Option \fB \-g\fR produces a plot of the distance dependent Kirkwood
82 \&G\-factor, as well as the average cosine of the angle between the dipoles
83 \&as a function of the distance. The plot also includes gOO and hOO
84 \&according to Nymand & Linse, JCP 112 (2000) pp 6386\-6395. In the same plot
85 \&we also include the energy per scale computed by taking the inner product of
86 \&the dipoles divided by the distance to the third power.
92 \&EXAMPLES
95 \&g_dipoles \-corr mol \-P1 \-o dip_sqr \-mu 2.273 \-mumax 5.0 \-nofft
98 \&This will calculate the autocorrelation function of the molecular
99 \&dipoles using a first order Legendre polynomial of the angle of the
100 \&dipole vector and itself a time t later. For this calculation 1001
101 \&frames will be used. Further the dielectric constant will be calculated
102 \&using an epsilonRF of infinity (default), temperature of 300 K (default) and
103 \&an average dipole moment of the molecule of 2.273 (SPC). For the
104 \&distribution function a maximum of 5.0 will be used.
105 .SH FILES
106 .BI "\-en" " ener.edr" 
107 .B Input, Opt.
108  Energy file 
110 .BI "\-f" " traj.xtc" 
111 .B Input
112  Trajectory: xtc trr trj gro g96 pdb cpt 
114 .BI "\-s" " topol.tpr" 
115 .B Input
116  Run input file: tpr tpb tpa 
118 .BI "\-n" " index.ndx" 
119 .B Input, Opt.
120  Index file 
122 .BI "\-o" " Mtot.xvg" 
123 .B Output
124  xvgr/xmgr file 
126 .BI "\-eps" " epsilon.xvg" 
127 .B Output
128  xvgr/xmgr file 
130 .BI "\-a" " aver.xvg" 
131 .B Output
132  xvgr/xmgr file 
134 .BI "\-d" " dipdist.xvg" 
135 .B Output
136  xvgr/xmgr file 
138 .BI "\-c" " dipcorr.xvg" 
139 .B Output, Opt.
140  xvgr/xmgr file 
142 .BI "\-g" " gkr.xvg" 
143 .B Output, Opt.
144  xvgr/xmgr file 
146 .BI "\-adip" " adip.xvg" 
147 .B Output, Opt.
148  xvgr/xmgr file 
150 .BI "\-dip3d" " dip3d.xvg" 
151 .B Output, Opt.
152  xvgr/xmgr file 
154 .BI "\-cos" " cosaver.xvg" 
155 .B Output, Opt.
156  xvgr/xmgr file 
158 .BI "\-cmap" " cmap.xpm" 
159 .B Output, Opt.
160  X PixMap compatible matrix file 
162 .BI "\-q" " quadrupole.xvg" 
163 .B Output, Opt.
164  xvgr/xmgr file 
166 .BI "\-slab" " slab.xvg" 
167 .B Output, Opt.
168  xvgr/xmgr file 
170 .SH OTHER OPTIONS
171 .BI "\-[no]h"  "no    "
172  Print help info and quit
174 .BI "\-[no]version"  "no    "
175  Print version info and quit
177 .BI "\-nice"  " int" " 19" 
178  Set the nicelevel
180 .BI "\-b"  " time" " 0     " 
181  First frame (ps) to read from trajectory
183 .BI "\-e"  " time" " 0     " 
184  Last frame (ps) to read from trajectory
186 .BI "\-dt"  " time" " 0     " 
187  Only use frame when t MOD dt = first time (ps)
189 .BI "\-[no]w"  "no    "
190  View output xvg, xpm, eps and pdb files
192 .BI "\-xvg"  " enum" " xmgrace" 
193  xvg plot formatting: \fB xmgrace\fR, \fB xmgr\fR or \fB none\fR
195 .BI "\-mu"  " real" " \-1    " 
196  dipole of a single molecule (in Debye)
198 .BI "\-mumax"  " real" " 5     " 
199  max dipole in Debye (for histrogram)
201 .BI "\-epsilonRF"  " real" " 0     " 
202  epsilon of the reaction field used during the simulation, needed for dielectric constant calculation. WARNING: 0.0 means infinity (default)
204 .BI "\-skip"  " int" " 0" 
205  Skip steps in the output (but not in the computations)
207 .BI "\-temp"  " real" " 300   " 
208  Average temperature of the simulation (needed for dielectric constant calculation)
210 .BI "\-corr"  " enum" " none" 
211  Correlation function to calculate: \fB none\fR, \fB mol\fR, \fB molsep\fR or \fB total\fR
213 .BI "\-[no]pairs"  "yes   "
214  Calculate |cos theta| between all pairs of molecules. May be slow
216 .BI "\-ncos"  " int" " 1" 
217  Must be 1 or 2. Determines whether the cos is computed between all mole cules in one group, or between molecules in two different groups. This turns on the \-gkr flag.
219 .BI "\-axis"  " string" " Z" 
220  Take the normal on the computational box in direction X, Y or Z.
222 .BI "\-sl"  " int" " 10" 
223  Divide the box in nr slices.
225 .BI "\-gkratom"  " int" " 0" 
226  Use the n\-th atom of a molecule (starting from 1) to calculate the distance between molecules rather than the center of charge (when 0) in the calculation of distance dependent Kirkwood factors
228 .BI "\-gkratom2"  " int" " 0" 
229  Same as previous option in case ncos = 2, i.e. dipole interaction between two groups of molecules
231 .BI "\-rcmax"  " real" " 0     " 
232  Maximum distance to use in the dipole orientation distribution (with ncos == 2). If zero, a criterium based on the box length will be used.
234 .BI "\-[no]phi"  "no    "
235  Plot the 'torsion angle' defined as the rotation of the two dipole vectors around the distance vector between the two molecules in the xpm file from the \-cmap option. By default the cosine of the angle between the dipoles is plotted.
237 .BI "\-nlevels"  " int" " 20" 
238  Number of colors in the cmap output
240 .BI "\-ndegrees"  " int" " 90" 
241  Number of divisions on the y\-axis in the camp output (for 180 degrees)
243 .BI "\-acflen"  " int" " \-1" 
244  Length of the ACF, default is half the number of frames
246 .BI "\-[no]normalize"  "yes   "
247  Normalize ACF
249 .BI "\-P"  " enum" " 0" 
250  Order of Legendre polynomial for ACF (0 indicates none): \fB 0\fR, \fB 1\fR, \fB 2\fR or \fB 3\fR
252 .BI "\-fitfn"  " enum" " none" 
253  Fit function: \fB none\fR, \fB exp\fR, \fB aexp\fR, \fB exp_exp\fR, \fB vac\fR, \fB exp5\fR, \fB exp7\fR or \fB exp9\fR
255 .BI "\-ncskip"  " int" " 0" 
256  Skip N points in the output file of correlation functions
258 .BI "\-beginfit"  " real" " 0     " 
259  Time where to begin the exponential fit of the correlation function
261 .BI "\-endfit"  " real" " \-1    " 
262  Time where to end the exponential fit of the correlation function, \-1 is until the end
264 .SH SEE ALSO
265 .BR gromacs(7)
267 More information about \fBGROMACS\fR is available at <\fIhttp://www.gromacs.org/\fR>.