Commit 58bd15e9 authored by Christoph Groth's avatar Christoph Groth
Browse files

clarify wave_function docstring

parent 835e1ed8
...@@ -513,16 +513,19 @@ class SparseSolver(object): ...@@ -513,16 +513,19 @@ class SparseSolver(object):
Notes Notes
----- -----
The returned object can be itself called like a function. Given a lead The returned object can be itself called like a function. Given a lead
number, it returns a 2d NumPy array containing the wave function within number, it returns a 2d NumPy array that contains the wave function
the scattering region due to each mode of the given lead. Index 0 is within the scattering region due to each incoming mode of the given
the mode number, index 1 is the orbital number. The modes appear in lead. Index 0 is the mode number, index 1 is the orbital number. The
the same order as incoming modes in `kwant.physics.modes`. modes appear in the same order as incoming modes in
`kwant.physics.modes`.
Examples Examples
-------- --------
>>> wf = kwant.solvers.default.wave_function(some_sys, some_energy) >>> wf = kwant.solvers.default.wave_function(some_sys, some_energy)
>>> wfs_of_lead_2 = wf(2) >>> wfs_of_lead_2 = wf(2)
""" """
return WaveFunction(self, sys, energy, args, check_hermiticity) return WaveFunction(self, sys, energy, args, check_hermiticity)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment