Ion
===

.. currentmodule:: fiasco

.. autoclass:: Ion
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~Ion.abundance
      ~Ion.atomic_number
      ~Ion.atomic_symbol
      ~Ion.charge_state
      ~Ion.dielectronic_recombination_rate
      ~Ion.direct_ionization_rate
      ~Ion.effective_collision_strength
      ~Ion.electron_collision_deexcitation_rate
      ~Ion.electron_collision_excitation_rate
      ~Ion.element_name
      ~Ion.excitation_autoionization_rate
      ~Ion.formation_temperature
      ~Ion.helium_like
      ~Ion.hydrogenic
      ~Ion.ion_name
      ~Ion.ion_name_roman
      ~Ion.ionization_fraction
      ~Ion.ionization_potential
      ~Ion.ionization_rate
      ~Ion.ionization_stage
      ~Ion.ionization_stage_roman
      ~Ion.isoelectronic_sequence
      ~Ion.levels
      ~Ion.mass
      ~Ion.n_levels
      ~Ion.n_transitions
      ~Ion.period
      ~Ion.proton_collision_deexcitation_rate
      ~Ion.proton_collision_excitation_rate
      ~Ion.proton_electron_ratio
      ~Ion.radiative_recombination_rate
      ~Ion.recombination_rate
      ~Ion.thermal_energy
      ~Ion.transitions

   .. rubric:: Methods Summary

   .. autosummary::

      ~Ion.contribution_function
      ~Ion.emissivity
      ~Ion.free_bound
      ~Ion.free_bound_radiative_loss
      ~Ion.free_free
      ~Ion.free_free_radiative_loss
      ~Ion.intensity
      ~Ion.level_populations
      ~Ion.next_ion
      ~Ion.previous_ion
      ~Ion.spectrum
      ~Ion.two_photon

   .. rubric:: Attributes Documentation

   .. autoattribute:: abundance
   .. autoattribute:: atomic_number
   .. autoattribute:: atomic_symbol
   .. autoattribute:: charge_state
   .. autoattribute:: dielectronic_recombination_rate
   .. autoattribute:: direct_ionization_rate
   .. autoattribute:: effective_collision_strength
   .. autoattribute:: electron_collision_deexcitation_rate
   .. autoattribute:: electron_collision_excitation_rate
   .. autoattribute:: element_name
   .. autoattribute:: excitation_autoionization_rate
   .. autoattribute:: formation_temperature
   .. autoattribute:: helium_like
   .. autoattribute:: hydrogenic
   .. autoattribute:: ion_name
   .. autoattribute:: ion_name_roman
   .. autoattribute:: ionization_fraction
   .. autoattribute:: ionization_potential
   .. autoattribute:: ionization_rate
   .. autoattribute:: ionization_stage
   .. autoattribute:: ionization_stage_roman
   .. autoattribute:: isoelectronic_sequence
   .. autoattribute:: levels
   .. autoattribute:: mass
   .. autoattribute:: n_levels
   .. autoattribute:: n_transitions
   .. autoattribute:: period
   .. autoattribute:: proton_collision_deexcitation_rate
   .. autoattribute:: proton_collision_excitation_rate
   .. autoattribute:: proton_electron_ratio
   .. autoattribute:: radiative_recombination_rate
   .. autoattribute:: recombination_rate
   .. autoattribute:: thermal_energy
   .. autoattribute:: transitions

   .. rubric:: Methods Documentation

   .. automethod:: contribution_function
   .. automethod:: emissivity
   .. automethod:: free_bound
   .. automethod:: free_bound_radiative_loss
   .. automethod:: free_free
   .. automethod:: free_free_radiative_loss
   .. automethod:: intensity
   .. automethod:: level_populations
   .. automethod:: next_ion
   .. automethod:: previous_ion
   .. automethod:: spectrum
   .. automethod:: two_photon