tboudreaux/GridFire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(docs): rebuilt docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-11-24 09:08:28 -05:00
parent 9fab4fbfae
commit 22c0329de0
2410 changed files with 309008 additions and 146081 deletions
Download Patch File Download Diff File Expand all files Collapse all files

474
docs/html/namespacegridfire_1_1utils.html
View File

@@ -102,7 +102,10 @@ $(function(){initNavTree('namespacegridfire_1_1utils.html',''); initResizable(tr
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> </div>
<a href="#concepts">Concepts</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">gridfire::utils Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
@@ -118,30 +121,129 @@ Classes</h2></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1utils_1_1_column_base.html">ColumnBase</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1utils_1_1_table.html">Table</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1utils_1_1_table_base.html">TableBase</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="concepts" name="concepts"></a>
Concepts</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">concept &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="conceptgridfire_1_1utils_1_1_streamable.html">Streamable</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a7cea622c9311bfd0f0b9d7b6298ea04e" id="r_a7cea622c9311bfd0f0b9d7b6298ea04e"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7cea622c9311bfd0f0b9d7b6298ea04e">SUNDIALS_RET_CODE_TYPES</a> { <a class="el" href="#a7cea622c9311bfd0f0b9d7b6298ea04eadd3b4add4b240136cb05dccdd9f74239">CVODE</a>
, <a class="el" href="#a7cea622c9311bfd0f0b9d7b6298ea04ea78689531838e490ef6bb41a3b5c43b7d">KINSOL</a>
}</td></tr>
<tr class="separator:a7cea622c9311bfd0f0b9d7b6298ea04e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a30bc2aa491806a4ac2a9039e267db282" id="r_a30bc2aa491806a4ac2a9039e267db282"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a30bc2aa491806a4ac2a9039e267db282">massFractionFromMolarAbundanceAndComposition</a> (const fourdst::composition::Composition &amp;composition, const fourdst::atomic::Species &amp;species, const double Yi)</td></tr>
<tr class="separator:a30bc2aa491806a4ac2a9039e267db282"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e0dbd737724f2ead65046b07639c931" id="r_a3e0dbd737724f2ead65046b07639c931"><td class="memItemLeft" align="right" valign="top">std::vector&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3e0dbd737724f2ead65046b07639c931">massFractionFromMolarAbundanceAndMolarMass</a> (const std::vector&lt; double &gt; &amp;molarAbundances, const std::vector&lt; double &gt; &amp;molarMasses) noexcept</td></tr>
<tr class="memdesc:a3e0dbd737724f2ead65046b07639c931"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a vector of molar abundances into a vector of mass fractions. <br /></td></tr>
<tr class="separator:a3e0dbd737724f2ead65046b07639c931"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1772aeeec2509ca45bc733b7615a7778" id="r_a1772aeeec2509ca45bc733b7615a7778"><td class="memItemLeft" align="right" valign="top">std::vector&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1772aeeec2509ca45bc733b7615a7778">molarMassVectorFromComposition</a> (const fourdst::composition::Composition &amp;composition)</td></tr>
<tr class="separator:a1772aeeec2509ca45bc733b7615a7778"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0dc0b71ddae108a47887458c2f3f780e" id="r_a0dc0b71ddae108a47887458c2f3f780e"><td class="memItemLeft" align="right" valign="top">uint_fast32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0dc0b71ddae108a47887458c2f3f780e">hash_atomic</a> (const uint16_t a, const uint8_t z) noexcept</td></tr>
<tr class="memdesc:a0dc0b71ddae108a47887458c2f3f780e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a unique hash for an isotope given its mass number (A) and atomic number (Z). <br /></td></tr>
<tr class="separator:a0dc0b71ddae108a47887458c2f3f780e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a011ac3184b4fcf21322868b1aaa4d2d1" id="r_a011ac3184b4fcf21322868b1aaa4d2d1"><td class="memItemLeft" align="right" valign="top">std::uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a011ac3184b4fcf21322868b1aaa4d2d1">hash_reaction</a> (const <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html">reaction::Reaction</a> &amp;reaction) noexcept</td></tr>
<tr class="separator:a011ac3184b4fcf21322868b1aaa4d2d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05fda32d3fc4ab10060b8c4c251c2f3d" id="r_a05fda32d3fc4ab10060b8c4c251c2f3d"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a05fda32d3fc4ab10060b8c4c251c2f3d">formatNuclearTimescaleLogString</a> (const <a class="el" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a> &amp;engine, const fourdst::composition::Composition &amp;composition, double T9, double rho)</td></tr>
<tr class="memdesc:a05fda32d3fc4ab10060b8c4c251c2f3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formats a map of nuclear species timescales into a human-readable string. <br /></td></tr>
<tr class="separator:a05fda32d3fc4ab10060b8c4c251c2f3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7145934af6bf925dc7c2d2d589f2f85" id="r_af7145934af6bf925dc7c2d2d589f2f85"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:af7145934af6bf925dc7c2d2d589f2f85"><td class="memTemplItemLeft" align="right" valign="top">std::size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#af7145934af6bf925dc7c2d2d589f2f85">hash_combine</a> (std::size_t seed, const T &amp;v)</td></tr>
<tr class="separator:af7145934af6bf925dc7c2d2d589f2f85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d0646bcc1a6fd8df22ac0c758bfd5c4" id="r_a3d0646bcc1a6fd8df22ac0c758bfd5c4"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3d0646bcc1a6fd8df22ac0c758bfd5c4">formatNuclearTimescaleLogString</a> (const <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html">engine::DynamicEngine</a> &amp;engine, const fourdst::composition::Composition &amp;composition, double T9, double rho)</td></tr>
<tr class="memdesc:a3d0646bcc1a6fd8df22ac0c758bfd5c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formats a map of nuclear species timescales into a human-readable string. <br /></td></tr>
<tr class="separator:a3d0646bcc1a6fd8df22ac0c758bfd5c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a334828d5d2b5e67560638ea9b3c031a1" id="r_a334828d5d2b5e67560638ea9b3c031a1"><td class="memTemplParams" colspan="2">template&lt;std::ranges::input_range Container, typename Elem = std::ranges::range_reference_t&lt;Container&gt;, typename Transform = std::identity, typename Pred = bool(*)(const std::ranges::range_value_t&lt;Container&gt;&amp;)&gt; <br />
requires std::invocable&lt;Transform, Elem&gt; &amp;&amp; Streamable&lt;std::invoke_result_t&lt;Transform, Elem&gt;&gt; &amp;&amp; std::predicate&lt;Pred, Elem&gt;</td></tr>
<tr class="memitem:a334828d5d2b5e67560638ea9b3c031a1"><td class="memTemplItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a334828d5d2b5e67560638ea9b3c031a1">iterable_to_delimited_string</a> (const Container &amp;container, const std::string_view delimiter=&quot;, &quot;, Transform transform={}, Pred pred=[](const auto &amp;){ return true;}) noexcept</td></tr>
<tr class="separator:a334828d5d2b5e67560638ea9b3c031a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad72bcf145a772cf83cec4fb3841e8dd4" id="r_ad72bcf145a772cf83cec4fb3841e8dd4"><td class="memItemLeft" align="right" valign="top">const std::unordered_map&lt; int, std::string &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad72bcf145a772cf83cec4fb3841e8dd4">sundials_retcode_map</a> (const <a class="el" href="#a7cea622c9311bfd0f0b9d7b6298ea04e">SUNDIALS_RET_CODE_TYPES</a> type)</td></tr>
<tr class="separator:ad72bcf145a772cf83cec4fb3841e8dd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9d0cfc158090ca9ed09646d407b04f2" id="r_ab9d0cfc158090ca9ed09646d407b04f2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab9d0cfc158090ca9ed09646d407b04f2">check_cvode_flag</a> (const int flag, const std::string &amp;func_name)</td></tr>
<tr class="separator:ab9d0cfc158090ca9ed09646d407b04f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfbe36ddda15b6e206d9726236d543ab" id="r_adfbe36ddda15b6e206d9726236d543ab"><td class="memItemLeft" align="right" valign="top">N_Vector&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adfbe36ddda15b6e206d9726236d543ab">init_sun_vector</a> (uint64_t size, SUNContext sun_ctx)</td></tr>
<tr class="separator:adfbe36ddda15b6e206d9726236d543ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9afa50593a895415d9314ad853806f3" id="r_ab9afa50593a895415d9314ad853806f3"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab9afa50593a895415d9314ad853806f3">visual_width</a> (const std::string &amp;s)</td></tr>
<tr class="separator:ab9afa50593a895415d9314ad853806f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6451ba6762273b91a8281043cfaa5d2a" id="r_a6451ba6762273b91a8281043cfaa5d2a"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6451ba6762273b91a8281043cfaa5d2a">format_table</a> (const std::string &amp;tableName, const std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgridfire_1_1utils_1_1_column_base.html">ColumnBase</a> &gt; &gt; &amp;columns)</td></tr>
<tr class="separator:a6451ba6762273b91a8281043cfaa5d2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2eed085058abdb9d7fbbdb9647b98323" id="r_a2eed085058abdb9d7fbbdb9647b98323"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2eed085058abdb9d7fbbdb9647b98323">format_table</a> (const <a class="el" href="classgridfire_1_1utils_1_1_table_base.html">TableBase</a> &amp;table)</td></tr>
<tr class="separator:a2eed085058abdb9d7fbbdb9647b98323"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbaa76c5f4021940995e274a86c2171a" id="r_acbaa76c5f4021940995e274a86c2171a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acbaa76c5f4021940995e274a86c2171a">print_table</a> (const std::string &amp;tableName, const std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgridfire_1_1utils_1_1_column_base.html">ColumnBase</a> &gt; &gt; &amp;columns)</td></tr>
<tr class="separator:acbaa76c5f4021940995e274a86c2171a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd3ba7a23f2affd403d5da4e813874d1" id="r_afd3ba7a23f2affd403d5da4e813874d1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afd3ba7a23f2affd403d5da4e813874d1">print_table</a> (const <a class="el" href="classgridfire_1_1utils_1_1_table_base.html">TableBase</a> &amp;table)</td></tr>
<tr class="separator:afd3ba7a23f2affd403d5da4e813874d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c58048a3127e6b87886971385a7fe06" id="r_a6c58048a3127e6b87886971385a7fe06"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6c58048a3127e6b87886971385a7fe06">to_csv</a> (const std::string &amp;filename, const std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgridfire_1_1utils_1_1_column_base.html">ColumnBase</a> &gt; &gt; &amp;columns)</td></tr>
<tr class="separator:a6c58048a3127e6b87886971385a7fe06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9f382b1b40867c1e70f062d7fba90cd" id="r_af9f382b1b40867c1e70f062d7fba90cd"><td class="memItemLeft" align="right" valign="top">nlohmann::json&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af9f382b1b40867c1e70f062d7fba90cd">to_json</a> (const std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgridfire_1_1utils_1_1_column_base.html">ColumnBase</a> &gt; &gt; &amp;columns)</td></tr>
<tr class="separator:af9f382b1b40867c1e70f062d7fba90cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf613180bab406ef2bfbb9b79397148e" id="r_adf613180bab406ef2bfbb9b79397148e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adf613180bab406ef2bfbb9b79397148e">to_json_file</a> (const std::string &amp;filename, const std::vector&lt; std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgridfire_1_1utils_1_1_column_base.html">ColumnBase</a> &gt; &gt; &gt; &amp;tables, const std::vector&lt; std::string &gt; &amp;tableNames)</td></tr>
<tr class="separator:adf613180bab406ef2bfbb9b79397148e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a06d386929b2274e2593b97868be2ac51" id="r_a06d386929b2274e2593b97868be2ac51"><td class="memItemLeft" align="right" valign="top">static std::unordered_map&lt; int, std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a06d386929b2274e2593b97868be2ac51">cvode_ret_code_map</a></td></tr>
<tr class="separator:a06d386929b2274e2593b97868be2ac51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96fc2701cfd6cb8172282e9999fe4b34" id="r_a96fc2701cfd6cb8172282e9999fe4b34"><td class="memItemLeft" align="right" valign="top">static std::unordered_map&lt; int, std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a96fc2701cfd6cb8172282e9999fe4b34">kinsol_ret_code_map</a></td></tr>
<tr class="separator:a96fc2701cfd6cb8172282e9999fe4b34"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a7cea622c9311bfd0f0b9d7b6298ea04e" name="a7cea622c9311bfd0f0b9d7b6298ea04e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7cea622c9311bfd0f0b9d7b6298ea04e">&#9670;&#160;</a></span>SUNDIALS_RET_CODE_TYPES</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum class <a class="el" href="#a7cea622c9311bfd0f0b9d7b6298ea04e">gridfire::utils::SUNDIALS_RET_CODE_TYPES</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel strong">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a7cea622c9311bfd0f0b9d7b6298ea04eadd3b4add4b240136cb05dccdd9f74239" name="a7cea622c9311bfd0f0b9d7b6298ea04eadd3b4add4b240136cb05dccdd9f74239"></a>CVODE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a7cea622c9311bfd0f0b9d7b6298ea04ea78689531838e490ef6bb41a3b5c43b7d" name="a7cea622c9311bfd0f0b9d7b6298ea04ea78689531838e490ef6bb41a3b5c43b7d"></a>KINSOL&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ab9d0cfc158090ca9ed09646d407b04f2" name="ab9d0cfc158090ca9ed09646d407b04f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9d0cfc158090ca9ed09646d407b04f2">&#9670;&#160;</a></span>check_cvode_flag()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void gridfire::utils::check_cvode_flag </td>
<td>(</td>
<td class="paramtype">const int</td> <td class="paramname"><span class="paramname"><em>flag</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>func_name</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a6451ba6762273b91a8281043cfaa5d2a" name="a6451ba6762273b91a8281043cfaa5d2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6451ba6762273b91a8281043cfaa5d2a">&#9670;&#160;</a></span>format_table()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#a6451ba6762273b91a8281043cfaa5d2a">&#9670;&#160;</a></span>format_table() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -169,8 +271,33 @@ Functions</h2></td></tr>
</div>
</div>
<a id="a05fda32d3fc4ab10060b8c4c251c2f3d" name="a05fda32d3fc4ab10060b8c4c251c2f3d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05fda32d3fc4ab10060b8c4c251c2f3d">&#9670;&#160;</a></span>formatNuclearTimescaleLogString()</h2>
<a id="a2eed085058abdb9d7fbbdb9647b98323" name="a2eed085058abdb9d7fbbdb9647b98323"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2eed085058abdb9d7fbbdb9647b98323">&#9670;&#160;</a></span>format_table() <span class="overload">[2/2]</span></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::utils::format_table </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgridfire_1_1utils_1_1_table_base.html">TableBase</a> &amp;</td> <td class="paramname"><span class="paramname"><em>table</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3d0646bcc1a6fd8df22ac0c758bfd5c4" name="a3d0646bcc1a6fd8df22ac0c758bfd5c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d0646bcc1a6fd8df22ac0c758bfd5c4">&#9670;&#160;</a></span>formatNuclearTimescaleLogString()</h2>
<div class="memitem">
<div class="memproto">
@@ -178,7 +305,7 @@ Functions</h2></td></tr>
<tr>
<td class="memname">std::string gridfire::utils::formatNuclearTimescaleLogString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a> &amp;</td> <td class="paramname"><span class="paramname"><em>engine</em></span>, </td>
<td class="paramtype">const <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html">engine::DynamicEngine</a> &amp;</td> <td class="paramname"><span class="paramname"><em>engine</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
@@ -202,7 +329,7 @@ Functions</h2></td></tr>
<p>This function takes a reaction network engine and the current plasma conditions to calculate the characteristic timescales for each species. It then formats this information into a neatly aligned ASCII table, which is suitable for logging or printing to the console.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">engine</td><td>A constant reference to a <code><a class="el" href="classgridfire_1_1_dynamic_engine.html" title="Abstract class for engines supporting Jacobian and stoichiometry operations.">DynamicEngine</a></code> object, used to calculate the species timescales. </td></tr>
<tr><td class="paramname">engine</td><td>A constant reference to a <code>DynamicEngine</code> object, used to calculate the species timescales. </td></tr>
<tr><td class="paramname">composition</td><td>The current composition of the plasma </td></tr>
<tr><td class="paramname">T9</td><td>The temperature in units of 10^9 K. </td></tr>
<tr><td class="paramname">rho</td><td>The plasma density in g/cm^3. </td></tr>
@@ -225,7 +352,7 @@ Functions</h2></td></tr>
<li>The final string, including header and footer lines, is returned.</li>
</ol>
<p><b>Usage</b> </p><div class="fragment"><div class="line"><span class="comment">// Assume &#39;my_engine&#39; is a valid DynamicEngine object and Y, T9, rho are initialized.</span></div>
<div class="line">std::string log_output = <a class="code hl_function" href="#a05fda32d3fc4ab10060b8c4c251c2f3d">gridfire::utils::formatNuclearTimescaleLogString</a>(my_engine, Y, T9, rho);</div>
<div class="line">std::string log_output = <a class="code hl_function" href="#a3d0646bcc1a6fd8df22ac0c758bfd5c4">gridfire::utils::formatNuclearTimescaleLogString</a>(my_engine, Y, T9, rho);</div>
<div class="line">std::cout &lt;&lt; log_output;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Example Output:</span></div>
@@ -236,7 +363,7 @@ Functions</h2></td></tr>
<div class="line"><span class="comment">// he4 inf</span></div>
<div class="line"><span class="comment">// c12 8.765e-02</span></div>
<div class="line"><span class="comment">// ==========================</span></div>
<div class="ttc" id="anamespacegridfire_1_1utils_html_a05fda32d3fc4ab10060b8c4c251c2f3d"><div class="ttname"><a href="#a05fda32d3fc4ab10060b8c4c251c2f3d">gridfire::utils::formatNuclearTimescaleLogString</a></div><div class="ttdeci">std::string formatNuclearTimescaleLogString(const DynamicEngine &amp;engine, const fourdst::composition::Composition &amp;composition, double T9, double rho)</div><div class="ttdoc">Formats a map of nuclear species timescales into a human-readable string.</div><div class="ttdef"><b>Definition</b> logging.cpp:12</div></div>
<div class="ttc" id="anamespacegridfire_1_1utils_html_a3d0646bcc1a6fd8df22ac0c758bfd5c4"><div class="ttname"><a href="#a3d0646bcc1a6fd8df22ac0c758bfd5c4">gridfire::utils::formatNuclearTimescaleLogString</a></div><div class="ttdeci">std::string formatNuclearTimescaleLogString(const engine::DynamicEngine &amp;engine, const fourdst::composition::Composition &amp;composition, double T9, double rho)</div><div class="ttdoc">Formats a map of nuclear species timescales into a human-readable string.</div><div class="ttdef"><b>Definition</b> logging.cpp:11</div></div>
</div><!-- fragment -->
</div>
</div>
@@ -277,6 +404,29 @@ Functions</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A unique 32-bit hash representing the isotope. This is computed as (A &lt;&lt; 8) | Z into an uint32_t. </dd></dl>
</div>
</div>
<a id="af7145934af6bf925dc7c2d2d589f2f85" name="af7145934af6bf925dc7c2d2d589f2f85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7145934af6bf925dc7c2d2d589f2f85">&#9670;&#160;</a></span>hash_combine()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="memname">
<tr>
<td class="memname">std::size_t gridfire::utils::hash_combine </td>
<td>(</td>
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>seed</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T &amp;</td> <td class="paramname"><span class="paramname"><em>v</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a011ac3184b4fcf21322868b1aaa4d2d1" name="a011ac3184b4fcf21322868b1aaa4d2d1"></a>
@@ -304,8 +454,8 @@ Functions</h2></td></tr>
</div>
</div>
<a id="a30bc2aa491806a4ac2a9039e267db282" name="a30bc2aa491806a4ac2a9039e267db282"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30bc2aa491806a4ac2a9039e267db282">&#9670;&#160;</a></span>massFractionFromMolarAbundanceAndComposition()</h2>
<a id="adfbe36ddda15b6e206d9726236d543ab" name="adfbe36ddda15b6e206d9726236d543ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfbe36ddda15b6e206d9726236d543ab">&#9670;&#160;</a></span>init_sun_vector()</h2>
<div class="memitem">
<div class="memproto">
@@ -314,19 +464,14 @@ Functions</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double gridfire::utils::massFractionFromMolarAbundanceAndComposition </td>
<td class="memname">N_Vector gridfire::utils::init_sun_vector </td>
<td>(</td>
<td class="paramtype">const fourdst::composition::Composition &amp;</td> <td class="paramname"><span class="paramname"><em>composition</em></span>, </td>
<td class="paramtype">uint64_t</td> <td class="paramname"><span class="paramname"><em>size</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const fourdst::atomic::Species &amp;</td> <td class="paramname"><span class="paramname"><em>species</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const double</td> <td class="paramname"><span class="paramname"><em>Yi</em></span>&#160;)</td>
<td class="paramtype">SUNContext</td> <td class="paramname"><span class="paramname"><em>sun_ctx</em></span>&#160;)</td>
</tr>
</table>
</td>
@@ -338,48 +483,50 @@ Functions</h2></td></tr>
</div>
</div>
<a id="a3e0dbd737724f2ead65046b07639c931" name="a3e0dbd737724f2ead65046b07639c931"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e0dbd737724f2ead65046b07639c931">&#9670;&#160;</a></span>massFractionFromMolarAbundanceAndMolarMass()</h2>
<a id="a334828d5d2b5e67560638ea9b3c031a1" name="a334828d5d2b5e67560638ea9b3c031a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a334828d5d2b5e67560638ea9b3c031a1">&#9670;&#160;</a></span>iterable_to_delimited_string()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;std::ranges::input_range Container, typename Elem = std::ranges::range_reference_t&lt;Container&gt;, typename Transform = std::identity, typename Pred = bool(*)(const std::ranges::range_value_t&lt;Container&gt;&amp;)&gt; <br />
requires std::invocable&lt;Transform, Elem&gt; &amp;&amp; Streamable&lt;std::invoke_result_t&lt;Transform, Elem&gt;&gt; &amp;&amp; std::predicate&lt;Pred, Elem&gt;</div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; double &gt; gridfire::utils::massFractionFromMolarAbundanceAndMolarMass </td>
<td class="memname">static std::string gridfire::utils::iterable_to_delimited_string </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; double &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>molarAbundances</em></span>, </td>
<td class="paramtype">const Container &amp;</td> <td class="paramname"><span class="paramname"><em>container</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; double &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>molarMasses</em></span>&#160;)</td>
<td class="paramtype">const std::string_view</td> <td class="paramname"><span class="paramname"><em>delimiter</em></span><span class="paramdefsep"> = </span><span class="paramdefval">&quot;,&#160;&quot;</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Transform</td> <td class="paramname"><span class="paramname"><em>transform</em></span><span class="paramdefsep"> = </span><span class="paramdefval">{}</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Pred</td> <td class="paramname"><span class="paramname"><em>pred</em></span><span class="paramdefsep"> = </span><span class="paramdefval">[](const&#160;auto&amp;){&#160;return&#160;true;&#160;}</span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel noexcept">noexcept</span></span> </td>
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a vector of molar abundances into a vector of mass fractions. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">molarAbundances</td><td>Vector of molar abundances </td></tr>
<tr><td class="paramname">molarMasses</td><td>Vector of molar masses</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The vectors molarAbundances and molarMasses must be parallel. This function does not provide any checks to ensure that the correct molar mass is being used with the correct molar abundance. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>A vector of molar masses such that each molar mass &lt; 1 and the sum of all is = 1 </dd></dl>
</div>
</div>
<a id="a1772aeeec2509ca45bc733b7615a7778" name="a1772aeeec2509ca45bc733b7615a7778"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1772aeeec2509ca45bc733b7615a7778">&#9670;&#160;</a></span>molarMassVectorFromComposition()</h2>
<a id="acbaa76c5f4021940995e274a86c2171a" name="acbaa76c5f4021940995e274a86c2171a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbaa76c5f4021940995e274a86c2171a">&#9670;&#160;</a></span>print_table() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -388,9 +535,38 @@ Functions</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; double &gt; gridfire::utils::molarMassVectorFromComposition </td>
<td class="memname">void gridfire::utils::print_table </td>
<td>(</td>
<td class="paramtype">const fourdst::composition::Composition &amp;</td> <td class="paramname"><span class="paramname"><em>composition</em></span></td><td>)</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>tableName</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgridfire_1_1utils_1_1_column_base.html">ColumnBase</a> &gt; &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>columns</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="afd3ba7a23f2affd403d5da4e813874d1" name="afd3ba7a23f2affd403d5da4e813874d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd3ba7a23f2affd403d5da4e813874d1">&#9670;&#160;</a></span>print_table() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void gridfire::utils::print_table </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgridfire_1_1utils_1_1_table_base.html">TableBase</a> &amp;</td> <td class="paramname"><span class="paramname"><em>table</em></span></td><td>)</td>
<td></td>
</tr>
</table>
@@ -401,6 +577,206 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ad72bcf145a772cf83cec4fb3841e8dd4" name="ad72bcf145a772cf83cec4fb3841e8dd4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad72bcf145a772cf83cec4fb3841e8dd4">&#9670;&#160;</a></span>sundials_retcode_map()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::unordered_map&lt; int, std::string &gt; &amp; gridfire::utils::sundials_retcode_map </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="#a7cea622c9311bfd0f0b9d7b6298ea04e">SUNDIALS_RET_CODE_TYPES</a></td> <td class="paramname"><span class="paramname"><em>type</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a6c58048a3127e6b87886971385a7fe06" name="a6c58048a3127e6b87886971385a7fe06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c58048a3127e6b87886971385a7fe06">&#9670;&#160;</a></span>to_csv()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void gridfire::utils::to_csv </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>filename</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgridfire_1_1utils_1_1_column_base.html">ColumnBase</a> &gt; &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>columns</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af9f382b1b40867c1e70f062d7fba90cd" name="af9f382b1b40867c1e70f062d7fba90cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9f382b1b40867c1e70f062d7fba90cd">&#9670;&#160;</a></span>to_json()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">nlohmann::json gridfire::utils::to_json </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgridfire_1_1utils_1_1_column_base.html">ColumnBase</a> &gt; &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>columns</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="adf613180bab406ef2bfbb9b79397148e" name="adf613180bab406ef2bfbb9b79397148e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf613180bab406ef2bfbb9b79397148e">&#9670;&#160;</a></span>to_json_file()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void gridfire::utils::to_json_file </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>filename</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgridfire_1_1utils_1_1_column_base.html">ColumnBase</a> &gt; &gt; &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>tables</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; std::string &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>tableNames</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ab9afa50593a895415d9314ad853806f3" name="ab9afa50593a895415d9314ad853806f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9afa50593a895415d9314ad853806f3">&#9670;&#160;</a></span>visual_width()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t gridfire::utils::visual_width </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>s</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a06d386929b2274e2593b97868be2ac51" name="a06d386929b2274e2593b97868be2ac51"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a06d386929b2274e2593b97868be2ac51">&#9670;&#160;</a></span>cvode_ret_code_map</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::unordered_map&lt;int, std::string&gt; gridfire::utils::cvode_ret_code_map</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a96fc2701cfd6cb8172282e9999fe4b34" name="a96fc2701cfd6cb8172282e9999fe4b34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96fc2701cfd6cb8172282e9999fe4b34">&#9670;&#160;</a></span>kinsol_ret_code_map</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::unordered_map&lt;int, std::string&gt; gridfire::utils::kinsol_ret_code_map</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">{</div>
<div class="line"> {0, <span class="stringliteral">&quot;KIN_SUCCESS: The solver succeeded.&quot;</span>},</div>
<div class="line"> {1, <span class="stringliteral">&quot;KIN_STEP_LT_STPTOL: The solver step size became less than the stopping tolerance.&quot;</span>},</div>
<div class="line"> {2, <span class="stringliteral">&quot;KIN_RES_REPTD_ERR: The residual function repeatedly failed recoverably.&quot;</span>},</div>
<div class="line"> {-1, <span class="stringliteral">&quot;KIN_MEM_NULL: The KINSOL memory structure is NULL.&quot;</span>},</div>
<div class="line"> {-2, <span class="stringliteral">&quot;KIN_ILL_INPUT: An illegal input was detected.&quot;</span>},</div>
<div class="line"> {-3, <span class="stringliteral">&quot;KIN_NO_MALLOC: The KINSOL memory structure has not been allocated.&quot;</span>},</div>
<div class="line"> {-4, <span class="stringliteral">&quot;KIN_MEM_FAIL: Memory allocation failed.&quot;</span>},</div>
<div class="line"> {-5, <span class="stringliteral">&quot;KIN_LINIT_FAIL: The linear solver&#39;s initialization function failed.&quot;</span>},</div>
<div class="line"> {-6, <span class="stringliteral">&quot;KIN_LSETUP_FAIL: The linear solver&#39;s setup function failed.&quot;</span>},</div>
<div class="line"> {-7, <span class="stringliteral">&quot;KIN_LSOLVE_FAIL: The linear solver&#39;s solve function failed.&quot;</span>},</div>
<div class="line"> {-8, <span class="stringliteral">&quot;KIN_RESFUNC_FAIL: The residual function failed in an unrecoverable manner.&quot;</span>},</div>
<div class="line"> {-9, <span class="stringliteral">&quot;KIN_CONSTR_FAIL: The inequality constraint was violated and the solver was unable to recover.&quot;</span>},</div>
<div class="line"> {-10, <span class="stringliteral">&quot;KIN_NLS_INIT_FAIL: The nonlinear solver&#39;s initialization function failed.&quot;</span>},</div>
<div class="line"> {-11, <span class="stringliteral">&quot;KIN_NLS_SETUP_FAIL: The nonlinear solver&#39;s setup function failed.&quot;</span>},</div>
<div class="line"> {-12, <span class="stringliteral">&quot;KIN_NLS_FAIL: The nonlinear solver&#39;s solve function failed.&quot;</span>}</div>
<div class="line"> }</div>
</div><!-- fragment -->
</div>
</div>
</div><!-- contents -->