Added 1 analysis tool manual.
[gromacs/rigid-bodies.git] / man / man1 / g_sorient.1
blob42b95d41233e1950ca21d1e9a5d3f32825df250d
1 .TH g_sorient 1 "Mon 4 Apr 2011" "" "GROMACS suite, VERSION 4.5.4-dev-20110404-3c0e5ec"
2 .SH NAME
3 g_sorient - analyzes solvent orientation around solutes
5 .B VERSION 4.5.4-dev-20110404-3c0e5ec
6 .SH SYNOPSIS
7 \f3g_sorient\fP
8 .BI "\-f" " traj.xtc "
9 .BI "\-s" " topol.tpr "
10 .BI "\-n" " index.ndx "
11 .BI "\-o" " sori.xvg "
12 .BI "\-no" " snor.xvg "
13 .BI "\-ro" " sord.xvg "
14 .BI "\-co" " scum.xvg "
15 .BI "\-rc" " scount.xvg "
16 .BI "\-[no]h" ""
17 .BI "\-[no]version" ""
18 .BI "\-nice" " int "
19 .BI "\-b" " time "
20 .BI "\-e" " time "
21 .BI "\-dt" " time "
22 .BI "\-[no]w" ""
23 .BI "\-xvg" " enum "
24 .BI "\-[no]com" ""
25 .BI "\-[no]v23" ""
26 .BI "\-rmin" " real "
27 .BI "\-rmax" " real "
28 .BI "\-cbin" " real "
29 .BI "\-rbin" " real "
30 .BI "\-[no]pbc" ""
31 .SH DESCRIPTION
32 \&\fB g_sorient\fR analyzes solvent orientation around solutes.
33 \&It calculates two angles between the vector from one or more
34 \&reference positions to the first atom of each solvent molecule:
37 \&[GRK]theta[grk]1: the angle with the vector from the first atom of the solvent
38 \&molecule to the midpoint between atoms 2 and 3.
40 \&[GRK]theta[grk]2: the angle with the normal of the solvent plane, defined by the
41 \&same three atoms, or, when the option \fB \-v23\fR is set, 
42 \&the angle with the vector between atoms 2 and 3.
45 \&The reference can be a set of atoms or
46 \&the center of mass of a set of atoms. The group of solvent atoms should
47 \&consist of 3 atoms per solvent molecule.
48 \&Only solvent molecules between \fB \-rmin\fR and \fB \-rmax\fR are
49 \&considered for \fB \-o\fR and \fB \-no\fR each frame.
52 \&\fB \-o\fR: distribtion of cos([GRK]theta[grk]1) for rmin=r=rmax.
55 \&\fB \-no\fR: distribution of cos([GRK]theta[grk]2) for rmin=r=rmax.
58 \&\fB \-ro\fR: cos([GRK]theta[grk]1) and 3cos2([GRK]theta[grk]2)\-1 as a function of the
59 \&distance.
62 \&\fB \-co\fR: the sum over all solvent molecules within distance r
63 \&of cos([GRK]theta[grk]1) and 3cos2([GRK]theta[grk]2)\-1 as a function of r.
66 \&\fB \-rc\fR: the distribution of the solvent molecules as a function of r
67 .SH FILES
68 .BI "\-f" " traj.xtc" 
69 .B Input
70  Trajectory: xtc trr trj gro g96 pdb cpt 
72 .BI "\-s" " topol.tpr" 
73 .B Input
74  Structure+mass(db): tpr tpb tpa gro g96 pdb 
76 .BI "\-n" " index.ndx" 
77 .B Input, Opt.
78  Index file 
80 .BI "\-o" " sori.xvg" 
81 .B Output
82  xvgr/xmgr file 
84 .BI "\-no" " snor.xvg" 
85 .B Output
86  xvgr/xmgr file 
88 .BI "\-ro" " sord.xvg" 
89 .B Output
90  xvgr/xmgr file 
92 .BI "\-co" " scum.xvg" 
93 .B Output
94  xvgr/xmgr file 
96 .BI "\-rc" " scount.xvg" 
97 .B Output
98  xvgr/xmgr file 
100 .SH OTHER OPTIONS
101 .BI "\-[no]h"  "no    "
102  Print help info and quit
104 .BI "\-[no]version"  "no    "
105  Print version info and quit
107 .BI "\-nice"  " int" " 19" 
108  Set the nicelevel
110 .BI "\-b"  " time" " 0     " 
111  First frame (ps) to read from trajectory
113 .BI "\-e"  " time" " 0     " 
114  Last frame (ps) to read from trajectory
116 .BI "\-dt"  " time" " 0     " 
117  Only use frame when t MOD dt = first time (ps)
119 .BI "\-[no]w"  "no    "
120  View output \fB .xvg\fR, \fB .xpm\fR, \fB .eps\fR and \fB .pdb\fR files
122 .BI "\-xvg"  " enum" " xmgrace" 
123  xvg plot formatting: \fB xmgrace\fR, \fB xmgr\fR or \fB none\fR
125 .BI "\-[no]com"  "no    "
126  Use the center of mass as the reference postion
128 .BI "\-[no]v23"  "no    "
129  Use the vector between atoms 2 and 3
131 .BI "\-rmin"  " real" " 0     " 
132  Minimum distance (nm)
134 .BI "\-rmax"  " real" " 0.5   " 
135  Maximum distance (nm)
137 .BI "\-cbin"  " real" " 0.02  " 
138  Binwidth for the cosine
140 .BI "\-rbin"  " real" " 0.02  " 
141  Binwidth for r (nm)
143 .BI "\-[no]pbc"  "no    "
144  Check PBC for the center of mass calculation. Only necessary when your reference group consists of several molecules.
146 .SH SEE ALSO
147 .BR gromacs(7)
149 More information about \fBGROMACS\fR is available at <\fIhttp://www.gromacs.org/\fR>.