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

docs(docs): added extensive docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-07-01 15:06:22 -04:00
parent 5b4db3ea43
commit 131f61c9e7
134 changed files with 5101 additions and 2191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/html/solver_8cpp_source.html
View File

@@ -615,7 +615,7 @@ $(function(){initNavTree('solver_8cpp_source.html',''); initResizable(true); });
<div class="ttc" id="aclassgridfire_1_1solver_1_1_q_s_e_network_solver_html_abaa567001df0007b714f474febae408b"><div class="ttname"><a href="classgridfire_1_1solver_1_1_q_s_e_network_solver.html#abaa567001df0007b714f474febae408b">gridfire::solver::QSENetworkSolver::initializeNetworkWithShortIgnition</a></div><div class="ttdeci">NetOut initializeNetworkWithShortIgnition(const NetIn &amp;netIn) const</div><div class="ttdoc">Initializes the network with a short ignition phase.</div><div class="ttdef"><b>Definition</b> <a href="#l00264">solver.cpp:264</a></div></div>
<div class="ttc" id="aengine__graph_8h_html"><div class="ttname"><a href="engine__graph_8h.html">engine_graph.h</a></div></div>
<div class="ttc" id="alogging_8h_html"><div class="ttname"><a href="logging_8h.html">logging.h</a></div></div>
<div class="ttc" id="anamespacegridfire_1_1screening_html_aa82aafbc4f8c28d0a75b60798e3a7d25ad80b95b1abb9c8659fa4cc9d3d29bb71"><div class="ttname"><a href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25ad80b95b1abb9c8659fa4cc9d3d29bb71">gridfire::screening::ScreeningType::BARE</a></div><div class="ttdeci">@ BARE</div><div class="ttdoc">No screening applied.</div><div class="ttdef"><b>Definition</b> <a href="screening__types_8h_source.html#l00009">screening_types.h:9</a></div></div>
<div class="ttc" id="anamespacegridfire_1_1screening_html_aa82aafbc4f8c28d0a75b60798e3a7d25ad80b95b1abb9c8659fa4cc9d3d29bb71"><div class="ttname"><a href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25ad80b95b1abb9c8659fa4cc9d3d29bb71">gridfire::screening::ScreeningType::BARE</a></div><div class="ttdeci">@ BARE</div><div class="ttdoc">No screening applied. The screening factor is always 1.0.</div><div class="ttdef"><b>Definition</b> <a href="screening__types_8h_source.html#l00016">screening_types.h:16</a></div></div>
<div class="ttc" id="anamespacegridfire_1_1solver_html"><div class="ttname"><a href="namespacegridfire_1_1solver.html">gridfire::solver</a></div><div class="ttdef"><b>Definition</b> <a href="solver_8h_source.html#l00017">solver.h:17</a></div></div>
<div class="ttc" id="anamespacegridfire_html_a96c062f94713921e5d7568ecedcdcb06"><div class="ttname"><a href="namespacegridfire.html#a96c062f94713921e5d7568ecedcdcb06">gridfire::MIN_ABUNDANCE_THRESHOLD</a></div><div class="ttdeci">static constexpr double MIN_ABUNDANCE_THRESHOLD</div><div class="ttdoc">Minimum abundance threshold below which species are ignored.</div><div class="ttdef"><b>Definition</b> <a href="engine__graph_8h_source.html#l00056">engine_graph.h:56</a></div></div>
<div class="ttc" id="anetwork_8h_html"><div class="ttname"><a href="network_8h.html">network.h</a></div></div>