EigenData

class plasmapy_nei.eigen.EigenData(element: plasmapy.particles.particle_class.Particle)[source]

Bases: object

Provides access to ionization and recombination rate data.

Parameters:element (particle-like) – Representation of the element to access data for.

Examples

>>> eigendata = EigenData("He")
>>> eigendata.nstates
3

Attributes Summary

element The element corresponding to an instance of this class.
ionization_rate
nstates Number of charge states corresponding to the element.
ntemp Number of points in temperature_grid.
recombination_rate
temperature
temperature_grid

Methods Summary

eigenvalues([T_e, T_e_index]) Returns the eigenvalues for the ionization and recombination rates for the temperature specified in the class.
eigenvector_inverses([T_e, T_e_index]) Returns the inverses of the eigenvectors for the ionization and recombination rates for the temperature specified in the class.
eigenvectors(T_e, T_e_index) Returns the eigenvectors for the ionization and recombination rates for the temperature specified in the class.
equilibrium_state([T_e, T_e_index]) Return the equilibrium charge state distribution for the temperature specified in the class.

Attributes Documentation

element

The element corresponding to an instance of this class.

ionization_rate
nstates

Number of charge states corresponding to the element.

ntemp

Number of points in temperature_grid.

recombination_rate
temperature
temperature_grid

Methods Documentation

eigenvalues(T_e=None, T_e_index=None)[source]

Returns the eigenvalues for the ionization and recombination rates for the temperature specified in the class.

eigenvector_inverses(T_e=None, T_e_index=None)[source]

Returns the inverses of the eigenvectors for the ionization and recombination rates for the temperature specified in the class.

Parameters:
  • T_e (Quantity) – The electron temperature
  • T_e_index (integer) – The index of the electron temperature array corresponding to the desired temperature.
eigenvectors(T_e: Unit("K") = None, T_e_index: Unit("K") = None)[source]

Returns the eigenvectors for the ionization and recombination rates for the temperature specified in the class.

Parameters:
  • T_e (Quantity) – The electron temperature
  • T_e_index (integer) – The index of the electron temperature array corresponding to the desired temperature.
equilibrium_state(T_e=None, T_e_index=None)[source]

Return the equilibrium charge state distribution for the temperature specified in the class.

Parameters:
  • T_e (Quantity) – The electron temperature
  • T_e_index (integer) – The index of the electron temperature array corresponding to the desired temperature.