grogupy.physics.MagneticEntityList

class grogupy.physics.MagneticEntityList(magnetic_entities: None | list[MagneticEntity] | ndarray[Any, dtype[_ScalarType_co]] | MagneticEntityList = None)

List of MagneticEntities.

It supports easier attribute access across the MagneticEntities in the list.

__init__(magnetic_entities: None | list[MagneticEntity] | ndarray[Any, dtype[_ScalarType_co]] | MagneticEntityList = None)

Methods

__init__([magnetic_entities])
append(item)	Appends to the magnetic entity list.
toarray()	Returns a numpy array from the underlying data.
tolist()	Returns a list from the underlying data.

Attributes

K	The anisotropy tensor, in meV.
K_J	The anisotropy tensor, but in J.
K_consistency	The consistency check, in meV.
K_consistency_J	The consistency check, but in J.
K_consistency_mRy	The consistency check, but in mRy.
K_consistency_meV	The consistency check, but in meV.
K_mRy	The anisotropy tensor, but in mRy.
K_meV	The anisotropy tensor, but in meV.
SBI	The spin box indices of the magnetic entity
SBS	The spin box size of the magnetic entity
cell	The cell of the Hamiltonian.
dh_ds_id	The ID of the Hamiltonian and the Density Matrix.
energies_J	The energies, but in J.
energies_mRy	The energies, but in mRy.
energies_meV	The energies, but in meV.
local_Q	The charge of the magnetic entity.
local_S	Spin moment of the magnetic entity.
local_Sx	Sx of the magnetic entity.
local_Sy	Sy of the magnetic entity.
local_Sz	Sz of the magnetic entity.
tag	The description of the magnetic entity
total_Q	The total charge of the atom or the atoms of the magnetic entity.
total_S	Total spin moment of the atom or the atoms of the magnetic entity.
total_Sx	Total Sx of the atom or the atoms of the magnetic entity.
total_Sy	Total Sy of the atom or the atoms of the magnetic entity.
total_Sz	Total Sz of the atom or the atoms of the magnetic entity.
xyz_center	The mean of the position of the atoms that are in the magnetic entity.