magnopy.SpinHamiltonian.map_to_all#

property

property SpinHamiltonian.map_to_all#

Index map from magnetic atoms to all atoms.

Returns:
map_to_all (M, ) list of int

Index map. Integers. M = len(spinham.magnetic_atoms.names)

See also

map_to_magnetic

Examples

See Magnetic vs non-magnetic atoms for more details on how to use this property.