Package ffx.potential.openmm

Class RestrainDistanceForce

java.lang.Object

ffx.openmm.Force

ffx.openmm.CustomBondForce

ffx.potential.openmm.RestrainDistanceForce

public class RestrainDistanceForce
extends CustomBondForce

Restrain-Distance Force.

Field Summary

Fields inherited from class ffx.openmm.Force

pointer

Constructor Summary

Constructors

Constructor	Description
RestrainDistanceForce(BondType.BondFunction bondFunction, RestrainDistancePotentialEnergy restrainDistancePotentialEnergy)	Restrain Bond Force constructor.

Method Summary

Modifier and Type	Method	Description
static Force	constructForce(BondType.BondFunction bondFunction, OpenMMEnergy openMMEnergy)	Add a Restrain-Bond force to the OpenMM System.

Methods inherited from class ffx.openmm.CustomBondForce

addBond, addEnergyParameterDerivative, addGlobalParameter, addPerBondParameter, destroy, getBondParameters, getBondParameters, getEnergyFunction, getEnergyParameterDerivativeName, getGlobalParameterDefaultValue, getGlobalParameterName, getNumBonds, getNumEnergyParameterDerivatives, getNumGlobalParameters, getNumPerBondParameters, getPerBondParameterName, setBondParameters, setEnergyFunction, setGlobalParameterDefaultValue, setGlobalParameterName, setPerBondParameterName, setUsesPeriodicBoundaryConditions, updateParametersInContext, usesPeriodicBoundaryConditions

Methods inherited from class ffx.openmm.Force

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

Methods inherited from class java.lang.Object

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

Constructor Details

RestrainDistanceForce

public RestrainDistanceForce(BondType.BondFunction bondFunction,
 RestrainDistancePotentialEnergy restrainDistancePotentialEnergy)

Restrain Bond Force constructor.

Parameters:

bondFunction - The bond function.

restrainDistancePotentialEnergy - RestraintDistancePotentialEnergy instance.

Method Details

constructForce

public static Force constructForce(BondType.BondFunction bondFunction,
 OpenMMEnergy openMMEnergy)

Add a Restrain-Bond force to the OpenMM System.

Parameters:

bondFunction - The bond function.

openMMEnergy - The OpenMM Energy.