find_connected_sites

openpnm.topotools.find_connected_sites(bonds, am, flatten=True, logic='or')[source]

Given an adjacency matrix, finds which sites are connected to the input bonds.

Parameters
  • am (scipy.sparse matrix) – The adjacency matrix of the network. Must be symmetrical such that if sites i and j are connected, the matrix contains non-zero values at locations (i, j) and (j, i).

  • flatten (bool (default is True)) – Indicates whether the returned result is a compressed array of all neighbors, or a list of lists with each sub-list containing the neighbors for each input site. Note that an unflattened list might be slow to generate since it is a Python list rather than a Numpy array.

  • logic (str) –

    Specifies logic to filter the resulting list. Options are:

    ’or’ : (default) All neighbors of the input bonds. This is also known as the ‘union’ in set theory or (sometimes) ‘any’ in boolean logic. Both keywords are accepted and treated as ‘or’.

    ’xor’ : Only neighbors of one and only one input bond. This is useful for finding the sites that are not shared by any of the input bonds. ‘exclusive_or’ is also accepted.

    ’xnor’ : Neighbors that are shared by two or more input bonds. This is equivalent to finding all neighbors with ‘or’, minus those found with ‘xor’, and is useful for finding neighbors that the inputs have in common. ‘nxor’ is also accepted.

    ’and’ : Only neighbors shared by all input bonds. This is also known as ‘intersection’ in set theory and (somtimes) as ‘all’ in boolean logic. Both keywords are accepted and treated as ‘and’.

Returns

  • An array containing the connected sites, filtered by the given logic. If

  • flatten is False then the result is a list of lists containing the

  • neighbors of each given input bond. In this latter case, sites that

  • have been removed by the given logic are indicated by nans, thus the

  • array is of type float and is not suitable for indexing.

See also

find_complement