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

docs(docs): added more callback docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-07-31 15:41:27 -04:00
parent 24049b2658
commit b0c1daada4
30 changed files with 371 additions and 329 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/html/search/all_8.js
View File

@@ -27,21 +27,21 @@ var searchData=
['calculaterhsandenergy_24',['CalculateRHSAndEnergy',['../structgridfire_1_1_multiscale_partitioning_engine_view_1_1_cache_stats.html#ac558e59f790508a5e8522c412be5b505aafefea58639f78d7c750970bbad28420',1,'gridfire::MultiscalePartitioningEngineView::CacheStats']]],
['calculaterhsandenergy_25',['calculateRHSAndEnergy',['../classgridfire_1_1_engine.html#a89f714d19b84a93a004a7afbb487a6cb',1,'gridfire::Engine::calculateRHSAndEnergy()'],['../classgridfire_1_1_graph_engine.html#aaed3743a52246b0f7bf03995e1c12081',1,'gridfire::GraphEngine::calculateRHSAndEnergy()'],['../classgridfire_1_1_adaptive_engine_view.html#af703ad17ea65ffff4b75bf8ccc00e5d5',1,'gridfire::AdaptiveEngineView::calculateRHSAndEnergy()'],['../classgridfire_1_1_defined_engine_view.html#a4b0d71367cb1d4c06bcd01251bbeb60d',1,'gridfire::DefinedEngineView::calculateRHSAndEnergy()'],['../classgridfire_1_1_multiscale_partitioning_engine_view.html#a716d7357e944e8394d8b8e0b5e7625eb',1,'gridfire::MultiscalePartitioningEngineView::calculateRHSAndEnergy()'],['../class_py_engine.html#a2f92602ecf210414b46838fc0a9ae26d',1,'PyEngine::calculateRHSAndEnergy()'],['../class_py_dynamic_engine.html#a5b7f0cfe327c634ec125303256de8b9a',1,'PyDynamicEngine::calculateRHSAndEnergy()']]],
['calculatescreeningfactors_26',['calculateScreeningFactors',['../classgridfire_1_1screening_1_1_screening_model.html#aaec9184d80c86a2d8674e395dad81bde',1,'gridfire::screening::ScreeningModel::calculateScreeningFactors(const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, const double T9, const double rho) const =0'],['../classgridfire_1_1screening_1_1_screening_model.html#a6c381a823cb9c1680d3e9c846da4ae22',1,'gridfire::screening::ScreeningModel::calculateScreeningFactors(const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< ADDouble > &Y, const ADDouble T9, const ADDouble rho) const =0'],['../classgridfire_1_1screening_1_1_bare_screening_model.html#ac35ad34c5da7e1b5087552aa5c83fe60',1,'gridfire::screening::BareScreeningModel::calculateScreeningFactors(const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, const double T9, const double rho) const override'],['../classgridfire_1_1screening_1_1_bare_screening_model.html#ac5647d633cd5bbd7cb5136b7fa4cad99',1,'gridfire::screening::BareScreeningModel::calculateScreeningFactors(const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< ADDouble > &Y, const ADDouble T9, const ADDouble rho) const override'],['../classgridfire_1_1screening_1_1_weak_screening_model.html#afbaeaefe6b3ab3ecf81889ddc1cff76c',1,'gridfire::screening::WeakScreeningModel::calculateScreeningFactors(const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, const double T9, const double rho) const override'],['../classgridfire_1_1screening_1_1_weak_screening_model.html#ac6bc78769670a460af1ff88284cb8ad4',1,'gridfire::screening::WeakScreeningModel::calculateScreeningFactors(const reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< CppAD::AD< double > > &Y, const CppAD::AD< double > T9, const CppAD::AD< double > rho) const override'],['../class_py_screening.html#a2b8756c197eb89e77cb6dd231c979315',1,'PyScreening::calculateScreeningFactors(const gridfire::reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, const double T9, const double rho) const override'],['../class_py_screening.html#a5539d59311c778cf7f0006acc8f84ade',1,'PyScreening::calculateScreeningFactors(const gridfire::reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< ADDouble > &Y, const ADDouble T9, const ADDouble rho) const override']]],
['callback_20example_27',['Callback Example',['../index.html#autotoc_md52',1,'']]],
['callbacks_28',['Python callbacks',['../index.html#autotoc_md55',1,'']]],
['chapter_29',['chapter',['../structgridfire_1_1reaclib_1_1_reaction_record.html#a5c853b69a23b0a8c39ab4b55ac3fe3cc',1,'gridfire::reaclib::ReactionRecord::chapter'],['../classgridfire_1_1reaction_1_1_reaction.html#a5cb438adfefb640e4bc58e09053bd629',1,'gridfire::reaction::Reaction::chapter()'],['../classgridfire_1_1_reaction.html#a5cb438adfefb640e4bc58e09053bd629',1,'gridfire::Reaction::chapter()']]],
['clang_20vs_20gcc_30',['Clang vs. GCC',['../index.html#autotoc_md24',1,'']]],
['clear_31',['clear',['../classgridfire_1_1reaction_1_1_templated_reaction_set.html#a05f71d318564d880079fd6c96d59ae21',1,'gridfire::reaction::TemplatedReactionSet']]],
['cli_20config_20loading_20setup_20and_20build_32',['CLI config loading, setup, and build',['../index.html#autotoc_md21',1,'']]],
['clone_33',['clone',['../classgridfire_1_1partition_1_1_composite_partition_function.html#a7b000d55c7d1f489e54a57f7f4e3808a',1,'gridfire::partition::CompositePartitionFunction::clone()'],['../classgridfire_1_1partition_1_1_partition_function.html#a677a90f992fd56b8718e36655c33ce6d',1,'gridfire::partition::PartitionFunction::clone()'],['../classgridfire_1_1partition_1_1_ground_state_partition_function.html#ade2b0f92a3d9b74968166793466a11e4',1,'gridfire::partition::GroundStatePartitionFunction::clone()'],['../classgridfire_1_1partition_1_1_rauscher_thielemann_partition_function.html#ad229cac0a84df5ebbcaf0550f83debf6',1,'gridfire::partition::RauscherThielemannPartitionFunction::clone()'],['../class_py_partition_function.html#af918b357e38fb82499ad53584557c43d',1,'PyPartitionFunction::clone()']]],
['code_20architecture_20and_20logical_20flow_34',['Code Architecture and Logical Flow',['../index.html#autotoc_md27',1,'']]],
['coeffs_35',['coeffs',['../structgridfire_1_1reaclib_1_1_reaction_record.html#a80803f612e574859fde0a163bca84bc0',1,'gridfire::reaclib::ReactionRecord']]],
['collect_36',['collect',['../classgridfire_1_1_defined_engine_view.html#adbc64284b5f5a3256867be46fa87c69e',1,'gridfire::DefinedEngineView']]],
['collectatomicreverserateatomicbases_37',['collectAtomicReverseRateAtomicBases',['../classgridfire_1_1_graph_engine.html#a29b338630c959449c15881935ac30746',1,'gridfire::GraphEngine']]],
['collectnetworkspecies_38',['collectNetworkSpecies',['../classgridfire_1_1_graph_engine.html#aedf42d83bfcc28313b6b6454034d2efa',1,'gridfire::GraphEngine']]],
['common_20platforms_39',['Dependency Installation on Common Platforms',['../index.html#autotoc_md22',1,'']]],
['common_20workflow_20examople_40',['Common Workflow Examople',['../index.html#autotoc_md54',1,'']]],
['common_20workflow_20example_41',['Common Workflow Example',['../index.html#autotoc_md50',1,'']]],
['callback_20context_27',['Callback Context',['../index.html#autotoc_md53',1,'']]],
['callback_20example_28',['Callback Example',['../index.html#autotoc_md52',1,'']]],
['callbacks_29',['Python callbacks',['../index.html#autotoc_md56',1,'']]],
['chapter_30',['chapter',['../structgridfire_1_1reaclib_1_1_reaction_record.html#a5c853b69a23b0a8c39ab4b55ac3fe3cc',1,'gridfire::reaclib::ReactionRecord::chapter'],['../classgridfire_1_1reaction_1_1_reaction.html#a5cb438adfefb640e4bc58e09053bd629',1,'gridfire::reaction::Reaction::chapter()'],['../classgridfire_1_1_reaction.html#a5cb438adfefb640e4bc58e09053bd629',1,'gridfire::Reaction::chapter()']]],
['clang_20vs_20gcc_31',['Clang vs. GCC',['../index.html#autotoc_md24',1,'']]],
['clear_32',['clear',['../classgridfire_1_1reaction_1_1_templated_reaction_set.html#a05f71d318564d880079fd6c96d59ae21',1,'gridfire::reaction::TemplatedReactionSet']]],
['cli_20config_20loading_20setup_20and_20build_33',['CLI config loading, setup, and build',['../index.html#autotoc_md21',1,'']]],
['clone_34',['clone',['../classgridfire_1_1partition_1_1_composite_partition_function.html#a7b000d55c7d1f489e54a57f7f4e3808a',1,'gridfire::partition::CompositePartitionFunction::clone()'],['../classgridfire_1_1partition_1_1_partition_function.html#a677a90f992fd56b8718e36655c33ce6d',1,'gridfire::partition::PartitionFunction::clone()'],['../classgridfire_1_1partition_1_1_ground_state_partition_function.html#ade2b0f92a3d9b74968166793466a11e4',1,'gridfire::partition::GroundStatePartitionFunction::clone()'],['../classgridfire_1_1partition_1_1_rauscher_thielemann_partition_function.html#ad229cac0a84df5ebbcaf0550f83debf6',1,'gridfire::partition::RauscherThielemannPartitionFunction::clone()'],['../class_py_partition_function.html#af918b357e38fb82499ad53584557c43d',1,'PyPartitionFunction::clone()']]],
['code_20architecture_20and_20logical_20flow_35',['Code Architecture and Logical Flow',['../index.html#autotoc_md27',1,'']]],
['coeffs_36',['coeffs',['../structgridfire_1_1reaclib_1_1_reaction_record.html#a80803f612e574859fde0a163bca84bc0',1,'gridfire::reaclib::ReactionRecord']]],
['collect_37',['collect',['../classgridfire_1_1_defined_engine_view.html#adbc64284b5f5a3256867be46fa87c69e',1,'gridfire::DefinedEngineView']]],
['collectatomicreverserateatomicbases_38',['collectAtomicReverseRateAtomicBases',['../classgridfire_1_1_graph_engine.html#a29b338630c959449c15881935ac30746',1,'gridfire::GraphEngine']]],
['collectnetworkspecies_39',['collectNetworkSpecies',['../classgridfire_1_1_graph_engine.html#aedf42d83bfcc28313b6b6454034d2efa',1,'gridfire::GraphEngine']]],
['common_20platforms_40',['Dependency Installation on Common Platforms',['../index.html#autotoc_md22',1,'']]],
['common_20workflow_20example_41',['Common Workflow Example',['../index.html#autotoc_md50',1,'Common Workflow Example'],['../index.html#autotoc_md55',1,'Common Workflow Example']]],
['compiler_20versions_42',['Minimum compiler versions',['../index.html#autotoc_md26',1,'']]],
['components_20and_20effects_43',['Workflow Components and Effects',['../index.html#autotoc_md51',1,'']]],
['composability_44',['A Note about composability',['../index.html#autotoc_md35',1,'']]],
@@ -67,8 +67,9 @@ var searchData=
['contains_5fproduct_64',['contains_product',['../classgridfire_1_1reaction_1_1_reaction.html#a074d3cd2421fd5d0133e47f0522403e2',1,'gridfire::reaction::Reaction::contains_product()'],['../classgridfire_1_1reaction_1_1_templated_reaction_set.html#a443ec5d7138764b32975232e13071ccf',1,'gridfire::reaction::TemplatedReactionSet::contains_product()'],['../classgridfire_1_1_reaction.html#a074d3cd2421fd5d0133e47f0522403e2',1,'gridfire::Reaction::contains_product()']]],
['contains_5freactant_65',['contains_reactant',['../classgridfire_1_1reaction_1_1_reaction.html#abbe243affa61ba9b2cd2a7b905cd5e45',1,'gridfire::reaction::Reaction::contains_reactant()'],['../classgridfire_1_1reaction_1_1_templated_reaction_set.html#ac42606350d7557106f7954b1f114c128',1,'gridfire::reaction::TemplatedReactionSet::contains_reactant()'],['../classgridfire_1_1_reaction.html#abbe243affa61ba9b2cd2a7b905cd5e45',1,'gridfire::Reaction::contains_reactant()']]],
['contains_5fspecies_66',['contains_species',['../classgridfire_1_1reaction_1_1_templated_reaction_set.html#ad870856d206d93f27125c88d44ff9e34',1,'gridfire::reaction::TemplatedReactionSet']]],
['convert_5fnetin_67',['convert_netIn',['../classgridfire_1_1approx8_1_1_approx8_network.html#a56426da6f1af7eb8a6d1cc70bc8e742a',1,'gridfire::approx8::Approx8Network']]],
['culling_68',['culling',['../structgridfire_1_1_net_in.html#a6a5e909b46094ffa20da9a3da906e43f',1,'gridfire::NetIn']]],
['cullreactionsbyflow_69',['cullReactionsByFlow',['../classgridfire_1_1_adaptive_engine_view.html#a42417e96fe9fd623458af109401daf08',1,'gridfire::AdaptiveEngineView']]],
['currently_20known_20good_20platforms_70',['Currently known good platforms',['../index.html#autotoc_md10',1,'']]]
['context_67',['Callback Context',['../index.html#autotoc_md53',1,'']]],
['convert_5fnetin_68',['convert_netIn',['../classgridfire_1_1approx8_1_1_approx8_network.html#a56426da6f1af7eb8a6d1cc70bc8e742a',1,'gridfire::approx8::Approx8Network']]],
['culling_69',['culling',['../structgridfire_1_1_net_in.html#a6a5e909b46094ffa20da9a3da906e43f',1,'gridfire::NetIn']]],
['cullreactionsbyflow_70',['cullReactionsByFlow',['../classgridfire_1_1_adaptive_engine_view.html#a42417e96fe9fd623458af109401daf08',1,'gridfire::AdaptiveEngineView']]],
['currently_20known_20good_20platforms_71',['Currently, known good platforms',['../index.html#autotoc_md10',1,'']]]
];