tboudreaux/libcomposition
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(standard_compositions): added working enum overloads

Browse Source 
also added docs
This commit is contained in:
Emily Boudreaux
2026-06-03 11:59:54 +02:00
parent 3d2eb46d0d
commit 1619eba529
2 changed files with 51 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
src/composition/include/fourdst/composition/io/standard_compositions.h
View File

@@ -95,6 +95,9 @@ namespace fourdst::composition::io {
* ParsedChemicalData data = parser->parse("my_reactions.txt"); * ParsedChemicalData data = parser->parse("my_reactions.txt");
* for (const auto& reaction_name : data.reactionPENames) { * for (const auto& reaction_name : data.reactionPENames) {
* // ... process reaction name * // ... process reaction name
const mfem::GridFunction& grav_potential_at_inf(FEM& fem, const Args& args, const mfem::GridFunction& rho, bool pho_warm) {
}
* } * }
* } catch (const std::runtime_error& e) { * } catch (const std::runtime_error& e) {
* // ... handle error * // ... handle error
@@ -109,14 +112,47 @@ namespace fourdst::composition::io {
} }
namespace fourdst::composition { namespace fourdst::composition {
/**
* @brief Function to retrieve a standard solar composition record indexed by their canonical names including
* - AG89
* - GN93
* - GS98
* - L03
* - AGS05
* - AGS08
* - A09_Pryzbilla
* - MB22_photospheric
* - AAG21_photospheric
* - L09
* Further, isotopic percentages can be selected as either
* - L03
* - L09
*
* These data have been extracted from chem_def.f90 from MESA <version>
*
* @note Composition names are case normalized; therefore, the inputs for metal fraction scheme and isotopic percentage scheme are case insensitive.
*
* @param metal_fraction_scheme The name of the metal fraction scheme to use. Must be one of the following: AG89, GN93, GS98, L03, AGS05, AGS08, A09_Pryzbilla, MB22_photospheric, AAG21_photospheric, L09
* @param isotopic_percentage_scheme The name of the isotopic percentage scheme to use. Must be one of the following: L03, L09
* @param initial_z <poojan_documenent_here>
* @param initial_y <poojan document here>
*/
[[nodiscard]] Composition get_composition_record(const std::string& metal_fraction_scheme, [[nodiscard]] Composition get_composition_record(const std::string& metal_fraction_scheme,
const std::string& isotopic_percentage_scheme, const std::string& isotopic_percentage_scheme,
double initial_z, double initial_z,
double initial_y); double initial_y);
// [[nodiscard]] Composition get_composition_record(const SolarCompositions metal_fraction_scheme, /**
// const IsotopicPercentages isotopic_percentage_scheme, * @brief Overload of the string based version of this function which accepts the enums Solar
// double initial_z, * @param metal_fraction_scheme Enum corresponding to the standard solar composition to select
// double initial_y); * @param isotopic_percentage_scheme Enum corresponding to the isotopic percentages prescription to select
* @param initial_z <poojan_document_here>
* @param initial_y <poojan_document_here>
* @return
*/
[[nodiscard]] Composition get_composition_record(io::SolarCompositions metal_fraction_scheme,
io::IsotopicPercentages isotopic_percentage_scheme,
double initial_z,
double initial_y);
} }

22
src/composition/lib/io/standard_compositions.cpp
View File

@@ -344,15 +344,15 @@ namespace fourdst::composition {
} }
// Composition get_composition_record(const io::SolarCompositions metal_fraction_scheme, Composition get_composition_record(const io::SolarCompositions metal_fraction_scheme,
// const io::IsotopicPercentages isotopic_percentage_scheme, const io::IsotopicPercentages isotopic_percentage_scheme,
// double initial_z, double initial_z,
// double initial_y) { double initial_y) {
// return get_composition_record( return get_composition_record(
// io::SolarComposition_to_string_map.at(metal_fraction_scheme), io::SolarCompositions_to_string_map.at(metal_fraction_scheme),
// io::IsotopicPercentages_to_string.at(isotopic_percentage_scheme), io::IsotopicPercentages_to_string_map.at(isotopic_percentage_scheme),
// initial_z, initial_z,
// initial_y initial_y
// ); );
// } }
} }