5.13.11. localizer.wannier_supercell_cost¶

eminus.localizer.wannier_supercell_cost(X, Y, Z)[source]¶

Calculate the supercell Wannier cost.

This is an equivalent criterion to the spread criterion, but not the same. This cost function will be maximized instead of the minimization of the spread.

Reference: Phys. Rev. B 59, 9703.

Parameters:

X – Calculation specific matrix.
Y – Calculation specific matrix.
Z – Calculation specific matrix.

Returns:

Supercell Wannier cost.