tbplas.SuperCell
================

.. currentmodule:: tbplas

.. autoclass:: SuperCell

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~SuperCell.__init__
      ~SuperCell.add_hopping
      ~SuperCell.add_subscriber
      ~SuperCell.add_vacancies
      ~SuperCell.add_vacancy
      ~SuperCell.check_lock
      ~SuperCell.get_hop
      ~SuperCell.get_lattice_area
      ~SuperCell.get_lattice_volume
      ~SuperCell.get_orb_eng
      ~SuperCell.get_orb_pos
      ~SuperCell.get_reciprocal_vectors
      ~SuperCell.lock
      ~SuperCell.orb_id_pc2sc
      ~SuperCell.orb_id_pc2sc_array
      ~SuperCell.orb_id_sc2pc
      ~SuperCell.orb_id_sc2pc_array
      ~SuperCell.plot
      ~SuperCell.set_orb_pos_modifier
      ~SuperCell.set_vacancies
      ~SuperCell.sync_array
      ~SuperCell.trim
      ~SuperCell.unlock
      ~SuperCell.update
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~SuperCell.num_orb_pc
      ~SuperCell.num_orb_sc
      ~SuperCell.num_vac
      ~SuperCell.pc_hop_eng
      ~SuperCell.pc_hop_ind
      ~SuperCell.pc_lat_vec
      ~SuperCell.pc_orb_eng
      ~SuperCell.pc_orb_pos
      ~SuperCell.pc_origin
      ~SuperCell.prim_cell
      ~SuperCell.sc_lat_vec