Uses of Class
ffx.openmm.Force

Packages that use Force

Package	Description
ffx.openmm	The OpenMM package includes Java classes that are analogues of the OpenMM C++ API.
ffx.openmm.amoeba	The AMOEBA package includes Java classes that are analogues of the OpenMM C++ API for the AMOEBA model.
ffx.openmm.drude	The Drude package includes Java classes that are analogues of the OpenMM C++ API for the Charmm Drude model.
ffx.potential.openmm	The openmm package contains utilities to construct and run Force Field X potentials on the OpenMM platform, including system builders, custom forces, alchemical fixed-charge forces, and integrators tailored to FFX simulations.

Uses of Force in ffx.openmm

Subclasses of Force in ffx.openmm

Modifier and Type	Class	Description
class	AndersenThermostat	This class uses the Andersen method to maintain constant temperature.
class	ATMForce	The ATMForce class implements the Alchemical Transfer Method (ATM) for OpenMM.
class	CMAPTorsionForce	This class implements an interaction between pairs of dihedral angles.
class	CMMotionRemover	This class prevents the center of mass of a System from drifting.
class	CustomAngleForce	This class implements interactions between sets of three particles that depend on the angle between them.
class	CustomBondForce	This class implements bonded interactions between pairs of particles.
class	CustomCentroidBondForce	This class is similar to CustomCompoundBondForce, but instead of applying forces between individual particles, it applies them between the centers of groups of particles.
class	CustomCompoundBondForce	This class supports a wide variety of bonded interactions.
class	CustomCVForce	This class supports energy functions that depend on collective variables.
class	CustomExternalForce	This class implements an "external" force on particles.
class	CustomGBForce	This class implements complex, multiple stage nonbonded interactions between particles.
class	CustomHbondForce	This class supports a wide variety of energy functions used to represent hydrogen bonding.
class	CustomManyParticleForce	This class supports a wide variety of nonbonded N-particle interactions, where N is user specified.
class	CustomNonbondedForce	This class implements nonbonded interactions between particles.
class	CustomTorsionForce	This class implements interactions between sets of four particles that depend on the torsion angle between them.
class	CustomVolumeForce	This class computes an energy that depends only on the volume of the periodic box, or more generally on the box shape as specified by the elements of the box vectors.
class	GayBerneForce	This class implements the Gay-Berne anisotropic potential.
class	GBSAOBCForce	This class implements an implicit solvation force using the GBSA-OBC model.
class	HarmonicAngleForce	This class implements an interaction between groups of three particles that varies harmonically with the angle between them.
class	HarmonicBondForce	This class implements an interaction between pairs of particles that varies harmonically with the distance between them.
class	MonteCarloAnisotropicBarostat	This class uses a Monte Carlo algorithm to adjust the size of the periodic box, simulating the effect of constant pressure.
class	MonteCarloBarostat	This class uses a Monte Carlo algorithm to adjust the size of the periodic box, simulating the effect of constant pressure.
class	MonteCarloFlexibleBarostat	This class uses a Monte Carlo algorithm to adjust the size of the periodic box, simulating the effect of constant pressure.
class	MonteCarloMembraneBarostat	This class uses a Monte Carlo algorithm to adjust the size of the periodic box, simulating the effect of constant pressure and surface tension on a membrane system.
class	NonbondedForce	This class implements nonbonded interactions between particles, including a Coulomb force to represent electrostatics and a Lennard-Jones force to represent van der Waals interactions.
class	PeriodicTorsionForce	This class implements an interaction between groups of four particles that varies periodically with the torsion angle between them.
class	RBTorsionForce	This class implements an interaction between groups of four particles that varies with the torsion angle between them according to the Ryckaert-Bellemans potential.
class	RMSDForce	This is a force whose energy equals the root mean squared deviation (RMSD) between the current coordinates and a reference structure.

Methods in ffx.openmm that return Force

Modifier and Type	Method	Description
Force	System.getForce(int index)	Get a force in the system.

Methods in ffx.openmm with parameters of type Force

Modifier and Type	Method	Description
int	ATMForce.addForce(Force force)	Add a Force whose energy will be computed by the ATMForce.
int	System.addForce(Force force)	Add a force to the system.

Uses of Force in ffx.openmm.amoeba

Subclasses of Force in ffx.openmm.amoeba

Modifier and Type	Class	Description
class	GeneralizedKirkwoodForce	This class implements an implicit solvation force using the Amoeba Generalized Kirkwood model.
class	GKCavitationForce	Implicit Solvent Cavitation Force.
class	HippoNonbondedForce	This class implements all nonbonded interactions in the HIPPO force field: electrostatics, induction, charge transfer, dispersion, and repulsion.
class	MultipoleForce	This class implements the Amoeba multipole interaction.
class	TorsionTorsionForce	This class implements the Amoeba torsion-torsion interaction.
class	VdwForce	This class models van der Waals forces in the AMOEBA force field.
class	WcaDispersionForce	This class implements a nonbonded interaction between pairs of particles typically used along with AmoebaGeneralizedKirkwoodForce as part of an implicit solvent model.

Uses of Force in ffx.openmm.drude

Subclasses of Force in ffx.openmm.drude

Modifier and Type	Class	Description
class	DrudeForce	This class implements forces that are specific to Drude oscillators.

Uses of Force in ffx.potential.openmm

Subclasses of Force in ffx.potential.openmm

Modifier and Type	Class	Description
class	AmoebaGeneralizedKirkwoodForce
class	AmoebaGKCavitationForce	AmoebaCavitationForce.
class	AmoebaMultipoleForce	AmoebaMultipoleForce.
class	AmoebaTorsionTorsionForce	OpenMM TorsionTorsion Force.
class	AmoebaVdwForce	The Amoeba vdW Force.
class	AmoebaWcaDispersionForce
class	AngleForce	OpenMM Angle Force.
class	AngleTorsionForce	OpenMM Angle-Torsion Force.
class	BondForce	Bond Force.
class	FixedChargeGBForce	FixedChargeGBForce.
class	FixedChargeNonbondedForce	Define a fixed charge non-bonded force.
class	ImproperTorsionForce	OpenMM Improper Torsion Force.
class	InPlaneAngleForce	OpenMM In-Plane Angle Force.
class	OutOfPlaneBendForce	OpenMM Out-of-Plane Bend Force.
class	PiOrbitalTorsionForce	OpenMM Pi-Orbital Torsion Force.
class	RestrainDistanceForce	Restrain-Distance Force.
class	RestrainGroupsForce	Restrain Groups Force.
class	RestrainPositionsForce	Restrain Positions Force.
class	RestrainTorsionsForce	Restrain Torsions Force.
class	StretchBendForce	OpenMM Stretch-Bend Force.
class	StretchTorsionForce	OpenMM Stretch-Torsion Force.
class	TorsionForce	Torsion Force.
class	UreyBradleyForce	Urey-Bradley Force.

Methods in ffx.potential.openmm that return Force

Modifier and Type	Method	Description
static Force	AmoebaGeneralizedKirkwoodForce.constructForce(OpenMMEnergy openMMEnergy)	Convenience method to construct an AMOEBA Generalized Kirkwood Force.
static Force	AmoebaGKCavitationForce.constructForce(OpenMMEnergy openMMEnergy)	Convenience method to construct an AMOEBA Cavitation Force.
static Force	AmoebaMultipoleForce.constructForce(int topology, OpenMMDualTopologyEnergy openMMDualTopologyEnergy)	Convenience method to construct an AMOEBA Multipole Force.
static Force	AmoebaMultipoleForce.constructForce(OpenMMEnergy openMMEnergy)	Convenience method to construct an AMOEBA Multipole Force.
static Force	AmoebaTorsionTorsionForce.constructForce(int topology, OpenMMDualTopologyEnergy openMMDualTopologyEnergy)	Convenience method to construct a Dual Topology OpenMM Torsion-Torsion Force.
static Force	AmoebaTorsionTorsionForce.constructForce(OpenMMEnergy openMMEnergy)	Convenience method to construct an OpenMM Torsion-Torsion Force.
static Force	AmoebaVdwForce.constructForce(int topology, OpenMMDualTopologyEnergy openMMDualTopologyEnergy)	Convenience method to construct an AMOEBA vdW force for a dual-topology simulation.
static Force	AmoebaVdwForce.constructForce(OpenMMEnergy openMMEnergy)	Convenience method to construct an AMOEBA vdW force.
static Force	AmoebaWcaDispersionForce.constructForce(OpenMMEnergy openMMEnergy)	Convenience method to construct an AMOEBA WCA Force.
static Force	AngleForce.constructForce(int topology, OpenMMDualTopologyEnergy openMMDualTopologyEnergy)	Add a bond force to the OpenMM System
static Force	AngleForce.constructForce(OpenMMEnergy openMMEnergy)	Convenience method to construct an OpenMM Angle Force.
static Force	AngleTorsionForce.constructForce(int topology, OpenMMDualTopologyEnergy openMMDualTopologyEnergy)	Convenience method to construct a Dual Topology OpenMM Angle-Torsion Force.
static Force	AngleTorsionForce.constructForce(OpenMMEnergy openMMEnergy)	Convenience method to construct an OpenMM Angle-Torsion Force.
static Force	BondForce.constructForce(int topology, OpenMMDualTopologyEnergy openMMDualTopologyEnergy)	Add a bond force to the OpenMM System.
static Force	BondForce.constructForce(OpenMMEnergy openMMEnergy)	Creat a bond force for the OpenMM System.
static Force	FixedChargeGBForce.constructForce(OpenMMEnergy openMMEnergy)	Construct a GB force.
static Force	FixedChargeNonbondedForce.constructForce(OpenMMEnergy openMMEnergy)	Convenience method to construct an OpenMM Non-Bonded Force.
static Force	ImproperTorsionForce.constructForce(int topology, OpenMMDualTopologyEnergy openMMDualTopologyEnergy)	Convenience method to construct a Dual Topology OpenMM Improper Torsion Force.
static Force	ImproperTorsionForce.constructForce(OpenMMEnergy openMMEnergy)	Convenience method to construct an OpenMM Improper Torsion Force.
static Force	InPlaneAngleForce.constructForce(int topology, OpenMMDualTopologyEnergy openMMDualTopologyEnergy)	Convenience method to construct a Dual Topology OpenMM In-Plane Angle Force.
static Force	InPlaneAngleForce.constructForce(OpenMMEnergy openMMEnergy)	Convenience method to construct an OpenMM In-Plane Angle Force.
static Force	OutOfPlaneBendForce.constructForce(int topology, OpenMMDualTopologyEnergy openMMDualTopologyEnergy)	Convenience method to construct a Dual-Topology OpenMM Out-of-Plane Bend Force.
static Force	OutOfPlaneBendForce.constructForce(OpenMMEnergy openMMEnergy)	Convenience method to construct an OpenMM Out-of-Plane Bend Force.
static Force	PiOrbitalTorsionForce.constructForce(int topology, OpenMMDualTopologyEnergy openMMDualTopologyEnergy)	Convenience method to construct a Dual-Topology OpenMM Pi-Orbital Torsion Force.
static Force	PiOrbitalTorsionForce.constructForce(OpenMMEnergy openMMEnergy)	Convenience method to construct an OpenMM Pi-Orbital Torsion Force.
static Force	RestrainDistanceForce.constructForce(BondType.BondFunction bondFunction, OpenMMEnergy openMMEnergy)	Add a Restrain-Bond force to the OpenMM System.
static Force	RestrainGroupsForce.constructForce(OpenMMEnergy openMMEnergy)	Add a Restrain-Groups force to the OpenMM System.
static Force	RestrainPositionsForce.constructForce(OpenMMEnergy openMMEnergy)	Add a Restrain-Position force to the OpenMM System.
static Force	RestrainTorsionsForce.constructForce(int topology, OpenMMDualTopologyEnergy openMMDualTopologyEnergy)	Convenience method to construct a Dual-Topology OpenMM Torsion Force.
static Force	RestrainTorsionsForce.constructForce(OpenMMEnergy openMMEnergy)	Convenience method to construct an OpenMM Torsion Force.
static Force	StretchBendForce.constructForce(int topology, OpenMMDualTopologyEnergy openMMDualTopologyEnergy)	Convenience method to construct a Dual-Topology OpenMM Stretch-Bend Force.
static Force	StretchBendForce.constructForce(OpenMMEnergy openMMEnergy)	Convenience method to construct an OpenMM Stretch-Bend Force.
static Force	StretchTorsionForce.constructForce(int topology, OpenMMDualTopologyEnergy openMMDualTopologyEnergy)	Convenience method to construct a Dual Topology OpenMM Stretch-Torsion Force.
static Force	StretchTorsionForce.constructForce(OpenMMEnergy openMMEnergy)	Convenience method to construct an OpenMM Stretch-Torsion Force.
static Force	TorsionForce.constructForce(int topology, OpenMMDualTopologyEnergy openMMDualTopologyEnergy)	Convenience method to construct a Dual-Topology OpenMM Torsion Force.
static Force	TorsionForce.constructForce(OpenMMEnergy openMMEnergy)	Convenience method to construct an OpenMM Torsion Force.
static Force	UreyBradleyForce.constructForce(int topology, OpenMMDualTopologyEnergy openMMDualTopologyEnergy)	Convenience method to construct an OpenMM Urey-Bradley Force.
static Force	UreyBradleyForce.constructForce(OpenMMEnergy openMMEnergy)	Convenience method to construct an OpenMM Urey-Bradley Force.

Methods in ffx.potential.openmm with parameters of type Force

Modifier and Type	Method	Description
void	OpenMMSystem.removeForce(Force force)	Remove a force from the OpenMM System.