initialize_metal_chemistry_rates -> init_misc_species_cool_rates

Author: mabruzzo

.clang-format-ignore

@@ -32,11 +32,11 @@ src/clib/grackle_macros.h
 src/clib/grackle_units.c
 src/clib/index_helper.c
 src/clib/index_helper.h
+src/clib/init_misc_species_cool_rates.cpp
 src/clib/initialize_UVbackground_data.c
 src/clib/initialize_chemistry_data.cpp
 src/clib/initialize_cloudy_data.c
 src/clib/initialize_dust_yields.cpp
-src/clib/initialize_metal_chemistry_rates.cpp
 src/clib/initialize_rates.cpp
 src/clib/internal_types.hpp
 src/clib/internal_units.h

src/clib/CMakeLists.txt

@@ -107,10 +107,10 @@ add_library(Grackle_Grackle
   # C++ Source (and Private Header Files)
   cool_multi_time_g.cpp cool_multi_time_g.h
   init_extra_collisional_rates.hpp
+  init_misc_species_cool_rates.cpp init_misc_species_cool_rates.hpp
   initialize_chemistry_data.cpp
   initialize_dust_yields.cpp initialize_dust_yields.hpp
   initialize_rates.cpp initialize_rates.hpp
-  initialize_metal_chemistry_rates.cpp initialize_metal_chemistry_rates.hpp
   internal_types.cpp internal_types.hpp
   opaque_storage.hpp
   rate_utils.cpp

src/clib/Make.config.objects

@@ -30,7 +30,7 @@ OBJS_CONFIG_LIB = \
         initialize_chemistry_data.lo \
         initialize_cloudy_data.lo \
         initialize_dust_yields.lo \
-        initialize_metal_chemistry_rates.lo \
+        init_misc_species_cool_rates.lo \
         initialize_rates.lo \
         initialize_UVbackground_data.lo \
         interpolators_g.lo \

src/clib/initialize_metal_chemistry_rates.cpp renamed to src/clib/init_misc_species_cool_rates.cpp

@@ -6,7 +6,7 @@
 //===----------------------------------------------------------------------===//
 ///
 /// @file
-/// Implement machinery for initializing various (non-reaction) rates
+/// Implement machinery for initializing miscellaneous species cooling rates
 ///
 //===----------------------------------------------------------------------===//
 
@@ -18,7 +18,7 @@
 #include "grackle.h"
 #include "grackle_macros.h"
 #include "interp_table_utils.h" // free_interp_grid_
-#include "initialize_metal_chemistry_rates.hpp"  // forward declarations
+#include "init_misc_species_cool_rates.hpp"  // forward declarations
 #include "internal_units.h"
 #include "phys_constants.h"
 #include "grackle_rate_functions.h" // forward declarations of some funcs
@@ -66,7 +66,7 @@ static int add_cieY06_cool_rate(double **rate_ptr, double coolunit,
   return GR_SUCCESS;
 }
 
-int grackle::impl::initialize_metal_chemistry_rates(
+int grackle::impl::init_misc_species_cool_rates(
   chemistry_data *my_chemistry, chemistry_data_storage *my_rates,
   code_units *my_units)
 {
@@ -95,8 +95,8 @@ int grackle::impl::initialize_metal_chemistry_rates(
   return GR_SUCCESS;
 }
 
-int grackle::impl::free_metal_chemistry_rates(chemistry_data *my_chemistry,
-                                              chemistry_data_storage *my_rates)
+int grackle::impl::free_misc_species_cool_rates(chemistry_data *my_chemistry,
+                                                chemistry_data_storage *my_rates)
 {
   if (my_chemistry->primordial_chemistry == 0) {
     return GR_SUCCESS;

src/clib/init_misc_species_cool_rates.hpp

@@ -0,0 +1,28 @@
+//===----------------------------------------------------------------------===//
+//
+// See the LICENSE file for license and copyright information
+// SPDX-License-Identifier: NCSA AND BSD-3-Clause
+//
+//===----------------------------------------------------------------------===//
+///
+/// @file
+/// Declares a function to initialize miscellaneous species cooling rates
+///
+//===----------------------------------------------------------------------===//
+
+#ifndef INIT_MISC_SPECIES_COOL_RATES_HPP
+#define INIT_MISC_SPECIES_COOL_RATES_HPP
+
+#include "grackle.h"
+
+namespace grackle::impl {
+
+int init_misc_species_cool_rates(chemistry_data* my_chemistry,
+                                 chemistry_data_storage* my_rates,
+                                 code_units* my_units);
+
+int free_misc_species_cool_rates(chemistry_data* my_chemistry,
+                                 chemistry_data_storage* my_rates);
+}  // namespace grackle::impl
+
+#endif /* INIT_MISC_SPECIES_COOL_RATES_HPP */

src/clib/initialize_chemistry_data.cpp

@@ -20,9 +20,9 @@
 #include "grackle_macros.h"
 #include "auto_general.h"
 #include "interp_table_utils.h" // free_interp_grid_
+#include "init_misc_species_cool_rates.hpp"  // free_misc_species_cool_rates
 #include "initialize_cloudy_data.h"
 #include "initialize_dust_yields.hpp"  // free_dust_yields
-#include "initialize_metal_chemistry_rates.hpp"  // free_metal_chemistry_rates
 #include "initialize_rates.hpp"
 #include "initialize_UVbackground_data.h"
 #include "internal_types.hpp" // drop_CollisionalRxnRateCollection
@@ -571,7 +571,7 @@ extern "C" int local_free_chemistry_data(chemistry_data *my_chemistry,
     free_interp_grid_(&my_rates->LHD);
 
     // we deal with freeing other interp grids inside of
-    // local_free_metal_chemistry_rates
+    // free_misc_species_cool_rates
 
     free_interp_grid_(&my_rates->alphap);
 
@@ -613,9 +613,9 @@ extern "C" int local_free_chemistry_data(chemistry_data *my_chemistry,
     GRACKLE_FREE(my_rates->UVbackground_table.crsHeI);
   }
 
-  if (grackle::impl::free_metal_chemistry_rates(my_chemistry, my_rates) == FAIL) {
+  if (grackle::impl::free_misc_species_cool_rates(my_chemistry, my_rates) != GR_SUCCESS) {
     fprintf(stderr, "Error in free_metal_chemistry_rates.\n");
-    return FAIL;
+    return GR_FAIL;
   }
 
   if (grackle::impl::free_dust_yields(my_chemistry, my_rates) == FAIL) {

src/clib/initialize_metal_chemistry_rates.hpp

@@ -87,8 +87,8 @@
 #include "grackle_macros.h"
 #include "grackle_rate_functions.h"
 #include "init_extra_collisional_rates.hpp"  // init_extra_collisional_rates
+#include "init_misc_species_cool_rates.hpp"  // init_misc_species_cool_rates
 #include "initialize_dust_yields.hpp"  // initialize_dust_yields
-#include "initialize_metal_chemistry_rates.hpp"  // initialize_metal_chemistry_rates
 #include "initialize_rates.hpp"
 #include "internal_types.hpp" // new_CollisionalRxnRateCollection
 #include "LUT.hpp" // CollisionalRxnLUT
@@ -619,23 +619,23 @@ int grackle::impl::initialize_rates(
     //(Equation B15, Krumholz, 2014)
     add_scalar_reaction_rate(&my_rates->gamma_isrf, gamma_isrf_rate, coolingUnits, my_chemistry); 
 
+    // initialize some extra collisional rates
     if (grackle::impl::init_extra_collisional_rates(my_chemistry, my_rates, my_units) != GR_SUCCESS) {
       fprintf(stderr, "Error in init_extra_collisional_rates.\n");
       return GR_FAIL;
     }
 
-    /* Metal chemistry rates */
-    if (grackle::impl::initialize_metal_chemistry_rates(my_chemistry, my_rates, my_units) == FAIL) {
+    // Miscellaneous species-based cooling rates
+    if (grackle::impl::init_misc_species_cool_rates(my_chemistry, my_rates, my_units) != GR_SUCCESS) {
       fprintf(stderr, "Error in initialize_metal_chemistry_rates.\n");
-      return FAIL;
+      return GR_FAIL;
     }
     /* Dust rates */
     if (grackle::impl::initialize_dust_yields(my_chemistry, my_rates, my_units) == FAIL) {
       fprintf(stderr, "Error in initialize_dust_yields.\n");
       return FAIL;
     }
 
-    //End of function definition.
     return SUCCESS;
 }