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,
Nonebehaves asTrue; for an existing SPRKKRAtoms object,Noneretains its present site symmetry.update_info (bool or None, optional) – If
True, recompute space-group information; ifFalse, never recompute it. IfNone, update it when site information has already been initialized.
- Returns:
The promoted object, or
Nonefor aNoneinput.- Return type:
SPRKKRAtoms or None