magnopy.SpinHamiltonian.atoms

property

property SpinHamiltonian.atoms: dict

Atoms of the crystal on which the Hamiltonian is build.

See Atoms/Sites for more details.

Returns:

atomsdict (with added sugar)

Dictionary with the atoms.

See also

M_prime

Notes

If is not recommended to change the atoms property after the creation of SpinHamiltonian. In fact an attempt to do so raises an AttributeError:

>>> import numpy as np
>>> import magnopy
>>> convention = magnopy.Convention()
>>> spinham = magnopy.SpinHamiltonian(
...     cell=np.eye(3), atoms={}, convention=convention
... )
>>> spinham.atoms = {"names": ["Cr"]}
Traceback (most recent call last):
...
AttributeError: Change of the atoms dictionary is not allowed after the creation of SpinHamiltonian instance. SpinHamiltonian.atoms is immutable.