Release 4.5.6
[alexxy/gromacs.git] / man / man1 / g_rotacf.1
1 .TH g_rotacf 1 "Fri 18 Jan 2013" "" "GROMACS suite, VERSION 4.5.6"
2 .SH NAME
3 g_rotacf - calculates the rotational correlation function for molecules
4
5 .B VERSION 4.5.6
6 .SH SYNOPSIS
7 \f3g_rotacf\fP
8 .BI "\-f" " traj.xtc "
9 .BI "\-s" " topol.tpr "
10 .BI "\-n" " index.ndx "
11 .BI "\-o" " rotacf.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]d" ""
21 .BI "\-[no]aver" ""
22 .BI "\-acflen" " int "
23 .BI "\-[no]normalize" ""
24 .BI "\-P" " enum "
25 .BI "\-fitfn" " enum "
26 .BI "\-ncskip" " int "
27 .BI "\-beginfit" " real "
28 .BI "\-endfit" " real "
29 .SH DESCRIPTION
30 \&\fB g_rotacf\fR calculates the rotational correlation function
31 \&for molecules. Atom triplets (i,j,k) must be given in the index
32 \&file, defining two vectors ij and jk. The rotational ACF
33 \&is calculated as the autocorrelation function of the vector
34 \&n = ij x jk, i.e. the cross product of the two vectors.
35 \&Since three atoms span a plane, the order of the three atoms
36 \&does not matter. Optionally, by invoking the \fB \-d\fR switch, you can
37 \&calculate the rotational correlation function for linear molecules
38 \&by specifying atom pairs (i,j) in the index file.
39 \&
40
41
42 \&EXAMPLES
43
44
45 \&\fB g_rotacf \-P 1 \-nparm 2 \-fft \-n index \-o rotacf\-x\-P1
46 \&\-fa expfit\-x\-P1 \-beginfit 2.5 \-endfit 20.0\fR
47
48
49 \&This will calculate the rotational correlation function using a first
50 \&order Legendre polynomial of the angle of a vector defined by the index
51 \&file. The correlation function will be fitted from 2.5 ps until 20.0 ps
52 \&to a two\-parameter exponential.
53 .SH FILES
54 .BI "\-f" " traj.xtc" 
55 .B Input
56  Trajectory: xtc trr trj gro g96 pdb cpt 
57
58 .BI "\-s" " topol.tpr" 
59 .B Input
60  Run input file: tpr tpb tpa 
61
62 .BI "\-n" " index.ndx" 
63 .B Input
64  Index file 
65
66 .BI "\-o" " rotacf.xvg" 
67 .B Output
68  xvgr/xmgr file 
69
70 .SH OTHER OPTIONS
71 .BI "\-[no]h"  "no    "
72  Print help info and quit
73
74 .BI "\-[no]version"  "no    "
75  Print version info and quit
76
77 .BI "\-nice"  " int" " 19" 
78  Set the nicelevel
79
80 .BI "\-b"  " time" " 0     " 
81  First frame (ps) to read from trajectory
82
83 .BI "\-e"  " time" " 0     " 
84  Last frame (ps) to read from trajectory
85
86 .BI "\-dt"  " time" " 0     " 
87  Only use frame when t MOD dt = first time (ps)
88
89 .BI "\-[no]w"  "no    "
90  View output \fB .xvg\fR, \fB .xpm\fR, \fB .eps\fR and \fB .pdb\fR files
91
92 .BI "\-xvg"  " enum" " xmgrace" 
93  xvg plot formatting: \fB xmgrace\fR, \fB xmgr\fR or \fB none\fR
94
95 .BI "\-[no]d"  "no    "
96  Use index doublets (vectors) for correlation function instead of triplets (planes)
97
98 .BI "\-[no]aver"  "yes   "
99  Average over molecules
100
101 .BI "\-acflen"  " int" " \-1" 
102  Length of the ACF, default is half the number of frames
103
104 .BI "\-[no]normalize"  "yes   "
105  Normalize ACF
106
107 .BI "\-P"  " enum" " 0" 
108  Order of Legendre polynomial for ACF (0 indicates none): \fB 0\fR, \fB 1\fR, \fB 2\fR or \fB 3\fR
109
110 .BI "\-fitfn"  " enum" " none" 
111  Fit function: \fB none\fR, \fB exp\fR, \fB aexp\fR, \fB exp_exp\fR, \fB vac\fR, \fB exp5\fR, \fB exp7\fR, \fB exp9\fR or \fB erffit\fR
112
113 .BI "\-ncskip"  " int" " 0" 
114  Skip this many points in the output file of correlation functions
115
116 .BI "\-beginfit"  " real" " 0     " 
117  Time where to begin the exponential fit of the correlation function
118
119 .BI "\-endfit"  " real" " \-1    " 
120  Time where to end the exponential fit of the correlation function, \-1 is until the end
121
122 .SH SEE ALSO
123 .BR gromacs(7)
124
125 More information about \fBGROMACS\fR is available at <\fIhttp://www.gromacs.org/\fR>.