State

class plasmapy.particles.State(integer_charge, ionic_fraction, ionic_symbol, number_density)

Bases: tuple

Named tuple class for representing an ionization state (collections.namedtuple).

Attributes Summary

integer_charge Alias for field number 0
ionic_fraction Alias for field number 1
ionic_symbol Alias for field number 2
number_density Alias for field number 3

Methods Summary

count Return number of occurrences of value.
index Return first index of value.

Attributes Documentation

integer_charge

Alias for field number 0

ionic_fraction

Alias for field number 1

ionic_symbol

Alias for field number 2

number_density

Alias for field number 3

Methods Documentation

count()

Return number of occurrences of value.

index()

Return first index of value.

Raises ValueError if the value is not present.