3. Documentation

tkwantoperator implements additional operators for tkwant that calculate energy related expectation values. They can be used in the same way as kwant’s operators in the module operator.

3.1. Helper Classes

EnergySiteValidator(syst)

A class that tells if energy related quantities can be calculated on a given site or hopping.

3.2. Energy observables

EnergyCurrent(syst, where, int]], …)	An operator for calculating the local energy current between two sites.
EnergySource(syst, where, …)	An operator for calculating the local input power on sites.
EnergyDensity(syst, where, …)	An operator for calculating the local energy density on sites.
LeadHeatCurrent(syst, …)	An operator that calculates the heat current out of a specific lead, into the central system.
EnergyCurrentDivergence(syst, where, …)	An operator that calculates the net energy current leaving a given site of the system by summing the outgoing energy currents towards its neighbors.

Reference article

A. Kara Slimane, P. Reck, G. Fleury, Simulating time-dependent thermoelectric transport in quantum systems [ Phys. Rev. B | arXiv ]