Package etomica.virial

Class ClusterDifference

java.lang.Object

etomica.virial.ClusterDifference

All Implemented Interfaces:

ClusterAbstract

public class ClusterDifference
extends java.lang.Object
implements ClusterAbstract

This class holds multiple clusters and returns the value from one minus the average value from the others. This could be implemented as a ClusterSum with a set of ClusterBonds for each of the clusters here, but it's a lot easier to do it this way.

Field Summary

Fields

Modifier and Type	Field	Description
protected ClusterAbstract	clusterAdd
protected ClusterAbstract[]	clusterSubtract

Constructor Summary

Constructors

Constructor	Description
ClusterDifference(ClusterAbstract fullTargetCluster, ClusterAbstract[] targetSubtract)

Method Summary

Modifier and Type	Method	Description
ClusterAbstract	makeCopy()	Returns another instance of an identical cluster (shallow copy).
int	pointCount()	Number of points in the cluster.
void	setTemperature(double temperature)
double	value(BoxCluster box)	Value of this cluster for the given pairset at the specified reciprocal temperature.

Methods inherited from class java.lang.Object

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

Field Detail

clusterAdd

protected final ClusterAbstract clusterAdd

clusterSubtract

protected final ClusterAbstract[] clusterSubtract

Constructor Detail

ClusterDifference

public ClusterDifference(ClusterAbstract fullTargetCluster,
                         ClusterAbstract[] targetSubtract)

Method Detail

value

public double value(BoxCluster box)

Description copied from interface: ClusterAbstract

Value of this cluster for the given pairset at the specified reciprocal temperature.

Specified by:

value in interface ClusterAbstract

setTemperature

public void setTemperature(double temperature)

Specified by:

setTemperature in interface ClusterAbstract

pointCount

public int pointCount()

Description copied from interface: ClusterAbstract

Number of points in the cluster.

Specified by:

pointCount in interface ClusterAbstract

Returns:

int

makeCopy

public ClusterAbstract makeCopy()

Description copied from interface: ClusterAbstract

Returns another instance of an identical cluster (shallow copy).

Specified by:

makeCopy in interface ClusterAbstract