radtools.ExchangeParameter

class radtools.ExchangeParameter(matrix=None, iso=None, aniso=None, dmi=None)

Exchange parameter (\(\boldsymbol{J}\)) class.

Basically it is a wrapper around numpy.ndarray with predefined exchange-specific attributes. Any function, which work on numpy.ndarray should work on ExchangeParameter as well. It will act on the matrix attribute.

If matrix is specified then iso, aniso and dmi are ignored and derived from matrix. If matrix is not specified then it is derived from iso, aniso and dmi. If nothing is provided exchange matrix is set to zero matrix.

Parameters:

isoint or float, optional

Value of isotropic exchange parameter.

aniso(3, 3) array-like, optional

3 x 3 matrix of symmetric anisotropic exchange.

dmi(3,) array-like, optional

Dzyaroshinsky-Moria interaction vector \((D_x, D_y, D_z)\).

matrix(3, 3) array-like, optional

Exchange matrix.

Methods:

Properties:

T	Transposes a matrix of the exchange parameter.
aniso	3 x 3 matrix of symmetric anisotropic exchange.
aniso_diagonal	Diagonal part of the symmetric anisotropic exchange.
aniso_diagonal_matrix	Diagonal part of the symmetric anisotropic exchange.
asymm_matrix	Asymmetric part of exchange matrix.
dmi	Dzyaroshinsky-Moria interaction vector (Dx, Dy, Dz).
dmi_matrix	Asymmetric part of the exchange matrix.
dmi_module	Length of the DMI vector in the units of exchange interaction.
iso	Value of isotropic exchange parameter.
iso_matrix	Isotropic part of the exchange matrix.
matrix	Full exchange matrix.
rel_dmi	Relative value of DMI.
symm_matrix	Symmetric part of exchange matrix.