magnopy.is_eigenstate

magnopy.is_eigenstate(spinham, spin_directions, energy_tolerance=1e-08)

Checks all eigenstate conditions as described in the supplementary note 4 of paper about Magnopy (eqs. S.40-S.50).

Parameters:

spinhammagnopy.SpinHamiltonian

Spin Hamiltonian

spin_directions(M, 3) array-like

Directional vectors. M is an amount of atoms in spinham.magnetic_atoms.

energy_tolerancefloat, default 1e-8

Numerical accuracy for comparing energy values to zero. Given in the same units as spinham.units.

Returns:

resultbool

True if spin_directions describe an eigenstate of spinham. False otherwise.