OpenMM
BrownianIntegrator Class Reference

This is an Integrator which simulates a System using Brownian dynamics. More...

+ Inheritance diagram for BrownianIntegrator:

Public Member Functions

def getTemperature (self, args)
 getTemperature(BrownianIntegrator self) -> double More...
 
def setTemperature (self, args)
 setTemperature(BrownianIntegrator self, double temp) More...
 
def getFriction (self, args)
 getFriction(BrownianIntegrator self) -> double More...
 
def setFriction (self, args)
 setFriction(BrownianIntegrator self, double coeff) More...
 
def getRandomNumberSeed (self, args)
 getRandomNumberSeed(BrownianIntegrator self) -> int More...
 
def setRandomNumberSeed (self, args)
 setRandomNumberSeed(BrownianIntegrator self, int seed) More...
 
def step (self, args)
 step(BrownianIntegrator self, int steps) More...
 
def __init__ (self, args)
 init(OpenMM::BrownianIntegrator self, double temperature, double frictionCoeff, double stepSize) -> BrownianIntegrator init(OpenMM::BrownianIntegrator self, BrownianIntegrator other) -> BrownianIntegrator More...
 
def __del__ (self)
 del(OpenMM::BrownianIntegrator self) More...
 
- Public Member Functions inherited from Integrator
def __init__ (self, args, kwargs)
 
def __del__ (self)
 del(OpenMM::Integrator self) More...
 
def getStepSize (self, args)
 getStepSize(Integrator self) -> double More...
 
def setStepSize (self, args)
 setStepSize(Integrator self, double size) More...
 
def getConstraintTolerance (self, args)
 getConstraintTolerance(Integrator self) -> double More...
 
def setConstraintTolerance (self, args)
 setConstraintTolerance(Integrator self, double tol) More...
 
def step (self, args)
 step(Integrator self, int steps) More...
 
def __getstate__ (self)
 
def __setstate__ (self, serializationString)
 

Public Attributes

 this
 
- Public Attributes inherited from Integrator
 this
 

Detailed Description

This is an Integrator which simulates a System using Brownian dynamics.

Constructor & Destructor Documentation

def __init__ (   self,
  args 
)

init(OpenMM::BrownianIntegrator self, double temperature, double frictionCoeff, double stepSize) -> BrownianIntegrator init(OpenMM::BrownianIntegrator self, BrownianIntegrator other) -> BrownianIntegrator

Create a BrownianIntegrator.

Parameters
temperaturethe temperature of the heat bath (in Kelvin)
frictionCoeffthe friction coefficient which couples the system to the heat bath, measured in 1/ps
stepSizethe step size with which to integrate the system (in picoseconds)

References simtk.openmm.openmm.stripUnits().

def __del__ (   self)

del(OpenMM::BrownianIntegrator self)

References simtk.openmm.openmm.stripUnits().

Member Function Documentation

def getFriction (   self,
  args 
)

getFriction(BrownianIntegrator self) -> double

Get the friction coefficient which determines how strongly the system is coupled to the heat bath (in inverse ps).

References simtk.openmm.openmm.stripUnits().

def getRandomNumberSeed (   self,
  args 
)

getRandomNumberSeed(BrownianIntegrator self) -> int

Get the random number seed. See setRandomNumberSeed() for details.

References simtk.openmm.openmm.stripUnits().

def getTemperature (   self,
  args 
)

getTemperature(BrownianIntegrator self) -> double

Get the temperature of the heat bath (in Kelvin).

References simtk.openmm.openmm.stripUnits().

def setFriction (   self,
  args 
)

setFriction(BrownianIntegrator self, double coeff)

Set the friction coefficient which determines how strongly the system is coupled to the heat bath (in inverse ps).

Parameters
coeffthe friction coefficient, measured in 1/ps

References simtk.openmm.openmm.stripUnits().

def setRandomNumberSeed (   self,
  args 
)

setRandomNumberSeed(BrownianIntegrator self, int seed)

Set the random number seed. The precise meaning of this parameter is undefined, and is left up to each Platform to interpret in an appropriate way. It is guaranteed that if two simulations are run with different random number seeds, the sequence of random forces will be different. On the other hand, no guarantees are made about the behavior of simulations that use the same seed. In particular, Platforms are permitted to use non-deterministic algorithms which produce different results on successive runs, even if those runs were initialized identically.

If seed is set to 0 (which is the default value assigned), a unique seed is chosen when a Context is created from this Force. This is done to ensure that each Context receives unique random seeds without you needing to set them explicitly.

References simtk.openmm.openmm.stripUnits().

def setTemperature (   self,
  args 
)

setTemperature(BrownianIntegrator self, double temp)

Set the temperature of the heat bath (in Kelvin).

Parameters
tempthe temperature of the heat bath, measured in Kelvin.

References simtk.openmm.openmm.stripUnits().

def step (   self,
  args 
)

step(BrownianIntegrator self, int steps)

Advance a simulation through time by taking a series of time steps.

Parameters
stepsthe number of time steps to take

References simtk.openmm.openmm.stripUnits().

Member Data Documentation

this

Referenced by System.__init__().


The documentation for this class was generated from the following file: