radtools.SpinHamiltonian
========================

.. currentmodule:: radtools

.. role:: custom-header

.. autoclass:: SpinHamiltonian

   
   
   :custom-header:`Methods:`

   .. autosummary::
      :toctree:
   
      ~SpinHamiltonian.add_atom
      ~SpinHamiltonian.add_bond
      ~SpinHamiltonian.converge_mag_dipdip_energy
      ~SpinHamiltonian.ferromagnetic_energy
      ~SpinHamiltonian.filter
      ~SpinHamiltonian.filtered
      ~SpinHamiltonian.find_primitive_cell
      ~SpinHamiltonian.form_model
      ~SpinHamiltonian.formed_model
      ~SpinHamiltonian.get_atom
      ~SpinHamiltonian.get_atom_coordinates
      ~SpinHamiltonian.get_distance
      ~SpinHamiltonian.get_vector
      ~SpinHamiltonian.input_for_magnons
      ~SpinHamiltonian.lattice_points
      ~SpinHamiltonian.mag_dipdip_energy
      ~SpinHamiltonian.remove_atom
      ~SpinHamiltonian.remove_bond
      ~SpinHamiltonian.set_interpretation
      ~SpinHamiltonian.type
      ~SpinHamiltonian.voronoi_cell
   
   

   
   
   :custom-header:`Properties:`

   .. autosummary::
      :toctree:
   
      ~SpinHamiltonian.a
      ~SpinHamiltonian.a1
      ~SpinHamiltonian.a2
      ~SpinHamiltonian.a3
      ~SpinHamiltonian.alpha
      ~SpinHamiltonian.b
      ~SpinHamiltonian.b1
      ~SpinHamiltonian.b2
      ~SpinHamiltonian.b3
      ~SpinHamiltonian.beta
      ~SpinHamiltonian.c
      ~SpinHamiltonian.cell
      ~SpinHamiltonian.cell_list
      ~SpinHamiltonian.centring_type
      ~SpinHamiltonian.conv_a
      ~SpinHamiltonian.conv_a1
      ~SpinHamiltonian.conv_a2
      ~SpinHamiltonian.conv_a3
      ~SpinHamiltonian.conv_alpha
      ~SpinHamiltonian.conv_b
      ~SpinHamiltonian.conv_beta
      ~SpinHamiltonian.conv_c
      ~SpinHamiltonian.conv_cell
      ~SpinHamiltonian.conv_gamma
      ~SpinHamiltonian.conv_parameters
      ~SpinHamiltonian.conv_unit_cell_volume
      ~SpinHamiltonian.crystal
      ~SpinHamiltonian.crystal_family
      ~SpinHamiltonian.double_counting
      ~SpinHamiltonian.eps
      ~SpinHamiltonian.eps_rel
      ~SpinHamiltonian.factor
      ~SpinHamiltonian.gamma
      ~SpinHamiltonian.k_a
      ~SpinHamiltonian.k_alpha
      ~SpinHamiltonian.k_b
      ~SpinHamiltonian.k_beta
      ~SpinHamiltonian.k_c
      ~SpinHamiltonian.k_gamma
      ~SpinHamiltonian.kpoints
      ~SpinHamiltonian.lattice
      ~SpinHamiltonian.magnetic_atoms
      ~SpinHamiltonian.name
      ~SpinHamiltonian.notation
      ~SpinHamiltonian.notation_string
      ~SpinHamiltonian.number_spins_in_unit_cell
      ~SpinHamiltonian.parameters
      ~SpinHamiltonian.pearson_symbol
      ~SpinHamiltonian.reciprocal_cell
      ~SpinHamiltonian.reciprocal_cell_volume
      ~SpinHamiltonian.reciprocal_parameters
      ~SpinHamiltonian.space_dimensions
      ~SpinHamiltonian.spin_normalized
      ~SpinHamiltonian.unit_cell_volume
      ~SpinHamiltonian.variation