Technical Documentation
SCRIPTING THE YAMMP MODULE: Run

The Run functions described in this page can be called only after the setup() function. Run functions can be mixed with calls to the Modify functions. Some functions return a result code.

These three functions take one argument each and no keywords. The behavior of these functions may be modified using the appropriate Modify functions.

Function
Summary
Return Values
dynamics()
integrate the equations of motion to the specified number of steps
1 if criterion met, 0 otherwise
Keyword
Argument
Type or Values
Interpretation
Initial Value
.
#1
Unsigned
number of steps
#0
Function
Summary
Return Values
minimize()
minimize the energy to the specified number of steps or perhaps fewer
1 if criterion met, 0 otherwise
Keyword
Argument
Type or Values
Interpretation
Initial Value
.
#1
Unsigned
number of steps
#0
Function
Summary
Return Values
montecarlo()
carry out a Monte Carlo simulation to the specified number of steps
1 if criterion met, 0 otherwise
Keyword
Argument
Type or Values
Interpretation
Initial Value
.
#1
Unsigned
number of steps
#0

These last remaining functions do not have arguments. Note that you still have to write an empty pair of parentheses after the function name. If you leave out the parentheses, you may still have a legal Python statement but it is probably not what you intend.

Except for the first and last, these functions do not return any values.

Function
Summary
Return Values
archive()
archive the current coordinates and/or velocities now
1 if OK, 0 otherwise
updatelist()
update the non-bond lists now
#0
backup()
copy current coordinates to memory
#0
restore()
replace coordinates with backup copy
#0
center()
move the molecule so that the center of mass is at the origin
#0
energies()
print the energies on the standard output
#0
energy_rmsgrad()
return energy and RMS gradient in traditional units
( #f, #g )

backup() must be called before restore(). For each call to backup(), restore() may be called multiple times. Note that non-bond list update and archive intervals can also be set to occur at regular and independent intervals within the Molecular Dynamics, Energy Minimization and Monte Carlo methods.

Notes:
#0 : None
#1 : this argument does not have a keyword
#f : potential energy [kcal/mol]
#g : RMS gradient [kcal/mol/Å]

Introduction
Python
Examples

setup()
setenviron()
editdynamics()
editminimizers()
editlinesearch()
editmontecarlo()
editnonbonds()
editconstraint()
editcontra()
Run

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