magnopy.SpinHamiltonian.map_to_magnetic

property

property SpinHamiltonian.map_to_magnetic

Index map from all atoms to the magnetic ones.

Returns:

map_to_magnetic (M_prime, ) list of int

Index map. Integers. M_prime = len(spinham.atoms.names)

See also

map_to_all

Examples

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