ClusterOperations

java.lang.Object
- etomica.virial.cluster.ClusterOperations

public class ClusterOperations
extends java.lang.Object

Field Summary

Fields
Modifier and Type Field Description

static int HNC

static int NONE

static int PY

Fields
Modifier and Type	Field	Description
`static int`	`HNC`
`static int`	`NONE`
`static int`	`PY`

Constructor Summary

Constructors
Constructor Description

ClusterOperations()

Constructors
Constructor	Description
`ClusterOperations()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static void`	`addEquivalents(java.util.ArrayList<ClusterDiagram> list)`	Replaces all isomorphic clusters in the given list by a single cluster with weight given by their sum.
`static ClusterDiagram[]`	`convolution(ClusterDiagram[] set1, ClusterDiagram[] set2)`	Returns an array of clusters formed from taking the convolution of each of the diagrams of the first set with each of the diagrams of the second set.
`static ClusterDiagram`	`convolution(ClusterDiagram cluster1, ClusterDiagram cluster2)`	Returns a new cluster that is a convolution of the given cluster, which is obtained by joining a root point from each diagram and turning it into a field point.
`static ClusterDiagram[]`	`difference(ClusterDiagram[] set1, ClusterDiagram[] set2)`	Generates the set of diagrams obtained by subtracting the second set from the first set.
`int`	`getApproximation()`
`ClusterDiagram[]`	`getB(int n)`
`ClusterDiagram[]`	`getC(int n)`
`ClusterDiagram[]`	`getEta(int n)`	Returns all diagrams of order n in the expansion for the indirect correlation function eta(r) = h(r) - c(r), in the presence of any approximations currently in effect.
`ClusterDiagram[]`	`getH(int n)`	Returns all diagrams of order n in the expansion for the total correlation function h(r), in the presence of any approximations currently in effect.
`ClusterDiagram[]`	`getW(int n)`	Returns all diagrams of order n in the sum [eta(r) + b(r)] (i.e., the sum of the indirect correlation function and the bridge function).
`static ClusterDiagram[]`	`integrate(ClusterDiagram[] clusters)`	Replaces each cluster in the given array with another having the same topology, but with the highest-index root point converted into a field point.
`static void`	`main(java.lang.String[] args)`
`static ClusterDiagram[]`	`makeReeHoover(ClusterDiagram cluster)`	Creates a set of Ree-Hoover clusters from the given cluster.
`static ClusterDiagram[]`	`makeReeHoover(ClusterDiagram[] clusters)`
`static ClusterDiagram`	`product(ClusterDiagram[] clusters)`	Returns the product of all the given clusters.
`static ClusterDiagram[]`	`product(ClusterDiagram[] set1, ClusterDiagram[] set2)`	Returns an array of clusters formed from taking the product of each of the diagrams of the first set with each of the diagrams of the second set.
`static ClusterDiagram`	`product(ClusterDiagram cluster1, ClusterDiagram cluster2)`	Returns a new cluster that is the product of the given clusters.
`static void`	`reduce(java.util.ArrayList<ClusterDiagram> list)`	Sorts cluster diagrams (but # of connections) and combines any diagrams that are identical, resulting in a diagram with a weight equal to the sum of the original weights.
`void`	`setApproximation(int approximation)`
`static void`	`sortConnections(ClusterDiagram cluster)`
`static void`	`sortDiagrams(ClusterDiagram[] diagrams)`	Sorts diagrams in order from most bonds to fewest bonds
`static ClusterDiagram[]`	`sum(ClusterDiagram[] set1, ClusterDiagram[] set2)`	Generates the set of diagrams obtained by adding the second set to the first set.
`static java.util.ArrayList<ClusterDiagram>`	`toE(ClusterDiagram f)`	Returns an array of cluster diagrams with all e-bonds representing the same sum of diagrams as the given f-bond cluster.
`static ClusterDiagram[]`	`toE(ClusterDiagram[] f)`	Returns an array of cluster diagrams with all e-bonds representing the same sum of diagrams as the given f-bond clusters.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NONE
```
public static final int NONE
```
    See Also:
    
    Constant Field Values
  - PY
```
public static final int PY
```
    See Also:
    
    Constant Field Values
  - HNC
```
public static final int HNC
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ClusterOperations
```
public ClusterOperations()
```
- Method Detail
  - sortDiagrams
```
public static void sortDiagrams(ClusterDiagram[] diagrams)
```
    Sorts diagrams in order from most bonds to fewest bonds
  - sortConnections
```
public static void sortConnections(ClusterDiagram cluster)
```
  - product
```
public static ClusterDiagram product(ClusterDiagram cluster1,
                                     ClusterDiagram cluster2)
```
    Returns a new cluster that is the product of the given clusters. Input clusters must have the same number of root points and my not both have bonds between the same root points. The weight of the returned cluster is the product of the weights of the given clusters. The input clusters are not changed.
  - product
```
public static ClusterDiagram product(ClusterDiagram[] clusters)
```
    Returns the product of all the given clusters. Length of input array must be at least 1, and no null elements are permitted. The input array and the clusters it contains are unchanged, and the returned cluster is new.
  - product
```
public static ClusterDiagram[] product(ClusterDiagram[] set1,
                                       ClusterDiagram[] set2)
```
    Returns an array of clusters formed from taking the product of each of the diagrams of the first set with each of the diagrams of the second set. The given arrays and the clusters in them are not changed, and all clusters in the returned array are new.
  - integrate
```
public static ClusterDiagram[] integrate(ClusterDiagram[] clusters)
```
    Replaces each cluster in the given array with another having the same topology, but with the highest-index root point converted into a field point. The resulting set is collapsed to add any newly equivalent clusters. Weights of each cluster are otherwise unchanged. The given arrays and the clusters in them are not changed, and all clusters in the returned array are new.
    
    Throws:
    
    java.lang.IllegalArgumentException - if any input cluster has no root points
  - addEquivalents
```
public static void addEquivalents(java.util.ArrayList<ClusterDiagram> list)
```
    Replaces all isomorphic clusters in the given list by a single cluster with weight given by their sum. The resulting list is also sorted by # of connections. Both the list and the the weights of the clusters it contains may be altered by this method.
  - reduce
```
public static void reduce(java.util.ArrayList<ClusterDiagram> list)
```
    Sorts cluster diagrams (but # of connections) and combines any diagrams that are identical, resulting in a diagram with a weight equal to the sum of the original weights.
  - convolution
```
public static ClusterDiagram convolution(ClusterDiagram cluster1,
                                         ClusterDiagram cluster2)
```
    Returns a new cluster that is a convolution of the given cluster, which is obtained by joining a root point from each diagram and turning it into a field point. Each given cluster must have exactly 2 root points. The weight of the returned cluster is the product of the weights of the given clusters. The input clusters are unchanged.
  - difference
```
public static ClusterDiagram[] difference(ClusterDiagram[] set1,
                                          ClusterDiagram[] set2)
```
    Generates the set of diagrams obtained by subtracting the second set from the first set. The returned array contains all diagrams from the first set, with weights modified by subtracting the weights of matching diagrams from the second set (if present), and all unmatched diagrams from the second set with their weights negated. The returned array and all clusters in it are new instances.
  - sum
```
public static ClusterDiagram[] sum(ClusterDiagram[] set1,
                                   ClusterDiagram[] set2)
```
    Generates the set of diagrams obtained by adding the second set to the first set. The returned array contains (copies of) all diagrams from the first set, with weights modified by adding the weights of matching diagrams from the second set (if present), and all unmatched diagrams from the second set. The returned array and all clusters in it are new instances.
  - convolution
```
public static ClusterDiagram[] convolution(ClusterDiagram[] set1,
                                           ClusterDiagram[] set2)
```
    Returns an array of clusters formed from taking the convolution of each of the diagrams of the first set with each of the diagrams of the second set. The given arrays and the clusters they change are unchanged, and all clusters in the returned array are new.
  - makeReeHoover
```
public static ClusterDiagram[] makeReeHoover(ClusterDiagram cluster)
```
    Creates a set of Ree-Hoover clusters from the given cluster. The input cluster is assumed to be formed from only f bonds. The set of returned clusters are full stars formed from f bonds and (implied) e bonds (e = f + 1), and sum to the original cluster.
  - makeReeHoover
```
public static ClusterDiagram[] makeReeHoover(ClusterDiagram[] clusters)
```
  - setApproximation
```
public void setApproximation(int approximation)
```
  - getApproximation
```
public int getApproximation()
```
  - getH
```
public ClusterDiagram[] getH(int n)
```
    Returns all diagrams of order n in the expansion for the total correlation function h(r), in the presence of any approximations currently in effect.
  - getC
```
public ClusterDiagram[] getC(int n)
```
  - getB
```
public ClusterDiagram[] getB(int n)
```
  - getEta
```
public ClusterDiagram[] getEta(int n)
```
    Returns all diagrams of order n in the expansion for the indirect correlation function eta(r) = h(r) - c(r), in the presence of any approximations currently in effect. Evaluates eta via convolution of appropriate terms in h(r) and c(r) up to order n-1.
  - getW
```
public ClusterDiagram[] getW(int n)
```
    Returns all diagrams of order n in the sum [eta(r) + b(r)] (i.e., the sum of the indirect correlation function and the bridge function).
  - toE
```
public static java.util.ArrayList<ClusterDiagram> toE(ClusterDiagram f)
```
    Returns an array of cluster diagrams with all e-bonds representing the same sum of diagrams as the given f-bond cluster.
  - toE
```
public static ClusterDiagram[] toE(ClusterDiagram[] f)
```
    Returns an array of cluster diagrams with all e-bonds representing the same sum of diagrams as the given f-bond clusters.
  - main
```
public static void main(java.lang.String[] args)
```

Class ClusterOperations

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NONE

PY

HNC

Constructor Detail

ClusterOperations

Method Detail

sortDiagrams

sortConnections

product

product

product

integrate

addEquivalents

reduce

convolution

difference

sum

convolution

makeReeHoover

makeReeHoover

setApproximation

getApproximation

getH

getC

getB

getEta

getW

toE

toE

main