Technical Documentation
POTENTIAL ENERGY FUNCTION: Introduction

The 14 existing and 7 future Energy modules implement the individual terms of the potential energy function. These terms quantify the interaction of groups of one to four atoms. Some terms are available in two versions: an Inclusion or an Exclusion version. Inclusion terms assume no interactions except those that are explicitly added to the term. Exclusion terms assume that all pair interactions are considered, except for those pairs that are explicitly excluded.

MODULE

POTENTIAL ENERGY TERM

EnergyID
[1]
[2]
[3]
[4]
Bonds

Bond

100001
2
N
B
E

Morse

100002
2
N
B
E
Angles

Angle

100003
3
N
B
E

Angle Power Series

100004
3
N
B
E
Torsions

Torsion (Cosine Series)

100005
4
N
B
E
Impropers

Improper Torsion

100007
4
N
B
E

Torsion Power Series

100006
4
N
B
E
SoftSphereI

Soft Sphere Inclusion

100009
2
N
U
E
SoftSphereX

Soft Sphere Exclusion

100008
2
X
U
E
ElectroI

Electrostatics Inclusion

100013
2
N
U
E
ElectroX

Electrostatics Exclusion

100012
2
X
U
E
VanderWaalsI

van der Waals Inclusion

100011
2
N
U
E
VanderWaalsX

van der Waals Exclusion

100010
2
X
U
E

Generalized Lennard-Jones Inclusion

100015
2
N
U
E

Generalized Lennard-Jones Exclusion

100014
2
X
U
E
Noens

Distance NOE

100016
2
N
UB
C
Hooke Hookean Bond Network 100019 2 N B E
Hand Chiral constraints for a Network 100022 4 N B C

Angle NOE

100017
3
N
UB
C

SwissCheeseX

Swiss Cheese

100020
1
X
U
C

Stud

100018
1
N
B
C

The explanations for the numbered columns are:

#

DESCRIPTION

[1]

Number of interacting atoms per term

[2]

Inclusion (N) or Exclusion (X) term.

[3]

Interaction amongst closely bonded (B) or non-bonded or unrelated atoms (U). Applying Periodic Boundaries has no affect on (B) terms but does affect (U) terms. (U) terms also make use of what is called a non-bond list that is updated regularly. (UB) terms recognize the Periodic Boundary but do not require a non-bond list update.

[4]

Primarily an energetic (E) term or primarily a constraint term (C)

All modules manage the parameters (force constants) for the term, allowing for the loading of parameter tables, reading of parameter sets and assigning new values to parameters. Each module also allows the creation, modification and deletion of groups of participating atoms. Finally, the most important function of these modules is to calculate the contribution of each term to the total potential energy and to the first derivatives.

Force Field Assembly

A molecular model is defined by a potential energy function. To create a model select the terms that you need and create a module for each. The modules can be created in any order and more than one instance of a particular module may be created. Each of the additional instances is independent of the other. The newly created instances should be saved in a list. You can manage this list yourself but it is easier to let the Potential module take care of this. The newly created modules are empty: Inclusion terms have no interactions but Exclusion terms assume all pair interactions. Force Field Assembly is the process of adding interacting groups to Inclusion terms and adding prohibited groups to the exclusion list of Exclusion terms. The details vary according to the model class (e.g., all-atom Protein model, reduced-representation RNA model) and the composition of the molecule (e.g., the amino-acid sequence, the secondary structure).

This process can be coded for each class of model. Then to assemble a force field, one need only supply a high level description of the model (e.g., amino-acid sequence, secondary structure) to the appropriate function.

All Energy modules are located in Yup.Energy.

OVERVIEW
Bonds
Angles
Torsions
SoftSphereI
ElectroI
VanderWaalsI
DistNOE
TorsionSeries
GenLJI
Potential
Hooke
Hand
Impropers
SoftSphereX
ElectroX
VanderWaalsX
SwissCheeseX
AngNOE
GenLJX

Technical
Introduction
Directory
Vectors
Energy
Model
Assembly
Methods
FPF
FFF
AVF
TaroScript
YammpScript
Python
Utilities

Home
Information
News
User
Technical
Programmer
iYup
Download
Showcase
ETC