triqs.lattice.super_lattice.TBSuperLattice.fold

TBSuperLattice.fold(D1, remove_internal=False, create_zero=None)[source]

Fold a real-space function defined on the base lattice onto the superlattice.

Parameters:
D1dict

Dictionary mapping base-lattice displacements r to an array-like f(r) indexed by [orbital1, orbital2] (numpy array, GfBloc, …).

remove_internalbool, default False

If True, drop the on-site (R = 0) block of the folded result, useful for adding Hartree-Fock terms at the cluster boundary.

create_zerocallable, optional

Factory returning a zero entry of the same type as f(r). Defaults to a complex numpy array of shape (Norb, Norb).

Returns:
dict

Folded function F(R) on the superlattice displacements.