radtools.MagnonDispersion.omega

method

MagnonDispersion.omega(k, zeros_to_none=False, return_G=False, return_imaginary=False)

Computes magnon energies.

Parameters:

k(3,) array-like

Reciprocal vector. In absolute coordinates.

zeros_to_nonebool, default=False

If True, then return None instead of 0 if Colpa fails.

return_Gbool, default False

Whether to return the transformation matrix. See solve_via_colpa() for details. .. versionadded:: 0.8.10

return_imaginarybool, default False

Whether to return imaginary part of the energies. If True, then real and imaginary part can be accessed via omegas.real and omegas.imag. .. versionadded:: 0.8.10

Returns:

omegas(N,) numpy.ndarray

Magnon energies for the vector k. If return_G is True, then return (2N,) numpy.ndarray else return (N,) numpy.ndarray. See solve_via_colpa() for details.

G(2N, 2N)numpy.ndarray

Transformation matrix. Returned only if return_G is True. See solve_via_colpa() for details.