Interactions (pengwann.interactions)#

Data structures representing interactions between atoms and Wannier functions.

This module contains several dataclasses/namedtuples that serve to store data relating to interactions between atoms and Wannier functions. It is generally expected that each of these data structures will be initialised with solely the data required to specify which atoms or Wannier functions are interacting, the remaining fields will usually be set by functions and methods in the descriptors module.

Classes#

AtomicInteractionContainer(sub_interactions)

Data structure for storing multiple AtomicInteraction objects.

AtomicInteraction(i, j, symbol_i, symbol_j, ...)

Data structure regarding the interaction between two atoms.

WannierInteraction(i, j, bl_i, bl_j[, ...])

Stores data regarding the interaction between two Wannier functions.