Polaron

class Polaron(specie=None, defect_site=None, bulk_structure=None, charge=None, multiplicity=None, label=None, bulk_volume=None, defect_structure=None)

Bases: Defect

Subclass of Defect for polarons.

defect_structure: Structure

Structure containing the polaron. If not provided the site index is searched in the bulk structure, and defect_structure is set equal to the bulk structure.

Methods

as_dict	A JSON serializable dict representation of an object.
from_dict	Reconstruct an MSONable object from a dict.
from_string
generate_defect_structure	Structure containing the polaron.
get_multiplicity	Get multiplicity of the defect in the structure.
load	Load an instance from a JSON file written by save().
save	Serialize the instance to JSON on disk, pickling fields if needed.
set_bulk_volume	Sets the volume of bulk cell
set_charge	Sets the charge of the defect.
set_label	Sets the label of the defect
set_multiplicity	Sets the Multiplicity of the defect.
to_json	Returns a json string representation of the MSONable object.
unsafe_hash	Return a hash of the current object.
validate_monty_v1	Pydantic validator with correct signature for pydantic v1.x.
validate_monty_v2	Pydantic validator with correct signature for pydantic v2.x.

Attributes

REDIRECT
bulk_structure	Structure without defects.
bulk_volume	Volume of bulk cell in A°^3.
charge	Charge of the defect.
defect_composition	Composition of the defect.
defect_site_index	Index of the defect site in the structure.
defect_structure	Structure of the defect.
defects
delta_atoms	Dictionary with delement as keys and difference in particle number between defect and bulk structure as values.
label	Defect label.
multiplicity	Multiplicity of a defect site within the structure
name	Name of the defect.
site	Defect position as a Site object
site_concentration_in_cm3	Site concentration (multiplicity/volume) expressed in cm^-3.
specie	Defect species.
symbol	Latex formatted name of the defect.
symbol_with_charge	Name in latex format with charge written as a number.
symbol_with_charge_kv	Name in latex format with charge written with Kröger and Vink notation.
type	Defect type.

property defect_composition

Composition of the defect.

property defect_site_index

Index of the defect site in the structure.

property delta_atoms

Dictionary with delement as keys and difference in particle number between defect and bulk structure as values.

generate_defect_structure(bulk_structure=None)

Structure containing the polaron. If not provided the site index is searched in the bulk structure, and defect_structure is set equal to the bulk structure.

get_multiplicity(**kwargs)

Get multiplicity of the defect in the structure.

Parameters:

**kwargs (dict) – Kwargs to pass to SpacegroupAnalyzer (“symprec”, “angle_tolerance”)

property name

Name of the defect.

property symbol

Latex formatted name of the defect.