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

docs(docs): rebuild with more usage examples

Browse Source
This commit is contained in:
Emily Boudreaux
2025-07-30 15:12:46 -04:00
parent 24870ffcbc
commit cd60ae5c1e
79 changed files with 5050 additions and 4496 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
docs/html/search/all_5.js
View File

@@ -1,27 +1,37 @@
var searchData=
[
['failed_5fto_5ffinalize_5fcomposition_0',['FAILED_TO_FINALIZE_COMPOSITION',['../namespacegridfire.html#a8bea3d74f35d640e693fa398e9b3e154ae8870a753743b62c511c939eef95c93f',1,'gridfire']]],
['failed_5fto_5ffind_5fcreation_5fchannel_1',['FAILED_TO_FIND_CREATION_CHANNEL',['../namespacegridfire.html#a8bea3d74f35d640e693fa398e9b3e154a9870268bdece09274aea75557a19158a',1,'gridfire']]],
['failed_5fto_5ffind_5fpriming_5freactions_2',['FAILED_TO_FIND_PRIMING_REACTIONS',['../namespacegridfire.html#a8bea3d74f35d640e693fa398e9b3e154a186367e42446c004076290ca7913d931',1,'gridfire']]],
['failedtopartitionengineerror_3',['FailedToPartitionEngineError',['../classgridfire_1_1exceptions_1_1_failed_to_partition_engine_error.html',1,'gridfire::exceptions::FailedToPartitionEngineError'],['../classgridfire_1_1exceptions_1_1_failed_to_partition_engine_error.html#a9b9e8752798876d34a444f61fc2f509a',1,'gridfire::exceptions::FailedToPartitionEngineError::FailedToPartitionEngineError()']]],
['failure_4',['FAILURE',['../namespacegridfire_1_1expectations.html#a926cb0409b1f38770eb028bcac70a87ca36fc6065a3e970bc3e6b2e59da52bf2a',1,'gridfire::expectations']]],
['fifthorder_5',['FifthOrder',['../namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57a5105376c2b90747e00bed5bf2953dd56',1,'gridfire']]],
['filedefinedengineview_6',['FileDefinedEngineView',['../classgridfire_1_1_file_defined_engine_view.html',1,'gridfire::FileDefinedEngineView'],['../classgridfire_1_1_file_defined_engine_view.html#a8f2f64bab0f516ed2a6fd529912e0acd',1,'gridfire::FileDefinedEngineView::FileDefinedEngineView()']]],
['finalizeactiveset_7',['finalizeActiveSet',['../classgridfire_1_1_adaptive_engine_view.html#aa79fb382c98461b02a2c30668491e6c5',1,'gridfire::AdaptiveEngineView']]],
['find_8',['find',['../classgridfire_1_1partition_1_1_rauscher_thielemann_partition_function.html#a12058e121981294f447e69a467fd84cd',1,'gridfire::partition::RauscherThielemannPartitionFunction']]],
['finddominantcreationchannel_9',['findDominantCreationChannel',['../namespacegridfire.html#aefc63ddbfe97dcb4178c94dfd1c4b256',1,'gridfire']]],
['findreachablespecies_10',['findReachableSpecies',['../classgridfire_1_1_adaptive_engine_view.html#a0ed21f7e7c1034fc87b40d4116c4221b',1,'gridfire::AdaptiveEngineView']]],
['flow_11',['Code Architecture and Logical Flow',['../index.html#autotoc_md9',1,'']]],
['flowrate_12',['flowRate',['../structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html#a6c2e9087f6c8af5d89a5f0de7bd4a5b4',1,'gridfire::AdaptiveEngineView::ReactionFlow']]],
['for_5fsparse_5fjac_13',['for_sparse_jac',['../classgridfire_1_1_graph_engine_1_1_atomic_reverse_rate.html#aec41632c2a362be33a1f7ff04204cbf4',1,'gridfire::GraphEngine::AtomicReverseRate']]],
['formatnucleartimescalelogstring_14',['formatNuclearTimescaleLogString',['../namespacegridfire_1_1utils.html#af56693a70d9e2b40c8ae2c3bcd4b26c8',1,'gridfire::utils']]],
['formatstringlookup_15',['FormatStringLookup',['../namespacegridfire.html#a4e9cabad30b57d636c2f0d73d8cc6bb4',1,'gridfire']]],
['forward_16',['forward',['../classgridfire_1_1_graph_engine_1_1_atomic_reverse_rate.html#ad9b8dd0e8ba9c7745e33acc9a649d2e0',1,'gridfire::GraphEngine::AtomicReverseRate']]],
['fourthorder_17',['FourthOrder',['../namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57a100e3bf0197221c19b222badf42aa964',1,'gridfire']]],
['front_18',['FRONT',['../classgridfire_1_1partition_1_1_rauscher_thielemann_partition_function.html#a7002ebbef966f89b2426f5ea0df33329aa692ae3131928d57ddcd2408d6b44d71',1,'gridfire::partition::RauscherThielemannPartitionFunction']]],
['full_19',['Full',['../namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57abbd47109890259c0127154db1af26c75',1,'gridfire']]],
['full_5fsuccess_20',['FULL_SUCCESS',['../namespacegridfire.html#a8bea3d74f35d640e693fa398e9b3e154a64d98633bac1de0eb2a539cbfd2a5c2a',1,'gridfire']]],
['functions_21',['Available Partition Functions',['../index.html#autotoc_md11',1,'']]],
['funding_22',['Funding',['../index.html#autotoc_md1',1,'']]],
['future_20solver_20implementations_23',['Future Solver Implementations',['../index.html#autotoc_md16',1,'']]]
['a_0',['a',['../structgridfire_1_1partition_1_1record_1_1_rauscher_thielemann_partition_data_record.html#a677505655a1c6922dfa9b32b70d7e815',1,'gridfire::partition::record::RauscherThielemannPartitionDataRecord']]],
['a0_1',['a0',['../structgridfire_1_1reaction_1_1_rate_coefficient_set.html#a2fa6b65e300dcd181222b743c2b3d6ed',1,'gridfire::reaction::RateCoefficientSet']]],
['a1_2',['a1',['../structgridfire_1_1reaction_1_1_rate_coefficient_set.html#ace9dbd928e179784e47eaa108ce8d721',1,'gridfire::reaction::RateCoefficientSet']]],
['a2_3',['a2',['../structgridfire_1_1reaction_1_1_rate_coefficient_set.html#a2a9316d19bc2e8bf0a7872eb6fe8a53f',1,'gridfire::reaction::RateCoefficientSet']]],
['a3_4',['a3',['../structgridfire_1_1reaction_1_1_rate_coefficient_set.html#a3d047485ebb57d6c763adfe4aae493b1',1,'gridfire::reaction::RateCoefficientSet']]],
['a4_5',['a4',['../structgridfire_1_1reaction_1_1_rate_coefficient_set.html#ae57b2eac71cb4ed9947f40c9cb8fc3ca',1,'gridfire::reaction::RateCoefficientSet']]],
['a5_6',['a5',['../structgridfire_1_1reaction_1_1_rate_coefficient_set.html#a8c79db4e649b4eb1d29c43ebe4e95458',1,'gridfire::reaction::RateCoefficientSet']]],
['a6_7',['a6',['../structgridfire_1_1reaction_1_1_rate_coefficient_set.html#adf8e6ed7f91cb9e15d1469a808b1877a',1,'gridfire::reaction::RateCoefficientSet']]],
['abs_5fstype_5fregister_5fdynamic_5fengine_5fbindings_8',['abs_stype_register_dynamic_engine_bindings',['../engine_2bindings_8cpp.html#a4066aaf2dca39ee1ed37ad53169f1cdf',1,'abs_stype_register_dynamic_engine_bindings(pybind11::module &m): bindings.cpp'],['../engine_2bindings_8h.html#a4066aaf2dca39ee1ed37ad53169f1cdf',1,'abs_stype_register_dynamic_engine_bindings(pybind11::module &m): bindings.cpp']]],
['abs_5fstype_5fregister_5fengine_5fbindings_9',['abs_stype_register_engine_bindings',['../engine_2bindings_8cpp.html#a01ff627d4ef6a21b3323cd383dd29841',1,'abs_stype_register_engine_bindings(pybind11::module &m): bindings.cpp'],['../engine_2bindings_8h.html#a01ff627d4ef6a21b3323cd383dd29841',1,'abs_stype_register_engine_bindings(pybind11::module &m): bindings.cpp']]],
['adaptive_20network_20view_10',['C++ Example: Adaptive Network View',['../index.html#autotoc_md19',1,'']]],
['adaptiveengineview_11',['AdaptiveEngineView',['../classgridfire_1_1_adaptive_engine_view.html',1,'gridfire::AdaptiveEngineView'],['../classgridfire_1_1_adaptive_engine_view.html#ad599363cdd457e72e2e2937b0222c455',1,'gridfire::AdaptiveEngineView::AdaptiveEngineView()']]],
['adaptiveengineview_20example_12',['AdaptiveEngineView Example',['../engine_8h.html#AdaptiveEngineViewExample',1,'']]],
['add_5freaction_13',['add_reaction',['../classgridfire_1_1reaction_1_1_logical_reaction.html#a14a24cb8ea25a1514134acc51197f1de',1,'gridfire::reaction::LogicalReaction::add_reaction()'],['../classgridfire_1_1reaction_1_1_templated_reaction_set.html#a339dbbf883b6ae20e33d9782d8376bcf',1,'gridfire::reaction::TemplatedReactionSet::add_reaction()']]],
['addouble_14',['ADDouble',['../classgridfire_1_1screening_1_1_screening_model.html#a107ff2897f040d6f27f69d56a0bdd28d',1,'gridfire::screening::ScreeningModel::ADDouble'],['../classgridfire_1_1screening_1_1_bare_screening_model.html#a51119d705267e0b415aae8b4881d8c96',1,'gridfire::screening::BareScreeningModel::ADDouble'],['../namespacegridfire.html#a1121d0b2d005195333412559fa29d3cc',1,'gridfire::ADDouble'],['../namespacegridfire_1_1screening.html#ae7dd1a7ccb7bf3c05084094ab008d8a3',1,'gridfire::screening::ADDouble'],['../py__screening_8cpp.html#a4c5a7b887f31226ce0b82409f819833b',1,'ADDouble: py_screening.cpp']]],
['affected_5fspecies_5findices_15',['affected_species_indices',['../structgridfire_1_1_graph_engine_1_1_precomputed_reaction.html#a3e2e67e532970738d20491ea56b170f3',1,'gridfire::GraphEngine::PrecomputedReaction']]],
['aion_16',['aIon',['../structgridfire_1_1approx8_1_1_approx8_net.html#a296e54c1b22f0c5d4d07a13577c6e069',1,'gridfire::approx8::Approx8Net']]],
['algebraic_5findices_17',['algebraic_indices',['../structgridfire_1_1_multiscale_partitioning_engine_view_1_1_q_s_e_group.html#ab11be6e7afeef1ac9e4314ad8345e0b0',1,'gridfire::MultiscalePartitioningEngineView::QSEGroup']]],
['algorithmic_20workflow_20in_20directnetworksolver_18',['Algorithmic Workflow in DirectNetworkSolver',['../index.html#autotoc_md15',1,'']]],
['all_19',['All',['../structgridfire_1_1_multiscale_partitioning_engine_view_1_1_cache_stats.html#ac558e59f790508a5e8522c412be5b505ab1c94ca2fbc3e78fc30069c8d0f01680',1,'gridfire::MultiscalePartitioningEngineView::CacheStats']]],
['all_5fspecies_20',['all_species',['../classgridfire_1_1reaction_1_1_reaction.html#a7dc8fda87e0581fde6da0a81cf4d7224',1,'gridfire::reaction::Reaction::all_species()'],['../classgridfire_1_1_reaction.html#a7dc8fda87e0581fde6da0a81cf4d7224',1,'gridfire::Reaction::all_species()']]],
['analyzetimescalepoolconnectivity_21',['analyzeTimescalePoolConnectivity',['../classgridfire_1_1_multiscale_partitioning_engine_view.html#af13e764c118a6cc51847384e9c70e05b',1,'gridfire::MultiscalePartitioningEngineView']]],
['and_20installation_22',['Python Bindings and Installation',['../index.html#autotoc_md7',1,'']]],
['and_20installation_20instructions_23',['Build and Installation Instructions',['../index.html#autotoc_md2',1,'']]],
['and_20logical_20flow_24',['Code Architecture and Logical Flow',['../index.html#autotoc_md9',1,'']]],
['and_20views_25',['2. Why These Engines and Views?',['../md_docs_2static_2usage.html#autotoc_md29',1,'']]],
['approx8_26',['APPROX8',['../namespacegridfire.html#a3f3d6b3f9742b70e62049ccefbb60f37a1fc7adf719c40457abfdb8334675faea',1,'gridfire']]],
['approx8net_27',['Approx8Net',['../structgridfire_1_1approx8_1_1_approx8_net.html',1,'gridfire::approx8']]],
['approx8network_28',['Approx8Network',['../classgridfire_1_1approx8_1_1_approx8_network.html',1,'gridfire::approx8::Approx8Network'],['../classgridfire_1_1approx8_1_1_approx8_network.html#a65066078081c544be4e56e25eb407c8b',1,'gridfire::approx8::Approx8Network::Approx8Network()']]],
['architecture_20and_20logical_20flow_29',['Code Architecture and Logical Flow',['../index.html#autotoc_md9',1,'']]],
['atomicreverserate_30',['AtomicReverseRate',['../classgridfire_1_1_graph_engine_1_1_atomic_reverse_rate.html',1,'gridfire::GraphEngine::AtomicReverseRate'],['../classgridfire_1_1_graph_engine_1_1_atomic_reverse_rate.html#a20d8e668f0af5fad5b7eda12564dc7cf',1,'gridfire::GraphEngine::AtomicReverseRate::AtomicReverseRate()']]],
['available_20engines_31',['Available Engines',['../engine_8h.html#AvailableEngines',1,'']]],
['available_20partition_20functions_32',['Available Partition Functions',['../index.html#autotoc_md11',1,'']]],
['available_20views_33',['Available Views',['../engine_8h.html#AvailableViews',1,'']]]
];