hopping_generator¶
- hopping_generator(name: str, energy: float | complex | ndarray) partial ¶
Introduce a new hopping family (with a new
hop_id
) via a list of index pairsThis can be used to create new hoppings independent of the main
Lattice
definition. It’s especially useful for creating additional local hoppings, e.g. to model defects.- Parameters:
- namestring
Friendly identifier for the new hopping family.
- energyUnion[float, complex]
Base hopping energy value.
Notes
The function parameters must be a combination of any number of the following:
- x, y, znp.ndarray
Lattice site position.
- system
System
Structural data of the model constructed so far. See
System
for details.
The function must return:
- Tuple[np.ndarray, np.ndarray]
A pair of arrays of indices which form the new hoppings.