tboudreaux/MeanField_SERiF
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
2fedb1a007da2467ca77df263d584e48d4650112
MeanField_SERiF/docs/html/backend_2mfem_2serialize_2top_8hpp.html

205 lines
16 KiB
HTML
Raw Normal View History

docs(docs): built docs Note for now much of the docs is LLM written. This was done to save time and focus on code development. The docs have been LOOSLEY reviewed. However, the code itself has been either fully written by hand or fully reviewed. Therefore, the docs should at the moment be seen as a loose resource rather than authoratiative (and this is on top of the general ability for docs to drift)
2026-11-09 14:09:44 -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.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SERiF: src/include/serif/backend/mfem/serialize/top.hpp File 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.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"/>
<link href="doxygen-extra.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">SERiF<span id="projectnumber">&#160;v0.0.1a</span>
</div>
<div id="projectbrief">Stellar Evolution and Rotation in Four Dimensions</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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',true);
$(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 */
$(function(){initNavTree('backend_2mfem_2serialize_2top_8hpp.html',''); initResizable(true); });
/* @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="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">top.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;array&gt;</code><br />
<code>#include &lt;cmath&gt;</code><br />
<code>#include &lt;filesystem&gt;</code><br />
<code>#include &lt;memory&gt;</code><br />
<code>#include &lt;numbers&gt;</code><br />
<code>#include &lt;span&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;type_traits&gt;</code><br />
<code>#include &quot;<a class="el" href="dof__map_8hpp.html">serif/backend/mfem/discretization/dof_map.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="backend_2mfem_2geometry_2deformation_2computations_8hpp.html">serif/backend/mfem/geometry/deformation/computations.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="eos_2models_2polytropic_8hpp.html">serif/eos/models/polytropic.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="barotropic__density_8hpp.html">serif/equations/barotropic_density.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="primal__gravity_8hpp.html">serif/equations/primal_gravity.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="isobaric_8hpp.html">serif/geometry/surface/isobaric.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="description_8hpp.html">serif/model/description.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="computation__cache_8hpp.html">serif/utils/dependencies/computation_cache.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="utils_2serialize_2top_8hpp.html">serif/utils/serialize/top.hpp</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for top.hpp:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="backend_2mfem_2serialize_2top_8hpp__incl.svg" width="100%" height="600"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="backend_2mfem_2serialize_2top_8hpp__dep__incl.svg" width="178" height="140"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classserif_1_1backend_1_1mfem_1_1serialize_1_1detail_1_1_top_model_sampler.html">serif::backend::mfem::serialize::detail::TopModelSampler</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sample copied coefficients on a private deformed geometry; the original state and mesh remain untouched. <a href="classserif_1_1backend_1_1mfem_1_1serialize_1_1detail_1_1_top_model_sampler.html#details">More...</a><br /></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="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif.html">serif</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1backend.html">serif::backend</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1backend_1_1mfem.html">serif::backend::mfem</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1backend_1_1mfem_1_1serialize.html">serif::backend::mfem::serialize</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1backend_1_1mfem_1_1serialize_1_1detail.html">serif::backend::mfem::serialize::detail</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1utils.html">serif::utils</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1utils_1_1serialize.html">serif::utils::serialize</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="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a626ed4fffd21b9419e919196731f7d65" id="r_a626ed4fffd21b9419e919196731f7d65"><td class="memTemplParams" colspan="2">template&lt;typename EOS&gt; </td></tr>
<tr class="memitem:a626ed4fffd21b9419e919196731f7d65"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1backend_1_1mfem_1_1serialize_1_1detail.html#a626ed4fffd21b9419e919196731f7d65">serif::backend::mfem::serialize::detail::top_matching_polytrope</a> (const EOS &amp;candidate, const <a class="el" href="classserif_1_1eos_1_1models_1_1_polytrope.html">eos::models::Polytrope</a> &amp;physical)</td></tr>
<tr class="memdesc:a626ed4fffd21b9419e919196731f7d65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Verify the actual closure EOS rather than assuming a borrowed equation uses the model's values. <br /></td></tr>
<tr class="separator:a626ed4fffd21b9419e919196731f7d65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac247352aee3417238eda1bf573f1b197" id="r_ac247352aee3417238eda1bf573f1b197"><td class="memTemplParams" colspan="2">template&lt;model::StellarModelType Model, typename FiniteElements, typename State&gt; </td></tr>
<tr class="memitem:ac247352aee3417238eda1bf573f1b197"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="namespaceserif_1_1utils_1_1serialize.html#ace9e0af29889a767ef1c95a09a4b7265">Result</a>&lt; <a class="el" href="structserif_1_1utils_1_1serialize_1_1_top_export_report.html">TopExportReport</a> &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1utils_1_1serialize.html#ac247352aee3417238eda1bf573f1b197">serif::utils::serialize::export_top</a> (const std::filesystem::path &amp;directory, const Model &amp;stellar_model, const FiniteElements &amp;finite_elements, const State &amp;state, const <a class="el" href="structserif_1_1utils_1_1serialize_1_1_top_export_options.html">TopExportOptions</a> &amp;options={})</td></tr>
<tr class="memdesc:ac247352aee3417238eda1bf573f1b197"><td class="mdescLeft">&#160;</td><td class="mdescRight">Export the accepted density and FE surface of a uniformly rotating vacuum polytrope to TOP. <br /></td></tr>
<tr class="separator:ac247352aee3417238eda1bf573f1b197"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5efebebb4fcf770cef7679e0e924627" id="r_aa5efebebb4fcf770cef7679e0e924627"><td class="memTemplParams" colspan="2">template&lt;typename FiniteElements, typename Solution&gt; <br />
requires requires(const Solution&amp; solution) { solution.has_state(); solution.model(); solution.state(); }</td></tr>
<tr class="memitem:aa5efebebb4fcf770cef7679e0e924627"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="namespaceserif_1_1utils_1_1serialize.html#ace9e0af29889a767ef1c95a09a4b7265">Result</a>&lt; <a class="el" href="structserif_1_1utils_1_1serialize_1_1_top_export_report.html">TopExportReport</a> &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1utils_1_1serialize.html#aa5efebebb4fcf770cef7679e0e924627">serif::utils::serialize::export_top</a> (const std::filesystem::path &amp;directory, const FiniteElements &amp;finite_elements, const Solution &amp;solution, const <a class="el" href="structserif_1_1utils_1_1serialize_1_1_top_export_options.html">TopExportOptions</a> &amp;options={})</td></tr>
<tr class="memdesc:aa5efebebb4fcf770cef7679e0e924627"><td class="mdescLeft">&#160;</td><td class="mdescRight">Export a solver result with the separately owned FE resources that interpret its accepted state. <br /></td></tr>
<tr class="separator:aa5efebebb4fcf770cef7679e0e924627"><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:adb44d596947c90d099959328bdff8951" id="r_adb44d596947c90d099959328bdff8951"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:adb44d596947c90d099959328bdff8951"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1backend_1_1mfem_1_1serialize_1_1detail.html#adb44d596947c90d099959328bdff8951">serif::backend::mfem::serialize::detail::top_rigid_barotrope</a> = false</td></tr>
<tr class="separator:adb44d596947c90d099959328bdff8951"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab31b49db042602ca034f4bbb679ec977" id="r_ab31b49db042602ca034f4bbb679ec977"><td class="memTemplParams" colspan="2">template&lt;typename EOS&gt; </td></tr>
<tr class="memitem:ab31b49db042602ca034f4bbb679ec977"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1backend_1_1mfem_1_1serialize_1_1detail.html#ab31b49db042602ca034f4bbb679ec977">serif::backend::mfem::serialize::detail::top_rigid_barotrope&lt; equations::BarotropicDensityBalance&lt; EOS &gt; &gt;</a> = true</td></tr>
<tr class="separator:ab31b49db042602ca034f4bbb679ec977"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b0856f6b0d80ccb263b2f415c91f9e17.html">include</a></li><li class="navelem"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a></li><li class="navelem"><a class="el" href="dir_5efd9e6a724a898950c58bd67170566f.html">backend</a></li><li class="navelem"><a class="el" href="dir_f4279ff9f0ade9101a3d0c95da9106b0.html">mfem</a></li><li class="navelem"><a class="el" href="dir_a6addf8d2b502bb84d626acd01a49eda.html">serialize</a></li><li class="navelem"><a class="el" href="backend_2mfem_2serialize_2top_8hpp.html">top.hpp</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.13.2 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue Copy Permalink