Add new GauntFactor class and add Itoh integrated Gaunt factors to f-f radiative loss

docs/references.bib

@@ -220,6 +220,21 @@ @article{itoh_relativistic_2000
   doi = {10.1086/313375}
 }
 
+@article{itoh_radiative_2002,
+  title = {Radiative Processes in the Intracluster Plasma},
+  author = {Itoh, N. and Sakamoto, T. and Kusano, S. and Kawana, Y. and Nozawa, S.},
+  year = {2002},
+  month = feb,
+  journal = {Astronomy and Astrophysics},
+  volume = {382},
+  pages = {722--729},
+  issn = {0004-6361},
+  doi = {10.1051/0004-6361:20011664},
+  urldate = {2024-09-23},
+  annotation = {ADS Bibcode: 2002A\&A...382..722I}
+}
+
+
 @article{karzas_electron_1961,
   title = {Electron {{Radiative Transitions}} in a {{Coulomb Field}}.},
   author = {Karzas, W. J. and Latter, R.},

fiasco/__init__.py

@@ -4,6 +4,7 @@
 from fiasco.collections import IonCollection
 from fiasco.elements import Element
 from fiasco.fiasco import list_elements, list_ions, proton_electron_ratio
+from fiasco.gaunt import GauntFactor
 from fiasco.ions import Ion
 from fiasco.levels import Level, Transitions
 from fiasco.util.util import setup_paths
@@ -51,6 +52,7 @@ def _get_bibtex():
     "Ion",
     "Level",
     "Transitions",
+    "GauntFactor",
     "defaults",
     "log",
     "__version__",

fiasco/base.py

@@ -92,33 +92,12 @@ class ContinuumBase(Base):
     .. note:: This is not meant to be instantiated directly by the user
               and primarily serves as a base class for `~fiasco.Ion`.
     """
-
-    @property
-    def _gffgu(self):
-        data_path = '/'.join(['continuum', 'gffgu'])
-        return DataIndexer.create_indexer(self.hdf5_dbase_root, data_path)
-
-    @property
-    def _gffint(self):
-        data_path = '/'.join(['continuum', 'gffint'])
-        return DataIndexer.create_indexer(self.hdf5_dbase_root, data_path)
-
-    @property
-    def _klgfb(self):
-        data_path = '/'.join(['continuum', 'klgfb'])
-        return DataIndexer.create_indexer(self.hdf5_dbase_root, data_path)
-
     @property
     def _verner(self):
         data_path = '/'.join([self.atomic_symbol.lower(), self._ion_name, 'continuum',
                               'verner_short'])
         return DataIndexer.create_indexer(self.hdf5_dbase_root, data_path)
 
-    @property
-    def _itoh(self):
-        data_path = '/'.join([self.atomic_symbol.lower(), 'continuum', 'itoh'])
-        return DataIndexer.create_indexer(self.hdf5_dbase_root, data_path)
-
     @property
     def _hseq(self):
         data_path = '/'.join([self.atomic_symbol.lower(), 'continuum', 'hseq_2photon'])

fiasco/collections.py

@@ -303,7 +303,7 @@ def spectrum(self, density: u.cm**(-3), emission_measure: u.cm**(-5), wavelength
         return wavelength, spectrum
 
     @u.quantity_input
-    def radiative_loss(self, density: u.cm**(-3), **kwargs) -> u.Unit('erg cm3 s-1'):
+    def radiative_loss(self, density: u.cm**(-3), use_itoh=False, **kwargs) -> u.Unit('erg cm3 s-1'):
         r"""
         Calculate the total wavelength-integrated radiative loss rate including the
         bound-bound, free-bound, and free-free emission contributions
@@ -315,14 +315,17 @@ def radiative_loss(self, density: u.cm**(-3), **kwargs) -> u.Unit('erg cm3 s-1')
         ----------
         density : `~astropy.units.Quantity`
             Electron number density
+        use_itoh : `bool`, optional
+            Whether to use Gaunt factors taken from :cite:t:`itoh_radiative_2002` for the calculation
+            of free-free emission.  Defaults to false.
 
         Returns
         -------
         rad_loss_total : `~astropy.units.Quantity`
             The total bolometric radiative loss rate
         """
         rad_loss_bound_bound = self.bound_bound_radiative_loss(density, **kwargs)
-        rad_loss_free_free = self.free_free_radiative_loss()
+        rad_loss_free_free = self.free_free_radiative_loss(use_itoh=use_itoh)
         rad_loss_free_bound = self.free_bound_radiative_loss()
 
         rad_loss_total = (rad_loss_bound_bound
@@ -363,20 +366,30 @@ def bound_bound_radiative_loss(self, density, **kwargs) -> u.Unit('erg cm3 s-1')
         return rad_loss
 
     @u.quantity_input
-    def free_free_radiative_loss(self) -> u.Unit('erg cm3 s-1'):
+    def free_free_radiative_loss(self, use_itoh=False) -> u.Unit('erg cm3 s-1'):
         r"""
         Calculate the radiative loss rate from free-free emission (bremsstrahlung)
         integrated over wavelength.
 
+        Parameters
+        ----------
+        use_itoh : `bool`, optional
+            Whether to use Gaunt factors taken from :cite:t:`itoh_radiative_2002`.
+            Defaults to false.
+
         Returns
         -------
         rad_loss : `~astropy.units.Quantity`
             The bolometric free-free radiative loss rate per unit emission measure
+
+        See Also
+        -------
+        fiasco.GauntFactor.free_free_integrated
         """
         free_free = u.Quantity(np.zeros(self.temperature.shape), 'erg cm^3 s^-1')
         for ion in self:
             try:
-                ff = ion.free_free_radiative_loss()
+                ff = ion.free_free_radiative_loss(use_itoh=use_itoh)
                 abundance = ion.abundance
                 ioneq = ion.ioneq
             except MissingDatasetException as e:

fiasco/conftest.py

@@ -14,12 +14,6 @@
 else:
     matplotlib.use('Agg')
 
-
-# Minimal set of CHIANTI files needed to run the tests
-# NOTE: need some way for this to be flexible depending on the supplied database version
-TEST_FILES = get_test_file_list()
-
-
 @pytest.fixture(scope='session')
 def ascii_dbase_tree(tmpdir_factory, request):
     path = request.config.getoption('--ascii-dbase-root')
@@ -47,7 +41,7 @@ def hdf5_dbase_root(ascii_dbase_tree, tmpdir_factory, request):
     if request.config.getoption('--include-all-files'):
         test_files = None
     else:
-        test_files = TEST_FILES
+        test_files = get_test_file_list()
     check_hash = not request.config.getoption('--disable-file-hash')
     # Optionally use a different URL for the database (e.g. for testing different versions)
     ascii_dbase_url = request.config.getoption('--ascii-dbase-url')