Skip to content

Commit

Permalink
removed position, it is not correct
Browse files Browse the repository at this point in the history
Signed-off-by: Nick Papior <nickpapior@gmail.com>
  • Loading branch information
zerothi committed Nov 14, 2024
1 parent 443c51f commit e7b8143
Showing 1 changed file with 0 additions and 37 deletions.
37 changes: 0 additions & 37 deletions src/sisl/physics/_ufuncs_electron.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,43 +55,6 @@ def velocity(state: StateCElectron, *args, **kwargs):
return v


@register_sisl_dispatch(StateCElectron, module="sisl.physics")
def position(state: StateCElectron, *args, **kwargs):
r"""Calculate position for the states
This routine calls ``derivative(1, *args, **kwargs)`` and returns the velocity for the states.
Note that the coefficients associated with the `StateCElectron` *must* correspond
to the energies of the states.
The unit is Ang/ps.
Notes
-----
The velocities are calculated without the Berry curvature contribution see Eq. (2) in :cite:`Wang2006`.
It is thus typically denoted as the *effective velocity operater* (see Ref. 21 in :cite:`Wang2006`.
The missing contribution may be added in later editions, for completeness sake, it is:
.. math::
\delta \mathbf v = - \mathbf k\times \Omega_i(\mathbf k)
where :math:`\Omega_i` is the Berry curvature for state :math:`i`.
Parameters
----------
*args, **kwargs:
arguments passed directly to `derivative`, see that method
for argument details.
See Also
--------
derivative : for details of the implementation
"""
v = state.derivative(1, *args, **kwargs)
v *= _velocity_const
return v


@register_sisl_dispatch(StateCElectron, module="sisl.physics")
def berry_curvature(
state: StateCElectron,
Expand Down

0 comments on commit e7b8143

Please sign in to comment.