An official website of the United States government

Here’s how you know

Here’s how you know

Search Site

Purely repulsive nonbonded term. This has the functional form which
depends on internuclear distance in piecewise quartic fashion.
 
   Nilges, M., Clore, G.M. and Gronenborn, A.M., ``Determination
   of three-dimensional structures of proteins from interproton
   distance data by hybrid distance geometry-dynamical simulated
   annealing calculations,'' FEBS Lett 229, 317-324 (1988).
 
 
Please use repelPotTools.create_repelPotTools to instantiate
instances of this potential term.
 
 
Constructor:
  RepelPot(instanceName,
           vdwParams,
           resExclusions,
           nbfixParams,
           selection)
 
  instanceName is a user-specified identifier, vdwParams is a map of
  atom chemical types to a list of a tuple of (eps, sigma, eps14,
  sigma14), where epsilon is a vdw well depth (unused in this term)
  and sigma is the equilibrium interatomic distance. The 14 versions
  are special values to use for atoms which are separated by three
  covalent bonds. resExclusions is a dictionary which contains pairs
  of atom names whose interactions are not to be computed. Normally,
  the interatomic distance at which the energy becomes nonzero is
  computed using the types of the two atoms involved, but exceptions
  to this rule can be specified by nbfixParams which is a dictionary
  with keys consisting of chemical types separated by the '*'
  character. The values in the dictionary is the tuple of VDW
  parameters (A,B, A14, B14). From these values sigma and sigma14 are
  computed. selection is an optional argument specifying which atoms
  in which simulation.Simulation this term should compute
  interactions for.
 
methods:
 
  calcEnergy()     - compute and return associated, scaled energy.
 
  simulation()     - return the associated Simulation.
 
  violations()     - return the number of contacts closer than threshold()
                     in all selection pairs.
 
  info()           - return an informational string.
 
  atomEnergies()   - contributions to inidivual energies - not yet supported.
 
  maxRadius()      - return the largest atomic radius
 
  typedef Pair<AtomSel,AtomSel> SelectionPair;
 
  numSelectionPairs()         - return the number of selection pairs.
 
  selectionPairs()            - return a list of selection pairs.
                         
  addSelectionPair(sel1,sel2) - add pair of atomSel.AtomSel objects
                                to compute nonbonded interactions between.
 
  setSelectionPairWeight(index
                         val) - specify a weight for the selection
                                pair identified by index.
 
  selectionPairWeight(index)  - return the associated selection pair weight.
  selectionPairEnergy(index)  - return the energy of the selection pair 
                                identified by index.
 
  nbExclusions()              - a list of lists of indices of excluded
                                interactions, indexed by atom index.
 
  deleteSelectionPair(index)  - delete the specified selection pair.
 
  resetSelectionPairs()- delete all selection pairs, and add back only
                         the default: interactions between all atoms
 
  bumps(selPairIndex)  - a list of close contacts (RepelBumps - see below),
                         closer than threshold() of the sum of the atomic
                         radii. The argument specifies a selection
                         pair index, and a negative value specifies that all 
                         selection pairs are to be reported on. [-1]
 
  neighborInfo(atom)   - return string with info about atoms in the neighbor list
                         of the specified atom. Note that if atom 1 is in atom
                         2's neighbor list, atom 2 will not be in atom 1's list.
 
  contactDistance(atom1, - given two atoms, report the distance at which
                  atom2)   the energy goes to zero.
 
  restraints()         - Return a sum of bumps() over all selection pairs.
 
 The following parameters can be set [defaults in square brackets]
 
    scale             - scale factor for energy.
    threshold         - 
    moveTol           - size of atomic displacement above which
                        recalculation of the nonbond list is
                        recalculated.
    e14Factor         - extra multiplicative factor for the 1-4
                        interaction 1.0].
    repel             - radius scale factor - see below [1.0].
    use14             - whether to disable 14 interactions
                        entirely [False].
    rMin              - smallest distance allowed for the interatomic distance
                        R [0.001]. 
 
    verbose           - a boolean describing whether or not to print
                        detailed information on the neighbor lists [False].
 
 the above quantities may be retrieved using the member function form
 quantity(), while they are set using the form setQuantity(value).
 
 
 
The energy is written as a sum over all atom pairs of
 
                /
  E =  scale * | ( max(rMin,R)^2 - (S R_0)^2 )^2  , for R < S R_0
               | 0                      , otherwise
                \
 
where R = | q_i - q_j |, R_0 is the sum of atomic radii specific to
the two nuclei, or specified by nxfixParams, and S is a scale factor
given by repel().
 
Each RepelBump contains the following members:
 
  atomi,
  atomj    - atoms defining the interaction
  dist     - the current intermolecular distance
  dist0    - the nominal distance (R_0) for these atoms.
  energy   - the associated, scaled energy
 
and these methods:
 
  name()     - a name for this interaction identifying the two atoms.
  diff()     - dist - dist0
  violated() - always returns True
 
 
 
# This file was automatically generated by SWIG (http://www.swig.org).
# Version 4.0.2
#
# Do not make changes to this file unless you know what you are doing--modify
# the SWIG interface file instead.