Reaktoro  v2.11.0
A unified framework for modeling chemically reactive systems
ClusterConnectivity Class Reference

Public Member Functions

 ClusterConnectivity ()
 Construct a default instance of ClusterConnectivity.
 
auto size () const -> Index
 Return number of currently tracked clusters.
 
auto extend () -> void
 Extend the connectivity matrix following creation of a new cluster.
 
auto increment (Index icluster, Index jcluster) -> void
 Increment the rank/usage count for the connectivity from one cluster to another. More...
 
auto order (Index icluster) const -> Deque< Index > const &
 Return the order of clusters for a given starting cluster. More...
 

Member Function Documentation

◆ increment()

auto increment ( Index  icluster,
Index  jcluster 
) -> void

Increment the rank/usage count for the connectivity from one cluster to another.

Parameters
iclusterThe index of the starting cluster.
jclusterThe index of the cluster which usage count is incremented.
Note
If index icluster is equal or greater than number of clusters, then usage count for jcluster is still incremented, but in a separate list, which can be used when a starting cluster cannot be specified and ordering of clusters solely based on their usage counts is used instead.

◆ order()

auto order ( Index  icluster) const -> Deque< Index > const &

Return the order of clusters for a given starting cluster.

Parameters
iclusterThe index of the starting cluster.
Note
If index icluster is equal or greater than number of clusters, then an ordering based on usage count of clusters is returned.

The documentation for this class was generated from the following file: