Polaron
=======

.. currentmodule:: defermi.defects

.. autoclass:: Polaron
   :members:
   :show-inheritance:
   :inherited-members:

   
   
   .. rubric:: Methods

   .. autosummary::
      :nosignatures:
   
      
      
      ~Polaron.as_dict
      
      
      ~Polaron.from_dict
      
      
      ~Polaron.from_string
      
      
      ~Polaron.generate_defect_structure
      
      
      ~Polaron.get_multiplicity
      
      
      ~Polaron.load
      
      
      ~Polaron.save
      
      
      ~Polaron.set_bulk_volume
      
      
      ~Polaron.set_charge
      
      
      ~Polaron.set_label
      
      
      ~Polaron.set_multiplicity
      
      
      ~Polaron.to_json
      
      
      ~Polaron.unsafe_hash
      
      
      ~Polaron.validate_monty_v1
      
      
      ~Polaron.validate_monty_v2
      
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~Polaron.REDIRECT
      ~Polaron.bulk_structure
      ~Polaron.bulk_volume
      ~Polaron.charge
      ~Polaron.defect_composition
      ~Polaron.defect_site_index
      ~Polaron.defect_structure
      ~Polaron.defects
      ~Polaron.delta_atoms
      ~Polaron.label
      ~Polaron.multiplicity
      ~Polaron.name
      ~Polaron.site
      ~Polaron.site_concentration_in_cm3
      ~Polaron.specie
      ~Polaron.symbol
      ~Polaron.symbol_with_charge
      ~Polaron.symbol_with_charge_kv
      ~Polaron.type