Files
MeanField_SERiF/docs/html/dir_000098_000065.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

121 lines
15 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/compile_time_checks/serif/model -&gt; include Relation</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('dir_5614155bcb6537e420aacf58075bceb6.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="contents">
<h3>model &rarr; include Relation</h3><table class="dirtab"><tr class="dirtab"><th class="dirtab">File in src/compile_time_checks/serif/model</th><th class="dirtab">Includes file in src/include</th></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="description_8cpp.html">description.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_c6d007d78fd1e188923aaa983ad27a9c.html">model</a>&#160;/&#160;<a class="el" href="description_8hpp.html">description.hpp</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="description_8cpp.html">description.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_c6d007d78fd1e188923aaa983ad27a9c.html">model</a>&#160;/&#160;<a class="el" href="eos__reference_8hpp.html">eos_reference.hpp</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="execution__validation_8cpp.html">execution_validation.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_1cd4bc29af7d9f4b3445a3b3eda8de98.html">equations</a>&#160;/&#160;<a class="el" href="angular__momentum_8hpp.html">angular_momentum.hpp</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="execution__validation_8cpp.html">execution_validation.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_1cd4bc29af7d9f4b3445a3b3eda8de98.html">equations</a>&#160;/&#160;<a class="el" href="barotropic__closure_8hpp.html">barotropic_closure.hpp</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="execution__validation_8cpp.html">execution_validation.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_1cd4bc29af7d9f4b3445a3b3eda8de98.html">equations</a>&#160;/&#160;<a class="el" href="central__density_8hpp.html">central_density.hpp</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="execution__validation_8cpp.html">execution_validation.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_1cd4bc29af7d9f4b3445a3b3eda8de98.html">equations</a>&#160;/&#160;<a class="el" href="displacement__force_8hpp.html">displacement_force.hpp</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="execution__validation_8cpp.html">execution_validation.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_c6d007d78fd1e188923aaa983ad27a9c.html">model</a>&#160;/&#160;<a class="el" href="execution__validation_8hpp.html">execution_validation.hpp</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="execution__validation_8cpp.html">execution_validation.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_1cd4bc29af7d9f4b3445a3b3eda8de98.html">equations</a>&#160;/&#160;<a class="el" href="hydrostatic__equilibrium_8hpp.html">hydrostatic_equilibrium.hpp</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="execution__validation_8cpp.html">execution_validation.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_1cd4bc29af7d9f4b3445a3b3eda8de98.html">equations</a>&#160;/&#160;<a class="el" href="mass__normalization_8hpp.html">mass_normalization.hpp</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="execution__validation_8cpp.html">execution_validation.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_1cd4bc29af7d9f4b3445a3b3eda8de98.html">equations</a>&#160;/&#160;<a class="el" href="mixed__gravity_8hpp.html">mixed_gravity.hpp</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="normalization_8cpp.html">normalization.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_1cd4bc29af7d9f4b3445a3b3eda8de98.html">equations</a>&#160;/&#160;<a class="el" href="angular__momentum_8hpp.html">angular_momentum.hpp</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="normalization_8cpp.html">normalization.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_1cd4bc29af7d9f4b3445a3b3eda8de98.html">equations</a>&#160;/&#160;<a class="el" href="barotropic__closure_8hpp.html">barotropic_closure.hpp</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="normalization_8cpp.html">normalization.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_1cd4bc29af7d9f4b3445a3b3eda8de98.html">equations</a>&#160;/&#160;<a class="el" href="central__density_8hpp.html">central_density.hpp</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="normalization_8cpp.html">normalization.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_61ce9618cc59c903e19fcd7c3ff79031.html">solver</a>&#160;/&#160;<a class="el" href="dir_c8469baf8535e36a5f500f5e7d20760c.html">normalization</a>&#160;/&#160;<a class="el" href="solver_2normalization_2computations_8hpp.html">computations.hpp</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="normalization_8cpp.html">normalization.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_c6d007d78fd1e188923aaa983ad27a9c.html">model</a>&#160;/&#160;<a class="el" href="dir_1321e11519a62974e86a4faacafbe0f0.html">backend</a>&#160;/&#160;<a class="el" href="dir_6e51cc7b7ddb655e1826abd9d1ba1d55.html">mfem</a>&#160;/&#160;<a class="el" href="configured__discretization_8hpp.html">configured_discretization.hpp</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="normalization_8cpp.html">normalization.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_1cd4bc29af7d9f4b3445a3b3eda8de98.html">equations</a>&#160;/&#160;<a class="el" href="displacement__force_8hpp.html">displacement_force.hpp</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="normalization_8cpp.html">normalization.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_1cd4bc29af7d9f4b3445a3b3eda8de98.html">equations</a>&#160;/&#160;<a class="el" href="hydrostatic__equilibrium_8hpp.html">hydrostatic_equilibrium.hpp</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="normalization_8cpp.html">normalization.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_afafc166fe2ea9700a3140fe454efa1d.html">geometry</a>&#160;/&#160;<a class="el" href="dir_98d749141d3718f6f33837ead6376b34.html">surface</a>&#160;/&#160;<a class="el" href="isobaric_8hpp.html">isobaric.hpp</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="normalization_8cpp.html">normalization.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_1cd4bc29af7d9f4b3445a3b3eda8de98.html">equations</a>&#160;/&#160;<a class="el" href="mass__normalization_8hpp.html">mass_normalization.hpp</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="normalization_8cpp.html">normalization.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_1cd4bc29af7d9f4b3445a3b3eda8de98.html">equations</a>&#160;/&#160;<a class="el" href="mixed__gravity_8hpp.html">mixed_gravity.hpp</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="normalization_8cpp.html">normalization.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_c6d007d78fd1e188923aaa983ad27a9c.html">model</a>&#160;/&#160;<a class="el" href="dir_68b73560b2431cfe0191ac50c96ddaa2.html">normalization</a>&#160;/&#160;<a class="el" href="model_2normalization_2plan_8hpp.html">plan.hpp</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="compile__time__checks_2serif_2model_2validation_8cpp.html">validation.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_1cd4bc29af7d9f4b3445a3b3eda8de98.html">equations</a>&#160;/&#160;<a class="el" href="barotropic__closure_8hpp.html">barotropic_closure.hpp</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="compile__time__checks_2serif_2model_2validation_8cpp.html">validation.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_1cd4bc29af7d9f4b3445a3b3eda8de98.html">equations</a>&#160;/&#160;<a class="el" href="hydrostatic__equilibrium_8hpp.html">hydrostatic_equilibrium.hpp</a></td></tr><tr class="dirtab"><td class="dirtab"><a class="el" href="compile__time__checks_2serif_2model_2validation_8cpp.html">validation.cpp</a></td><td class="dirtab"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a>&#160;/&#160;<a class="el" href="dir_c6d007d78fd1e188923aaa983ad27a9c.html">model</a>&#160;/&#160;<a class="el" href="model_2validation_8hpp.html">validation.hpp</a></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_d4f25029f94d80d3ecc4f4b833d0060b.html">compile_time_checks</a></li><li class="navelem"><a class="el" href="dir_2305031ee4c21bc973ff70c56d2979de.html">serif</a></li><li class="navelem"><a class="el" href="dir_5614155bcb6537e420aacf58075bceb6.html">model</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>