sisl.physics.electron.EigenstateElectron
========================================















.. currentmodule:: sisl.physics.electron

.. autoclass:: EigenstateElectron







   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         


   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
            
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         











   .. rubric:: Plotting

   .. autosummary::
      :removeprefix: EigenstateElectron.

      EigenstateElectron.plot
      





   

   

   

   

   

   

   

   

   


   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   
      
      EigenstateElectron.plot.wavefunction

   

   

   

   

   

   

   

   

   

   








   .. rubric:: Methods

   .. autosummary::
      





   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.COHP

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.COOP

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.COP

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.DOS

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.PDOS

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.Sk

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.align_norm

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.align_phase

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.asCoefficient

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.asState

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.berry_curvature

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.change_gauge

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.copy

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.degenerate

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.derivative

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.effective_mass

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.inner

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.ipr

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.iter

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.norm

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.norm2

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.normalize

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.occupation

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.outer

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.phase

   

   

   
   

   
      
         
      
      
      

   

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.remove

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.rotate

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.sort

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.spin_berry_curvature

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.spin_moment

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.sub

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.tile

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.translate

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.velocity

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.wavefunction




   .. rubric:: Attributes

   .. autosummary::
      





   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.c

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.dkind

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.dtype

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.eig

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.info

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.parent

   

   

   
   
      
      

   
      
      
      
      

   

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.shape

   

   

   
   

   
      
      
      
      

   
      
   
      ~EigenstateElectron.state