Package ffx.potential.openmm

Class InPlaneAngleForce

java.lang.Object

ffx.openmm.Force

ffx.openmm.CustomCompoundBondForce

ffx.potential.openmm.InPlaneAngleForce

public class InPlaneAngleForce
extends CustomCompoundBondForce

OpenMM In-Plane Angle Force.

Field Summary

Fields inherited from class ffx.openmm.Force

pointer

Constructor Summary

Constructors

Constructor	Description
InPlaneAngleForce(OpenMMEnergy openMMEnergy)	Create an OpenMM Angle Force.

Method Summary

Modifier and Type	Method	Description
static Force	constructForce(OpenMMEnergy openMMEnergy)	Convenience method to construct an OpenMM In-Plane Angle Force.
void	updateForce(OpenMMEnergy openMMEnergy)	Update an existing angle force for the OpenMM System.

Methods inherited from class ffx.openmm.CustomCompoundBondForce

addBond, addGlobalParameter, addPerBondParameter, destroy, setBondParameters, updateParametersInContext

Methods inherited from class ffx.openmm.Force

getForceGroup, getForceIndex, getName, getPointer, setForceGroup, setForceIndex, setName, usesPeriodicBoundaryConditions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

InPlaneAngleForce

public InPlaneAngleForce(OpenMMEnergy openMMEnergy)

Create an OpenMM Angle Force.

Parameters:

openMMEnergy - The OpenMM Energy instance that contains the angles.

Method Details

constructForce

public static Force constructForce(OpenMMEnergy openMMEnergy)

Convenience method to construct an OpenMM In-Plane Angle Force.

Parameters:

openMMEnergy - The OpenMM Energy instance that contains the angles.

Returns:

An OpenMM Angle Force, or null if there are no angles.

updateForce

public void updateForce(OpenMMEnergy openMMEnergy)

Update an existing angle force for the OpenMM System.

Parameters:

openMMEnergy - The OpenMM Energy instance that contains the angles.