site_generator¶
- site_generator(name: str, energy: float | complex | ndarray) partial ¶
Introduce a new site family (with a new
sub_id
) via a list of site positionsThis can be used to create new sites independent of the main
Lattice
definition. It’s especially useful for creating disorder or terminating system edges with atoms of a different element.- Parameters:
- namestring
Friendly identifier for the new site family.
- energyUnion[float, complex, array_like]
Base hopping energy value – scalar or matrix.
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, np.ndarray]
Tuple of (x, y, z) arrays which indicate the positions of the new sites.