Merge branch 'release-4-5-patches' of git@git.gromacs.org:gromacs into release-4...
[gromacs/rigid-bodies.git] / man / man1 / g_dielectric.1
bloba10fee14a0b54f52e7601e46450b5a9d5f392914
1 .TH g_dielectric 1 "Thu 26 Aug 2010" "" "GROMACS suite, VERSION 4.5"
2 .SH NAME
3 g_dielectric - calculates frequency dependent dielectric constants
5 .B VERSION 4.5
6 .SH SYNOPSIS
7 \f3g_dielectric\fP
8 .BI "\-f" " dipcorr.xvg "
9 .BI "\-d" " deriv.xvg "
10 .BI "\-o" " epsw.xvg "
11 .BI "\-c" " cole.xvg "
12 .BI "\-[no]h" ""
13 .BI "\-[no]version" ""
14 .BI "\-nice" " int "
15 .BI "\-b" " time "
16 .BI "\-e" " time "
17 .BI "\-dt" " time "
18 .BI "\-[no]w" ""
19 .BI "\-xvg" " enum "
20 .BI "\-[no]fft" ""
21 .BI "\-[no]x1" ""
22 .BI "\-eint" " real "
23 .BI "\-bfit" " real "
24 .BI "\-efit" " real "
25 .BI "\-tail" " real "
26 .BI "\-A" " real "
27 .BI "\-tau1" " real "
28 .BI "\-tau2" " real "
29 .BI "\-eps0" " real "
30 .BI "\-epsRF" " real "
31 .BI "\-fix" " int "
32 .BI "\-ffn" " enum "
33 .BI "\-nsmooth" " int "
34 .SH DESCRIPTION
35 \&dielectric calculates frequency dependent dielectric constants
36 \&from the autocorrelation function of the total dipole moment in
37 \&your simulation. This ACF can be generated by g_dipoles.
38 \&For an estimate of the error you can run g_statistics on the
39 \&ACF, and use the output thus generated for this program.
40 \&The functional forms of the available functions are:
43 \&One parameter  : y = Exp[\-a1 x],
44 \&Two parameters : y = a2 Exp[\-a1 x],
45 \&Three parameters: y = a2 Exp[\-a1 x] + (1 \- a2) Exp[\-a3 x].
46 \&Start values for the fit procedure can be given on the command line.
47 \&It is also possible to fix parameters at their start value, use \-fix
48 \&with the number of the parameter you want to fix.
52 \&Three output files are generated, the first contains the ACF,
53 \&an exponential fit to it with 1, 2 or 3 parameters, and the
54 \&numerical derivative of the combination data/fit.
55 \&The second file contains the real and imaginary parts of the
56 \&frequency\-dependent dielectric constant, the last gives a plot
57 \&known as the Cole\-Cole plot, in which the imaginary
58 \&component is plotted as a function of the real component.
59 \&For a pure exponential relaxation (Debye relaxation) the latter
60 \&plot should be one half of a circle.
61 .SH FILES
62 .BI "\-f" " dipcorr.xvg" 
63 .B Input
64  xvgr/xmgr file 
66 .BI "\-d" " deriv.xvg" 
67 .B Output
68  xvgr/xmgr file 
70 .BI "\-o" " epsw.xvg" 
71 .B Output
72  xvgr/xmgr file 
74 .BI "\-c" " cole.xvg" 
75 .B Output
76  xvgr/xmgr file 
78 .SH OTHER OPTIONS
79 .BI "\-[no]h"  "no    "
80  Print help info and quit
82 .BI "\-[no]version"  "no    "
83  Print version info and quit
85 .BI "\-nice"  " int" " 19" 
86  Set the nicelevel
88 .BI "\-b"  " time" " 0     " 
89  First frame (ps) to read from trajectory
91 .BI "\-e"  " time" " 0     " 
92  Last frame (ps) to read from trajectory
94 .BI "\-dt"  " time" " 0     " 
95  Only use frame when t MOD dt = first time (ps)
97 .BI "\-[no]w"  "no    "
98  View output xvg, xpm, eps and pdb files
100 .BI "\-xvg"  " enum" " xmgrace" 
101  xvg plot formatting: \fB xmgrace\fR, \fB xmgr\fR or \fB none\fR
103 .BI "\-[no]fft"  "no    "
104  use fast fourier transform for correlation function
106 .BI "\-[no]x1"  "yes   "
107  use first column as X axis rather than first data set
109 .BI "\-eint"  " real" " 5     " 
110  Time were to end the integration of the data and start to use the fit
112 .BI "\-bfit"  " real" " 5     " 
113  Begin time of fit
115 .BI "\-efit"  " real" " 500   " 
116  End time of fit
118 .BI "\-tail"  " real" " 500   " 
119  Length of function including data and tail from fit
121 .BI "\-A"  " real" " 0.5   " 
122  Start value for fit parameter A
124 .BI "\-tau1"  " real" " 10    " 
125  Start value for fit parameter tau1
127 .BI "\-tau2"  " real" " 1     " 
128  Start value for fit parameter tau2
130 .BI "\-eps0"  " real" " 80    " 
131  Epsilon 0 of your liquid
133 .BI "\-epsRF"  " real" " 78.5  " 
134  Epsilon of the reaction field used in your simulation. A value of 0 means infinity.
136 .BI "\-fix"  " int" " 0" 
137  Fix parameters at their start values, A (2), tau1 (1), or tau2 (4)
139 .BI "\-ffn"  " enum" " none" 
140  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
142 .BI "\-nsmooth"  " int" " 3" 
143  Number of points for smoothing
145 .SH SEE ALSO
146 .BR gromacs(7)
148 More information about \fBGROMACS\fR is available at <\fIhttp://www.gromacs.org/\fR>.