CompositeRMSD¶

class cvpack.CompositeRMSD(referencePositions, groups, numAtoms=None, name='composite_rmsd')[source]¶

The composite root-mean-square deviation (RMSD) between the current and reference coordinates of \(m\) groups of atoms:

\[d_{\rm crms}({\bf r}) = \sqrt{ \frac{1}{n} \min_{ \bf q \in \mathbb{R}^4 \atop \|{\bf q}\| = 1 } \sum_{j=1}^m \sum_{i \in {\bf g}_j} \left\| {\bf A}({\bf q})\left({\bf r}_i - {\bf c}_j\right) - {\bf r}_i^{\rm ref} + {\bf c}_j^{\rm ref} \right\|^2 }\]

where each group \({\bf g}_j\) is a set of \(n_j\) atom indices, \(n = \sum_{j=1}^m n_j\) is the total number of atoms in these groups, \({\bf A}(\bf q)\) is the rotation matrix corresponding to a unit quaternion \({\bf q}\), \({\bf r}_i\) and \({\bf r}_i^{\rm ref}\) are the positions of atom \(i\) in the current and reference structures, respectively, \({\bf c}_j\) is the position of atom \(i\), given by

\[{\bf c}_j = \frac{1}{n_j} \sum_{i \in {\bf g}_j} {\bf r}_i\]

and \({\bf c}_j^{\rm ref}\) is the centroid of the reference structure for group \(j\), defined analogously to \({\bf c}_j\).

Warning

To use this class, you must install the openmm-cpp-forces conda package.

Parameters:

referencePositions (Quantity | ndarray | Sequence[Vec3] | Sequence[ndarray] | Dict[int, Quantity | ndarray | Vec3]) – The reference coordinates, which can be either a coordinate matrix or a mapping from atom indices to coordinate vectors. It must contain all atoms in groups, and does not need to contain all atoms in the system. See numAtoms below.
groups (Iterable[Iterable[int]]) – A sequence of disjoint atom groups. Each group is a sequence of atom indices.
numAtoms (int | None) – The total number of atoms in the system, including those that are not in groups. This argument is necessary only if referencePositions does not contain all atoms in the system.
name (str) – The name of the collective variable.

Raises:

ImportError – If the openmm-cpp-forces conda package is not installed.
ValueError – If groups is not a sequence of disjoint atom groups.

Example

>>> import cvpack
>>> import openmm as mm
>>> import pytest
>>> from openmmtools import testsystems
>>> from openmm import unit
>>> model = testsystems.HostGuestVacuum()
>>> host_atoms, guest_atoms = (
...     [a.index for a in r.atoms()]
...     for r in model.topology.residues()
... )
>>> try:
...     composite_rmsd = cvpack.CompositeRMSD(
...         model.positions,
...         [host_atoms, guest_atoms],
...     )
... except ImportError:
...     pytest.skip("openmm-cpp-forces is not installed")
>>> composite_rmsd.addToSystem(model.system)
>>> context = mm.Context(
...     model.system,
...     mm.VerletIntegrator(1.0 * unit.femtoseconds),
...     mm.Platform.getPlatformByName('Reference'),
... )
>>> context.setPositions(model.positions)
>>> composite_rmsd.getValue(context)
0.0 nm
>>> model.positions[guest_atoms] += 1.0 * unit.nanometers
>>> context.setPositions(model.positions)
>>> composite_rmsd.getValue(context)
0.0 nm

Methods

addToSystem(system, setUnusedForceGroup=True)¶

Add this collective variable to an openmm.System.

Parameters:

system (System) – The system to which this collective variable should be added
setUnusedForceGroup (bool) – If True, the force group of this collective variable will be set to the first available force group in the system

getEffectiveMass(context, allowReinitialization=False)¶

Compute the effective mass of this collective variable at a given openmm.Context.

The effective mass of a collective variable \(q({\bf r})\) is defined as [1]:

\[m_\mathrm{eff}({\bf r}) = \left( \sum_{i=1}^N \frac{1}{m_i} \left\| \frac{dq}{d{\bf r}_i} \right\|^2 \right)^{-1}\]

If this collective variable share the force group with other forces, then evaluating its effective mass requires reinitializing the openmm.Context twice at each call. This is inefficient and should be avoided. To allow this behavior, the allowReinitialization parameter must be set to True.

Note

By adding this collective variable to the system using the addToSystem() method, the force group of this collective variable is set to an available force group in the system by default.

Parameters:

context (Context) – The context at which this collective variable’s effective mass should be evaluated.
allowReinitialization (bool) – If True, the context will be reinitialized if necessary.

Returns:

The effective mass of this collective variable at the given context.

Return type:

Quantity

Example

In this example, we compute the effective masses of the backbone dihedral angles and the radius of gyration of an alanine dipeptide molecule in water:

>>> import cvpack
>>> import openmm
>>> from openmmtools import testsystems
>>> model = testsystems.AlanineDipeptideExplicit()
>>> top = model.mdtraj_topology
>>> backbone_atoms = top.select("name N C CA and resid 1 2")
>>> phi = cvpack.Torsion(*backbone_atoms[0:4])
>>> psi = cvpack.Torsion(*backbone_atoms[1:5])
>>> radius_of_gyration = cvpack.RadiusOfGyration(
...     top.select("not water")
... )
>>> for cv in [phi, psi, radius_of_gyration]:
...     cv.addToSystem(model.system)
>>> context = openmm.Context(
...     model.system, openmm.VerletIntegrator(0)
... )
>>> context.setPositions(model.positions)
>>> phi.getEffectiveMass(context)
0.05119... nm**2 Da/(rad**2)
>>> psi.getEffectiveMass(context)
0.05186... nm**2 Da/(rad**2)
>>> radius_of_gyration.getEffectiveMass(context)
30.946... Da

getMassUnit()¶

Get the unit of measurement of the effective mass of this collective variable.

Return type:: Unit

getName()¶

Get the name of this collective variable.

Return type:: str

getPeriodicBounds()¶

Get the periodic bounds of this collective variable.

Returns:: The periodic bounds of this collective variable or None if it is not periodic
Return type:: Union[Quantity, None]

getUnit()¶

Get the unit of measurement of this collective variable.

Return type:: Unit

getValue(context, allowReinitialization=False)¶

Evaluate this collective variable at a given openmm.Context.

If this collective variable share the force group with other forces, then its evaluation requires reinitializing the openmm.Context twice at each call. This is inefficient and should be avoided. To allow this behavior, the allowReinitialization parameter must be set to True.

Note

By adding this collective variable to the system using the addToSystem() method, the force group of this collective variable is set to an available force group in the system by default.

Parameters:

context (Context) – The context at which this collective variable should be evaluated.
allowReinitialization (bool) – If True, the context will be reinitialized if necessary.

Returns:

The value of this collective variable at the given context.

Return type:

Quantity

Example

In this example, we compute the values of the backbone dihedral angles and the radius of gyration of an alanine dipeptide molecule in water:

>>> import cvpack
>>> import openmm
>>> from openmmtools import testsystems
>>> model = testsystems.AlanineDipeptideExplicit()
>>> top = model.mdtraj_topology
>>> backbone_atoms = top.select("name N C CA and resid 1 2")
>>> phi = cvpack.Torsion(*backbone_atoms[0:4])
>>> psi = cvpack.Torsion(*backbone_atoms[1:5])
>>> radius_of_gyration = cvpack.RadiusOfGyration(
...     top.select("not water")
... )
>>> for cv in [phi, psi, radius_of_gyration]:
...     cv.addToSystem(model.system)
>>> context = openmm.Context(
...     model.system, openmm.VerletIntegrator(0)
... )
>>> context.setPositions(model.positions)
>>> phi.getValue(context)
3.1415... rad
>>> psi.getValue(context)
3.1415... rad
>>> radius_of_gyration.getValue(context)
0.29514... nm

CompositeRMSD¶

CVPack v0.12.2

Table of Contents