Files
MeanField_SERiF/docs/html/backend_2mfem_2model_2graph_8hpp.html
Emily Boudreaux 6b57738330 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

200 lines
19 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SERiF: src/include/serif/backend/mfem/model/graph.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_2model_2graph_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="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">graph.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;limits&gt;</code><br />
<code>#include &lt;memory&gt;</code><br />
<code>#include &lt;tuple&gt;</code><br />
<code>#include &lt;utility&gt;</code><br />
<code>#include &quot;<a class="el" href="interior_8hpp.html">serif/backend/mfem/model/computations/interior.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="backend_2mfem_2model_2computations_2surface__potential_8hpp.html">serif/backend/mfem/model/computations/surface_potential.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="potential__infinity_8hpp.html">serif/backend/mfem/model/computations/potential_infinity.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="model_2computations_2pressure__boundary_8hpp.html">serif/backend/mfem/model/computations/pressure_boundary.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="equilibrium__plan_8hpp.html">serif/model/equilibrium_plan.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="volume__displacement_8hpp.html">serif/backend/mfem/model/volume_displacement.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="boundary__computations_8hpp.html">serif/backend/mfem/geometry/surface/boundary_computations.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="model_2keys_8hpp.html">serif/model/keys.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="model_2plan_8hpp.html">serif/model/plan.hpp</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for graph.hpp:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="backend_2mfem_2model_2graph_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"><div class="zoom"><iframe scrolling="no" frameborder="0" src="backend_2mfem_2model_2graph_8hpp__dep__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><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_1model.html">serif::model</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_1model_1_1detail.html">serif::model::detail</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:a1913d9c0eef4efd5fef3eef1c1f097de" id="r_a1913d9c0eef4efd5fef3eef1c1f097de"><td class="memTemplParams" colspan="2">template&lt;typename Layout, typename Owner, typename... ContributionKeys&gt; </td></tr>
<tr class="memitem:a1913d9c0eef4efd5fef3eef1c1f097de"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1model_1_1detail.html#a1913d9c0eef4efd5fef3eef1c1f097de">serif::model::detail::physical_system_computation</a> (Layout layout, std::shared_ptr&lt; const Owner &gt; owner, <a class="el" href="structserif_1_1utils_1_1dependencies_1_1_key_list.html">utils::dependencies::KeyList</a>&lt; ContributionKeys... &gt;)</td></tr>
<tr class="memdesc:a1913d9c0eef4efd5fef3eef1c1f097de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Collect all additions before applying any boundary replacement. <br /></td></tr>
<tr class="separator:a1913d9c0eef4efd5fef3eef1c1f097de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae83ec19dfdc74cef1e310754e1fc7d12" id="r_ae83ec19dfdc74cef1e310754e1fc7d12"><td class="memTemplParams" colspan="2">template&lt;typename... Equations, typename... Additional&gt; </td></tr>
<tr class="memitem:ae83ec19dfdc74cef1e310754e1fc7d12"><td class="memTemplItemLeft" align="right" valign="top">consteval auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1model_1_1detail.html#ae83ec19dfdc74cef1e310754e1fc7d12">serif::model::detail::contribution_keys</a> (<a class="el" href="structserif_1_1utils_1_1types_1_1_type_list.html">utils::types::TypeList</a>&lt; Equations... &gt;, <a class="el" href="structserif_1_1utils_1_1dependencies_1_1_key_list.html">utils::dependencies::KeyList</a>&lt; Additional... &gt;)</td></tr>
<tr class="memdesc:ae83ec19dfdc74cef1e310754e1fc7d12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Every interior equation contributes once; extension keys identify explicit additions or replacements. <br /></td></tr>
<tr class="separator:ae83ec19dfdc74cef1e310754e1fc7d12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac05e8685fe7931d74aec47a2fad22331" id="r_ac05e8685fe7931d74aec47a2fad22331"><td class="memTemplParams" colspan="2">template&lt;typename Registry, typename Discretization, typename Layout, typename... Equations&gt; </td></tr>
<tr class="memitem:ac05e8685fe7931d74aec47a2fad22331"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1model_1_1detail.html#ac05e8685fe7931d74aec47a2fad22331">serif::model::detail::interior_computations</a> (const std::shared_ptr&lt; const Registry &gt; &amp;registry, const Discretization &amp;discretization, const Layout &amp;layout, <a class="el" href="structserif_1_1operators_1_1backend_1_1mfem_1_1_volume_options.html">operators::backend::mfem::VolumeOptions</a> options, <a class="el" href="structserif_1_1utils_1_1types_1_1_type_list.html">utils::types::TypeList</a>&lt; Equations... &gt;)</td></tr>
<tr class="memdesc:ac05e8685fe7931d74aec47a2fad22331"><td class="mdescLeft">&#160;</td><td class="mdescRight">Share each immutable equation with its volume graph, then publish one complete row contribution. <br /></td></tr>
<tr class="separator:ac05e8685fe7931d74aec47a2fad22331"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a818040e7235375f50650868a1fec3ae6" id="r_a818040e7235375f50650868a1fec3ae6"><td class="memTemplParams" colspan="2">template&lt;ExecutableInteriorEquations Registry, typename Discretization, discretization::blocks::SystemLayoutType Layout, typename... AdditionalComputations, typename... AdditionalContributions&gt; </td></tr>
<tr class="memitem:a818040e7235375f50650868a1fec3ae6"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1model.html#a818040e7235375f50650868a1fec3ae6">serif::model::make_model_graph</a> (std::shared_ptr&lt; const Registry &gt; registry, std::shared_ptr&lt; const Discretization &gt; discretization, const Layout &amp;layout, std::tuple&lt; AdditionalComputations... &gt; additional={}, <a class="el" href="structserif_1_1utils_1_1dependencies_1_1_key_list.html">utils::dependencies::KeyList</a>&lt; AdditionalContributions... &gt; contributions={}, <a class="el" href="structserif_1_1operators_1_1backend_1_1mfem_1_1_volume_options.html">operators::backend::mfem::VolumeOptions</a> options={})</td></tr>
<tr class="memdesc:a818040e7235375f50650868a1fec3ae6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct the complete stellar graph at one explicit composition point. <br /></td></tr>
<tr class="separator:a818040e7235375f50650868a1fec3ae6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a085910a172d862a4116162850b0222c5" id="r_a085910a172d862a4116162850b0222c5"><td class="memTemplParams" colspan="2">template&lt;ExecutableInteriorEquations Registry, typename Discretization, discretization::blocks::SystemLayoutType Layout, typename... AdditionalComputations, typename... AdditionalContributions&gt; </td></tr>
<tr class="memitem:a085910a172d862a4116162850b0222c5"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1model.html#a085910a172d862a4116162850b0222c5">serif::model::make_model_graph</a> (Registry registry, std::shared_ptr&lt; const Discretization &gt; discretization, const Layout &amp;layout, std::tuple&lt; AdditionalComputations... &gt; additional={}, <a class="el" href="structserif_1_1utils_1_1dependencies_1_1_key_list.html">utils::dependencies::KeyList</a>&lt; AdditionalContributions... &gt; contributions={}, <a class="el" href="structserif_1_1operators_1_1backend_1_1mfem_1_1_volume_options.html">operators::backend::mfem::VolumeOptions</a> options={})</td></tr>
<tr class="memdesc:a085910a172d862a4116162850b0222c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retain a standalone registry, including move-only equations supplied as an rvalue. <br /></td></tr>
<tr class="separator:a085910a172d862a4116162850b0222c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97a157a31fd3f1ab1b0277bd7f2ebcba" id="r_a97a157a31fd3f1ab1b0277bd7f2ebcba"><td class="memTemplParams" colspan="2">template&lt;typename Bound, typename Layout&gt; </td></tr>
<tr class="memitem:a97a157a31fd3f1ab1b0277bd7f2ebcba"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1model_1_1detail.html#a97a157a31fd3f1ab1b0277bd7f2ebcba">serif::model::detail::shape_computations</a> (const std::shared_ptr&lt; const Bound &gt; &amp;bound, const Layout &amp;layout)</td></tr>
<tr class="memdesc:a97a157a31fd3f1ab1b0277bd7f2ebcba"><td class="mdescLeft">&#160;</td><td class="mdescRight">One shared deformation feeds all geometry derivatives and the surface-potential shape row. <br /></td></tr>
<tr class="separator:a97a157a31fd3f1ab1b0277bd7f2ebcba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3b51c0962e8dfbe23c9f31450df4aee" id="r_af3b51c0962e8dfbe23c9f31450df4aee"><td class="memTemplParams" colspan="2">template&lt;typename Bound, typename Layout&gt; </td></tr>
<tr class="memitem:af3b51c0962e8dfbe23c9f31450df4aee"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1model_1_1detail.html#af3b51c0962e8dfbe23c9f31450df4aee">serif::model::detail::boundary_computations</a> (const Bound &amp;, const Layout &amp;layout)</td></tr>
<tr class="memdesc:af3b51c0962e8dfbe23c9f31450df4aee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sample the internally selected pressure formulation through its compiled traces. <br /></td></tr>
<tr class="separator:af3b51c0962e8dfbe23c9f31450df4aee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aabda0aaee8d4b1e56058c6429d72332c" id="r_aabda0aaee8d4b1e56058c6429d72332c"><td class="memTemplParams" colspan="2">template&lt;typename Plan&gt; </td></tr>
<tr class="memitem:aabda0aaee8d4b1e56058c6429d72332c"><td class="memTemplItemLeft" align="right" valign="top">consteval auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1model_1_1detail.html#aabda0aaee8d4b1e56058c6429d72332c">serif::model::detail::equilibrium_contribution_keys</a> ()</td></tr>
<tr class="memdesc:aabda0aaee8d4b1e56058c6429d72332c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name exactly the explicitly selected non-interior contributions to final assembly. <br /></td></tr>
<tr class="separator:aabda0aaee8d4b1e56058c6429d72332c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74e1efe91e9ad6f773134036585a39b6" id="r_a74e1efe91e9ad6f773134036585a39b6"><td class="memTemplParams" colspan="2">template&lt;typename Bound, typename Layout, typename... NumericalComputations&gt; </td></tr>
<tr class="memitem:a74e1efe91e9ad6f773134036585a39b6"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1model.html#a74e1efe91e9ad6f773134036585a39b6">serif::model::make_equilibrium_graph</a> (std::shared_ptr&lt; const Bound &gt; bound, const Layout &amp;layout, std::tuple&lt; NumericalComputations... &gt; numerical={}, <a class="el" href="structserif_1_1operators_1_1backend_1_1mfem_1_1_volume_options.html">operators::backend::mfem::VolumeOptions</a> options={})</td></tr>
<tr class="memdesc:a74e1efe91e9ad6f773134036585a39b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect the explicit equilibrium definition in one readable place. <br /></td></tr>
<tr class="separator:a74e1efe91e9ad6f773134036585a39b6"><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_1233560eb10cdcde82755d8d2adeb88b.html">model</a></li><li class="navelem"><a class="el" href="backend_2mfem_2model_2graph_8hpp.html">graph.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>