Force Class Reference

Force objects apply forces to the particles in a System, or alter their behavior in other ways. More...

Inheritance diagram for Force:

List of all members.

Public Member Functions
def	__init__
def	getForceGroup
	getForceGroup(self) -> int
def	setForceGroup
	Set the force group this Force belongs to.
def	usesPeriodicBoundaryConditions
	usesPeriodicBoundaryConditions(self) -> bool
def	__getstate__
def	__setstate__
def	__deepcopy__
def	__copy__
	__copy__(self) -> Force
Public Attributes
	this

---

Detailed Description

Force objects apply forces to the particles in a System, or alter their behavior in other ways.

This is an abstract class. Subclasses define particular forces.

More specifically, a Force object can do any or all of the following:

• Add a contribution to the force on each particle
• Add a contribution to the potential energy of the System
• Modify the positions and velocities of particles at the start of each time step
• Define parameters which are stored in the Context and can be modified by the user
• Change the values of parameters defined by other Force objects at the start of each time step

Forces may be organized into "force groups". This is used for multiple time step integration, and allows subsets of the Forces in a System to be evaluated at different times. By default, all Forces are in group 0. Call setForceGroup() to change this. Some Force subclasses may provide additional methods to further split their computations into multiple groups. Be aware that particular Platforms may place restrictions on the use of force groups, such as requiring all nonbonded forces to be in the same group.

---

Constructor & Destructor Documentation

def __init__	(		self,
			args,
			kwargs
	)

---

Member Function Documentation

def __copy__

(

self

)

__copy__(self) -> Force

def __deepcopy__	(		self,
			memo
	)

def __getstate__

(

self

)

def __setstate__	(		self,
			serializationString
	)

def getForceGroup

(

self

)

getForceGroup(self) -> int

Get the force group this Force belongs to.

def setForceGroup	(		self,
			group
	)

Set the force group this Force belongs to.

Parameters:

group

(int) the group index. Legal values are between 0 and 31 (inclusive).

def usesPeriodicBoundaryConditions

(

self

)

usesPeriodicBoundaryConditions(self) -> bool

Returns whether or not this force makes use of periodic boundary conditions. This method should be overridden for all Force subclasses, or a OpenMM::OpenMMException will be thrown

Returns:

(bool) true if Force uses periodic boundaries or false if it does not

Reimplemented in RPMDMonteCarloBarostat, RBTorsionForce, PeriodicTorsionForce, NonbondedForce, MonteCarloMembraneBarostat, MonteCarloBarostat, MonteCarloAnisotropicBarostat, HarmonicBondForce, HarmonicAngleForce, GBSAOBCForce, DrudeForce, CustomTorsionForce, CustomNonbondedForce, CustomManyParticleForce, CustomHbondForce, CustomGBForce, CustomExternalForce, CustomCompoundBondForce, CustomCentroidBondForce, CustomBondForce, CustomAngleForce, CMMotionRemover, CMAPTorsionForce, AndersenThermostat, AmoebaWcaDispersionForce, AmoebaVdwForce, AmoebaTorsionTorsionForce, AmoebaStretchBendForce, AmoebaPiTorsionForce, AmoebaOutOfPlaneBendForce, AmoebaMultipoleForce, AmoebaInPlaneAngleForce, AmoebaGeneralizedKirkwoodForce, AmoebaBondForce, and AmoebaAngleForce.

---

Member Data Documentation

this

Reimplemented in RPMDMonteCarloBarostat, RBTorsionForce, PeriodicTorsionForce, NonbondedForce, MonteCarloMembraneBarostat, MonteCarloBarostat, MonteCarloAnisotropicBarostat, HarmonicBondForce, HarmonicAngleForce, GBSAOBCForce, DrudeForce, CustomTorsionForce, CustomNonbondedForce, CustomManyParticleForce, CustomHbondForce, CustomGBForce, CustomExternalForce, CustomCompoundBondForce, CustomCentroidBondForce, CustomBondForce, CustomAngleForce, CMMotionRemover, CMAPTorsionForce, AndersenThermostat, AmoebaWcaDispersionForce, AmoebaVdwForce, AmoebaTorsionTorsionForce, AmoebaStretchBendForce, AmoebaPiTorsionForce, AmoebaOutOfPlaneBendForce, AmoebaMultipoleForce, AmoebaInPlaneAngleForce, AmoebaGeneralizedKirkwoodForce, AmoebaBondForce, and AmoebaAngleForce.

---

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

• openmm.py