Package ffx.potential.openmm

Class OutOfPlaneBendForce

java.lang.Object

ffx.openmm.Force

ffx.openmm.CustomCompoundBondForce

ffx.potential.openmm.OutOfPlaneBendForce

public class OutOfPlaneBendForce
extends CustomCompoundBondForce

OpenMM Out-of-Plane Bend Force.

Field Summary

Fields inherited from class ffx.openmm.Force

pointer

Constructor Summary

Constructors

Constructor	Description
OutOfPlaneBendForce(OpenMMEnergy openMMEnergy)	Create an Out-of-Plane Bend Force.

Method Summary

Modifier and Type	Method	Description
static Force	constructForce(OpenMMEnergy openMMEnergy)	Convenience method to construct an OpenMM Out-of-Plane Bend 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

OutOfPlaneBendForce

public OutOfPlaneBendForce(OpenMMEnergy openMMEnergy)

Create an Out-of-Plane Bend Force.

Parameters:

openMMEnergy - The OpenMM Energy instance that contains the out-of-plane bends.

Method Details

constructForce

public static Force constructForce(OpenMMEnergy openMMEnergy)

Convenience method to construct an OpenMM Out-of-Plane Bend Force.

Parameters:

openMMEnergy - The OpenMM Energy instance that contains the out-of-plane bends.

Returns:

An OpenMM Out-of-Plane Bend Force, or null if there are no out-of-plane bends.

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.