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

173 lines
12 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/model/backend/mfem/equilibrium.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('equilibrium_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> </div>
<div class="headertitle"><div class="title">equilibrium.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;expected&gt;</code><br />
<code>#include &quot;<a class="el" href="model_2backend_2mfem_2binding_8hpp.html">serif/model/backend/mfem/binding.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="configured__discretization_8hpp.html">serif/model/backend/mfem/configured_discretization.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="model_2normalization_2computations_8hpp.html">serif/model/normalization/computations.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="discretization_8hpp.html">serif/model/backend/mfem/discretization.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="model_2backend_2mfem_2failure_8hpp.html">serif/model/backend/mfem/failure.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="problem_8hpp.html">serif/model/backend/mfem/problem.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="model_2graph_8hpp.html">serif/model/graph.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="execution__validation_8hpp.html">serif/model/execution_validation.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="stellar__model_8hpp.html">serif/model/stellar_model.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="checks_2finite_8hpp.html">serif/utils/checks/finite.hpp</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for equilibrium.hpp:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="equilibrium_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><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_1model_1_1backend_1_1mfem_1_1_stellar_equilibrium.html">serif::model::backend::mfem::StellarEquilibrium&lt; Bound, Problem, AdditionalInputs, PreparedKey &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute one immutable physical definition against explicit candidate fields and geometry. <a href="classserif_1_1model_1_1backend_1_1mfem_1_1_stellar_equilibrium.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_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_1backend.html">serif::model::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_1model_1_1backend_1_1mfem.html">serif::model::backend::mfem</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:aeebf423f33a0836e029a7f3b42c590b5" id="r_aeebf423f33a0836e029a7f3b42c590b5"><td class="memTemplParams" colspan="2">template&lt;utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList&lt;&gt;, utils::dependencies::IsBindings SpecificationMap = DefaultSpecificationBindings, utils::dependencies::IsKeyList ExplicitZeroCouplings = utils::dependencies::KeyList&lt;&gt;, StellarModelType Model, typename Discretization, typename Coefficients, typename Geometry&gt; </td></tr>
<tr class="memitem:aeebf423f33a0836e029a7f3b42c590b5"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1model_1_1backend_1_1mfem.html#aeebf423f33a0836e029a7f3b42c590b5">serif::model::backend::mfem::bind_stellar_model</a> (Model model, Discretization discretization, const Coefficients &amp;coefficients, const Geometry &amp;geometry, <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:aeebf423f33a0836e029a7f3b42c590b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bind explicitly selected equilibrium equations without evaluating a candidate or starting a solve. <br /></td></tr>
<tr class="separator:aeebf423f33a0836e029a7f3b42c590b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc0b06b403d8cb9ff16f5620f23664dc" id="r_afc0b06b403d8cb9ff16f5620f23664dc"><td class="memTemplParams" colspan="2">template&lt;utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList&lt;&gt;, utils::dependencies::IsBindings SpecificationMap = DefaultSpecificationBindings, utils::dependencies::IsKeyList ExplicitZeroCouplings = utils::dependencies::KeyList&lt;&gt;, StellarModelType Model, typename Discretization, typename Options, typename Coefficients, typename Geometry&gt; </td></tr>
<tr class="memitem:afc0b06b403d8cb9ff16f5620f23664dc"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1model_1_1backend_1_1mfem.html#afc0b06b403d8cb9ff16f5620f23664dc">serif::model::backend::mfem::bind_stellar_model</a> (<a class="el" href="structserif_1_1model_1_1backend_1_1mfem_1_1_configured_discretization.html">ConfiguredDiscretization</a>&lt; Model, Discretization, Options &gt; configuration, const Coefficients &amp;coefficients, const Geometry &amp;geometry, <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:afc0b06b403d8cb9ff16f5620f23664dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bind the configured star and prepare its physical and normalized systems in one dependency graph. <br /></td></tr>
<tr class="separator:afc0b06b403d8cb9ff16f5620f23664dc"><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_c6d007d78fd1e188923aaa983ad27a9c.html">model</a></li><li class="navelem"><a class="el" href="dir_1321e11519a62974e86a4faacafbe0f0.html">backend</a></li><li class="navelem"><a class="el" href="dir_6e51cc7b7ddb655e1826abd9d1ba1d55.html">mfem</a></li><li class="navelem"><a class="el" href="equilibrium_8hpp.html">equilibrium.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