.. _api_parameter:

*****************
ExchangeParameter
*****************

.. currentmodule:: radtools

Class
=====

.. autosummary::
    :toctree: generated/

    ExchangeParameter

Modification
============

.. autosummary::
    :toctree: generated/

    ExchangeParameter.T

Full exchange matrix
====================

.. autosummary::
    :toctree: generated/

    ExchangeParameter.matrix
    ExchangeParameter.symm_matrix
    ExchangeParameter.asymm_matrix
    ExchangeParameter.xx
    ExchangeParameter.xy
    ExchangeParameter.xz
    ExchangeParameter.yx
    ExchangeParameter.yy
    ExchangeParameter.yz
    ExchangeParameter.zx
    ExchangeParameter.zy
    ExchangeParameter.zz

Isotropic exchange
==================

.. autosummary::
    :toctree: generated/

    ExchangeParameter.iso
    ExchangeParameter.iso_matrix

Symmetric anisotropic exchange
==============================

.. autosummary::
    :toctree: generated/

    ExchangeParameter.aniso
    ExchangeParameter.aniso_diagonal
    ExchangeParameter.aniso_diagonal_matrix

Dzyaroshinsky-Moria
===================

.. autosummary::
    :toctree: generated/

    ExchangeParameter.dmi
    ExchangeParameter.dmi_module
    ExchangeParameter.dmi_matrix
    ExchangeParameter.rel_dmi