[newchem-cpp] Cleanup initialization of kcol_rate_tables
#413
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
These deleted declarations already occur within the grackle.h header. Some include directives were also deleted that were redundant with including then grackle.h header
This is important once we start compiling with C++
For context, the historic convention in Grackle project was to use .C as the suffix for C++ source files. Thus, when we began transcribing files, we used the .C suffix (even though it is a less common choice than .cpp) However, it turns out that converting a file named `<prefix>.c` to `<prefix>.C` causes lots of issues performing Git operations when your machine has a case-insensitive file-system (common on macOS). This comes up in operations as simple as changing between 2 branches Consequently, we will be transitioning to the .cpp suffix
For context, the historic convention in Grackle project was to use .C as the suffix for C++ source files. Thus, when we began transcribing files, we used the .C suffix (even though it is a less common choice than .cpp) However, it turns out that converting a file named `<prefix>.c` to `<prefix>.C` causes lots of issues performing Git operations when your machine has a case-insensitive file-system (common on macOS). This comes up in operations as simple as changing between 2 branches Consequently, we will be transitioning to the .cpp suffix
I also adjusted the boilerplate at the top of this file and at the top of solve_rate_cool_g-cpp.h
A few tweaks were necessary: - I needed to add the `extern "C"` annotation to a number of functions that are publicly exposed as the C API - I removed the leading underscore from some internal helper functions - I needed to tweak make the group name argument passed to initialize_cloudy_data expect a `const char*`, rather than just a `char*`. This is essential since we are passing a string literal (this was a very minimal change) I also added to the `static` specifier to some internal functions (this ensures that these helper functions will not be accessible to external code)
I also renamed initialize_rates.h to initialize_rates.hpp to denote that the header is **ONLY** compatible with C++ source files
…units & internalu.a_value)
…the values directly from my_chemistry)
…le::impl::initialize_metal_chemistry_rates
This information has been formatted into a markdown table (that will be rendered into a table if/when we use doxygen)
… initialize_metal_chemistry_rates.cpp
mabruzzo
force-pushed
the
cleanup-kcol_rate_tables_init
branch
from
6cef850 to
046e49e
Compare
mabruzzo
changed the title
kcol_rate_tableskcol_rate_tables
mabruzzo
added
the
refactor
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR must be reviewed after #411 is merged
Overview
At a high-level this PR:
In more detail, all functionality that was previously in initialize_metal_chemistry_rates.cpp has been split between init_misc_species_cool_rates.cpp and collisional_rate_props.cpp.
Let's talk more about collisional_rate_props.cpp:
As part of this PR:
k1_rate,k2_rate, ...)1grackle::impl::visit_rate_propsfunction that effectively iterates through all standardized collisional reaction rate functions. This includes all of the existingprimordial_chemistry=1,2, and 3 functions as well as the newprimordial_chemistry=4andmetal_chemistry=1rates.grackle::impl::visit_rate_propsto actually initialize the standardized collisional reaction rate functions.Overall, I think this leads to much cleaner code. Now that we have ~882 of the standardized collisional reaction rate functions. I have structured it in the current manner for reasons that should become apparent once #415 is finished
Footnotes
I left comments that explain the work that should be done before we are ready to expose all the new rate functions as part of the public API ↩
At the moment, I'm taking a very broad definition of "standard". In the future, one might imagine treating a handful of rates more specially again. Examples of such rates include: k13 (due to the existence of k13dd), k56 (since we use it to infer a deuterium rate), as well as the 3 body rates. ↩