Package etomica.virial

Class ClusterMultivalueUmbrella

java.lang.Object

etomica.virial.ClusterMultivalueUmbrella

All Implemented Interfaces:

ClusterAbstract, ClusterWeight

public class ClusterMultivalueUmbrella
extends java.lang.Object
implements ClusterWeight

Umbrella cluster wraps a ClusterAbstractMultivalue. The umbrella cluster's value is the weighted sum of the absolute value of the derivative values (0-n). The weights are equal by default, but can be set.

Nested Class Summary

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

ClusterWeight.Factory

Constructor Summary

Constructors

Constructor	Description
ClusterMultivalueUmbrella(ClusterAbstractMultivalue cluster)	Contructs an umbrella cluster that wraps a multi-value cluster

Method Summary

Modifier and Type	Method	Description
ClusterAbstractMultivalue	getCluster()
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

ClusterMultivalueUmbrella

public ClusterMultivalueUmbrella(ClusterAbstractMultivalue cluster)

Contructs an umbrella cluster that wraps a multi-value cluster

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

getCluster

public ClusterAbstractMultivalue getCluster()