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

206 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/model/equilibrium_equations.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__equations_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="#concepts">Concepts</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">equilibrium_equations.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;functional&gt;</code><br />
<code>#include &lt;tuple&gt;</code><br />
<code>#include &lt;type_traits&gt;</code><br />
<code>#include &lt;utility&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for equilibrium_equations.hpp:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="equilibrium__equations_8hpp__incl.svg" width="346" height="126"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></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="equilibrium__equations_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="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structserif_1_1model_1_1_no_shape_force.html">serif::model::NoShapeForce</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Explicitly omit a shape equation from a declarative formulation. <a href="structserif_1_1model_1_1_no_shape_force.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structserif_1_1model_1_1_no_surface_condition.html">serif::model::NoSurfaceCondition</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Explicitly omit a surface prescription from a declarative formulation. <a href="structserif_1_1model_1_1_no_surface_condition.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structserif_1_1model_1_1_equilibrium_equations.html">serif::model::EquilibriumEquations&lt; Interior, Shape, Surface &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">State the chosen equations explicitly, without selecting physics from the EOS. <a href="structserif_1_1model_1_1_equilibrium_equations.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_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="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="conceptserif_1_1model_1_1_equilibrium_equation_description.html">serif::model::EquilibriumEquationDescription</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Recognize composition without instantiating any numerical equation contract. <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="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ae40b696afec46eacfa0e74ef448b46bb" id="r_ae40b696afec46eacfa0e74ef448b46bb"><td class="memTemplParams" colspan="2">template&lt;typename Interior, typename Shape = NoShapeForce, typename Surface = NoSurfaceCondition&gt; </td></tr>
<tr class="memitem:ae40b696afec46eacfa0e74ef448b46bb"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1model.html#ae40b696afec46eacfa0e74ef448b46bb">serif::model::EquilibriumEquations</a> (Interior, Shape={}, Surface={}) -&gt; EquilibriumEquations&lt; Interior, Shape, Surface &gt;</td></tr>
<tr class="memdesc:ae40b696afec46eacfa0e74ef448b46bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Preserve every authored member when a declaration passes through a templated model factory. <br /></td></tr>
<tr class="separator:ae40b696afec46eacfa0e74ef448b46bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16f3eb10a3c11e985ea40a4845ab3bdc" id="r_a16f3eb10a3c11e985ea40a4845ab3bdc"><td class="memTemplParams" colspan="2">template&lt;typename Definition, typename Model&gt; </td></tr>
<tr class="memitem:a16f3eb10a3c11e985ea40a4845ab3bdc"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto)&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1model_1_1detail.html#a16f3eb10a3c11e985ea40a4845ab3bdc">serif::model::detail::resolve_equation_member</a> (Definition &amp;&amp;definition, const Model &amp;model)</td></tr>
<tr class="memdesc:a16f3eb10a3c11e985ea40a4845ab3bdc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Evaluate a physical definition or retain its immutable object without requiring a copy. <br /></td></tr>
<tr class="separator:a16f3eb10a3c11e985ea40a4845ab3bdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7cda9f3b910ea61b555ca6936a8cd3f0" id="r_a7cda9f3b910ea61b555ca6936a8cd3f0"><td class="memTemplParams" colspan="2">template&lt;typename Definition, typename Model&gt; </td></tr>
<tr class="memitem:a7cda9f3b910ea61b555ca6936a8cd3f0"><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#a7cda9f3b910ea61b555ca6936a8cd3f0">serif::model::detail::resolve_equation_members</a> (Definition &amp;&amp;definition, const Model &amp;model)</td></tr>
<tr class="memdesc:a7cda9f3b910ea61b555ca6936a8cd3f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resolve each explicit part, owning temporary results and borrowing unchanged model members. <br /></td></tr>
<tr class="separator:a7cda9f3b910ea61b555ca6936a8cd3f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa55d6cc09e69d07412896dedcb71c5a5" id="r_aa55d6cc09e69d07412896dedcb71c5a5"><td class="memTemplParams" colspan="2">template&lt;typename Model&gt; <br />
requires requires(const Model&amp; model) { model.equations(); } &amp;&amp; EquilibriumEquationDescription&lt;decltype(<a class="el" href="namespaceserif_1_1model_1_1detail.html#a16f3eb10a3c11e985ea40a4845ab3bdc">detail::resolve_equation_member</a>(std::declval&lt;const Model&amp;&gt;().equations(), std::declval&lt;const Model&amp;&gt;()))&gt;</td></tr>
<tr class="memitem:aa55d6cc09e69d07412896dedcb71c5a5"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1model.html#aa55d6cc09e69d07412896dedcb71c5a5">serif::model::resolve_equilibrium_equations</a> (const Model &amp;model)</td></tr>
<tr class="memdesc:aa55d6cc09e69d07412896dedcb71c5a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resolve an explicit composition at binding; retain the model while the result borrows its members. <br /></td></tr>
<tr class="separator:aa55d6cc09e69d07412896dedcb71c5a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1e5714cfeffe321e29886eec5b93020" id="r_af1e5714cfeffe321e29886eec5b93020"><td class="memTemplParams" colspan="2">template&lt;typename Model&gt; <br />
requires (!std::is_lvalue_reference_v&lt;Model&gt;)</td></tr>
<tr class="memitem:af1e5714cfeffe321e29886eec5b93020"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1model.html#af1e5714cfeffe321e29886eec5b93020">serif::model::resolve_equilibrium_equations</a> (Model &amp;&amp;)=delete</td></tr>
<tr class="memdesc:af1e5714cfeffe321e29886eec5b93020"><td class="mdescLeft">&#160;</td><td class="mdescRight">A temporary model cannot retain the equation members borrowed by the resolved description. <br /></td></tr>
<tr class="separator:af1e5714cfeffe321e29886eec5b93020"><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:a554c794ba8dc7ba3a4a6e7dffd031515" id="r_a554c794ba8dc7ba3a4a6e7dffd031515"><td class="memTemplParams" colspan="2">template&lt;typename Candidate&gt; </td></tr>
<tr class="memitem:a554c794ba8dc7ba3a4a6e7dffd031515"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1model_1_1detail.html#a554c794ba8dc7ba3a4a6e7dffd031515">serif::model::detail::is_equilibrium_equations</a> = false</td></tr>
<tr class="separator:a554c794ba8dc7ba3a4a6e7dffd031515"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3085cd4e8cd8539adb985bc8c4036ea" id="r_ac3085cd4e8cd8539adb985bc8c4036ea"><td class="memTemplParams" colspan="2">template&lt;typename Interior, typename Shape, typename Surface&gt; </td></tr>
<tr class="memitem:ac3085cd4e8cd8539adb985bc8c4036ea"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1model_1_1detail.html#ac3085cd4e8cd8539adb985bc8c4036ea">serif::model::detail::is_equilibrium_equations&lt; EquilibriumEquations&lt; Interior, Shape, Surface &gt; &gt;</a> = true</td></tr>
<tr class="separator:ac3085cd4e8cd8539adb985bc8c4036ea"><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="equilibrium__equations_8hpp.html">equilibrium_equations.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