triqs_modest.module.fold

triqs_modest.module.fold()

Function dispatched to the following (C++) functions:

[1] (sl: Superlattice, tb: TbHamiltonian)
  -> TbHamiltonian

[2] (sl: Superlattice, obe: OneBodyElementsTb)
  -> OneBodyElementsTb

---

Convert a tight binding Hamiltonian to its superlattice equivalent.

---

Parameters

sl:

The superlattice object containing its lattice vectors and locations of cluster points.

obe:

A one_body_elements object containing the tb_hamiltonian.

---

Returns

one_body_elements object based on the superlattice tight binding Hamiltonian.

---