The 23.01 release of Cloudy

We announce the C23.01 update of Cloudy. This corrects a simple coding error, present since $\sim$ 1990, in one routine that required a conversion from the line-center to the mean normalization of the Ly$\alpha$ optical depth. This affects the destruction of H I Ly$\alpha$ by background opacities. Its largest effect is upon the Ly$\alpha$ intensity in high-ionization dusty clouds, where the predicted intensity is now up to three times stronger. Other properties that depend on Ly$\alpha$ destruction, such as grain infrared emission, change in response.


INTRODUCTION
We present the C23.01 update to cloudy, succeeding C23.00 (Ferland et al. 1998(Ferland et al. , 2013(Ferland et al. , 2017;;Chatzikos et al. 2023).We correct an error in our use of the Hummer & Kunasz (1980) theory of Ly destruction that dates back to ∼1990.The Ly intensity can change by as much as 0.5 dex for highly ionized dusty clouds.

LINE TRANSFER IN DUSTY MEDIA
Resonance lines of abundant atoms often have large optical depths, so the effects of scattering and absorption must be taken into account.Line photons can be lost by either collisional deexcitation, where the photon's energy is converted into thermal energy, or by absorption by background opacities, where the photon is absorbed by photoelectric or grain opacity (Mihalas 1970;Elitzur 1992;Rutten 2003;Hubeny & Mihalas 2014).
The escape probability formalization is a powerful treatment of the effects of radiative trapping (Netzer et al. 1985;Elitzur 1992;Osterbrock & Ferland 2006).This replaces the net radiative bracket in the radiative transfer equation with the product of the transition rate and the probability that a photon will escape in a single scattering,  esc   (Netzer et al. 1985;Elitzur 1992).
Here  esc is the escape probability for a transition with upper and lower levels , .
The line profile function () lies at the heart of line transfer physics.Radiative trapping and escape compete with photon destruction through continuous absorption processes, the so-called "background opacity".The Voigt line profile, describes how matter absorbs photons, while the redistribution function describes the relation between absorption and subsequent emission.Here,  is the frequency displacement from line-center, and  is the Voigt parameter (Hjerting 1938;Hummer & Kunasz 1980).
There are two normalizations of the optical depth, line-center and mean.Optical and ultraviolet spectroscopy conventionally use line-center optical depths (Mihalas 1970;Rutten 2003).Mean optical depths are more convenient for very large values of the damping constant, as is typical of allowed lines of high-ionization species in the X-ray regime (Hummer & Kunasz 1980).For small , the mean optical depth is a factor of √  times larger than the line-center optical depth.cloudy internally works with line-center optical depths throughout.When the code expanded to higher energies, mean optical depths became more useful, and mean optical depths are now reported.cloudy treats line overlap and integrates the line optical depth through a medium where the Doppler width will generally be varying, so it is not straightforward to convert the line-center optical depths used internally to a mean optical depth.To avoid these difficulties, we report a mean optical depth that is exactly a factor √  times larger than the line-center optical depth.This assumes that the Voigt function at line-center is  (0, ) ≈ 1.This approximation is valid when the damping parameter  is small,  ≪ 1 which is generally the case in the IR, optical, and UV wavelength range.This conversion is more approximate in the X-ray regime where  can be much larger.
cloudy uses fits to the escape  esc and destruction  des probabilities presented in Hummer & Kunasz (1980, hereafter HK80) for H I Ly.This theory uses mean optical depths , and considers a wide variation in the values of .The original incorporation of the HK80 theory into cloudy, dating back to at least the C80 (circa ∼1990) release, required a conversion from  to  0 within one routine.We found that this conversion had an erroneous factor of  in the calculation of  HK , a parameter in the HK80 theory.This affected the loss of H I Ly photons due to "background" opacity, with dust being the dominant opacity absorbing Ly.
In the following sections, we derive the new calculation of  HK , discuss changes in the simulated spectra, and detail how the C23.01 release can be downloaded.

LYMAN 𝛼 ESCAPE & DESTRUCTION PROBABILITY
The starting point of the HK80 theory is the  HK parameter, defined as (Eq.2.7 of HK80): where  c is the continuum opacity of background destruction processes (such as absorption on dust grains), and  L is the line opacity.cloudy uses a slightly different definition for  HK that is better behaved in extreme conditions (like hydrogen-deficient and very dust-rich gas, see e.g., Borkowski & Harrington 1991): For the range of conditions considered by HK80 ( c ≪  L ), there is very little difference between the two definitions.The opacity of the line is defined as (Eq.2.3 of HK80): Here   is the lower-level population,   is the Einstein-B coefficient for absorption, ℎ is the Planck constant,  0 is the central frequency of the line, and Δ is the Doppler width of the line.The Einstein-B coefficient is related to the oscillator strength   as follows (Rybicki & Lightman 1979): Here  is the elementary charge in electrostatic units,  e is the mass of the electron, and  is the speed of light.The Doppler width is converted to velocity units Δ v as follows: where  0 is the wavenumber of the line,  0 =  0 /.Substituting Eqs. 4 and 5 into Eq. 3 yields: The opacity constant of the line  L is defined in cloudy as: Substituting Eq. 7 into Eq.6 yields: In the previous cloudy code,  HK was calculated using the   derived in Equation 8 divided by .

CHANGES TO SPECTRA
With this change,   is now larger by a factor of , decreasing  HK by approximately the same factor (assuming  c ≪  L ).Thus, the destruction probability by background opacities is now reduced by approximately the same factor of .
cloudy includes a large test suite which makes autonomous testing possible.These showed that the largest changes occurred for dusty clouds where H Ly destruction is important.Figure 1 shows the H Ly intensity for a blister H II region model inspired by the Orion H II region, a hydrostatic ionized layer on the surface of a molecular cloud (Baldwin et al. 1991).We consider a range of hydrogen densities (10 ≤ (H) ≤ 10 6 cm −3 ) and stellar ionizing photon fluxes (10 11 ≤ (H) ≤ 10 14 photons cm −2 s −1 ).
The Figure shows predictions of C23.01 relative to those of C23.00.
Our new calculations have reduced the destruction probability so H Ly is now stronger.The biggest change occurs at high () and low (), corresponding to high ionization parameters ( = (H)/(H)).As we increase  and the ionization, grains proportionately absorb more of the ionizing photons (Bottorff et al. 1998;Gunasekera et al. 2023).More highly ionized clouds have less atomic opacity but the same grain opacity, so there is a greater probability of a photon being absorbed by grains rather than scattered from a hydrogen atom.The destruction probability of H Ly is higher at high .Reducing the destruction probability by a factor of  results in the greatest enhancement of H Ly in the lower right corner.

SUMMARY
The primary result of this update are changes to the H Ly line in dusty environments at moderate to high ionization parameter.We present an update to cloudy, which includes changes in the hydrogen Lyman  escape and destruction probabilities based on HK80.Since H Ly is often the strongest line in the spectrum, significant changes in its physics will have consequences on other physical parameters.A discussion of the changes to the grain emission and other consequences will be presented in the C24 release paper.
This update has been released as C23.01 and is now available to download from wiki.nublado.org.Papers that use this version of cloudy should cite both Chatzikos et al. (2023) and the present paper.

Figure 1 .
Figure 1.A contour plot of H Ly line intensity predicted by C23.01 relative to the same quantity from C23.00, for the baseline model orion hii open.in in the cloudy test suite.The ratio of ionizing photon flux () to hydrogen density () is effectively the ionization parameter .The lower-right corner of the panels corresponds to high and the upper-left corner is low .