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

185 lines
15 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/geometry/surface/detail/automatic_relations.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('automatic__relations_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="#concepts">Concepts</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">automatic_relations.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="compilation_8hpp.html">serif/geometry/surface/compilation.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="discretization_2blocks_2traits_8hpp.html">serif/discretization/blocks/traits.hpp</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for automatic_relations.hpp:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="automatic__relations_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="automatic__relations_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_1geometry.html">serif::geometry</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_1geometry_1_1surface.html">serif::geometry::surface</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_1geometry_1_1surface_1_1detail.html">serif::geometry::surface::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_1geometry_1_1surface_1_1detail_1_1_thermodynamic_boundary_field.html">serif::geometry::surface::detail::ThermodynamicBoundaryField</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Globals require an explicit physical role: matching units alone would mistake C or a multiplier for enthalpy. <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:a20efef5a4c76937c7b0c55b68ef1c8c9" id="r_a20efef5a4c76937c7b0c55b68ef1c8c9"><td class="memTemplParams" colspan="2">template&lt;typename... Terms&gt; </td></tr>
<tr class="memitem:a20efef5a4c76937c7b0c55b68ef1c8c9"><td class="memTemplItemLeft" align="right" valign="top">consteval auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1geometry_1_1surface_1_1detail.html#a20efef5a4c76937c7b0c55b68ef1c8c9">serif::geometry::surface::detail::thermodynamic_fields</a> (<a class="el" href="structserif_1_1utils_1_1dependencies_1_1_key_list.html">utils::dependencies::KeyList</a>&lt; Terms... &gt;)</td></tr>
<tr class="memdesc:a20efef5a4c76937c7b0c55b68ef1c8c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Collect physical fields, retaining distinct terms with equal quantities so ambiguity remains visible. <br /></td></tr>
<tr class="separator:a20efef5a4c76937c7b0c55b68ef1c8c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a054743686d2e9c126d7a91dffd3342b7" id="r_a054743686d2e9c126d7a91dffd3342b7"><td class="memTemplParams" colspan="2">template&lt;typename Quantity, typename Carrier, typename... Fields&gt; </td></tr>
<tr class="memitem:a054743686d2e9c126d7a91dffd3342b7"><td class="memTemplItemLeft" align="right" valign="top">consteval auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1geometry_1_1surface_1_1detail.html#a054743686d2e9c126d7a91dffd3342b7">serif::geometry::surface::detail::quantity_field</a> (<a class="el" href="structserif_1_1utils_1_1dependencies_1_1_key_list.html">utils::dependencies::KeyList</a>&lt; Fields... &gt;)</td></tr>
<tr class="memdesc:a054743686d2e9c126d7a91dffd3342b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a unique field for a quantity; the chosen residual carrier supplies its own quantity unambiguously. <br /></td></tr>
<tr class="separator:a054743686d2e9c126d7a91dffd3342b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20c3b7f26d331c003cc7298e16ac8fd2" id="r_a20c3b7f26d331c003cc7298e16ac8fd2"><td class="memTemplParams" colspan="2">template&lt;typename Carrier, typename Fields, typename... Quantities&gt; </td></tr>
<tr class="memitem:a20c3b7f26d331c003cc7298e16ac8fd2"><td class="memTemplItemLeft" align="right" valign="top">consteval auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1geometry_1_1surface_1_1detail.html#a20c3b7f26d331c003cc7298e16ac8fd2">serif::geometry::surface::detail::relation_bindings</a> (<a class="el" href="structserif_1_1utils_1_1dependencies_1_1_key_list.html">utils::dependencies::KeyList</a>&lt; Quantities... &gt;)</td></tr>
<tr class="memdesc:a20c3b7f26d331c003cc7298e16ac8fd2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bind only the quantities read by this candidate, ignoring unrelated fields and quantities. <br /></td></tr>
<tr class="separator:a20c3b7f26d331c003cc7298e16ac8fd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1349b4774527454fa74d4e8ffdf8ce6c" id="r_a1349b4774527454fa74d4e8ffdf8ce6c"><td class="memTemplParams" colspan="2">template&lt;typename EOS, typename Carrier, typename Fields, typename Relation&gt; </td></tr>
<tr class="memitem:a1349b4774527454fa74d4e8ffdf8ce6c"><td class="memTemplItemLeft" align="right" valign="top">consteval auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1geometry_1_1surface_1_1detail.html#a1349b4774527454fa74d4e8ffdf8ce6c">serif::geometry::surface::detail::inverse_candidate</a> ()</td></tr>
<tr class="memdesc:a1349b4774527454fa74d4e8ffdf8ce6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test a declared inverse and every required analytic partial before publishing its formulation. <br /></td></tr>
<tr class="separator:a1349b4774527454fa74d4e8ffdf8ce6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ec42570e4d5c2a3c4cff02fcce3f8f4" id="r_a8ec42570e4d5c2a3c4cff02fcce3f8f4"><td class="memTemplParams" colspan="2">template&lt;typename EOS, typename Carrier, typename Fields, typename Relation&gt; </td></tr>
<tr class="memitem:a8ec42570e4d5c2a3c4cff02fcce3f8f4"><td class="memTemplItemLeft" align="right" valign="top">consteval auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1geometry_1_1surface_1_1detail.html#a8ec42570e4d5c2a3c4cff02fcce3f8f4">serif::geometry::surface::detail::direct_candidate</a> ()</td></tr>
<tr class="memdesc:a8ec42570e4d5c2a3c4cff02fcce3f8f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">A direct pressure relation may replace only a row belonging to one of its solved inputs. <br /></td></tr>
<tr class="separator:a8ec42570e4d5c2a3c4cff02fcce3f8f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a793bbc0e02d2552de83928fbbc24a8aa" id="r_a793bbc0e02d2552de83928fbbc24a8aa"><td class="memTemplParams" colspan="2">template&lt;bool Inverse, typename EOS, typename Carrier, typename Fields, typename... Relations&gt; </td></tr>
<tr class="memitem:a793bbc0e02d2552de83928fbbc24a8aa"><td class="memTemplItemLeft" align="right" valign="top">consteval auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1geometry_1_1surface_1_1detail.html#a793bbc0e02d2552de83928fbbc24a8aa">serif::geometry::surface::detail::relation_candidates</a> (<a class="el" href="structserif_1_1eos_1_1relations_1_1_relation_catalog.html">eos::relations::RelationCatalog</a>&lt; Relations... &gt;)</td></tr>
<tr class="memdesc:a793bbc0e02d2552de83928fbbc24a8aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Keep every admissible relation; catalog order never selects a physical implementation. <br /></td></tr>
<tr class="separator:a793bbc0e02d2552de83928fbbc24a8aa"><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_afafc166fe2ea9700a3140fe454efa1d.html">geometry</a></li><li class="navelem"><a class="el" href="dir_98d749141d3718f6f33837ead6376b34.html">surface</a></li><li class="navelem"><a class="el" href="dir_c25dfbd4cdf6c1e2a7451b3f8e63338f.html">detail</a></li><li class="navelem"><a class="el" href="automatic__relations_8hpp.html">automatic_relations.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