Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
kwant
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
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
Dennis Heffels
kwant
Commits
3a6056ef
Commit
3a6056ef
authored
5 years ago
by
Christoph Groth
Browse files
Options
Downloads
Patches
Plain Diff
rearrange docstring of vectorized system
Describe more fundamental attributes first.
parent
dc280613
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
kwant/system.py
+12
-12
12 additions, 12 deletions
kwant/system.py
with
12 additions
and
12 deletions
kwant/system.py
+
12
−
12
View file @
3a6056ef
...
...
@@ -546,6 +546,18 @@ class VectorizedSystem(System, metaclass=abc.ABCMeta):
----------
symmetry : kwant.system.Symmetry
The symmetry of the system.
site_arrays : sequence of SiteArray
The sites of the system. The family of each site array must have
``norbs`` specified.
site_ranges : Nx3 integer array
Has 1 row per site array, plus one extra row. Each row consists
of ``(first_site, norbs, orb_offset)``: the index of the first
site in the site array, the number of orbitals on each site in
the site array, and the offset of the first orbital of the first
site in the site array. In addition, the final row has the form
``(len(graph.num_nodes), 0, tot_norbs)`` where ``tot_norbs`` is the
total number of orbitals in the system. Note
'
site_ranges
'
is directly computable from
'
site_arrays
'
.
graph : kwant.graph.CGraph
The system graph.
subgraphs : sequence of tuples
...
...
@@ -561,18 +573,6 @@ class VectorizedSystem(System, metaclass=abc.ABCMeta):
'
hermitian
'
is
'
True
'
if the term needs its Hermitian
conjugate to be added when evaluating the Hamiltonian, and
'
parameters
'
contains a list of parameter names used when evaluating this term.
site_arrays : sequence of SiteArray
The sites of the system. The family of each site array must have
``norbs`` specified.
site_ranges : Nx3 integer array
Has 1 row per site array, plus one extra row. Each row consists
of ``(first_site, norbs, orb_offset)``: the index of the first
site in the site array, the number of orbitals on each site in
the site array, and the offset of the first orbital of the first
site in the site array. In addition, the final row has the form
``(len(graph.num_nodes), 0, tot_norbs)`` where ``tot_norbs`` is the
total number of orbitals in the system. Note
'
site_ranges
'
is directly computable from
'
site_arrays
'
.
parameters : frozenset of strings
The names of the parameters on which the system depends. This attribute
is provisional and may be changed in a future version of Kwant
...
...
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