sisl.physics.Hamiltonian
========================















.. currentmodule:: sisl.physics

.. autoclass:: Hamiltonian







   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         


   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
            
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         











   .. rubric:: Plotting

   .. autosummary::
      :removeprefix: Hamiltonian.

      Hamiltonian.plot
      





   

   

   

   

   

   

   

   

   

   

   

   

   


   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   
      
      Hamiltonian.plot.atomicmatrix

   
      
      Hamiltonian.plot.pdos

   
      
      Hamiltonian.plot.wavefunction

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   








   .. rubric:: Methods

   .. autosummary::
      





   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.Hk

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.Rij

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.Sk

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.add

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.append

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.construct

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.copy

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.create_construct

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.dHk

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.dSk

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.ddHk

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.ddSk

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.edges

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.eig

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.eigenstate

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.eigenvalue

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.eigh

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.eigsh

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.eliminate_zeros

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.empty

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.fermi_level

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.finalize

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.fromsp

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.iter_nnz

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.iter_orbitals

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.nonzero

   

   

   
   

   
      
         
      
      
      

   

   

   

   
   

   
      
         
      
      
      

   

   

   

   
   

   
      
         
      
      
      

   

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.prepend

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.read

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.remove

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.remove_orbital

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.repeat

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.replace

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.reset

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.rij

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.set_nsc

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.shift

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.spalign

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.spsame

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.sub

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.sub_orbital

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.swap

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.tile

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.toSparseAtom

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.tocsr

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.transform

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.translate2uc

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.transpose

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.trs

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.unrepeat

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.untile

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.write




   .. rubric:: Attributes

   .. autosummary::
      





   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.H

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.S

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.dim

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.dkind

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.dtype

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.finalized

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.geometry

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.nnz

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.non_orthogonal

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.orthogonal

   

   

   
   
      
      

   
      
      
      
      

   

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.shape

   

   

   
   

   
      
      
      
      

   
      
   
      ~Hamiltonian.spin