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

88
docs/html/search/all_12.js
View File

@@ -1,58 +1,36 @@
var searchData=
[
['s_5fall_5freaclib_5freactions_5fptr_0',['s_all_reaclib_reactions_ptr',['../namespacegridfire_1_1reaclib.html#a5dba5efc372d2a9e9e846dfd6563f3c0',1,'gridfire::reaclib']]],
['s_5fdebug_1',['s_debug',['../namespacegridfire.html#afd6f117eb2da3bab3873edc09d0926cf',1,'gridfire']]],
['s_5finitialized_2',['s_initialized',['../namespacegridfire_1_1reaclib.html#af6ff0dfe7ffe34c73ba9acbab5ef8a66',1,'gridfire::reaclib']]],
['s_5foperator_5fparens_5fcalled_3',['s_operator_parens_called',['../namespacegridfire.html#a8b632637f62614f509cde0e404a79054',1,'gridfire']]],
['screening_2eh_4',['screening.h',['../screening_8h.html',1,'']]],
['screening_5fabstract_2eh_5',['screening_abstract.h',['../screening__abstract_8h.html',1,'']]],
['screening_5fbare_2ecpp_6',['screening_bare.cpp',['../screening__bare_8cpp.html',1,'']]],
['screening_5fbare_2eh_7',['screening_bare.h',['../screening__bare_8h.html',1,'']]],
['screening_5ftypes_2ecpp_8',['screening_types.cpp',['../screening__types_8cpp.html',1,'']]],
['screening_5ftypes_2eh_9',['screening_types.h',['../screening__types_8h.html',1,'']]],
['screening_5fweak_2ecpp_10',['screening_weak.cpp',['../screening__weak_8cpp.html',1,'']]],
['screening_5fweak_2eh_11',['screening_weak.h',['../screening__weak_8h.html',1,'']]],
['screeningmodel_12',['ScreeningModel',['../classgridfire_1_1screening_1_1_screening_model.html',1,'gridfire::screening']]],
['screeningtype_13',['ScreeningType',['../namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25',1,'gridfire::screening']]],
['secondorder_14',['SecondOrder',['../namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57a264572d66aed5373d19dc80c7cde1f46',1,'gridfire']]],
['seed_5findices_15',['seed_indices',['../structgridfire_1_1_multiscale_partitioning_engine_view_1_1_q_s_e_group.html#a997efc7ef138efb0e60e60790fcce681',1,'gridfire::MultiscalePartitioningEngineView::QSEGroup']]],
['selectpartitionfunction_16',['selectPartitionFunction',['../classgridfire_1_1partition_1_1_composite_partition_function.html#a44325e313db7f8f901c0dd5d84d4845b',1,'gridfire::partition::CompositePartitionFunction']]],
['selectscreeningmodel_17',['selectScreeningModel',['../namespacegridfire_1_1screening.html#a6ca8556d27ac373e176f5b23437c416e',1,'gridfire::screening']]],
['setformat_18',['setFormat',['../classgridfire_1_1_network.html#a787c601f6e4bd06600bf946efbcc98d4',1,'gridfire::Network']]],
['setnetworkreactions_19',['setNetworkReactions',['../classgridfire_1_1_dynamic_engine.html#afb2ec904d88fc8aab516db4059d0e00f',1,'gridfire::DynamicEngine::setNetworkReactions()'],['../classgridfire_1_1_graph_engine.html#a371ba0881d6903ddb2d586faa61805d0',1,'gridfire::GraphEngine::setNetworkReactions()'],['../classgridfire_1_1_adaptive_engine_view.html#a7b3a6b3ab0a52f0f84d2b142e74ea672',1,'gridfire::AdaptiveEngineView::setNetworkReactions()'],['../classgridfire_1_1_defined_engine_view.html#a9736edfb7c9148b60de30d50c0d3530d',1,'gridfire::DefinedEngineView::setNetworkReactions()'],['../classgridfire_1_1_multiscale_partitioning_engine_view.html#acb5fa7f03cd89b8c1b6b9ffdf3abb12e',1,'gridfire::MultiscalePartitioningEngineView::setNetworkReactions()'],['../class_py_dynamic_engine.html#afd818c408c64d207e71b1a90426328d6',1,'PyDynamicEngine::setNetworkReactions()']]],
['setprecomputation_20',['setPrecomputation',['../classgridfire_1_1_graph_engine.html#a6c5410878496abc349ba30b691cdf0f1',1,'gridfire::GraphEngine']]],
['setscreeningmodel_21',['setScreeningModel',['../classgridfire_1_1_dynamic_engine.html#a3fb44b6f55563a2f590f31916528f2bd',1,'gridfire::DynamicEngine::setScreeningModel()'],['../classgridfire_1_1_graph_engine.html#a8110e687844f921438bb517e1d8ce62f',1,'gridfire::GraphEngine::setScreeningModel()'],['../classgridfire_1_1_adaptive_engine_view.html#aae4ddbef1c4e2202fd236221a4bf376b',1,'gridfire::AdaptiveEngineView::setScreeningModel()'],['../classgridfire_1_1_defined_engine_view.html#abf2da57c83c3c4c635cb301f53088258',1,'gridfire::DefinedEngineView::setScreeningModel()'],['../classgridfire_1_1_multiscale_partitioning_engine_view.html#a1a0c0a0ade632eb10f0eecab828a059f',1,'gridfire::MultiscalePartitioningEngineView::setScreeningModel()'],['../class_py_dynamic_engine.html#afa3abfd612033336a656f092721c14ac',1,'PyDynamicEngine::setScreeningModel()']]],
['setstiff_22',['setStiff',['../classgridfire_1_1approx8_1_1_approx8_network.html#aefed972081514c29cdaaa1efd857ad8d',1,'gridfire::approx8::Approx8Network::setStiff()'],['../classgridfire_1_1_network.html#a84de2d691af06c4b62cfab5022b1e8fe',1,'gridfire::Network::setStiff()']]],
['setusereversereactions_23',['setUseReverseReactions',['../classgridfire_1_1_graph_engine.html#a409991d527ea4d4b05d1af907fe5d197',1,'gridfire::GraphEngine']]],
['shallow_24',['Shallow',['../namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57a928d0f1285ee7d36c1c2fa1b1b7a164c',1,'gridfire']]],
['simplereactionlistfileparser_25',['SimpleReactionListFileParser',['../classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html',1,'gridfire::io::SimpleReactionListFileParser'],['../classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html#afc8ed91e8c98205c505e3d9f0cff1993',1,'gridfire::io::SimpleReactionListFileParser::SimpleReactionListFileParser()']]],
['size_26',['size',['../classgridfire_1_1reaction_1_1_logical_reaction.html#afa41050855b842c63db16c94d2e9b897',1,'gridfire::reaction::LogicalReaction::size()'],['../classgridfire_1_1reaction_1_1_templated_reaction_set.html#a6a1dc3c56690386ae9f6aa5c2aa37ba2',1,'gridfire::reaction::TemplatedReactionSet::size()']]],
['solveqseabundances_27',['solveQSEAbundances',['../classgridfire_1_1_multiscale_partitioning_engine_view.html#a3c5fcb8e3396d74359fd601554c9ffa9',1,'gridfire::MultiscalePartitioningEngineView']]],
['solver_20implementations_28',['Future Solver Implementations',['../index.html#autotoc_md16',1,'']]],
['solver_20strategies_29',['Numerical Solver Strategies',['../index.html#autotoc_md13',1,'']]],
['solver_2ecpp_30',['solver.cpp',['../solver_8cpp.html',1,'']]],
['solver_2eh_31',['solver.h',['../solver_8h.html',1,'']]],
['sourcelabel_32',['sourceLabel',['../classgridfire_1_1reaction_1_1_reaction.html#a410e2ab0784ad751f82bbe55be603db0',1,'gridfire::reaction::Reaction::sourceLabel()'],['../classgridfire_1_1_reaction.html#a410e2ab0784ad751f82bbe55be603db0',1,'gridfire::Reaction::sourceLabel()']]],
['sources_33',['sources',['../classgridfire_1_1reaction_1_1_logical_reaction.html#add094eda0e71126f8443698d7f3317f4',1,'gridfire::reaction::LogicalReaction']]],
['sparsitypattern_34',['SparsityPattern',['../namespacegridfire.html#a898dfe22579e649935645cbd6f073178',1,'gridfire']]],
['species_5findices_35',['species_indices',['../structgridfire_1_1_multiscale_partitioning_engine_view_1_1_q_s_e_group.html#a3840e7faa591b7c3006b27ae3df9e21e',1,'gridfire::MultiscalePartitioningEngineView::QSEGroup']]],
['stale_36',['STALE',['../namespacegridfire_1_1expectations.html#a926cb0409b1f38770eb028bcac70a87ca4d855a061b3066dc14a3b12ed26b5456',1,'gridfire::expectations']]],
['staleengineerror_37',['StaleEngineError',['../classgridfire_1_1exceptions_1_1_stale_engine_error.html',1,'gridfire::exceptions::StaleEngineError'],['../structgridfire_1_1expectations_1_1_stale_engine_error.html',1,'gridfire::expectations::StaleEngineError'],['../classgridfire_1_1exceptions_1_1_stale_engine_error.html#a6672e4c3f42260bba25d78e14ebd5a50',1,'gridfire::exceptions::StaleEngineError::StaleEngineError()'],['../structgridfire_1_1expectations_1_1_stale_engine_error.html#ad477b6e562bf4167ad327ebaccd4cf10',1,'gridfire::expectations::StaleEngineError::StaleEngineError()']]],
['staleengineerrortypes_38',['StaleEngineErrorTypes',['../namespacegridfire_1_1expectations.html#aef568e2802c03adef56dbcb6511d66c7',1,'gridfire::expectations']]],
['staleenginetrigger_39',['StaleEngineTrigger',['../classgridfire_1_1exceptions_1_1_stale_engine_trigger.html',1,'gridfire::exceptions::StaleEngineTrigger'],['../classgridfire_1_1exceptions_1_1_stale_engine_trigger.html#afb50f1694a806e8bcaf99111d99aeb5d',1,'gridfire::exceptions::StaleEngineTrigger::StaleEngineTrigger()']]],
['staletype_40',['staleType',['../structgridfire_1_1expectations_1_1_stale_engine_error.html#a10bce51a63024715959a66673b909590',1,'gridfire::expectations::StaleEngineError']]],
['state_41',['state',['../structgridfire_1_1exceptions_1_1_stale_engine_trigger_1_1state.html',1,'gridfire::exceptions::StaleEngineTrigger']]],
['status_42',['status',['../structgridfire_1_1_priming_report.html#a5fec4b465afb4f2d9bc30cd1cab1b50d',1,'gridfire::PrimingReport']]],
['std_43',['std',['../namespacestd.html',1,'']]],
['stepderivatives_44',['StepDerivatives',['../structgridfire_1_1_step_derivatives.html',1,'gridfire']]],
['stoichiometric_5fcoefficients_45',['stoichiometric_coefficients',['../structgridfire_1_1_graph_engine_1_1_precomputed_reaction.html#a7a7e9167b19e339e0d69544b9c00e79c',1,'gridfire::GraphEngine::PrecomputedReaction']]],
['stoichiometry_46',['stoichiometry',['../classgridfire_1_1reaction_1_1_reaction.html#aaf0c94db6536b4a9ac1ec08a5c8f01ac',1,'gridfire::reaction::Reaction::stoichiometry(const fourdst::atomic::Species &species) const'],['../classgridfire_1_1reaction_1_1_reaction.html#ad359c06d7196c1a7a955a7b66a51dbe3',1,'gridfire::reaction::Reaction::stoichiometry() const'],['../classgridfire_1_1_reaction.html#aaf0c94db6536b4a9ac1ec08a5c8f01ac',1,'gridfire::Reaction::stoichiometry(const fourdst::atomic::Species &species) const'],['../classgridfire_1_1_reaction.html#ad359c06d7196c1a7a955a7b66a51dbe3',1,'gridfire::Reaction::stoichiometry() const']]],
['strategies_47',['Numerical Solver Strategies',['../index.html#autotoc_md13',1,'']]],
['stringtobasepartitiontype_48',['stringToBasePartitionType',['../namespacegridfire_1_1partition.html#a84de6308486d35ce8bc1a9dea52dfa4a',1,'gridfire::partition']]],
['success_49',['success',['../structgridfire_1_1_priming_report.html#afa4dd791ddd9df84039554524b681fb3',1,'gridfire::PrimingReport']]],
['sum_5fproduct_50',['sum_product',['../namespacegridfire_1_1approx8.html#aafd24448743672021dd4507316060817',1,'gridfire::approx8']]],
['supports_51',['supports',['../classgridfire_1_1partition_1_1_composite_partition_function.html#ae8908a78f087ea516cdd5a4cdd449a9c',1,'gridfire::partition::CompositePartitionFunction::supports()'],['../classgridfire_1_1partition_1_1_partition_function.html#a6df4191d10516477371a0384e1e55bf5',1,'gridfire::partition::PartitionFunction::supports()'],['../classgridfire_1_1partition_1_1_ground_state_partition_function.html#a49b18aae58eb6250aaa23d43d55f02bd',1,'gridfire::partition::GroundStatePartitionFunction::supports()'],['../classgridfire_1_1partition_1_1_rauscher_thielemann_partition_function.html#a588a11c654751765b04d6425c99041f5',1,'gridfire::partition::RauscherThielemannPartitionFunction::supports()'],['../class_py_partition_function.html#a0f288a01a3ed7fb92fff5d9fd7d56aa8',1,'PyPartitionFunction::supports()']]],
['symmetry_5ffactor_52',['symmetry_factor',['../structgridfire_1_1_graph_engine_1_1_precomputed_reaction.html#ac42504e868c0b9fd9ac9a405ea739f0e',1,'gridfire::GraphEngine::PrecomputedReaction']]],
['syncinternalmaps_53',['syncInternalMaps',['../classgridfire_1_1_graph_engine.html#acdce8d87e23a2cd1504bc9472e538c0f',1,'gridfire::GraphEngine']]],
['system_5fresized_54',['SYSTEM_RESIZED',['../namespacegridfire_1_1expectations.html#aef568e2802c03adef56dbcb6511d66c7a109aa03c8823fcc0ab193b7e48664cbf',1,'gridfire::expectations']]]
['n14a_5frate_0',['n14a_rate',['../namespacegridfire_1_1approx8.html#a3a9861a77093effdfc061743eb13fcdb',1,'gridfire::approx8']]],
['n14p_5frate_1',['n14p_rate',['../namespacegridfire_1_1approx8.html#a34f18b2345a8fd8d96bbe1a9825c1f21',1,'gridfire::approx8']]],
['n15pa_5frate_2',['n15pa_rate',['../namespacegridfire_1_1approx8.html#a9a90b83dd4aa2dcc928bd14f4678dcef',1,'gridfire::approx8']]],
['n15pg_5ffrac_3',['n15pg_frac',['../namespacegridfire_1_1approx8.html#ac309c160c806208bf01bebeb29c23896',1,'gridfire::approx8']]],
['n15pg_5frate_4',['n15pg_rate',['../namespacegridfire_1_1approx8.html#acdbb3ee2ef22bfd9c836324285d0da98',1,'gridfire::approx8']]],
['na_5',['Na',['../structgridfire_1_1_graph_engine_1_1constants.html#a5ccc874d6704615e0ce54c14dc67699d',1,'gridfire::GraphEngine::constants']]],
['ne20a_5frate_6',['ne20a_rate',['../namespacegridfire_1_1approx8.html#ad7a6f894fa4bdeebb4cae0eba3b2c210',1,'gridfire::approx8']]],
['netin_7',['NetIn',['../structgridfire_1_1_net_in.html',1,'gridfire']]],
['netout_8',['NetOut',['../structgridfire_1_1_net_out.html',1,'gridfire']]],
['network_9',['Network',['../classgridfire_1_1_network.html',1,'gridfire::Network'],['../classgridfire_1_1_network.html#a20b631f2404bfdec2333f680a62abf55',1,'gridfire::Network::Network()']]],
['network_20view_10',['C++ Example: Adaptive Network View',['../index.html#autotoc_md19',1,'']]],
['network_2ecpp_11',['network.cpp',['../network_8cpp.html',1,'']]],
['network_2eh_12',['network.h',['../network_8h.html',1,'']]],
['network_5ffile_2ecpp_13',['network_file.cpp',['../network__file_8cpp.html',1,'']]],
['network_5ffile_2eh_14',['network_file.h',['../network__file_8h.html',1,'']]],
['networkbuilddepth_15',['NetworkBuildDepth',['../namespacegridfire.html#a0210bd2e07538932135a56b62b8ddb57',1,'gridfire']]],
['networkfileparser_16',['NetworkFileParser',['../classgridfire_1_1io_1_1_network_file_parser.html',1,'gridfire::io']]],
['networkformat_17',['NetworkFormat',['../namespacegridfire.html#a3f3d6b3f9742b70e62049ccefbb60f37',1,'gridfire']]],
['networkprimingengineview_18',['NetworkPrimingEngineView',['../classgridfire_1_1_network_priming_engine_view.html',1,'gridfire::NetworkPrimingEngineView'],['../classgridfire_1_1_network_priming_engine_view.html#ad13ec8d4974421c72cffd88558d71177',1,'gridfire::NetworkPrimingEngineView::NetworkPrimingEngineView(const std::string &primingSymbol, DynamicEngine &baseEngine)'],['../classgridfire_1_1_network_priming_engine_view.html#a96751b66dd11f1155d0c488f39f9f6a6',1,'gridfire::NetworkPrimingEngineView::NetworkPrimingEngineView(const fourdst::atomic::Species &primingSpecies, DynamicEngine &baseEngine)']]],
['networkprimingengineview_20example_19',['NetworkPrimingEngineView Example',['../engine_8h.html#NetworkPrimingEngineViewExample',1,'']]],
['networkresizederror_20',['NetworkResizedError',['../classgridfire_1_1exceptions_1_1_network_resized_error.html',1,'gridfire::exceptions::NetworkResizedError'],['../classgridfire_1_1exceptions_1_1_network_resized_error.html#a80c0adb088e8083309591d24051b056b',1,'gridfire::exceptions::NetworkResizedError::NetworkResizedError()']]],
['networks_21',['4. Visualizing Reaction Networks',['../md_docs_2static_2usage.html#autotoc_md33',1,'']]],
['networksolverstrategy_22',['NetworkSolverStrategy',['../classgridfire_1_1solver_1_1_network_solver_strategy.html',1,'gridfire::solver::NetworkSolverStrategy< EngineT >'],['../classgridfire_1_1solver_1_1_network_solver_strategy.html#a01cbbec0eb5c3a60f50da38cdaf66505',1,'gridfire::solver::NetworkSolverStrategy::NetworkSolverStrategy()']]],
['networksolverstrategy_3c_20dynamicengine_20_3e_23',['NetworkSolverStrategy< DynamicEngine >',['../classgridfire_1_1solver_1_1_network_solver_strategy.html',1,'gridfire::solver']]],
['niso_24',['nIso',['../structgridfire_1_1approx8_1_1_approx8_net.html#a31928b4041479da6515a90569322fc02',1,'gridfire::approx8::Approx8Net']]],
['no_5fspecies_5fto_5fprime_25',['NO_SPECIES_TO_PRIME',['../namespacegridfire.html#a8bea3d74f35d640e693fa398e9b3e154a708c14ec56942aa5f32e7bef1e29db45',1,'gridfire']]],
['normalized_5fg_5fvalues_26',['normalized_g_values',['../structgridfire_1_1partition_1_1_rauscher_thielemann_partition_function_1_1_isotope_data.html#aea71e9198606e0ba393321178f988fcc',1,'gridfire::partition::RauscherThielemannPartitionFunction::IsotopeData::normalized_g_values'],['../structgridfire_1_1partition_1_1record_1_1_rauscher_thielemann_partition_data_record.html#a64c1cef58c1bdeab1fcc7f9a30a71609',1,'gridfire::partition::record::RauscherThielemannPartitionDataRecord::normalized_g_values']]],
['nuclearenergygenerationrate_27',['nuclearEnergyGenerationRate',['../structgridfire_1_1_step_derivatives.html#ab4aeb41be952c7b5844e1ee81fef9008',1,'gridfire::StepDerivatives']]],
['num_5fspecies_28',['num_species',['../classgridfire_1_1reaction_1_1_reaction.html#a1d3c8ab6d55155f9a21ad80ed8b9ef97',1,'gridfire::reaction::Reaction::num_species()'],['../classgridfire_1_1_reaction.html#a1d3c8ab6d55155f9a21ad80ed8b9ef97',1,'gridfire::Reaction::num_species()']]],
['num_5fsteps_29',['num_steps',['../structgridfire_1_1_net_out.html#a51c16703132cf739ec2fd89eae7badd6',1,'gridfire::NetOut']]],
['numerical_20solver_20strategies_30',['Numerical Solver Strategies',['../index.html#autotoc_md13',1,'']]],
['numspecies_31',['numSpecies',['../classgridfire_1_1exceptions_1_1_stale_engine_trigger.html#a44ac2f7510ecf86cd5b556a842eee30c',1,'gridfire::exceptions::StaleEngineTrigger']]],
['nvar_32',['nVar',['../structgridfire_1_1approx8_1_1_approx8_net.html#a7218aa9b3dbe7c6eca52119e115692db',1,'gridfire::approx8::Approx8Net']]]
];