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

72
docs/html/search/all_d.js
View File

@@ -1,35 +1,43 @@
var searchData=
[
['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()']]],
['networksolverstrategy_21',['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_22',['NetworkSolverStrategy< DynamicEngine >',['../classgridfire_1_1solver_1_1_network_solver_strategy.html',1,'gridfire::solver']]],
['niso_23',['nIso',['../structgridfire_1_1approx8_1_1_approx8_net.html#a31928b4041479da6515a90569322fc02',1,'gridfire::approx8::Approx8Net']]],
['no_5fspecies_5fto_5fprime_24',['NO_SPECIES_TO_PRIME',['../namespacegridfire.html#a8bea3d74f35d640e693fa398e9b3e154a708c14ec56942aa5f32e7bef1e29db45',1,'gridfire']]],
['normalized_5fg_5fvalues_25',['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_26',['nuclearEnergyGenerationRate',['../structgridfire_1_1_step_derivatives.html#ab4aeb41be952c7b5844e1ee81fef9008',1,'gridfire::StepDerivatives']]],
['num_5fspecies_27',['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_28',['num_steps',['../structgridfire_1_1_net_out.html#a51c16703132cf739ec2fd89eae7badd6',1,'gridfire::NetOut']]],
['numerical_20solver_20strategies_29',['Numerical Solver Strategies',['../index.html#autotoc_md13',1,'']]],
['numspecies_30',['numSpecies',['../classgridfire_1_1exceptions_1_1_stale_engine_trigger.html#a44ac2f7510ecf86cd5b556a842eee30c',1,'gridfire::exceptions::StaleEngineTrigger']]],
['nvar_31',['nVar',['../structgridfire_1_1approx8_1_1_approx8_net.html#a7218aa9b3dbe7c6eca52119e115692db',1,'gridfire::approx8::Approx8Net']]]
['ic12_0',['ic12',['../structgridfire_1_1approx8_1_1_approx8_net.html#a95b9a07e29285884e6de523f8132f653',1,'gridfire::approx8::Approx8Net']]],
['id_1',['id',['../classgridfire_1_1reaction_1_1_reaction.html#a084c38181408ed5e6fa2a2dd4d0ec905',1,'gridfire::reaction::Reaction::id()'],['../classgridfire_1_1_reaction.html#a084c38181408ed5e6fa2a2dd4d0ec905',1,'gridfire::Reaction::id()']]],
['idensity_2',['iDensity',['../structgridfire_1_1approx8_1_1_approx8_net.html#a562c2383f585d3e9984225584d61c037',1,'gridfire::approx8::Approx8Net']]],
['identifiedisotope_3',['IdentifiedIsotope',['../structgridfire_1_1partition_1_1_rauscher_thielemann_partition_function_1_1_identified_isotope.html',1,'gridfire::partition::RauscherThielemannPartitionFunction']]],
['identifymeanslowestpool_4',['identifyMeanSlowestPool',['../classgridfire_1_1_multiscale_partitioning_engine_view.html#a54ca8004fbd8d6d3ea6f67efeb5dbc8d',1,'gridfire::MultiscalePartitioningEngineView']]],
['ienergy_5',['iEnergy',['../structgridfire_1_1approx8_1_1_approx8_net.html#a18501627dceb5d084bc7ba19f119826f',1,'gridfire::approx8::Approx8Net']]],
['ih1_6',['ih1',['../structgridfire_1_1approx8_1_1_approx8_net.html#acc735a17e005f7e25c68a86d9735ec4c',1,'gridfire::approx8::Approx8Net']]],
['ihe3_7',['ihe3',['../structgridfire_1_1approx8_1_1_approx8_net.html#ab0a43fee658efcaacfe7e6fb4870569b',1,'gridfire::approx8::Approx8Net']]],
['ihe4_8',['ihe4',['../structgridfire_1_1approx8_1_1_approx8_net.html#a82977ad3df7f620e80a6235b3fe64731',1,'gridfire::approx8::Approx8Net']]],
['img24_9',['img24',['../structgridfire_1_1approx8_1_1_approx8_net.html#a9647205f52fb0fa21316be39c3a6d709',1,'gridfire::approx8::Approx8Net']]],
['implementations_10',['Future Solver Implementations',['../index.html#autotoc_md16',1,'']]],
['implicit_20rosenbrock_20method_11',['DirectNetworkSolver (Implicit Rosenbrock Method)',['../index.html#autotoc_md14',1,'']]],
['in_20directnetworksolver_12',['Algorithmic Workflow in DirectNetworkSolver',['../index.html#autotoc_md15',1,'']]],
['in14_13',['in14',['../structgridfire_1_1approx8_1_1_approx8_net.html#a1af9135867aa3786721b89dbfdc4aee0',1,'gridfire::approx8::Approx8Net']]],
['index_14',['INDEX',['../namespacegridfire_1_1expectations.html#a926cb0409b1f38770eb028bcac70a87cacb4ae3b37047fb4b2c0d16f8bf84f076',1,'gridfire::expectations']]],
['ine20_15',['ine20',['../structgridfire_1_1approx8_1_1_approx8_net.html#ad43418fd8c536ebc814d5e6de555256c',1,'gridfire::approx8::Approx8Net']]],
['initialization_16',['C++ Example: GraphEngine Initialization',['../index.html#autotoc_md18',1,'']]],
['initializeallreaclibreactions_17',['initializeAllReaclibReactions',['../namespacegridfire_1_1reaclib.html#a02ff11b88be94392151873e06a30b276',1,'gridfire::reaclib']]],
['inputs_18',['inputs',['../structgridfire_1_1_multiscale_partitioning_engine_view_1_1_eigen_functor.html#a0adf1074b5e6ba448cedff7563c450d0',1,'gridfire::MultiscalePartitioningEngineView::EigenFunctor']]],
['inputsatcompiletime_19',['InputsAtCompileTime',['../structgridfire_1_1_multiscale_partitioning_engine_view_1_1_eigen_functor.html#a5a2ecfa4d17720d1da14e53f4c261a81a753b594931f9ee122e2079986ad572c9',1,'gridfire::MultiscalePartitioningEngineView::EigenFunctor']]],
['inputtype_20',['InputType',['../structgridfire_1_1_multiscale_partitioning_engine_view_1_1_eigen_functor.html#a3ebf684b36e98da38d8ee6f0be4f91e2',1,'gridfire::MultiscalePartitioningEngineView::EigenFunctor']]],
['installation_21',['Installation',['../md_docs_2static_2usage.html#autotoc_md25',1,'1. Installation'],['../index.html#autotoc_md7',1,'Python Bindings and Installation']]],
['installation_20instructions_22',['Build and Installation Instructions',['../index.html#autotoc_md2',1,'']]],
['installation_20on_20common_20platforms_23',['Dependency Installation on Common Platforms',['../index.html#autotoc_md4',1,'']]],
['installing_20the_20library_24',['Installing the Library',['../index.html#autotoc_md6',1,'']]],
['instructions_25',['Build and Installation Instructions',['../index.html#autotoc_md2',1,'']]],
['interpolationpoints_26',['InterpolationPoints',['../structgridfire_1_1partition_1_1_rauscher_thielemann_partition_function_1_1_interpolation_points.html',1,'gridfire::partition::RauscherThielemannPartitionFunction']]],
['involvesspecies_27',['involvesSpecies',['../classgridfire_1_1_graph_engine.html#aa6202cee0c3c481eda77cc9a91bc126b',1,'gridfire::GraphEngine']]],
['io_2eh_28',['io.h',['../io_8h.html',1,'']]],
['io16_29',['io16',['../structgridfire_1_1approx8_1_1_approx8_net.html#ab4e95622dc0414ad7e636ef811e600af',1,'gridfire::approx8::Approx8Net']]],
['is_5fin_5fequilibrium_30',['is_in_equilibrium',['../structgridfire_1_1_multiscale_partitioning_engine_view_1_1_q_s_e_group.html#af8dc75a5e022510ec13da0be8c53aa06',1,'gridfire::MultiscalePartitioningEngineView::QSEGroup']]],
['is_5freverse_31',['is_reverse',['../classgridfire_1_1reaction_1_1_reaction.html#aa67d05dfabf007c1acad34052d9a1dba',1,'gridfire::reaction::Reaction::is_reverse()'],['../classgridfire_1_1_reaction.html#aa67d05dfabf007c1acad34052d9a1dba',1,'gridfire::Reaction::is_reverse()']]],
['isarithmeticorad_32',['IsArithmeticOrAD',['../conceptgridfire_1_1_is_arithmetic_or_a_d.html',1,'gridfire']]],
['isdynamicengine_33',['IsDynamicEngine',['../concept_0d012022023301355052304263320136165002200160012126_1_1_is_dynamic_engine.html',1,'@012022023301355052304263320136165002200160012126']]],
['isotopedata_34',['IsotopeData',['../structgridfire_1_1partition_1_1_rauscher_thielemann_partition_function_1_1_isotope_data.html',1,'gridfire::partition::RauscherThielemannPartitionFunction']]],
['isprecomputationenabled_35',['isPrecomputationEnabled',['../classgridfire_1_1_graph_engine.html#a015f8975701f028c29835d3a9794e00f',1,'gridfire::GraphEngine']]],
['isstale_36',['isStale',['../classgridfire_1_1_dynamic_engine.html#a942e65ced17ca602482cc42e469d6398',1,'gridfire::DynamicEngine::isStale()'],['../classgridfire_1_1_graph_engine.html#af04a9f8a629d6f6c58c477af0f1ab9e5',1,'gridfire::GraphEngine::isStale()'],['../classgridfire_1_1_adaptive_engine_view.html#ad268c9942655e5c9605148fe07718e88',1,'gridfire::AdaptiveEngineView::isStale()'],['../classgridfire_1_1_defined_engine_view.html#a7d9e738dd28efb4d6127de7379169c87',1,'gridfire::DefinedEngineView::isStale()'],['../classgridfire_1_1_multiscale_partitioning_engine_view.html#ae7847959fc5af2b83f5446dd73567b46',1,'gridfire::MultiscalePartitioningEngineView::isStale()'],['../class_py_dynamic_engine.html#a55bf19ed7534a312a36faf74753f7b14',1,'PyDynamicEngine::isStale()']]],
['isstiff_37',['isStiff',['../classgridfire_1_1approx8_1_1_approx8_network.html#a5b17b2831389829533385900ce19a37a',1,'gridfire::approx8::Approx8Network::isStiff()'],['../classgridfire_1_1_network.html#ae93ad65deba79def4b77d420e7affa0b',1,'gridfire::Network::isStiff()']]],
['isusingreversereactions_38',['isUsingReverseReactions',['../classgridfire_1_1_graph_engine.html#ae7a210d9ab13ad5fb0c612f027acabd0',1,'gridfire::GraphEngine']]],
['itemp_39',['iTemp',['../structgridfire_1_1approx8_1_1_approx8_net.html#a010df59d40b3bc8a802224968922ebde',1,'gridfire::approx8::Approx8Net']]]
];