radtools.SpinHamiltonian.input_for_magnons#

method

SpinHamiltonian.input_for_magnons(nodmi=False, noaniso=False, custom_mask=None)[source]#

Input from the spin Hamiltonian.

This function prepare the list of exchange parameters to be used as an input for magnon dispersion calculation.

Parameters:

nodmibool, default=False: If True, then DMI is not included in the dispersion.
noanisobool, default=False: If True, then anisotropy is not included in the dispersion.
custom_maskfunc: Custom mask for the exchange parameter. Function which take (3,3) numpy:ndarray as an input and returns (3,3) numpy:ndarray as an output.

Returns: