refactor(.gitignore): removed html/ from .gitignore
This commit is contained in:
@@ -103,6 +103,7 @@ $(function(){initNavTree('classgridfire_1_1reaction_1_1_reaction.html',''); init
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="#pro-attribs">Protected Attributes</a> |
|
||||
<a href="#pri-methods">Private Member Functions</a> |
|
||||
<a href="#friends">Friends</a> |
|
||||
<a href="classgridfire_1_1reaction_1_1_reaction-members.html">List of all members</a> </div>
|
||||
<div class="headertitle"><div class="title">gridfire::reaction::Reaction Class Reference</div></div>
|
||||
</div><!--header-->
|
||||
@@ -241,6 +242,11 @@ Private Member Functions</h2></td></tr>
|
||||
<tr class="memitem:a648b9ed6108bed2469dc028fb7e351af"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a648b9ed6108bed2469dc028fb7e351af">calculate_rate</a> (const T T9) const</td></tr>
|
||||
<tr class="memdesc:a648b9ed6108bed2469dc028fb7e351af"><td class="mdescLeft"> </td><td class="mdescRight">Template implementation for calculating the reaction rate. <br /></td></tr>
|
||||
<tr class="separator:a648b9ed6108bed2469dc028fb7e351af"><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:a2b05ab608187216fc751bd2e42e8b7d8" id="r_a2b05ab608187216fc751bd2e42e8b7d8"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2b05ab608187216fc751bd2e42e8b7d8">operator<<</a> (std::ostream &os, const <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html">Reaction</a> &r)</td></tr>
|
||||
<tr class="separator:a2b05ab608187216fc751bd2e42e8b7d8"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Represents a single nuclear reaction from a specific data source. </p>
|
||||
@@ -252,7 +258,7 @@ Private Member Functions</h2></td></tr>
|
||||
<div class="line"><span class="keywordtype">double</span> rate = p_gamma_d.calculate_rate(0.1); <span class="comment">// T9 = 0.1</span></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1reaction_1_1_reaction_html_a7dff19d387e771d96c26e98d75ee9d5c"><div class="ttname"><a href="#a7dff19d387e771d96c26e98d75ee9d5c">gridfire::reaction::Reaction::Reaction</a></div><div class="ttdeci">Reaction(const std::string_view id, const std::string_view peName, const int chapter, const std::vector< fourdst::atomic::Species > &reactants, const std::vector< fourdst::atomic::Species > &products, const double qValue, const std::string_view label, const RateCoefficientSet &sets, const bool reverse=false)</div><div class="ttdoc">Constructs a Reaction object.</div><div class="ttdef"><b>Definition</b> <a href="reaction_8cpp_source.html#l00019">reaction.cpp:19</a></div></div>
|
||||
</div><!-- fragment -->
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00071">71</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00072">72</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||||
<a id="ab1860df84843be70f97469761e11ab6a" name="ab1860df84843be70f97469761e11ab6a"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ab1860df84843be70f97469761e11ab6a">◆ </a></span>~Reaction()</h2>
|
||||
@@ -503,7 +509,7 @@ template<typename T> </div>
|
||||
<dl class="section return"><dt>Returns</dt><dd>The calculated reaction rate.</dd></dl>
|
||||
<p>The rate is calculated using the standard REACLIB formula: <code>rate = exp(a0 + a1/T9 + a2/T9^(1/3) + a3*T9^(1/3) + a4*T9 + a5*T9^(5/3) + a6*ln(T9))</code> </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00276">276</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00281">281</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -533,7 +539,7 @@ template<typename T> </div>
|
||||
<p>Gets the REACLIB chapter number. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>The chapter number. </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00125">125</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00126">126</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -738,7 +744,7 @@ template<typename T> </div>
|
||||
<p>Gets the unique identifier of the reaction. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>The reaction ID. </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00201">201</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00202">202</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -768,7 +774,7 @@ template<typename T> </div>
|
||||
<p>Checks if this is a reverse reaction rate. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>True if it is a reverse rate, false otherwise. </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00225">225</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00226">226</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -834,7 +840,7 @@ template<typename T> </div>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>True if the reactions are not equal. </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00245">245</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00246">246</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -870,7 +876,7 @@ template<typename T> </div>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>True if the reaction IDs are the same. </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00238">238</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00239">239</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -900,7 +906,7 @@ template<typename T> </div>
|
||||
<p>Gets the reaction name in (projectile, ejectile) notation. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>The reaction name (e.g., "p(p,g)d"). </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00119">119</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00120">120</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -960,7 +966,7 @@ template<typename T> </div>
|
||||
<p>Gets the vector of product species. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>A const reference to the vector of products. </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00219">219</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00220">220</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -990,7 +996,7 @@ template<typename T> </div>
|
||||
<p>Gets the Q-value of the reaction. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>The Q-value in whatever units the reaction was defined in (usually MeV). </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00207">207</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00208">208</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -1020,7 +1026,7 @@ template<typename T> </div>
|
||||
<p>Gets the set of rate coefficients. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>A const reference to the <a class="el" href="structgridfire_1_1reaction_1_1_rate_coefficient_set.html" title="Holds the seven coefficients for the REACLIB rate equation.">RateCoefficientSet</a>. </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00137">137</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00138">138</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -1080,7 +1086,7 @@ template<typename T> </div>
|
||||
<p>Gets the vector of reactant species. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>A const reference to the vector of reactants. </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00213">213</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00214">214</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -1110,7 +1116,7 @@ template<typename T> </div>
|
||||
<p>Gets the source label for the rate data. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>The source label (e.g., "wc12w", "st08"). </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00131">131</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00132">132</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -1176,6 +1182,38 @@ template<typename T> </div>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>The stoichiometric coefficient (negative for reactants, positive for products). </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
|
||||
<a id="a2b05ab608187216fc751bd2e42e8b7d8" name="a2b05ab608187216fc751bd2e42e8b7d8"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a2b05ab608187216fc751bd2e42e8b7d8">◆ </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"><span class="paramname"><em>os</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html">Reaction</a> &</td> <td class="paramname"><span class="paramname"><em>r</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel friend">friend</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00256">256</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Member Data Documentation</h2>
|
||||
@@ -1201,7 +1239,7 @@ template<typename T> </div>
|
||||
|
||||
<p>Chapter number from the REACLIB database, defining the reaction structure. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00259">259</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00264">264</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -1227,7 +1265,7 @@ template<typename T> </div>
|
||||
|
||||
<p>Unique identifier for the reaction (e.g., "h1+h1=>h2+e+nu"). </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00257">257</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00262">262</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -1251,7 +1289,7 @@ template<typename T> </div>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00256">256</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00261">261</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -1277,7 +1315,7 @@ template<typename T> </div>
|
||||
|
||||
<p>Name of the reaction in (projectile, ejectile) notation (e.g. "p(p,g)d"). </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00258">258</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00263">263</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -1303,7 +1341,7 @@ template<typename T> </div>
|
||||
|
||||
<p>Products of the reaction. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00262">262</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00267">267</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -1329,7 +1367,7 @@ template<typename T> </div>
|
||||
|
||||
<p>Q-value of the reaction in MeV. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00260">260</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00265">265</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -1355,7 +1393,7 @@ template<typename T> </div>
|
||||
|
||||
<p>The seven rate coefficients. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00264">264</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00269">269</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -1381,7 +1419,7 @@ template<typename T> </div>
|
||||
|
||||
<p>Reactants of the reaction. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00261">261</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00266">266</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -1407,7 +1445,7 @@ template<typename T> </div>
|
||||
|
||||
<p>Flag indicating if this is a reverse reaction rate. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00265">265</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00270">270</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -1433,7 +1471,7 @@ template<typename T> </div>
|
||||
|
||||
<p>Source label for the rate data (e.g., "wc12w", "st08"). </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00263">263</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="reaction_8h_source.html#l00268">268</a> of file <a class="el" href="reaction_8h_source.html">reaction.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user