ScatteringStates

class ScatteringStates(save_scattering_states=None)

The scattering states method used to calculate the Green’s function.

Parameters:save_scattering_states (bool) – Whether calculated scattering states should be cached.
Default: True
saveScatteringStates()
Returns:True when the scattering states are saved.
Return type:bool

Usage Examples

Setup a device calculation that computes the non-equilibrium contribution to the contour integral via the scattering states method while computed scattering states are cached.

non_equilibrium_method = ScatteringStates(save_scattering_states=True)
device_algorithm_parameters = DeviceAlgorithmParameters(
    non_equilibrium_method=non_equilibrium_method,
    )
calculator = DeviceHuckelCalculator(
    device_algorithm_parameters=device_algorithm_parameters,
    )