promote_ase_atoms

Full name: ase2sprkkr.promote_ase_atoms

ase2sprkkr.promote_ase_atoms(obj, symmetry=None, update_info=None)

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