radtools.ExchangeHamiltonian
============================

.. currentmodule:: radtools

.. role:: custom-header

.. autoclass:: ExchangeHamiltonian

   
   
   :custom-header:`Methods:`

   .. autosummary::
      :toctree:
   
      ~ExchangeHamiltonian.add_atom
      ~ExchangeHamiltonian.add_bond
      ~ExchangeHamiltonian.ferromagnetic_energy
      ~ExchangeHamiltonian.filter
      ~ExchangeHamiltonian.filtered
      ~ExchangeHamiltonian.force_symmetry
      ~ExchangeHamiltonian.forced_symmetry
      ~ExchangeHamiltonian.get_atom_coordinates
      ~ExchangeHamiltonian.get_bond_vector
      ~ExchangeHamiltonian.get_distance
      ~ExchangeHamiltonian.input_for_magnons
      ~ExchangeHamiltonian.remove_atom
      ~ExchangeHamiltonian.remove_bond
      ~ExchangeHamiltonian.set_interpretation
      ~ExchangeHamiltonian.summary_as_txt
   
   

   
   
   :custom-header:`Properties:`

   .. autosummary::
      :toctree:
   
      ~ExchangeHamiltonian.cell
      ~ExchangeHamiltonian.cell_list
      ~ExchangeHamiltonian.crystal
      ~ExchangeHamiltonian.double_counting
      ~ExchangeHamiltonian.factor_one_half
      ~ExchangeHamiltonian.factor_two
      ~ExchangeHamiltonian.magnetic_atoms
      ~ExchangeHamiltonian.minus_sign
      ~ExchangeHamiltonian.notation
      ~ExchangeHamiltonian.number_spins_in_unit_cell
      ~ExchangeHamiltonian.space_dimensions
      ~ExchangeHamiltonian.spin_normalized