Opm::AssembledConnections Class Reference
Detailed DescriptionForm CSR adjacency matrix representation of graph provided as a list of connections between entities, possibly including edge weights. Member Typedef Documentation◆ CellNeighboursRange of neighbours connected to a particular entity. Includes edge weights. ◆ ConnWeight
Aggregate connection weights. ◆ Neighbours
Representation of neighbouring entities. ◆ Offset
Offset into neighbour array. ◆ Start
CSR start pointers. Member Function Documentation◆ addConnection() [1/2]
Add connection between entities.
◆ addConnection() [2/2]
Add weighted connection between entities.
◆ cellNeighbourhood()
Provide a range over a cell neighbourhood. Example usage: // connection.neigbour is the neigbouring cell
// connection.weight is the corresponding connection weight
}
CellNeighbours cellNeighbourhood(const int cell) const This method can only be called if the weight-providing overload of addConnection() was used to build the instance. ◆ compress()
Form CSR adjacency matrix representation of input graph from connections established in previous calls to addConnection(). A call to function compress() will fail unless all previously established connections have an explicit edge weight ( addConnection(i,j,v)
void addConnection(const int i, const int j) ) or none of those connections have an explicit edge weight ( addConnection(i,j)
). This method destroys the connection list so if there are subsequent calls to method addConnection() then those will effectively create a new graph.
◆ connectionWeight()
Retrieve accumulated connection weights for each aggregate neighbour relation in the adjacency matrix. Only valid if the input graph is specified in terms of explicit edge weights ( addConnection(i,j,v)
). Weights have the same ordering as the neighbours represented by neighbourhood(). ◆ neighbourhood()
Retrieve raw CSR column indices pertaining to current input graph. Only valid after compress() is called. The neighbours of entity neighbourhood()[startPointers()[i + 0]] ...
neighbourhood()[startPointers()[i + 1] - 1]
const Neighbours & neighbourhood() const const Start & startPointers() const ◆ numRows()
Retrieve number of rows (source entities) in input graph. Corresponds to value of argument passed to compress(). Valid only after calling compress(). ◆ startPointers()
Retrieve raw CSR start pointers pertaining to current input graph. Only valid after compress() is called. The documentation for this class was generated from the following file: |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||