microphysics

microphysics.hydrogen_cross_section(wavelength=None, energy=None)[source]

Compute the photoionization cross-section of hydrogen in function of wavelength or energy.

Parameters:
wavelengthfloat or numpy.ndarray, optional

Wavelength in unit of angstrom. Default is None. If None, energy cannot be None.

energyfloat or numpy.ndarray, optional

Energy in unit of electron-volt. Default is None. If None, wavelength cannot be None.

Returns:
a_lambdafloat or numpy.ndarray

Cross-section in function of wavelength and in unit of cm ** 2. Only returned if wavelength was input.

a_nufloat or numpy.ndarray

Cross-section in function of energy and in unit of cm ** 2. Only returned if energy was input.

microphysics.helium_singlet_cross_section(wavelength)[source]

Compute the photoionization cross-section of helium singlet in function of wavelength.

Parameters:
wavelengthfloat or numpy.ndarray

Wavelength in unit of angstrom.

Returns:
a_lambda_1float or numpy.ndarray

Cross-section in function of wavelength and in unit of cm ** 2.

microphysics.helium_triplet_cross_section()[source]

Compute the photoionization cross-section of helium triplet in function of wavelength.

Returns:
wavelengthnumpy.ndarray

Wavelength in which the cross-section was sampled in Norcross (1971).

a_lambda_3numpy.ndarray

Cross-section in function of wavelength and in unit of cm ** 2.

microphysics.he_collisional_strength()[source]

Returns a hard-coded array containing the helium collisional strengths in function of temperature.

Returns:
arraynumpy.ndarray

Collisional strengths array. Columns: 0 = temperature, 1 = gamma_13, 2 = gamma_31a, 3 = gamma_31b.

microphysics.general_cross_section(wavelength, species)[source]

Calculates the photoionization cross-section of an atomic or ion species using the parametrization of Verner et al. (1996) [https://ui.adsabs.harvard.edu/abs/1996ApJ…465..487V/abstract].

Parameters:
wavelengthfloat or numpy.ndarray

Photon wavelength in angstrom.

speciesstr

String containing the species for which you request the cross-section in the format 'X N' where X is the element and N is the ionization number. Example: 'C II'.

Returns:
cross_sectionfloat or numpy.ndarray

Cross-section in unit of cm ** (-2)

microphysics.sigma_properties_v1996()[source]

Function that hard-codes the cross-section parameters from Verner et al. (1996). We include only the species important for exoplanetary atmospheres.

Returns:
parameters_dictdict

Dictionary containing the parameters.