sisl.geom.AtomNeighborList

class sisl.geom.AtomNeighborList

Bases: Neighbors

List of atoms that are close to a given atom.

The usual way to get an AtomNeighborList object is by iterating over a FullNeighborList or a PartialNeighborList. See their documentation for examples.

See also

FullNeighborList, PartialNeighborList

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 atom.
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.

atom: int

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

Number of neighbors of the atom.

property split_indices: ndarray

Indices to split the interactions of each atom.