System

classSystem

This class represents a molecular system. The definition of a System involves four elements:

  • The set of particles in the system

  • The forces acting on them

  • Pairs of particles whose separation should be constrained to a fixed value

  • For periodic systems, the dimensions of the periodic box

The particles and constraints are defined directly by the System object, while forces are defined by objects that extend the Force class. After creating a System, call addParticle() once for each particle, addConstraint() for each constraint, and addForce() for each Force.

In addition, particles may be designated as "virtual sites". These are particles whose positions are computed automatically based on the positions of other particles. To define a virtual site, call setVirtualSite(), passing in a VirtualSite object that defines the rules for computing its position.

Public Functions

System()

Create a new System.

intgetNumParticles()const

Get the number of particles in this System.

inlineintaddParticle(doublemass)

Add a particle to the System. If the mass is 0, Integrators will ignore the particle and not modify its position or velocity. This is most often used for virtual sites, but can also be used as a way to prevent a particle from moving.

Parameters:

mass – the mass of the particle (in atomic mass units)

Returns:

the index of the particle that was added

doublegetParticleMass(intindex)const

Get the mass (in atomic mass units) of a particle. If the mass is 0, Integrators will ignore the particle and not modify its position or velocity. This is most often used for virtual sites, but can also be used as a way to prevent a particle from moving.

Parameters:

index – the index of the particle for which to get the mass

voidsetParticleMass(intindex, doublemass)

Set the mass (in atomic mass units) of a particle. If the mass is 0, Integrators will ignore the particle and not modify its position or velocity. This is most often used for virtual sites, but can also be used as a way to prevent a particle from moving.

Parameters:

  • index – the index of the particle for which to set the mass

  • mass – the mass of the particle

voidsetVirtualSite(intindex, VirtualSite *virtualSite)

Set a particle to be a virtual site. The VirtualSite object should have been created on the heap with the "new" operator. The System takes over ownership of it, and deletes it when the System itself is deleted.

Parameters:

  • index – the index of the particle that should be treated as a virtual site

  • virtualSite – a pointer to the VirtualSite object describing it

inlineboolisVirtualSite(intindex)const

Get whether a particle is a VirtualSite.

Parameters:

index – the index of the particle to check

constVirtualSite &getVirtualSite(intindex)const

Get VirtualSite object for a particle. If the particle is not a virtual site, this throws an exception.

Parameters:

index – the index of the particle to get

intgetNumConstraints()const

Get the number of distance constraints in this System.

intaddConstraint(intparticle1, intparticle2, doubledistance)

Add a constraint to the System. Particles whose mass is 0 cannot participate in constraints.

Parameters:

  • particle1 – the index of the first particle involved in the constraint

  • particle2 – the index of the second particle involved in the constraint

  • distance – the required distance between the two particles, measured in nm

Returns:

the index of the constraint that was added

voidgetConstraintParameters(intindex, int&particle1, int&particle2, double&distance)const

Get the parameters defining a distance constraint.

Parameters:

  • index – the index of the constraint for which to get parameters

  • particle1 – [out] the index of the first particle involved in the constraint

  • particle2 – [out] the index of the second particle involved in the constraint

  • distance – [out] the required distance between the two particles, measured in nm

voidsetConstraintParameters(intindex, intparticle1, intparticle2, doubledistance)

Set the parameters defining a distance constraint. Particles whose mass is 0 cannot participate in constraints.

Parameters:

  • index – the index of the constraint for which to set parameters

  • particle1 – the index of the first particle involved in the constraint

  • particle2 – the index of the second particle involved in the constraint

  • distance – the required distance between the two particles, measured in nm

voidremoveConstraint(intindex)

Remove a constraint from the System.

Parameters:

index – the index of the constraint to remove

inlineintaddForce(Force *force)

Add a Force to the System. The Force should have been created on the heap with the "new" operator. The System takes over ownership of it, and deletes the Force when the System itself is deleted.

Parameters:

force – a pointer to the Force object to be added

Returns:

the index within the System of the Force that was added

intgetNumForces()const

Get the number of Force objects that have been added to the System.

constForce &getForce(intindex)const

Get a const reference to one of the Forces in this System.

Parameters:

index – the index of the Force to get

Force &getForce(intindex)

Get a writable reference to one of the Forces in this System.

Parameters:

index – the index of the Force to get

voidremoveForce(intindex)

Remove a Force from the System. The memory associated with the removed Force object is deleted.

Parameters:

index – the index of the Force to remove

voidgetDefaultPeriodicBoxVectors(Vec3 &a, Vec3 &b, Vec3 &c)const

Get the default values of the vectors defining the axes of the periodic box (measured in nm). Any newly created Context will have its box vectors set to these. They will affect any Force added to the System that uses periodic boundary conditions.

Parameters:

  • a – [out] the vector defining the first edge of the periodic box

  • b – [out] the vector defining the second edge of the periodic box

  • c – [out] the vector defining the third edge of the periodic box

voidsetDefaultPeriodicBoxVectors(constVec3 &a, constVec3 &b, constVec3 &c)

Set the default values of the vectors defining the axes of the periodic box (measured in nm). Any newly created Context will have its box vectors set to these. They will affect any Force added to the System that uses periodic boundary conditions.

Triclinic boxes are supported, but the vectors must satisfy certain requirements. In particular, a must point in the x direction, b must point "mostly" in the y direction, and c must point "mostly" in the z direction. See the documentation for details.

Parameters:

  • a – the vector defining the first edge of the periodic box

  • b – the vector defining the second edge of the periodic box

  • c – the vector defining the third edge of the periodic box

boolusesPeriodicBoundaryConditions()const

Returns whether or not any forces in this System use periodic boundaries.

If a force in this System does not implement usesPeriodicBoundaryConditions a OpenMM::OpenMMException is thrown

Returns:

true if at least one force uses PBC and false otherwise