magnopy.SpinHamiltonian.remove

method

SpinHamiltonian.remove(nus, alphas, remove_equivalent=False)

Removes any parameter with at most four components of spin operator from the Hamiltonian.

Added in version 0.5.0.

See Spin Hamiltonian for the definition of the Hamiltonian.

Parameters:

nus(n, 3) or (n-1, 3) list/tuple of tuple of int

List of unit cell indices associated with the parameter. Each unit cell index is a tuple of three integers (t_1, t_2, t_3) corresponding to the translation by \(t_1 \boldsymbol{a}_1 + t_2 \boldsymbol{a}_2 + t_3 \boldsymbol{a}_3\).

alphas(n,) list/tuple of int

List of indices of atoms associated with the parameter. Based on the order in SpinHamiltonian.atoms.

remove_equivalentbool, default False

Whether to automatically remove all equivalent parameters related by the symmetrization procedure. Ignored if convention.multiple_counting is False. See Equivalent parameters for more details.

Notes

See notes of SpinHamiltonian.add() for the details on nus and alphas.

Be careful when removing SpinHamiltonian.p1 parameters when SpinHamiltonian.magnetic_field is not zero, as the Zeeman term is stored as a SpinHamiltonian.p1 parameters.

Examples

See Removing a parameter for more details on how to use this method.