Package ffx.openmm

Class CustomGBForce

java.lang.Object

ffx.openmm.Force

ffx.openmm.CustomGBForce

Direct Known Subclasses:

FixedChargeGBForce

public class CustomGBForce
extends Force

Custom GB Force.

Field Summary

Fields inherited from class ffx.openmm.Force

pointer

Constructor Summary

Constructors

Constructor	Description
CustomGBForce()	OpenMM CustomGBForce constructor.

Method Summary

Modifier and Type	Method	Description
void	addComputedValue(String name, String expression, int type)	Add a computed value.
void	addEnergyTerm(String expression, int type)	Add an energy term.
void	addGlobalParameter(String name, double value)	Add a global parameter.
void	addParticle(DoubleArray particleParameters)	Add a particle to the force.
void	addPerParticleParameter(String name)	Add per particle parameter.
void	destroy()	Destroy the force.
void	setCutoffDistance(double off)	Set the cutoff distance.
void	setParticleParameters(int index, DoubleArray particleParameters)	Set the particle parameters.
void	updateParametersInContext(Context context)	Update the parameters in the context.

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

CustomGBForce

public CustomGBForce()

OpenMM CustomGBForce constructor.

Method Details

addPerParticleParameter

public void addPerParticleParameter(String name)

Add per particle parameter.

Parameters:

name - The name of the parameter.

addGlobalParameter

public void addGlobalParameter(String name,
 double value)

Add a global parameter.

Parameters:

name - The parameter name.

value - The parameter value.

addComputedValue

public void addComputedValue(String name,
 String expression,
 int type)

Add a computed value.

Parameters:

name - The computed value name.

expression - The computed value expression.

type - The computed value type.

addEnergyTerm

public void addEnergyTerm(String expression,
 int type)

Add an energy term.

Parameters:

expression - The energy term expression.

type - The energy term type.

addParticle

public void addParticle(DoubleArray particleParameters)

Add a particle to the force.

Parameters:

particleParameters - The particle parameters.

setParticleParameters

public void setParticleParameters(int index,
 DoubleArray particleParameters)

Set the particle parameters.

Parameters:

index - The particle index.

particleParameters - The particle parameters.

setCutoffDistance

public void setCutoffDistance(double off)

Set the cutoff distance.

Parameters:

off - The cutoff distance.

updateParametersInContext

public void updateParametersInContext(Context context)

Update the parameters in the context.

Parameters:

context - The context.

destroy

public void destroy()

Destroy the force.