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

315 lines
15 KiB
HTML
Raw Blame History

<!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::reaction::RateCoefficientSet 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">&#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('structgridfire_1_1reaction_1_1RateCoefficientSet.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> &#124;
<a href="#friends">Friends</a> &#124;
<a href="structgridfire_1_1reaction_1_1RateCoefficientSet-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">gridfire::reaction::RateCoefficientSet Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Holds the seven coefficients for the REACLIB rate equation.
<a href="structgridfire_1_1reaction_1_1RateCoefficientSet.html#details">More...</a></p>
<p><code>#include &lt;reaction.h&gt;</code></p>
<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:a2fa6b65e300dcd181222b743c2b3d6ed" id="r_a2fa6b65e300dcd181222b743c2b3d6ed"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1reaction_1_1RateCoefficientSet.html#a2fa6b65e300dcd181222b743c2b3d6ed">a0</a></td></tr>
<tr class="memdesc:a2fa6b65e300dcd181222b743c2b3d6ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Coefficient a0. <br /></td></tr>
<tr class="separator:a2fa6b65e300dcd181222b743c2b3d6ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace9dbd928e179784e47eaa108ce8d721" id="r_ace9dbd928e179784e47eaa108ce8d721"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1reaction_1_1RateCoefficientSet.html#ace9dbd928e179784e47eaa108ce8d721">a1</a></td></tr>
<tr class="memdesc:ace9dbd928e179784e47eaa108ce8d721"><td class="mdescLeft">&#160;</td><td class="mdescRight">Coefficient a1. <br /></td></tr>
<tr class="separator:ace9dbd928e179784e47eaa108ce8d721"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a9316d19bc2e8bf0a7872eb6fe8a53f" id="r_a2a9316d19bc2e8bf0a7872eb6fe8a53f"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1reaction_1_1RateCoefficientSet.html#a2a9316d19bc2e8bf0a7872eb6fe8a53f">a2</a></td></tr>
<tr class="memdesc:a2a9316d19bc2e8bf0a7872eb6fe8a53f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Coefficient a2. <br /></td></tr>
<tr class="separator:a2a9316d19bc2e8bf0a7872eb6fe8a53f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d047485ebb57d6c763adfe4aae493b1" id="r_a3d047485ebb57d6c763adfe4aae493b1"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1reaction_1_1RateCoefficientSet.html#a3d047485ebb57d6c763adfe4aae493b1">a3</a></td></tr>
<tr class="memdesc:a3d047485ebb57d6c763adfe4aae493b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Coefficient a3. <br /></td></tr>
<tr class="separator:a3d047485ebb57d6c763adfe4aae493b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae57b2eac71cb4ed9947f40c9cb8fc3ca" id="r_ae57b2eac71cb4ed9947f40c9cb8fc3ca"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1reaction_1_1RateCoefficientSet.html#ae57b2eac71cb4ed9947f40c9cb8fc3ca">a4</a></td></tr>
<tr class="memdesc:ae57b2eac71cb4ed9947f40c9cb8fc3ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Coefficient a4. <br /></td></tr>
<tr class="separator:ae57b2eac71cb4ed9947f40c9cb8fc3ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c79db4e649b4eb1d29c43ebe4e95458" id="r_a8c79db4e649b4eb1d29c43ebe4e95458"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1reaction_1_1RateCoefficientSet.html#a8c79db4e649b4eb1d29c43ebe4e95458">a5</a></td></tr>
<tr class="memdesc:a8c79db4e649b4eb1d29c43ebe4e95458"><td class="mdescLeft">&#160;</td><td class="mdescRight">Coefficient a5. <br /></td></tr>
<tr class="separator:a8c79db4e649b4eb1d29c43ebe4e95458"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf8e6ed7f91cb9e15d1469a808b1877a" id="r_adf8e6ed7f91cb9e15d1469a808b1877a"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1reaction_1_1RateCoefficientSet.html#adf8e6ed7f91cb9e15d1469a808b1877a">a6</a></td></tr>
<tr class="memdesc:adf8e6ed7f91cb9e15d1469a808b1877a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Coefficient a6. <br /></td></tr>
<tr class="separator:adf8e6ed7f91cb9e15d1469a808b1877a"><td class="memSeparator" colspan="2">&#160;</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:a31a92f95a27e4430209dfc2bdfa5c40f" id="r_a31a92f95a27e4430209dfc2bdfa5c40f"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1reaction_1_1RateCoefficientSet.html#a31a92f95a27e4430209dfc2bdfa5c40f">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="structgridfire_1_1reaction_1_1RateCoefficientSet.html">RateCoefficientSet</a> &amp;r)</td></tr>
<tr class="memdesc:a31a92f95a27e4430209dfc2bdfa5c40f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overloads the stream insertion operator for easy printing. <br /></td></tr>
<tr class="separator:a31a92f95a27e4430209dfc2bdfa5c40f"><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>Holds the seven coefficients for the REACLIB rate equation. </p>
<p>This struct stores the parameters (a0-a6) used to calculate reaction rates as a function of temperature. </p>
</div><h2 class="groupheader">Friends And Related Symbol Documentation</h2>
<a id="a31a92f95a27e4430209dfc2bdfa5c40f" name="a31a92f95a27e4430209dfc2bdfa5c40f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31a92f95a27e4430209dfc2bdfa5c40f">&#9670;&#160;</a></span>operator&lt;&lt;</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::ostream &amp; operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;&#160;</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_1reaction_1_1RateCoefficientSet.html">RateCoefficientSet</a> &amp;&#160;</td>
<td class="paramname"><em>r</em>&#160;</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>Overloads the stream insertion operator for easy printing. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">os</td><td>The output stream. </td></tr>
<tr><td class="paramname">r</td><td>The <a class="el" href="structgridfire_1_1reaction_1_1RateCoefficientSet.html" title="Holds the seven coefficients for the REACLIB rate equation.">RateCoefficientSet</a> to print. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The output stream. </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a2fa6b65e300dcd181222b743c2b3d6ed" name="a2fa6b65e300dcd181222b743c2b3d6ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2fa6b65e300dcd181222b743c2b3d6ed">&#9670;&#160;</a></span>a0</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double gridfire::reaction::RateCoefficientSet::a0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Coefficient a0. </p>
</div>
</div>
<a id="ace9dbd928e179784e47eaa108ce8d721" name="ace9dbd928e179784e47eaa108ce8d721"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace9dbd928e179784e47eaa108ce8d721">&#9670;&#160;</a></span>a1</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double gridfire::reaction::RateCoefficientSet::a1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Coefficient a1. </p>
</div>
</div>
<a id="a2a9316d19bc2e8bf0a7872eb6fe8a53f" name="a2a9316d19bc2e8bf0a7872eb6fe8a53f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a9316d19bc2e8bf0a7872eb6fe8a53f">&#9670;&#160;</a></span>a2</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double gridfire::reaction::RateCoefficientSet::a2</td>
</tr>
</table>
</div><div class="memdoc">
<p>Coefficient a2. </p>
</div>
</div>
<a id="a3d047485ebb57d6c763adfe4aae493b1" name="a3d047485ebb57d6c763adfe4aae493b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d047485ebb57d6c763adfe4aae493b1">&#9670;&#160;</a></span>a3</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double gridfire::reaction::RateCoefficientSet::a3</td>
</tr>
</table>
</div><div class="memdoc">
<p>Coefficient a3. </p>
</div>
</div>
<a id="ae57b2eac71cb4ed9947f40c9cb8fc3ca" name="ae57b2eac71cb4ed9947f40c9cb8fc3ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae57b2eac71cb4ed9947f40c9cb8fc3ca">&#9670;&#160;</a></span>a4</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double gridfire::reaction::RateCoefficientSet::a4</td>
</tr>
</table>
</div><div class="memdoc">
<p>Coefficient a4. </p>
</div>
</div>
<a id="a8c79db4e649b4eb1d29c43ebe4e95458" name="a8c79db4e649b4eb1d29c43ebe4e95458"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c79db4e649b4eb1d29c43ebe4e95458">&#9670;&#160;</a></span>a5</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double gridfire::reaction::RateCoefficientSet::a5</td>
</tr>
</table>
</div><div class="memdoc">
<p>Coefficient a5. </p>
</div>
</div>
<a id="adf8e6ed7f91cb9e15d1469a808b1877a" name="adf8e6ed7f91cb9e15d1469a808b1877a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf8e6ed7f91cb9e15d1469a808b1877a">&#9670;&#160;</a></span>a6</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double gridfire::reaction::RateCoefficientSet::a6</td>
</tr>
</table>
</div><div class="memdoc">
<p>Coefficient a6. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/include/gridfire/reaction/<a class="el" href="reaction_8h.html">reaction.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_1reaction.html">reaction</a></li><li class="navelem"><a class="el" href="structgridfire_1_1reaction_1_1RateCoefficientSet.html">RateCoefficientSet</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 View Git Blame Copy Permalink