Package etomica.virial

Class ClusterWeightUmbrella

java.lang.Object

etomica.virial.ClusterWeightUmbrella

All Implemented Interfaces:

ClusterAbstract, ClusterWeight, java.io.Serializable

public class ClusterWeightUmbrella
extends java.lang.Object
implements ClusterWeight, java.io.Serializable

Umbrella cluster weight wrapper function. The umbrella cluster's value will be positive when any of the sub clusters have non-zero values. This differs from a ClusterSum mostly because the sub cluster values are not actually summed.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface etomica.virial.ClusterWeight

ClusterWeight.Factory

Constructor Summary

Constructors

Constructor	Description
ClusterWeightUmbrella(ClusterAbstract[] allClusters)	Contructs an umbrella cluster from the given clusters.

Method Summary

Modifier and Type	Method	Description
ClusterAbstract[]	getClusters()
double[]	getWeightCoefficients()
ClusterAbstract	makeCopy()	Returns another instance of an identical cluster (shallow copy).
int	pointCount()	Number of points in the cluster.
void	setTemperature(double temp)
void	setWeightCoefficients(double[] a)
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

Constructor Detail

ClusterWeightUmbrella

public ClusterWeightUmbrella(ClusterAbstract[] allClusters)

Contructs an umbrella cluster from the given clusters.

Method Detail

makeCopy

public ClusterAbstract makeCopy()

Description copied from interface: ClusterAbstract

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

Specified by:

makeCopy 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

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

setWeightCoefficients

public void setWeightCoefficients(double[] a)

getWeightCoefficients

public double[] getWeightCoefficients()

setTemperature

public void setTemperature(double temp)

Specified by:

setTemperature in interface ClusterAbstract

getClusters

public ClusterAbstract[] getClusters()