Document correct comm_mode option
[gromacs.git] / share / html / online / genpr.html
blob51d3e8a9019ec299332bede832967f34ccd2cf9a
1 <HTML>
2 <HEAD>
3 <TITLE>genpr</TITLE>
4 <LINK rel=stylesheet href="style.css" type="text/css">
5 <BODY text="#000000" bgcolor="#FFFFFF" link="#0000FF" vlink="#990000" alink="#FF0000">
6 <TABLE WIDTH="98%" NOBORDER >
7 <TR><TD WIDTH=400>
8 <TABLE WIDTH=400 NOBORDER>
9 <TD WIDTH=116>
10 <a href="http://www.gromacs.org/"><img SRC="../images/gmxlogo_small.jpg"BORDER=0 height=133 width=116></a></td>
11 <td ALIGN=LEFT VALIGN=TOP WIDTH=280><br><h2>genpr</h2><font size=-1><A HREF="../online.html">Main Table of Contents</A></font><br><br></td>
12 </TABLE></TD><TD WIDTH="*" ALIGN=RIGHT VALIGN=BOTTOM><p><B>VERSION 4.0<br>
13 Sun 18 Jan 2009</B></td></tr></TABLE>
14 <HR>
15 <H3>Description</H3>
16 <p>
17 genpr produces an include file for a topology containing
18 a list of atom numbers and three force constants for the
19 X, Y and Z direction. A single isotropic force constant may
20 be given on the command line instead of three components.<p>
21 WARNING: genpr only works for the first molecule.
22 Position restraints are interactions within molecules, therefore
23 they should be included within the correct <tt>[ moleculetype ]</tt>
24 block in the topology. Since the atom numbers in every moleculetype
25 in the topology start at 1 and the numbers in the input file for
26 genpr number consecutively from 1, genpr will only produce a useful
27 file for the first molecule.<p>
28 The -of option produces an index file that can be used for
29 freezing atoms. In this case the input file must be a <a href="pdb.html">pdb</a> file.
30 <P>
31 <H3>Files</H3>
32 <TABLE BORDER=1 CELLSPACING=0 CELLPADDING=2>
33 <TR><TH>option</TH><TH>filename</TH><TH>type</TH><TH>description</TH></TR>
34 <TR><TD ALIGN=RIGHT> <b><tt>-f</tt></b> </TD><TD ALIGN=RIGHT> <tt><a href="files.html"> conf.gro</a></tt> </TD><TD> Input </TD><TD> Generic structure: <a href="gro.html">gro</a> <a href="g96.html">g96</a> <a href="pdb.html">pdb</a> <a href="tpr.html">tpr</a> <a href="tpb.html">tpb</a> <a href="tpa.html">tpa</a> xml </TD></TR>
35 <TR><TD ALIGN=RIGHT> <b><tt>-n</tt></b> </TD><TD ALIGN=RIGHT> <tt><a href="ndx.html"> index.ndx</a></tt> </TD><TD> Input, Opt. </TD><TD> Index file </TD></TR>
36 <TR><TD ALIGN=RIGHT> <b><tt>-o</tt></b> </TD><TD ALIGN=RIGHT> <tt><a href="itp.html"> posre.itp</a></tt> </TD><TD> Output </TD><TD> Include file for topology </TD></TR>
37 <TR><TD ALIGN=RIGHT> <b><tt>-of</tt></b> </TD><TD ALIGN=RIGHT> <tt><a href="ndx.html"> freeze.ndx</a></tt> </TD><TD> Output, Opt. </TD><TD> Index file </TD></TR>
38 </TABLE>
39 <P>
40 <H3>Other options</H3>
41 <TABLE BORDER=1 CELLSPACING=0 CELLPADDING=2>
42 <TR><TH>option</TH><TH>type</TH><TH>default</TH><TH>description</TH></TR>
43 <TR><TD ALIGN=RIGHT> <b><tt>-[no]h</tt></b> </TD><TD ALIGN=RIGHT> bool </TD><TD ALIGN=RIGHT> <tt> no</tt> </TD><TD> Print help info and quit </TD></TD>
44 <TR><TD ALIGN=RIGHT> <b><tt>-nice</tt></b> </TD><TD ALIGN=RIGHT> int </TD><TD ALIGN=RIGHT> <tt>0</tt> </TD><TD> Set the nicelevel </TD></TD>
45 <TR><TD ALIGN=RIGHT> <b><tt>-fc</tt></b> </TD><TD ALIGN=RIGHT> vector </TD><TD ALIGN=RIGHT> <tt>1000 1000 1000</tt> </TD><TD> force constants (kJ mol-1 nm-2) </TD></TD>
46 <TR><TD ALIGN=RIGHT> <b><tt>-freeze</tt></b> </TD><TD ALIGN=RIGHT> real </TD><TD ALIGN=RIGHT> <tt> 0</tt> </TD><TD> if the -of option or this one is given an index file will be written containing atom numbers of all atoms that have a B-factor less than the level given here </TD></TD>
47 </TABLE>
48 <P>
49 <hr>
50 <div ALIGN=RIGHT>
51 <font size="-1"><a href="http://www.gromacs.org">http://www.gromacs.org</a></font><br>
52 <font size="-1"><a href="mailto:gromacs@gromacs.org">gromacs@gromacs.org</a></font><br>
53 </div>
54 </BODY>