241 lines
12 KiB
HTML
241 lines
12 KiB
HTML
|
<!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::engine::PrimingReport Struct 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"> 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&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&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&dn=expat.txt MIT */
|
||
|
|
$(document).ready(function(){initNavTree('structgridfire_1_1engine_1_1PrimingReport.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-attribs">Public Attributes</a> |
|
||
|
|
<a href="#friends">Friends</a> |
|
||
|
|
<a href="structgridfire_1_1engine_1_1PrimingReport-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle"><div class="title">gridfire::engine::PrimingReport Struct Reference</div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>Captures the result of a network priming operation.
|
||
|
|
<a href="structgridfire_1_1engine_1_1PrimingReport.html#details">More...</a></p>
|
||
|
|
|
||
|
|
<p><code>#include <reporting.h></code></p>
|
||
|
|
<div class="dynheader">
|
||
|
|
Collaboration diagram for gridfire::engine::PrimingReport:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center"><iframe scrolling="no" frameborder="0" src="structgridfire_1_1engine_1_1PrimingReport__coll__graph.svg" width="234" 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>
|
||
|
|
<table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
||
|
|
Public Attributes</h2></td></tr>
|
||
|
|
<tr class="memitem:a73acbf3cbec59f5516e4c7aa3f6ca150" id="r_a73acbf3cbec59f5516e4c7aa3f6ca150"><td class="memItemLeft" align="right" valign="top">fourdst::composition::Composition </td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1engine_1_1PrimingReport.html#a73acbf3cbec59f5516e4c7aa3f6ca150">primedComposition</a></td></tr>
|
||
|
|
<tr class="separator:a73acbf3cbec59f5516e4c7aa3f6ca150"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a68aa5f346f5d9d598bf921e175c49239" id="r_a68aa5f346f5d9d598bf921e175c49239"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1engine_1_1PrimingReport.html#a68aa5f346f5d9d598bf921e175c49239">success</a></td></tr>
|
||
|
|
<tr class="separator:a68aa5f346f5d9d598bf921e175c49239"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ac3e0c141e56c7bc41dd89d5fc873fa41" id="r_ac3e0c141e56c7bc41dd89d5fc873fa41"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegridfire_1_1engine.html#ada706e6a92b733f6be85aa4425b135c1">PrimingReportStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1engine_1_1PrimingReport.html#ac3e0c141e56c7bc41dd89d5fc873fa41">status</a></td></tr>
|
||
|
|
<tr class="separator:ac3e0c141e56c7bc41dd89d5fc873fa41"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
|
||
|
|
Friends</h2></td></tr>
|
||
|
|
<tr class="memitem:ac6c3112c984203fd5a672006be421736" id="r_ac6c3112c984203fd5a672006be421736"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1engine_1_1PrimingReport.html#ac6c3112c984203fd5a672006be421736">operator<<</a> (std::ostream &os, const <a class="el" href="structgridfire_1_1engine_1_1PrimingReport.html">PrimingReport</a> &report)</td></tr>
|
||
|
|
<tr class="memdesc:ac6c3112c984203fd5a672006be421736"><td class="mdescLeft"> </td><td class="mdescRight">Serialize the report to a stream. <br /></td></tr>
|
||
|
|
<tr class="separator:ac6c3112c984203fd5a672006be421736"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p>Captures the result of a network priming operation. </p>
|
||
|
|
<p>Contains the finalized composition, the changes in mass fractions for species, a success flag, and a detailed status code.</p>
|
||
|
|
<dl class="section pre"><dt>Precondition</dt><dd>A priming algorithm must be executed before constructing a valid report. </dd></dl>
|
||
|
|
<dl class="section post"><dt>Postcondition</dt><dd>All fields reflect the outcome of the priming run. </dd></dl>
|
||
|
|
</div><h2 class="groupheader">Friends And Related Symbol Documentation</h2>
|
||
|
|
<a id="ac6c3112c984203fd5a672006be421736" name="ac6c3112c984203fd5a672006be421736"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac6c3112c984203fd5a672006be421736">◆ </a></span>operator<<</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">std::ostream & operator<< </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">std::ostream & </td>
|
||
|
|
<td class="paramname"><em>os</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">const <a class="el" href="structgridfire_1_1engine_1_1PrimingReport.html">PrimingReport</a> & </td>
|
||
|
|
<td class="paramname"><em>report</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Serialize the report to a stream. </p>
|
||
|
|
<p>Formats the success flag and status string into the output stream. </p><dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">os</td><td>Output stream to write to. </td></tr>
|
||
|
|
<tr><td class="paramname">report</td><td>Report to serialize. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>Reference to the modified output stream. </dd></dl>
|
||
|
|
<dl class="section post"><dt>Postcondition</dt><dd>The stream contains a textual representation of the report. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
||
|
|
<a id="a73acbf3cbec59f5516e4c7aa3f6ca150" name="a73acbf3cbec59f5516e4c7aa3f6ca150"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a73acbf3cbec59f5516e4c7aa3f6ca150">◆ </a></span>primedComposition</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">fourdst::composition::Composition gridfire::engine::PrimingReport::primedComposition</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>Finalized composition after priming. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ac3e0c141e56c7bc41dd89d5fc873fa41" name="ac3e0c141e56c7bc41dd89d5fc873fa41"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac3e0c141e56c7bc41dd89d5fc873fa41">◆ </a></span>status</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="namespacegridfire_1_1engine.html#ada706e6a92b733f6be85aa4425b135c1">PrimingReportStatus</a> gridfire::engine::PrimingReport::status</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>Detailed status code indicating the result. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a68aa5f346f5d9d598bf921e175c49239" name="a68aa5f346f5d9d598bf921e175c49239"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a68aa5f346f5d9d598bf921e175c49239">◆ </a></span>success</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool gridfire::engine::PrimingReport::success</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>True if priming completed without error. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
||
|
|
<li>src/include/gridfire/engine/types/<a class="el" href="reporting_8h.html">reporting.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_1engine.html">engine</a></li><li class="navelem"><a class="el" href="structgridfire_1_1engine_1_1PrimingReport.html">PrimingReport</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>
|