TwoParticleAverageSite Class Reference

This is a VirtualSite that computes the particle location as a weighted average of two other particle's locations. More...

Inheritance diagram for TwoParticleAverageSite:

List of all members.

Public Member Functions
def	getWeight
	getWeight(self, particle) -> double
def	__init__
	__init__(self, particle1, particle2, weight1, weight2) -> TwoParticleAverageSite __init__(self, other) -> TwoParticleAverageSite
Public Attributes
	this

---

Detailed Description

This is a VirtualSite that computes the particle location as a weighted average of two other particle's locations.

Assuming the weights add up to 1, this means the virtual site is on the line passing through the two particles.

---

Constructor & Destructor Documentation

def __init__	(		self,
			args
	)

__init__(self, particle1, particle2, weight1, weight2) -> TwoParticleAverageSite __init__(self, other) -> TwoParticleAverageSite

Create a new TwoParticleAverageSite virtual site. Normally weight1 and weight2 should add up to 1, although this is not strictly required.

Parameters:

particle1	(int) the index of the first particle
particle2	(int) the index of the second particle
weight1	(double) the weight factor (between 0 and 1) for the first particle
weight2	(double) the weight factor (between 0 and 1) for the second particle

---

Member Function Documentation

def getWeight	(		self,
			particle
	)

getWeight(self, particle) -> double

Get the weight factor used for a particle this virtual site depends on.

Parameters:

particle

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

Returns:

(double) the weight factor used for that particle

---

Member Data Documentation

this

---

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

• openmm.py