magnopy.SpinHamiltonian.add_22#

method

SpinHamiltonian.add_22(alpha: int, beta: int, nu: tuple, parameter, units=None, when_present='raise error')#

Adds a parameter of two spins & two sites term of the Hamiltonian (partition 1+1).

Deprecated since version 0.5.0: Use SpinHamiltonian.add() instead.

See Spin Hamiltonian for the definition of the relevant term of the Hamiltonian.

See SpinHamiltonian.add() for the detailed description of units, when_present, and populate_equivalent arguments.

Parameters:

alphaint

Index of an atom from the (0, 0, 0) unit cell.

0 <= alpha < len(spinham.atoms.names).

betaint

Index of an atom from the nu unit cell.

0 <= beta < len(spinham.atoms.names).

nutuple of 3 int

Three relative coordinates with respect to the three lattice vectors, that specify the unit cell for the second atom.

parameter(3, 3) array-like

Value of the parameter (\(3 imes3\) matrix). Given in the units of units.

unitsstr, optional

Added in version 0.3.0.

when_presentstr, default "raise error"

Added in version 0.4.0.