man/man1/genion.1

   1 .TH genion 1 "Mon 4 Apr 2011" "" "GROMACS suite, VERSION 4.5.4-dev-20110404-3c0e5ec"
   2 .SH NAME
   3 genion - generates mono atomic ions on energetically favorable positions
   4
   5 .B VERSION 4.5.4-dev-20110404-3c0e5ec
   6 .SH SYNOPSIS
   7 \f3genion\fP
   8 .BI "\-s" " topol.tpr "
   9 .BI "\-table" " table.xvg "
  10 .BI "\-n" " index.ndx "
  11 .BI "\-o" " out.gro "
  12 .BI "\-g" " genion.log "
  13 .BI "\-pot" " pot.pdb "
  14 .BI "\-p" " topol.top "
  15 .BI "\-[no]h" ""
  16 .BI "\-[no]version" ""
  17 .BI "\-nice" " int "
  18 .BI "\-xvg" " enum "
  19 .BI "\-np" " int "
  20 .BI "\-pname" " string "
  21 .BI "\-pq" " int "
  22 .BI "\-nn" " int "
  23 .BI "\-nname" " string "
  24 .BI "\-nq" " int "
  25 .BI "\-rmin" " real "
  26 .BI "\-[no]random" ""
  27 .BI "\-seed" " int "
  28 .BI "\-scale" " real "
  29 .BI "\-conc" " real "
  30 .BI "\-[no]neutral" ""
  31 .SH DESCRIPTION
  32 \&\fB genion\fR replaces solvent molecules by monoatomic ions at
  33 \&the position of the first atoms with the most favorable electrostatic
  34 \&potential or at random. The potential is calculated on all atoms, using
  35 \&normal GROMACS particle\-based methods (in contrast to other methods
  36 \&based on solving the Poisson\-Boltzmann equation).
  37 \&The potential is recalculated after every ion insertion.
  38 \&If specified in the run input file, a reaction field, shift function
  39 \&or user function can be used. For the user function a table file
  40 \&can be specified with the option \fB \-table\fR.
  41 \&The group of solvent molecules should be continuous and all molecules
  42 \&should have the same number of atoms.
  43 \&The user should add the ion molecules to the topology file or use
  44 \&the \fB \-p\fR option to automatically modify the topology.
  45
  46
  47 \&The ion molecule type, residue and atom names in all force fields
  48 \&are the capitalized element names without sign. This molecule name
  49 \&should be given with \fB \-pname\fR or \fB \-nname\fR, and the
  50 \&\fB [molecules]\fR section of your topology updated accordingly,
  51 \&either by hand or with \fB \-p\fR. Do not use an atom name instead!
  52 \&
  53
  54 Ions which can have multiple charge states get the multiplicity
  55 \&added, without sign, for the uncommon states only.
  56
  57
  58 \&With the option \fB \-pot\fR the potential can be written as B\-factors
  59 \&in a \fB .pdb\fR file (for visualisation using e.g. Rasmol).
  60 \&The unit of the potential is 1000 kJ/(mol e), the scaling be changed
  61 \&with the \fB \-scale\fR option.
  62
  63
  64 \&For larger ions, e.g. sulfate we recommended using \fB genbox\fR.
  65 .SH FILES
  66 .BI "\-s" " topol.tpr"
  67 .B Input
  68  Run input file: tpr tpb tpa
  69
  70 .BI "\-table" " table.xvg"
  71 .B Input, Opt.
  72  xvgr/xmgr file
  73
  74 .BI "\-n" " index.ndx"
  75 .B Input, Opt.
  76  Index file
  77
  78 .BI "\-o" " out.gro"
  79 .B Output
  80  Structure file: gro g96 pdb etc.
  81
  82 .BI "\-g" " genion.log"
  83 .B Output
  84  Log file
  85
  86 .BI "\-pot" " pot.pdb"
  87 .B Output, Opt.
  88  Protein data bank file
  89
  90 .BI "\-p" " topol.top"
  91 .B In/Out, Opt.
  92  Topology file
  93
  94 .SH OTHER OPTIONS
  95 .BI "\-[no]h"  "no    "
  96  Print help info and quit
  97
  98 .BI "\-[no]version"  "no    "
  99  Print version info and quit
 100
 101 .BI "\-nice"  " int" " 19"
 102  Set the nicelevel
 103
 104 .BI "\-xvg"  " enum" " xmgrace"
 105  xvg plot formatting: \fB xmgrace\fR, \fB xmgr\fR or \fB none\fR
 106
 107 .BI "\-np"  " int" " 0"
 108  Number of positive ions
 109
 110 .BI "\-pname"  " string" " NA"
 111  Name of the positive ion
 112
 113 .BI "\-pq"  " int" " 1"
 114  Charge of the positive ion
 115
 116 .BI "\-nn"  " int" " 0"
 117  Number of negative ions
 118
 119 .BI "\-nname"  " string" " CL"
 120  Name of the negative ion
 121
 122 .BI "\-nq"  " int" " \-1"
 123  Charge of the negative ion
 124
 125 .BI "\-rmin"  " real" " 0.6   "
 126  Minimum distance between ions
 127
 128 .BI "\-[no]random"  "yes   "
 129  Use random placement of ions instead of based on potential. The rmin option should still work
 130
 131 .BI "\-seed"  " int" " 1993"
 132  Seed for random number generator
 133
 134 .BI "\-scale"  " real" " 0.001 "
 135  Scaling factor for the potential for \fB \-pot\fR
 136
 137 .BI "\-conc"  " real" " 0     "
 138  Specify salt concentration (mol/liter). This will add sufficient ions to reach up to the specified concentration as computed from the volume of the cell in the input \fB .tpr\fR file. Overrides the \fB \-np\fR and \fB \-nn\fR options.
 139
 140 .BI "\-[no]neutral"  "no    "
 141  This option will add enough ions to neutralize the system. In combination with the concentration option a neutral system at a given salt concentration will be generated.
 142
 143 .SH KNOWN PROBLEMS
 144 \- Calculation of the potential is not reliable, therefore the \fB \-random\fR option is now turned on by default.
 145
 146 \- If you specify a salt concentration existing ions are not taken into account. In effect you therefore specify the amount of salt to be added.
 147
 148 .SH SEE ALSO
 149 .BR gromacs(7)
 150
 151 More information about \fBGROMACS\fR is available at <\fIhttp://www.gromacs.org/\fR>.