| torsionInterpolPot |
index |
Interpolated Torsion Angle Energy Terms
TorsionInterpolPot1D - 1D torsion angle energy (depends on a single torsion angle)
TorsionInterpolPot2D - 2D torsion angle energy (depends on two torsion angles)
TorsionInterpolPot3D - 3D torsion angle energy (depends on three torsion angle)
Constructors:
TorsionInterpolPot1D(instanceName,
angle1vals,
scalars,
simulation)
TorsionInterpolPot2D(instanceName,
angle1vals,
angle2vals,
scalars,
simulation)
TorsionInterpolPot3D(instanceName,
angle1vals,
angle2vals,
angle3vals,
scalars,
simulation)
instanceName is a user-specified identifier. The energy term is defined by
the angle1vals, angle2vals, angle3vals and scalars arguments which
specify angle values (in degrees) on a 1-, 2- or 3-dimensional grid
and corresponding energy values, respectively. The angle values
should cover the range -180 to 180, and the scalar values should have the
dimensions len(angle1vals), len(angle1vals)*len(angle2vals), or
len(angle1vals)*len(angle2vals)*len(angle3vals), respectively,
corresponding to energy values on the grid of appropriate
dimension. The energy values on the edges of the grids should be
repeat. For example, for TorsionInterpoPo1D, scalars[0] = scalars[-1]
The argument simulation is an optional simulation.Simulation
specification (defaults to the current Simulation).
For each term, the energy is a smooth function of the ange values,
with the surface represented by cubic spline (1D) or bicubic
interpolation 2D or tricubic interpolation (3D) implemented using
spline.Spline, spline.Spline2D, or spline3D.Spline3D.
Members:
noPotSummary
Methods:
calcEnergy() - calc energy, returns the energy value.
calcEnergyAndDerivs(derivs) - calc energy, derivs, returns the energy value.
void addRestraints(restraints) - argument is a string specifying
to which angles the term applies.
violations() - return number of violations
rms() - not implemented (returns -1)
numRestraints() - return the number of restraints defined for this term.
simulation() - return the associated simulation
String info();
restraints() - return the list of restraints. See the description of the
Restraint class below. The string consists of the following:
name nameString
assign (sel1) (sel2) (sel3) (sel4)
The name statement is used to specify a name for the restraint
(by default the name is the index of the restraint).
The assign statement takes four atom selections comprising a
single atom each (see atomSelLang), which define a
torsion angle.
surf(angleSpec) - return the raw energy surface value corresponding to
the specified angleSpec value (angle1),
(angle1,angle2), or (angle1,angle2,angle3)
surfderiv(angleSpec) - return the gradient of angleSpec. The return
value will be a scalar, or a 2- or 3-membered
sequence.
The following parameters can be set
[defaults in square brackets]
comment - comment for this energy term
verbose - if true, sporadically spit out info [False]
Restraint Classes
TorsionInterpolPot1D_Restraint
TorsionInterpolPot2D_Restraint
TorsionInterpolPot3D_Restraint
These objects are created by their respective Pot term.
Methods:
energy() - energy associated with this Restraint
deriv(derivs) - compute derivs and update the derivs DerivList.DerivList
object.
Members:
angle1 - a Dihedral.Dihedral object
angle1val - torsion angle in degrees.
for TorsionInterpolPot2D_Restraint, TorsionInterpolPot3D_Restraint:
angle2 - a Dihedral.Dihedral object
angle2val - torsion angle in degrees.
for TorsionInterpolPot3D_Restraint
angle3 - a Dihedral.Dihedral object
angle3val - torsion angle in degrees.
# 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.
| Classes | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Functions | ||
| ||