VirtualSite Class Reference

A VirtualSite describes the rules for computing a particle's position based on other particles. More...

Inheritance diagram for VirtualSite:

List of all members.

Public Member Functions
def	__init__
def	getNumParticles
	getNumParticles(self) -> int
def	getParticle
	getParticle(self, particle) -> int

---

Detailed Description

A VirtualSite describes the rules for computing a particle's position based on other particles.

This is an abstract class. Subclasses define particular rules. To define a virtual site, create an instance of a VirtualSite subclass and then call setVirtualSite() on the System.

---

Constructor & Destructor Documentation

def __init__	(		self,
			args,
			kwargs
	)

---

Member Function Documentation

def getNumParticles

(

self

)

getNumParticles(self) -> int

Get the number of particles this virtual site depends on.

def getParticle	(		self,
			particle
	)

getParticle(self, particle) -> int

Get the index of a particle this virtual site depends on.

Parameters:

particle

(int) the particle to get (between 0 and getNumParticles())

Returns:

(int) the index of the particle in the System

---

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

• openmm.py