Added 1 analysis tool manual.
[gromacs/rigid-bodies.git] / man / man1 / g_current.1
blobdda3b71a12ecef39786d8db9911d6f69856ffc14
1 .TH g_current 1 "Mon 4 Apr 2011" "" "GROMACS suite, VERSION 4.5.4-dev-20110404-3c0e5ec"
2 .SH NAME
3 g_current - calculate current autocorrelation function of system
5 .B VERSION 4.5.4-dev-20110404-3c0e5ec
6 .SH SYNOPSIS
7 \f3g_current\fP
8 .BI "\-s" " topol.tpr "
9 .BI "\-n" " index.ndx "
10 .BI "\-f" " traj.xtc "
11 .BI "\-o" " current.xvg "
12 .BI "\-caf" " caf.xvg "
13 .BI "\-dsp" " dsp.xvg "
14 .BI "\-md" " md.xvg "
15 .BI "\-mj" " mj.xvg "
16 .BI "\-mc" " mc.xvg "
17 .BI "\-[no]h" ""
18 .BI "\-[no]version" ""
19 .BI "\-nice" " int "
20 .BI "\-b" " time "
21 .BI "\-e" " time "
22 .BI "\-dt" " time "
23 .BI "\-[no]w" ""
24 .BI "\-xvg" " enum "
25 .BI "\-sh" " int "
26 .BI "\-[no]nojump" ""
27 .BI "\-eps" " real "
28 .BI "\-bfit" " real "
29 .BI "\-efit" " real "
30 .BI "\-bvit" " real "
31 .BI "\-evit" " real "
32 .BI "\-tr" " real "
33 .BI "\-temp" " real "
34 .SH DESCRIPTION
35 \&\fB g_current\fR is a tool for calculating the current autocorrelation function, the correlation
36 \&of the rotational and translational dipole moment of the system, and the resulting static
37 \&dielectric constant. To obtain a reasonable result, the index group has to be neutral.
38 \&Furthermore, the routine is capable of extracting the static conductivity from the current 
39 \&autocorrelation function, if velocities are given. Additionally, an Einstein\-Helfand fit 
40 \&can be used to obtain the static conductivity.
43 \&The flag \fB \-caf\fR is for the output of the current autocorrelation function and \fB \-mc\fR writes the
44 \&correlation of the rotational and translational part of the dipole moment in the corresponding
45 \&file. However, this option is only available for trajectories containing velocities.
46 \&Options \fB \-sh\fR and \fB \-tr\fR are responsible for the averaging and integration of the
47 \&autocorrelation functions. Since averaging proceeds by shifting the starting point
48 \&through the trajectory, the shift can be modified with \fB \-sh\fR to enable the choice of uncorrelated
49 \&starting points. Towards the end, statistical inaccuracy grows and integrating the
50 \&correlation function only yields reliable values until a certain point, depending on
51 \&the number of frames. The option \fB \-tr\fR controls the region of the integral taken into account
52 \&for calculating the static dielectric constant.
56 \&Option \fB \-temp\fR sets the temperature required for the computation of the static dielectric constant.
60 \&Option \fB \-eps\fR controls the dielectric constant of the surrounding medium for simulations using
61 \&a Reaction Field or dipole corrections of the Ewald summation (eps=0 corresponds to
62 \&tin\-foil boundary conditions).
66 \&\fB \-[no]nojump\fR unfolds the coordinates to allow free diffusion. This is required to get a continuous
67 \&translational dipole moment, required for the Einstein\-Helfand fit. The results from the fit allow
68 \&the determination of the dielectric constant for system of charged molecules. However, it is also possible to extract
69 \&the dielectric constant from the fluctuations of the total dipole moment in folded coordinates. But this
70 \&option has to be used with care, since only very short time spans fulfill the approximation that the density
71 \&of the molecules is approximately constant and the averages are already converged. To be on the safe side,
72 \&the dielectric constant should be calculated with the help of the Einstein\-Helfand method for
73 \&the translational part of the dielectric constant.
74 .SH FILES
75 .BI "\-s" " topol.tpr" 
76 .B Input
77  Structure+mass(db): tpr tpb tpa gro g96 pdb 
79 .BI "\-n" " index.ndx" 
80 .B Input, Opt.
81  Index file 
83 .BI "\-f" " traj.xtc" 
84 .B Input
85  Trajectory: xtc trr trj gro g96 pdb cpt 
87 .BI "\-o" " current.xvg" 
88 .B Output
89  xvgr/xmgr file 
91 .BI "\-caf" " caf.xvg" 
92 .B Output, Opt.
93  xvgr/xmgr file 
95 .BI "\-dsp" " dsp.xvg" 
96 .B Output
97  xvgr/xmgr file 
99 .BI "\-md" " md.xvg" 
100 .B Output
101  xvgr/xmgr file 
103 .BI "\-mj" " mj.xvg" 
104 .B Output
105  xvgr/xmgr file 
107 .BI "\-mc" " mc.xvg" 
108 .B Output, Opt.
109  xvgr/xmgr file 
111 .SH OTHER OPTIONS
112 .BI "\-[no]h"  "no    "
113  Print help info and quit
115 .BI "\-[no]version"  "no    "
116  Print version info and quit
118 .BI "\-nice"  " int" " 0" 
119  Set the nicelevel
121 .BI "\-b"  " time" " 0     " 
122  First frame (ps) to read from trajectory
124 .BI "\-e"  " time" " 0     " 
125  Last frame (ps) to read from trajectory
127 .BI "\-dt"  " time" " 0     " 
128  Only use frame when t MOD dt = first time (ps)
130 .BI "\-[no]w"  "no    "
131  View output \fB .xvg\fR, \fB .xpm\fR, \fB .eps\fR and \fB .pdb\fR files
133 .BI "\-xvg"  " enum" " xmgrace" 
134  xvg plot formatting: \fB xmgrace\fR, \fB xmgr\fR or \fB none\fR
136 .BI "\-sh"  " int" " 1000" 
137  Shift of the frames for averaging the correlation functions and the mean\-square displacement.
139 .BI "\-[no]nojump"  "yes   "
140  Removes jumps of atoms across the box.
142 .BI "\-eps"  " real" " 0     " 
143  Dielectric constant of the surrounding medium. eps=0.0 corresponds to eps=infinity (tin\-foil boundary conditions).
145 .BI "\-bfit"  " real" " 100   " 
146  Begin of the fit of the straight line to the MSD of the translational fraction of the dipole moment.
148 .BI "\-efit"  " real" " 400   " 
149  End of the fit of the straight line to the MSD of the translational fraction of the dipole moment.
151 .BI "\-bvit"  " real" " 0.5   " 
152  Begin of the fit of the current autocorrelation function to a*tb.
154 .BI "\-evit"  " real" " 5     " 
155  End of the fit of the current autocorrelation function to a*tb.
157 .BI "\-tr"  " real" " 0.25  " 
158  Fraction of the trajectory taken into account for the integral.
160 .BI "\-temp"  " real" " 300   " 
161  Temperature for calculating epsilon.
163 .SH SEE ALSO
164 .BR gromacs(7)
166 More information about \fBGROMACS\fR is available at <\fIhttp://www.gromacs.org/\fR>.