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

10
docs/html/network__file_8cpp_source.html
View File

@@ -181,13 +181,13 @@ $(function(){initNavTree('network__file_8cpp_source.html',''); initResizable(tru
</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span>}</div>
<div class="ttc" id="aclassgridfire_1_1io_1_1_simple_reaction_list_file_parser_html_a4df01e3a93e1291d2cde0458545325f8"><div class="ttname"><a href="classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html#a4df01e3a93e1291d2cde0458545325f8">gridfire::io::SimpleReactionListFileParser::parse</a></div><div class="ttdeci">ParsedNetworkData parse(const std::string &amp;filename) const override</div><div class="ttdef"><b>Definition</b> <a href="#l00044">network_file.cpp:44</a></div></div>
<div class="ttc" id="aclassgridfire_1_1io_1_1_simple_reaction_list_file_parser_html_acef7eafe3cbea159259f69c88d309b66"><div class="ttname"><a href="classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html#acef7eafe3cbea159259f69c88d309b66">gridfire::io::SimpleReactionListFileParser::m_logger</a></div><div class="ttdeci">quill::Logger * m_logger</div><div class="ttdef"><b>Definition</b> <a href="network__file_8h_source.html#l00033">network_file.h:33</a></div></div>
<div class="ttc" id="aclassgridfire_1_1io_1_1_simple_reaction_list_file_parser_html_afc8ed91e8c98205c505e3d9f0cff1993"><div class="ttname"><a href="classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html#afc8ed91e8c98205c505e3d9f0cff1993">gridfire::io::SimpleReactionListFileParser::SimpleReactionListFileParser</a></div><div class="ttdeci">SimpleReactionListFileParser()</div><div class="ttdef"><b>Definition</b> <a href="#l00042">network_file.cpp:42</a></div></div>
<div class="ttc" id="aclassgridfire_1_1io_1_1_simple_reaction_list_file_parser_html_a4df01e3a93e1291d2cde0458545325f8"><div class="ttname"><a href="classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html#a4df01e3a93e1291d2cde0458545325f8">gridfire::io::SimpleReactionListFileParser::parse</a></div><div class="ttdeci">ParsedNetworkData parse(const std::string &amp;filename) const override</div><div class="ttdoc">Parses a simple reaction list file.</div><div class="ttdef"><b>Definition</b> <a href="#l00044">network_file.cpp:44</a></div></div>
<div class="ttc" id="aclassgridfire_1_1io_1_1_simple_reaction_list_file_parser_html_acef7eafe3cbea159259f69c88d309b66"><div class="ttname"><a href="classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html#acef7eafe3cbea159259f69c88d309b66">gridfire::io::SimpleReactionListFileParser::m_logger</a></div><div class="ttdeci">quill::Logger * m_logger</div><div class="ttdef"><b>Definition</b> <a href="network__file_8h_source.html#l00123">network_file.h:123</a></div></div>
<div class="ttc" id="aclassgridfire_1_1io_1_1_simple_reaction_list_file_parser_html_afc8ed91e8c98205c505e3d9f0cff1993"><div class="ttname"><a href="classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html#afc8ed91e8c98205c505e3d9f0cff1993">gridfire::io::SimpleReactionListFileParser::SimpleReactionListFileParser</a></div><div class="ttdeci">SimpleReactionListFileParser()</div><div class="ttdoc">Constructs a SimpleReactionListFileParser.</div><div class="ttdef"><b>Definition</b> <a href="#l00042">network_file.cpp:42</a></div></div>
<div class="ttc" id="anamespacegridfire_1_1io_html"><div class="ttname"><a href="namespacegridfire_1_1io.html">gridfire::io</a></div><div class="ttdef"><b>Definition</b> <a href="network__file_8h_source.html#l00011">network_file.h:11</a></div></div>
<div class="ttc" id="anetwork__file_8h_html"><div class="ttname"><a href="network__file_8h.html">network_file.h</a></div></div>
<div class="ttc" id="astructgridfire_1_1io_1_1_parsed_network_data_html"><div class="ttname"><a href="structgridfire_1_1io_1_1_parsed_network_data.html">gridfire::io::ParsedNetworkData</a></div><div class="ttdef"><b>Definition</b> <a href="network__file_8h_source.html#l00013">network_file.h:13</a></div></div>
<div class="ttc" id="astructgridfire_1_1io_1_1_parsed_network_data_html_a5145c672877638e6113abf1f719b246d"><div class="ttname"><a href="structgridfire_1_1io_1_1_parsed_network_data.html#a5145c672877638e6113abf1f719b246d">gridfire::io::ParsedNetworkData::reactionPENames</a></div><div class="ttdeci">std::vector&lt; std::string &gt; reactionPENames</div><div class="ttdef"><b>Definition</b> <a href="network__file_8h_source.html#l00014">network_file.h:14</a></div></div>
<div class="ttc" id="astructgridfire_1_1io_1_1_parsed_network_data_html"><div class="ttname"><a href="structgridfire_1_1io_1_1_parsed_network_data.html">gridfire::io::ParsedNetworkData</a></div><div class="ttdoc">Holds the data parsed from a network file.</div><div class="ttdef"><b>Definition</b> <a href="network__file_8h_source.html#l00020">network_file.h:20</a></div></div>
<div class="ttc" id="astructgridfire_1_1io_1_1_parsed_network_data_html_a5145c672877638e6113abf1f719b246d"><div class="ttname"><a href="structgridfire_1_1io_1_1_parsed_network_data.html#a5145c672877638e6113abf1f719b246d">gridfire::io::ParsedNetworkData::reactionPENames</a></div><div class="ttdeci">std::vector&lt; std::string &gt; reactionPENames</div><div class="ttdoc">A vector of reaction names in their PEN-style format.</div><div class="ttdef"><b>Definition</b> <a href="network__file_8h_source.html#l00027">network_file.h:27</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->