tardis.opacities.continuum.macro_atom_state module

Structured continuum inputs consumed by the macro-atom solver.

class tardis.opacities.continuum.macro_atom_state.ContinuumMacroAtomState(radiative_ionization_rate: DataFrame, radiative_recombination_rate: DataFrame, collisional_excitation_rate: DataFrame, collisional_deexcitation_rate: DataFrame, collisional_ionization_rate: DataFrame, collisional_recombination_rate: DataFrame, delta_E_yg: Series, collisional_excitation_cooling_probability: ndarray[tuple[Any, ...], dtype[float64]], collisional_excitation_cooling_array: ndarray[tuple[Any, ...], dtype[float64]], collisional_excitation_references: MultiIndex, collisional_ionization_cooling_probability: ndarray[tuple[Any, ...], dtype[float64]], collisional_ionization_cooling_array: ndarray[tuple[Any, ...], dtype[float64]], radiative_recombination_cooling_probability: ndarray[tuple[Any, ...], dtype[float64]], radiative_recombination_cooling_array: ndarray[tuple[Any, ...], dtype[float64]], free_free_cooling_probability: ndarray[tuple[Any, ...], dtype[float64]])[source]

Bases: object

Continuum rates and cooling branches used by the macro atom.

collisional_deexcitation_rate: DataFrame
collisional_excitation_cooling_array: ndarray[tuple[Any, ...], dtype[float64]]
collisional_excitation_cooling_probability: ndarray[tuple[Any, ...], dtype[float64]]
collisional_excitation_rate: DataFrame
collisional_excitation_references: MultiIndex
collisional_ionization_cooling_array: ndarray[tuple[Any, ...], dtype[float64]]
collisional_ionization_cooling_probability: ndarray[tuple[Any, ...], dtype[float64]]
collisional_ionization_rate: DataFrame
collisional_recombination_rate: DataFrame
delta_E_yg: Series
free_free_cooling_probability: ndarray[tuple[Any, ...], dtype[float64]]
classmethod from_equilibrium(atomic_data: AtomData, lines: DataFrame, photo_ion_cross_sections: DataFrame, continuum_coefficients: ContinuumCoefficientState, level_to_continuum_saha_factor: DataFrame, ion_number_density: DataFrame, level_number_density: DataFrame, electron_densities: Series, t_electrons: ArrayLike, stimulated_recombination_cooling_estimator: DataFrame | None = None) ContinuumMacroAtomState[source]

Format accepted equilibrium rates for continuum macro atoms.

Parameters:
atomic_dataobject

Atomic levels and collision data used for collisional rates.

linespandas.DataFrame

Bound-bound transitions associated with the continuum species.

photo_ion_cross_sectionspandas.DataFrame

Photoionization thresholds and cross sections.

continuum_coefficientsContinuumCoefficientState

Equilibrium continuum rate coefficients.

level_to_continuum_saha_factorpandas.DataFrame

Saha factors relating bound levels to their continua.

ion_number_densitypandas.DataFrame

Ion populations for each shell.

level_number_densitypandas.DataFrame

Level populations for each shell.

electron_densitiespandas.Series

Electron number densities for each shell.

t_electronsnumpy.typing.ArrayLike

Electron temperatures for each shell.

stimulated_recombination_cooling_estimatorpandas.DataFrame, optional

Estimated stimulated-recombination cooling, if available.

Returns:
ContinuumMacroAtomState

Continuum rates and cooling branches for transport.

radiative_ionization_rate: DataFrame
radiative_recombination_cooling_array: ndarray[tuple[Any, ...], dtype[float64]]
radiative_recombination_cooling_probability: ndarray[tuple[Any, ...], dtype[float64]]
radiative_recombination_rate: DataFrame