Package ffx.potential.openmm

Class RestrainPositionsForce

java.lang.Object

ffx.openmm.Force

ffx.openmm.CustomExternalForce

ffx.potential.openmm.RestrainPositionsForce

public class RestrainPositionsForce
extends CustomExternalForce

Restrain Positions Force.

Field Summary

Fields inherited from class ffx.openmm.Force

pointer

Constructor Summary

Constructors

Constructor	Description
RestrainPositionsForce(RestrainPositionPotentialEnergy restrainPositionPotentialEnergy)	Restrain Positions Force constructor.

Method Summary

Modifier and Type	Method	Description
static Force	constructForce(OpenMMEnergy openMMEnergy)	Add a Restrain-Position force to the OpenMM System.

Methods inherited from class ffx.openmm.CustomExternalForce

addGlobalParameter, addParticle, addPerParticleParameter, destroy, getEnergyFunction, getGlobalParameterDefaultValue, getGlobalParameterName, getNumGlobalParameters, getNumParticles, getNumPerParticleParameters, getParticleParameters, getParticleParameters, getPerParticleParameterName, setEnergyFunction, setGlobalParameterDefaultValue, setGlobalParameterName, setParticleParameters, setPerParticleParameterName, 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

RestrainPositionsForce

public RestrainPositionsForce(RestrainPositionPotentialEnergy restrainPositionPotentialEnergy)

Restrain Positions Force constructor.

Parameters:

restrainPositionPotentialEnergy - RestrainPositionPotentialEnergy instance.

Method Details

constructForce

public static Force constructForce(OpenMMEnergy openMMEnergy)

Add a Restrain-Position force to the OpenMM System.