Release 4.5.6
[alexxy/gromacs.git] / man / man1 / g_msd.1
1 .TH g_msd 1 "Fri 18 Jan 2013" "" "GROMACS suite, VERSION 4.5.6"
2 .SH NAME
3 g_msd - calculates mean square displacements
4
5 .B VERSION 4.5.6
6 .SH SYNOPSIS
7 \f3g_msd\fP
8 .BI "\-f" " traj.xtc "
9 .BI "\-s" " topol.tpr "
10 .BI "\-n" " index.ndx "
11 .BI "\-o" " msd.xvg "
12 .BI "\-mol" " diff_mol.xvg "
13 .BI "\-pdb" " diff_mol.pdb "
14 .BI "\-[no]h" ""
15 .BI "\-[no]version" ""
16 .BI "\-nice" " int "
17 .BI "\-b" " time "
18 .BI "\-e" " time "
19 .BI "\-tu" " enum "
20 .BI "\-[no]w" ""
21 .BI "\-xvg" " enum "
22 .BI "\-type" " enum "
23 .BI "\-lateral" " enum "
24 .BI "\-[no]ten" ""
25 .BI "\-ngroup" " int "
26 .BI "\-[no]mw" ""
27 .BI "\-[no]rmcomm" ""
28 .BI "\-tpdb" " time "
29 .BI "\-trestart" " time "
30 .BI "\-beginfit" " time "
31 .BI "\-endfit" " time "
32 .SH DESCRIPTION
33 \&\fB g_msd\fR computes the mean square displacement (MSD) of atoms from
34 \&a set of initial positions. This provides an easy way to compute
35 \&the diffusion constant using the Einstein relation.
36 \&The time between the reference points for the MSD calculation
37 \&is set with \fB \-trestart\fR.
38 \&The diffusion constant is calculated by least squares fitting a
39 \&straight line (D*t + c) through the MSD(t) from \fB \-beginfit\fR to
40 \&\fB \-endfit\fR (note that t is time from the reference positions,
41 \&not simulation time). An error estimate given, which is the difference
42 \&of the diffusion coefficients obtained from fits over the two halves
43 \&of the fit interval.
44
45
46 \&There are three, mutually exclusive, options to determine different
47 \&types of mean square displacement: \fB \-type\fR, \fB \-lateral\fR
48 \&and \fB \-ten\fR. Option \fB \-ten\fR writes the full MSD tensor for
49 \&each group, the order in the output is: trace xx yy zz yx zx zy.
50
51
52 \&If \fB \-mol\fR is set, \fB g_msd\fR plots the MSD for individual molecules
53 \&(including making molecules whole across periodic boundaries): 
54 \&for each individual molecule a diffusion constant is computed for 
55 \&its center of mass. The chosen index group will be split into 
56 \&molecules.
57
58
59 \&The default way to calculate a MSD is by using mass\-weighted averages.
60 \&This can be turned off with \fB \-nomw\fR.
61
62
63 \&With the option \fB \-rmcomm\fR, the center of mass motion of a 
64 \&specific group can be removed. For trajectories produced with 
65 \&GROMACS this is usually not necessary, 
66 \&as \fB mdrun\fR usually already removes the center of mass motion.
67 \&When you use this option be sure that the whole system is stored
68 \&in the trajectory file.
69
70
71 \&The diffusion coefficient is determined by linear regression of the MSD,
72 \&where, unlike for the normal output of D, the times are weighted
73 \&according to the number of reference points, i.e. short times have
74 \&a higher weight. Also when \fB \-beginfit\fR=\-1,fitting starts at 10%
75 \&and when \fB \-endfit\fR=\-1, fitting goes to 90%.
76 \&Using this option one also gets an accurate error estimate
77 \&based on the statistics between individual molecules.
78 \&Note that this diffusion coefficient and error estimate are only
79 \&accurate when the MSD is completely linear between
80 \&\fB \-beginfit\fR and \fB \-endfit\fR.
81
82
83 \&Option \fB \-pdb\fR writes a \fB .pdb\fR file with the coordinates of the frame
84 \&at time \fB \-tpdb\fR with in the B\-factor field the square root of
85 \&the diffusion coefficient of the molecule.
86 \&This option implies option \fB \-mol\fR.
87 .SH FILES
88 .BI "\-f" " traj.xtc" 
89 .B Input
90  Trajectory: xtc trr trj gro g96 pdb cpt 
91
92 .BI "\-s" " topol.tpr" 
93 .B Input
94  Structure+mass(db): tpr tpb tpa gro g96 pdb 
95
96 .BI "\-n" " index.ndx" 
97 .B Input, Opt.
98  Index file 
99
100 .BI "\-o" " msd.xvg" 
101 .B Output
102  xvgr/xmgr file 
103
104 .BI "\-mol" " diff_mol.xvg" 
105 .B Output, Opt.
106  xvgr/xmgr file 
107
108 .BI "\-pdb" " diff_mol.pdb" 
109 .B Output, Opt.
110  Protein data bank file 
111
112 .SH OTHER OPTIONS
113 .BI "\-[no]h"  "no    "
114  Print help info and quit
115
116 .BI "\-[no]version"  "no    "
117  Print version info and quit
118
119 .BI "\-nice"  " int" " 19" 
120  Set the nicelevel
121
122 .BI "\-b"  " time" " 0     " 
123  First frame (ps) to read from trajectory
124
125 .BI "\-e"  " time" " 0     " 
126  Last frame (ps) to read from trajectory
127
128 .BI "\-tu"  " enum" " ps" 
129  Time unit: \fB fs\fR, \fB ps\fR, \fB ns\fR, \fB us\fR, \fB ms\fR or \fB s\fR
130
131 .BI "\-[no]w"  "no    "
132  View output \fB .xvg\fR, \fB .xpm\fR, \fB .eps\fR and \fB .pdb\fR files
133
134 .BI "\-xvg"  " enum" " xmgrace" 
135  xvg plot formatting: \fB xmgrace\fR, \fB xmgr\fR or \fB none\fR
136
137 .BI "\-type"  " enum" " no" 
138  Compute diffusion coefficient in one direction: \fB no\fR, \fB x\fR, \fB y\fR or \fB z\fR
139
140 .BI "\-lateral"  " enum" " no" 
141  Calculate the lateral diffusion in a plane perpendicular to: \fB no\fR, \fB x\fR, \fB y\fR or \fB z\fR
142
143 .BI "\-[no]ten"  "no    "
144  Calculate the full tensor
145
146 .BI "\-ngroup"  " int" " 1" 
147  Number of groups to calculate MSD for
148
149 .BI "\-[no]mw"  "yes   "
150  Mass weighted MSD
151
152 .BI "\-[no]rmcomm"  "no    "
153  Remove center of mass motion
154
155 .BI "\-tpdb"  " time" " 0     " 
156  The frame to use for option \fB \-pdb\fR (ps)
157
158 .BI "\-trestart"  " time" " 10    " 
159  Time between restarting points in trajectory (ps)
160
161 .BI "\-beginfit"  " time" " \-1    " 
162  Start time for fitting the MSD (ps), \-1 is 10%
163
164 .BI "\-endfit"  " time" " \-1    " 
165  End time for fitting the MSD (ps), \-1 is 90%
166
167 .SH SEE ALSO
168 .BR gromacs(7)
169
170 More information about \fBGROMACS\fR is available at <\fIhttp://www.gromacs.org/\fR>.