sisl.physics.SparseOrbitalBZSpin
================================















.. currentmodule:: sisl.physics

.. autoclass:: SparseOrbitalBZSpin







   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         


   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
      
         
      
         
      
         

   
      
         
            
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         

   
      
      
         
      
         
      
         











   .. rubric:: Plotting

   .. autosummary::
      :removeprefix: SparseOrbitalBZSpin.

      SparseOrbitalBZSpin.plot
      





   

   

   

   

   

   

   

   

   

   

   

   


   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   
      
      SparseOrbitalBZSpin.plot.atomicmatrix

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   

   








   .. rubric:: Methods

   .. autosummary::
      





   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.Rij

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.Sk

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.add

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.append

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.astype

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.bond_order

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.construct

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.copy

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.create_construct

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.dSk

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.ddSk

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.edges

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.eig

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.eigh

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.eigsh

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.eliminate_zeros

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.empty

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.finalize

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.fromsp

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.iter_nnz

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.iter_orbitals

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.nonzero

   

   

   
   

   
      
         
      
      
      

   

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.prepend

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.prune_range

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.remove

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.remove_orbital

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.repeat

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.replace

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.reset

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.rij

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.set_nsc

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.spalign

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.spin_align

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.spin_rotate

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.spsame

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.sub

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.sub_orbital

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.swap

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.tile

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.toSparseAtom

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.tocsr

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.transform

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.translate2uc

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.transpose

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.trs

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.unrepeat

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.untile




   .. rubric:: Attributes

   .. autosummary::
      





   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.S

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.dim

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.dkind

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.dtype

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.finalized

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.geometry

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.nnz

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.non_orthogonal

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.orthogonal

   

   

   
   
      
      

   
      
      
      
      

   

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.shape

   

   

   
   

   
      
      
      
      

   
      
   
      ~SparseOrbitalBZSpin.spin