updated FindCUDA to version from cmake 2.8.1 for CUDA 2.3 support
[gromacs/rigid-bodies.git] / man / man1 / g_dipoles.1
blob79ff900b15fdf5470a7c800090f02dfd77d2e06d
1 .TH g_dipoles 1 "Thu 16 Oct 2008"
2 .SH NAME
3 g_dipoles - computes the total dipole plus fluctuations
5 .B VERSION 4.0
6 .SH SYNOPSIS
7 \f3g_dipoles\fP
8 .BI "-enx" " 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 "-nice" " int "
26 .BI "-b" " time "
27 .BI "-e" " time "
28 .BI "-dt" " time "
29 .BI "-[no]w" ""
30 .BI "-[no]xvgr" ""
31 .BI "-mu" " real "
32 .BI "-mumax" " real "
33 .BI "-epsilonRF" " real "
34 .BI "-skip" " int "
35 .BI "-temp" " real "
36 .BI "-corr" " enum "
37 .BI "-[no]pairs" ""
38 .BI "-ncos" " int "
39 .BI "-axis" " string "
40 .BI "-sl" " int "
41 .BI "-gkratom" " int "
42 .BI "-gkratom2" " int "
43 .BI "-rcmax" " real "
44 .BI "-[no]phi" ""
45 .BI "-nlevels" " int "
46 .BI "-ndegrees" " int "
47 .BI "-acflen" " int "
48 .BI "-[no]normalize" ""
49 .BI "-P" " enum "
50 .BI "-fitfn" " enum "
51 .BI "-ncskip" " int "
52 .BI "-beginfit" " real "
53 .BI "-endfit" " real "
54 .SH DESCRIPTION
55 g_dipoles computes the total dipole plus fluctuations of a simulation
56 system. From this you can compute e.g. the dielectric constant for
57 low dielectric media.
58 For molecules with a net charge, the net charge is subtracted at
59 center of mass of the molecule.
62 The file Mtot.xvg contains the total dipole moment of a frame, the
63 components as well as the norm of the vector.
64 The file aver.xvg contains  |Mu|2  and  |Mu| 2 during the
65 simulation.
66 The file dipdist.xvg contains the distribution of dipole moments during
67 the simulation
68 The mu_max is used as the highest value in the distribution graph.
71 Furthermore the dipole autocorrelation function will be computed when
72 option -corr is used. The output file name is given with the 
73 .B -c
75 option.
76 The correlation functions can be averaged over all molecules
78 .B mol
79 ), plotted per molecule seperately (
80 .B molsep
82 or it can be computed over the total dipole moment of the simulation box
84 .B total
88 Option 
89 .B -g
90 produces a plot of the distance dependent Kirkwood
91 G-factor, as well as the average cosine of the angle between the dipoles
92 as a function of the distance. The plot also includes gOO and hOO
93 according to Nymand & Linse, JCP 112 (2000) pp 6386-6395. In the same plot
94 we also include the energy per scale computed by taking the inner product of
95 the dipoles divided by the distance to the third power.
101 EXAMPLES
104 g_dipoles -corr mol -P1 -o dip_sqr -mu 2.273 -mumax 5.0 -nofft
107 This will calculate the autocorrelation function of the molecular
108 dipoles using a first order Legendre polynomial of the angle of the
109 dipole vector and itself a time t later. For this calculation 1001
110 frames will be used. Further the dielectric constant will be calculated
111 using an epsilonRF of infinity (default), temperature of 300 K (default) and
112 an average dipole moment of the molecule of 2.273 (SPC). For the
113 distribution function a maximum of 5.0 will be used.
114 .SH FILES
115 .BI "-enx" " ener.edr" 
116 .B Input, Opt.
117  Energy file: edr ene 
119 .BI "-f" " traj.xtc" 
120 .B Input
121  Trajectory: xtc trr trj gro g96 pdb cpt 
123 .BI "-s" " topol.tpr" 
124 .B Input
125  Run input file: tpr tpb tpa 
127 .BI "-n" " index.ndx" 
128 .B Input, Opt.
129  Index file 
131 .BI "-o" " Mtot.xvg" 
132 .B Output
133  xvgr/xmgr file 
135 .BI "-eps" " epsilon.xvg" 
136 .B Output
137  xvgr/xmgr file 
139 .BI "-a" " aver.xvg" 
140 .B Output
141  xvgr/xmgr file 
143 .BI "-d" " dipdist.xvg" 
144 .B Output
145  xvgr/xmgr file 
147 .BI "-c" " dipcorr.xvg" 
148 .B Output, Opt.
149  xvgr/xmgr file 
151 .BI "-g" " gkr.xvg" 
152 .B Output, Opt.
153  xvgr/xmgr file 
155 .BI "-adip" " adip.xvg" 
156 .B Output, Opt.
157  xvgr/xmgr file 
159 .BI "-dip3d" " dip3d.xvg" 
160 .B Output, Opt.
161  xvgr/xmgr file 
163 .BI "-cos" " cosaver.xvg" 
164 .B Output, Opt.
165  xvgr/xmgr file 
167 .BI "-cmap" " cmap.xpm" 
168 .B Output, Opt.
169  X PixMap compatible matrix file 
171 .BI "-q" " quadrupole.xvg" 
172 .B Output, Opt.
173  xvgr/xmgr file 
175 .BI "-slab" " slab.xvg" 
176 .B Output, Opt.
177  xvgr/xmgr file 
179 .SH OTHER OPTIONS
180 .BI "-[no]h"  "no    "
181  Print help info and quit
183 .BI "-nice"  " int" " 19" 
184  Set the nicelevel
186 .BI "-b"  " time" " 0     " 
187  First frame (ps) to read from trajectory
189 .BI "-e"  " time" " 0     " 
190  Last frame (ps) to read from trajectory
192 .BI "-dt"  " time" " 0     " 
193  Only use frame when t MOD dt = first time (ps)
195 .BI "-[no]w"  "no    "
196  View output xvg, xpm, eps and pdb files
198 .BI "-[no]xvgr"  "yes   "
199  Add specific codes (legends etc.) in the output xvg files for the xmgrace program
201 .BI "-mu"  " real" " -1    " 
202  dipole of a single molecule (in Debye)
204 .BI "-mumax"  " real" " 5     " 
205  max dipole in Debye (for histrogram)
207 .BI "-epsilonRF"  " real" " 0     " 
208  epsilon of the reaction field used during the simulation, needed for dieclectric constant calculation. WARNING: 0.0 means infinity (default)
210 .BI "-skip"  " int" " 0" 
211  Skip steps in the output (but not in the computations)
213 .BI "-temp"  " real" " 300   " 
214  Average temperature of the simulation (needed for dielectric constant calculation)
216 .BI "-corr"  " enum" " none" 
217  Correlation function to calculate: 
218 .B none
220 .B mol
222 .B molsep
223 or 
224 .B total
227 .BI "-[no]pairs"  "yes   "
228  Calculate |cos theta| between all pairs of molecules. May be slow
230 .BI "-ncos"  " int" " 1" 
231  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.
233 .BI "-axis"  " string" " Z" 
234  Take the normal on the computational box in direction X, Y or Z.
236 .BI "-sl"  " int" " 10" 
237  Divide the box in nr slices.
239 .BI "-gkratom"  " int" " 0" 
240  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
242 .BI "-gkratom2"  " int" " 0" 
243  Same as previous option in case ncos = 2, i.e. dipole interaction between two groups of molecules
245 .BI "-rcmax"  " real" " 0     " 
246  Maximum distance to use in the dipole orientation distribution (with ncos == 2). If zero, a criterium based on the box length will be used.
248 .BI "-[no]phi"  "no    "
249  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.
251 .BI "-nlevels"  " int" " 20" 
252  Number of colors in the cmap output
254 .BI "-ndegrees"  " int" " 90" 
255  Number of divisions on the y-axis in the camp output (for 180 degrees)
257 .BI "-acflen"  " int" " -1" 
258  Length of the ACF, default is half the number of frames
260 .BI "-[no]normalize"  "yes   "
261  Normalize ACF
263 .BI "-P"  " enum" " 0" 
264  Order of Legendre polynomial for ACF (0 indicates none): 
265 .B 0
267 .B 1
269 .B 2
270 or 
271 .B 3
274 .BI "-fitfn"  " enum" " none" 
275  Fit function: 
276 .B none
278 .B exp
280 .B aexp
282 .B exp_exp
284 .B vac
286 .B exp5
288 .B exp7
289 or 
290 .B exp9
293 .BI "-ncskip"  " int" " 0" 
294  Skip N points in the output file of correlation functions
296 .BI "-beginfit"  " real" " 0     " 
297  Time where to begin the exponential fit of the correlation function
299 .BI "-endfit"  " real" " -1    " 
300  Time where to end the exponential fit of the correlation function, -1 is till the end