Verified Commit 96ce9c31 authored by Adel Kara Slimane's avatar Adel Kara Slimane
Browse files

Update docstrings in energy.pyx

parent 4b4eeaef
......@@ -252,11 +252,12 @@ cdef class EnergyCurrent:
`operatorType` = 2.
time_name : :py:class:`str`
The name the time parameter has in the ``params`` dictionary given to `__call__`.
The name the time parameter has in the ``params`` dictionary given to `__call__`. It
is initialised with tkwant's default name, which is ``time``.
time_start : :py:class:`float`
The instant :math:`t_0` at which time dependence starts in the Hamiltonian.
Initialized to tKwant's default value.
Initialized with tKwant's default value, which is ``0``.
where : 2D array of `~kwant.graph.defs.gint` (a python :py:class:`int` compatible type) of shape :math:`n \times 2`
List of hoppings :math:`(j, i)` (accessed as ``j, i = where[n, 0], where[n, 1]``)
......@@ -586,11 +587,12 @@ cdef class EnergySource:
`operatorType` = 2.
time_name : :py:class:`str`
The name the time parameter has in the ``params`` dictionary given to `__call__`.
The name the time parameter has in the ``params`` dictionary given to `__call__`. It
is initialised with tkwant's default name, which is ``time``.
time_start : :py:class:`float`
The instant :math:`t_0` at which time dependence starts in the Hamiltonian.
Initialized to tKwant's default value.
Initialized with tKwant's default value, which is ``0``.
dt_customOnsite : :py:const:`None` (default) or (`~kwant.builder.Site`, :py:class:`dict`) :math:`\rightarrow` complex matrix-like object
Used as the value of the time derivative of the energy operator :math:`ε`
......@@ -967,11 +969,12 @@ cdef class EnergyDensity:
`operatorType` = 2.
time_name : :py:class:`str`
The name the time parameter has in the ``params`` dictionary given to `__call__`.
The name the time parameter has in the ``params`` dictionary given to `__call__`. It
is initialised with tkwant's default name, which is ``time``.
time_start : :py:class:`float`
The instant :math:`t_0` at which time dependence starts in the hamiltonian.
Initialized to tKwant's default value.
The instant :math:`t_0` at which time dependence starts in the Hamiltonian.
Initialized with tKwant's default value, which is ``0``.
where : 2D array of `~kwant.graph.defs.gint` (a python :py:class:`int` compatible type) of shape :math:`n \times 2`
List of sites :math:`i` (accessed as ``i = where[n, 0]``) on which the energy density is calculated at each call.
......
Supports Markdown
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