updated FindCUDA to version from cmake 2.8.1 for CUDA 2.3 support
[gromacs/rigid-bodies.git] / man / man1 / g_rotacf.1
blob2543ef7532609065757e0f60aa95764fe8c1b22c
1 .TH g_rotacf 1 "Thu 16 Oct 2008"
2 .SH NAME
3 g_rotacf - calculates the rotational correlation function for molecules
5 .B VERSION 4.0
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 "-nice" " int "
14 .BI "-b" " time "
15 .BI "-e" " time "
16 .BI "-dt" " time "
17 .BI "-[no]w" ""
18 .BI "-[no]xvgr" ""
19 .BI "-[no]d" ""
20 .BI "-[no]aver" ""
21 .BI "-acflen" " int "
22 .BI "-[no]normalize" ""
23 .BI "-P" " enum "
24 .BI "-fitfn" " enum "
25 .BI "-ncskip" " int "
26 .BI "-beginfit" " real "
27 .BI "-endfit" " real "
28 .SH DESCRIPTION
29 g_rotacf calculates the rotational correlation function
30 for molecules. Three atoms (i,j,k) must be given in the index
31 file, defining two vectors ij and jk. The rotational acf
32 is calculated as the autocorrelation function of the vector
33 n = ij x jk, i.e. the cross product of the two vectors.
34 Since three atoms span a plane, the order of the three atoms
35 does not matter. Optionally, controlled by the -d switch, you can
36 calculate the rotational correlation function for linear molecules
37 by specifying two atoms (i,j) in the index file.
41 EXAMPLES
44 g_rotacf -P 1 -nparm 2 -fft -n index -o rotacf-x-P1
45 -fa expfit-x-P1 -beginfit 2.5 -endfit 20.0
48 This will calculate the rotational correlation function using a first
49 order Legendre polynomial of the angle of a vector defined by the index
50 file. The correlation function will be fitted from 2.5 ps till 20.0 ps
51 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 
58 .BI "-s" " topol.tpr" 
59 .B Input
60  Run input file: tpr tpb tpa 
62 .BI "-n" " index.ndx" 
63 .B Input
64  Index file 
66 .BI "-o" " rotacf.xvg" 
67 .B Output
68  xvgr/xmgr file 
70 .SH OTHER OPTIONS
71 .BI "-[no]h"  "no    "
72  Print help info and quit
74 .BI "-nice"  " int" " 19" 
75  Set the nicelevel
77 .BI "-b"  " time" " 0     " 
78  First frame (ps) to read from trajectory
80 .BI "-e"  " time" " 0     " 
81  Last frame (ps) to read from trajectory
83 .BI "-dt"  " time" " 0     " 
84  Only use frame when t MOD dt = first time (ps)
86 .BI "-[no]w"  "no    "
87  View output xvg, xpm, eps and pdb files
89 .BI "-[no]xvgr"  "yes   "
90  Add specific codes (legends etc.) in the output xvg files for the xmgrace program
92 .BI "-[no]d"  "no    "
93  Use index doublets (vectors) for correlation function instead of triplets (planes)
95 .BI "-[no]aver"  "yes   "
96  Average over molecules
98 .BI "-acflen"  " int" " -1" 
99  Length of the ACF, default is half the number of frames
101 .BI "-[no]normalize"  "yes   "
102  Normalize ACF
104 .BI "-P"  " enum" " 0" 
105  Order of Legendre polynomial for ACF (0 indicates none): 
106 .B 0
108 .B 1
110 .B 2
111 or 
112 .B 3
115 .BI "-fitfn"  " enum" " none" 
116  Fit function: 
117 .B none
119 .B exp
121 .B aexp
123 .B exp_exp
125 .B vac
127 .B exp5
129 .B exp7
130 or 
131 .B exp9
134 .BI "-ncskip"  " int" " 0" 
135  Skip N points in the output file of correlation functions
137 .BI "-beginfit"  " real" " 0     " 
138  Time where to begin the exponential fit of the correlation function
140 .BI "-endfit"  " real" " -1    " 
141  Time where to end the exponential fit of the correlation function, -1 is till the end