Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
K
kwant
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Joseph Weston
kwant
Commits
58bd15e9
Commit
58bd15e9
authored
9 years ago
by
Christoph Groth
Browse files
Options
Downloads
Patches
Plain Diff
clarify wave_function docstring
parent
835e1ed8
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
kwant/solvers/common.py
+7
-4
7 additions, 4 deletions
kwant/solvers/common.py
with
7 additions
and
4 deletions
kwant/solvers/common.py
+
7
−
4
View file @
58bd15e9
...
...
@@ -513,16 +513,19 @@ class SparseSolver(object):
Notes
-----
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
the scattering region due to each mode of the given lead. Index 0 is
the mode number, index 1 is the orbital number. The modes appear in
the same order as incoming modes in `kwant.physics.modes`.
number, it returns a 2d NumPy array that contains the wave function
within the scattering region due to each incoming mode of the given
lead. Index 0 is the mode number, index 1 is the orbital number. The
modes appear in the same order as incoming modes in
`kwant.physics.modes`.
Examples
--------
>>>
wf
=
kwant
.
solvers
.
default
.
wave_function
(
some_sys
,
some_energy
)
>>>
wfs_of_lead_2
=
wf
(
2
)
"""
return
WaveFunction
(
self
,
sys
,
energy
,
args
,
check_hermiticity
)
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment