tboudreaux/GridFire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
a0dcfe43326464b2dadae0f3935be2769d421001
GridFire/docs/html/classgridfire_1_1io_1_1MESANetworkFileParser.html

358 lines
19 KiB
HTML
Raw Normal View History

docs(docs): rebuilt for version v0.7.1_rc2
2025-11-28 09:46:00 -05:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GridFire: gridfire::io::MESANetworkFileParser Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">GridFire<span id="projectnumber">&#160;v0.7.1_rc2</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classgridfire_1_1io_1_1MESANetworkFileParser.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-types">Private Types</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classgridfire_1_1io_1_1MESANetworkFileParser-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">gridfire::io::MESANetworkFileParser Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>A parser for MESA-format network files.
<a href="classgridfire_1_1io_1_1MESANetworkFileParser.html#details">More...</a></p>
<p><code>#include &lt;network_file.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for gridfire::io::MESANetworkFileParser:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1io_1_1MESANetworkFileParser__inherit__graph.svg" width="200" height="139"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for gridfire::io::MESANetworkFileParser:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1io_1_1MESANetworkFileParser__coll__graph.svg" width="323" height="243"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac5963d0da6780de753df996b490f8d2c" id="r_ac5963d0da6780de753df996b490f8d2c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1io_1_1MESANetworkFileParser.html#ac5963d0da6780de753df996b490f8d2c">MESANetworkFileParser</a> (const std::string &amp;filename)</td></tr>
<tr class="memdesc:ac5963d0da6780de753df996b490f8d2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a <a class="el" href="classgridfire_1_1io_1_1MESANetworkFileParser.html" title="A parser for MESA-format network files.">MESANetworkFileParser</a>. <br /></td></tr>
<tr class="separator:ac5963d0da6780de753df996b490f8d2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a568194277733b5c537901f8af32ee329" id="r_a568194277733b5c537901f8af32ee329"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegridfire_1_1io.html#abcbdcbd13cfa8c9fbe1b48e8ee2cc352">ParsedNetworkData</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1io_1_1MESANetworkFileParser.html#a568194277733b5c537901f8af32ee329">parse</a> (const std::string &amp;filename) const override</td></tr>
<tr class="memdesc:a568194277733b5c537901f8af32ee329"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses a MESA-format network file. <br /></td></tr>
<tr class="separator:a568194277733b5c537901f8af32ee329"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgridfire_1_1io_1_1NetworkFileParser"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgridfire_1_1io_1_1NetworkFileParser')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgridfire_1_1io_1_1NetworkFileParser.html">gridfire::io::NetworkFileParser</a></td></tr>
<tr class="memitem:a9b4095d06fad5df3805c92ae97b3eab3 inherit pub_methods_classgridfire_1_1io_1_1NetworkFileParser" id="r_a9b4095d06fad5df3805c92ae97b3eab3"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1io_1_1NetworkFileParser.html#a9b4095d06fad5df3805c92ae97b3eab3">~NetworkFileParser</a> ()=default</td></tr>
<tr class="memdesc:a9b4095d06fad5df3805c92ae97b3eab3 inherit pub_methods_classgridfire_1_1io_1_1NetworkFileParser"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor for the base class. <br /></td></tr>
<tr class="separator:a9b4095d06fad5df3805c92ae97b3eab3 inherit pub_methods_classgridfire_1_1io_1_1NetworkFileParser"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-types" name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:af43ad8375abf1cedfdccc296b9958c2b" id="r_af43ad8375abf1cedfdccc296b9958c2b"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1io_1_1MESANetworkFileParser.html#af43ad8375abf1cedfdccc296b9958c2b">Config</a> = fourdst::config::Config</td></tr>
<tr class="separator:af43ad8375abf1cedfdccc296b9958c2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84aa6894a331ad57bdab1e1ab85d4055" id="r_a84aa6894a331ad57bdab1e1ab85d4055"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1io_1_1MESANetworkFileParser.html#a84aa6894a331ad57bdab1e1ab85d4055">LogManager</a> = fourdst::logging::LogManager</td></tr>
<tr class="separator:a84aa6894a331ad57bdab1e1ab85d4055"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:aea206c3a7600db8d657666fef88fa20d" id="r_aea206c3a7600db8d657666fef88fa20d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgridfire_1_1io_1_1MESANetworkFileParser.html#af43ad8375abf1cedfdccc296b9958c2b">Config</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1io_1_1MESANetworkFileParser.html#aea206c3a7600db8d657666fef88fa20d">m_config</a> = Config::getInstance()</td></tr>
<tr class="separator:aea206c3a7600db8d657666fef88fa20d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9c683289d48e58edf06bf59215b4937" id="r_ab9c683289d48e58edf06bf59215b4937"><td class="memItemLeft" align="right" valign="top">quill::Logger *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1io_1_1MESANetworkFileParser.html#ab9c683289d48e58edf06bf59215b4937">m_logger</a> = LogManager::getInstance().getLogger(&quot;log&quot;)</td></tr>
<tr class="separator:ab9c683289d48e58edf06bf59215b4937"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7f82597abf17f16c401bcdf528bd099" id="r_ab7f82597abf17f16c401bcdf528bd099"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1io_1_1MESANetworkFileParser.html#ab7f82597abf17f16c401bcdf528bd099">m_filename</a></td></tr>
<tr class="separator:ab7f82597abf17f16c401bcdf528bd099"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A parser for MESA-format network files. </p>
<p>This class is designed to parse reaction network files that follow the format used by the MESA stellar evolution code. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="af43ad8375abf1cedfdccc296b9958c2b" name="af43ad8375abf1cedfdccc296b9958c2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af43ad8375abf1cedfdccc296b9958c2b">&#9670;&#160;</a></span>Config</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classgridfire_1_1io_1_1MESANetworkFileParser.html#af43ad8375abf1cedfdccc296b9958c2b">gridfire::io::MESANetworkFileParser::Config</a> = fourdst::config::Config</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a84aa6894a331ad57bdab1e1ab85d4055" name="a84aa6894a331ad57bdab1e1ab85d4055"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84aa6894a331ad57bdab1e1ab85d4055">&#9670;&#160;</a></span>LogManager</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classgridfire_1_1io_1_1MESANetworkFileParser.html#a84aa6894a331ad57bdab1e1ab85d4055">gridfire::io::MESANetworkFileParser::LogManager</a> = fourdst::logging::LogManager</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ac5963d0da6780de753df996b490f8d2c" name="ac5963d0da6780de753df996b490f8d2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5963d0da6780de753df996b490f8d2c">&#9670;&#160;</a></span>MESANetworkFileParser()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">gridfire::io::MESANetworkFileParser::MESANetworkFileParser </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a <a class="el" href="classgridfire_1_1io_1_1MESANetworkFileParser.html" title="A parser for MESA-format network files.">MESANetworkFileParser</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>The path to the MESA network file. This may be used to pre-configure the parser.</td></tr>
</table>
</dd>
</dl>
<dl class="section post"><dt>Postcondition</dt><dd>The parser is initialized with the context of the given file. </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a568194277733b5c537901f8af32ee329" name="a568194277733b5c537901f8af32ee329"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a568194277733b5c537901f8af32ee329">&#9670;&#160;</a></span>parse()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacegridfire_1_1io.html#abcbdcbd13cfa8c9fbe1b48e8ee2cc352">ParsedNetworkData</a> gridfire::io::MESANetworkFileParser::parse </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Parses a MESA-format network file. </p>
<p>This method will read and interpret the structure of a MESA network file to extract the list of reactions.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>The path to the MESA network file. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <code>ParsedNetworkData</code> struct containing the list of reaction names.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::runtime_error</td><td>If the file cannot be opened or if it contains formatting errors. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classgridfire_1_1io_1_1NetworkFileParser.html#a66e8e724c903d6ef4dd1c8103276bdbf">gridfire::io::NetworkFileParser</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aea206c3a7600db8d657666fef88fa20d" name="aea206c3a7600db8d657666fef88fa20d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea206c3a7600db8d657666fef88fa20d">&#9670;&#160;</a></span>m_config</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgridfire_1_1io_1_1MESANetworkFileParser.html#af43ad8375abf1cedfdccc296b9958c2b">Config</a>&amp; gridfire::io::MESANetworkFileParser::m_config = Config::getInstance()</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ab7f82597abf17f16c401bcdf528bd099" name="ab7f82597abf17f16c401bcdf528bd099"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7f82597abf17f16c401bcdf528bd099">&#9670;&#160;</a></span>m_filename</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string gridfire::io::MESANetworkFileParser::m_filename</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ab9c683289d48e58edf06bf59215b4937" name="ab9c683289d48e58edf06bf59215b4937"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9c683289d48e58edf06bf59215b4937">&#9670;&#160;</a></span>m_logger</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">quill::Logger* gridfire::io::MESANetworkFileParser::m_logger = LogManager::getInstance().getLogger(&quot;log&quot;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/include/gridfire/io/<a class="el" href="network__file_8h.html">network_file.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacegridfire.html">gridfire</a></li><li class="navelem"><a class="el" href="namespacegridfire_1_1io.html">io</a></li><li class="navelem"><a class="el" href="classgridfire_1_1io_1_1MESANetworkFileParser.html">MESANetworkFileParser</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue Copy Permalink