sisl.geom.PointNeighborList

class sisl.geom.PointNeighborList

Bases: Neighbors

List of atoms that are close to a point in space.

The usual way to get a PointNeighborList object is by iterating over a PointsNeighborList. See its documentation for examples.

See also

PointsNeighborList

The list that, when iterated, returns PointNeighborList objects.

Attributes

I

For each neighbor pair (I, J), the first index.

J

For each neighbor pair (I, J), the second index.

i

Same as I, provided for backwards compatibility, may be deprecated later

isc

For each neighbor pair (I, J), the supercell indices of \(J\).

j

Same as J, provided for backwards compatibility, may be deprecated later

min_nsc

The minimum nsc for an auxiliary supercell to contain all neighbors in this object.

n_neighbors

Number of neighbors of the point.

split_indices

Indices to split the interactions of each atom.
property I: ndarray

For each neighbor pair (I, J), the first index.

property J: ndarray

For each neighbor pair (I, J), the second index.

property i: ndarray

Same as I, provided for backwards compatibility, may be deprecated later

property isc: ndarray

For each neighbor pair (I, J), the supercell indices of \(J\).

property j: ndarray

Same as J, provided for backwards compatibility, may be deprecated later

property min_nsc: ndarray

The minimum nsc for an auxiliary supercell to contain all neighbors in this object.

property n_neighbors: int[source]

Number of neighbors of the point.

point: np.ndarray
property split_indices: ndarray

Indices to split the interactions of each atom.