SPRKKRAtoms

class ase2sprkkr.sprkkr.sprkkr_atoms.SPRKKRAtoms(*args, potential=None, symmetry=True, **kwargs)[source]

ASE Atoms object extended by the data necessary for SPR-KKR calculations

Class hierarchy

Inheritance diagram of ase2sprkkr.sprkkr.sprkkr_atoms.SPRKKRAtoms


Constructor

__init__(*args, potential=None, symmetry=True, **kwargs)[source]

Creates SPRKKRAtoms atoms

Parameters:
  • *args (list) – The positionals arguments of ase.Atoms.__init__

  • symmetry (bool) – The symmetry will be computed when the sites property will be initialized. I.e., the by-symmetry-equal atomic sites will share the same sites object.

  • **kwargs (dict) – The named arguments of ase.Atoms.__init__

sites_array_name = 'sprkkr_sites_data'
static promote_ase_atoms(obj, symmetry=None, update_info=None)[source]

Promote an ASE atoms object for SPR-KKR calculations.

The object is promoted in place by replacing its __class__ with an SPRKKR-enabled subclass.

Parameters:
  • obj (ase.Atoms) – Atoms to promote.

  • symmetry (bool or None, optional) – If enabled, symmetry-equivalent atoms share a site type. For an unpromoted object, None behaves as True; for an existing SPRKKRAtoms object, None retains its present site symmetry.

  • update_info (bool or None, optional) – If True, recompute space-group information; if False, never recompute it. If None, update it when site information has already been initialized.

Returns:

The promoted object, or None for a None input.

Return type:

SPRKKRAtoms or None

_init(symmetry=True, potential=None)[source]

The initialization of the additional (not-in-ASE) properties. To be used by constructor and by promote_ase_atoms

property regions
add_region(region)[source]

Add a region of a given name

remove_region(name)[source]
set_regions(regions)[source]
Parameters:

regions (List)

property symmetry

Whether the sites property is/will be generated using symmetry, i.e. whether the Sites objects in the sites property will be shared among symmetric atomic sites.

update_sites_from_symbols()[source]
compute_sites_symmetry(symmetry=None, consider_old=False, symmetry_precision=1e-05, angular_precision=1e-05)[source]

SPRKKR has some properties shared by all by-symmetry-equal sites. This method can be called to recompute the equivalent sites.

breaks_sites_symmetry(*args, **kwargs)[source]

Cancel the use of symmetry in the structure, i.e., makes the Site object uniqe (not shared) for each atomic site.

Calling this method is nearly equivalent to setting the symmetry property to False, however, this method always recompute the sites object, while setting symmetry=False recomputes the sites property only if it was previously set to True.

property sites

The sites property holds all the information for the SPR-KKR package: atomic types (including number of semicore and valence electrons), occupancy, symmetries, meshes… Some of the properties are stored in the ASE atoms properties (e.g. occupancy, atomic symbol), however, ASE is not able to hold them all and/or to describe fully the SPR-KKR options; thus, these properties are hold in this array.

The changes made on this array are reflected (as is possible) to the ASE properties, but the opposite does not hold - to reflect the changes in these properties please create a new Atoms object with given properties.

are_sites_inited()[source]
set_sites(sites, spacegroup_info=None, update=True)[source]

Set the sites property and update all other dependent properties (symbols, occupancy) according to the sites.

Unlike sites setter, this method allow also set the spacegoup_info containing the computed informations about the symmetry.

Parameters:
  • sites (numpy.ndarray) – The array of the ase2sprkkr.sprkkr.sites.Site objects.

  • sg_info – Information, about the symmetry. If None is given, no info is available, the symmetry will be determined if needed. If False, there is no symmetry. If True, retain the current symmetry.

  • update (bool) – Pass False to prevent updating spacegroup_kinds and occupancy

  • spacegroup_info (ase2sprkkr.sprkkr.spacegroup_info.SpacegroupInfo | bool | None)

property spacegroup_info
property potential
has_potential()[source]
sprkkr_has_converged_data()[source]

Return whether all atomic types contain restartable SCF data.

sprkkr_is_scf_converged()[source]

Return whether the SPR-KKR SCF state represented by these atoms is converged.

If a Potential is attached, its SCF status is authoritative. Without an attached Potential, convergence is inferred from restartable data stored in the atomic types. The check does not create a Potential as a side effect.

sprkkr_reset_potential()[source]

Reset all SPR-KKR potential data stored in the atoms.

copy()[source]
_promote_if_other(other)[source]
extend(other)[source]