tboudreaux/MeanField_SERiF
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
2fedb1a007da2467ca77df263d584e48d4650112
MeanField_SERiF/docs/html/configuration_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

201 lines
17 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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/solver/normalization/configuration.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('configuration_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> </div>
<div class="headertitle"><div class="title">configuration.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;concepts&gt;</code><br />
<code>#include &lt;expected&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;tuple&gt;</code><br />
<code>#include &lt;utility&gt;</code><br />
<code>#include &quot;<a class="el" href="type__alias_8hpp.html">serif/dimensions/type_alias.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="scales_8hpp.html">serif/solver/normalization/scales.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="dependency__context_8hpp.html">serif/utils/dependencies/dependency_context.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="laneemden_8hpp.html">serif/utils/laneemden/laneemden.hpp</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for configuration.hpp:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="configuration_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="configuration_8hpp__dep__incl.svg" width="100%" height="549"><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_1solver_1_1normalization_1_1_from_model.html">serif::solver::normalization::FromModel</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Obtain a reference value from the corresponding descriptive model prescription. <a href="structserif_1_1solver_1_1normalization_1_1_from_model.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_1solver_1_1normalization_1_1_automatic_plan.html">serif::solver::normalization::AutomaticPlan</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Derive the coordinate rules from the selected fields, equations and boundary formulation. <a href="structserif_1_1solver_1_1normalization_1_1_automatic_plan.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_1solver_1_1normalization_1_1_dimensionless.html">serif::solver::normalization::Dimensionless</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove physical and geometric units from the solver's coordinates and norms. <a href="structserif_1_1solver_1_1normalization_1_1_dimensionless.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_1solver_1_1normalization_1_1_physical_riesz.html">serif::solver::normalization::PhysicalRiesz</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retain the original physical Riesz convention, including dimensional geometric measures. <a href="structserif_1_1solver_1_1normalization_1_1_physical_riesz.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_1solver_1_1normalization_1_1_lane_emden_approximation.html">serif::solver::normalization::LaneEmdenApproximation&lt; Mass, CentralDensity &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Estimate a reference radius from a Lane–Emden shape, mass and central density. <a href="structserif_1_1solver_1_1normalization_1_1_lane_emden_approximation.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_1solver_1_1normalization_1_1_normalization_options.html">serif::solver::normalization::NormalizationOptions&lt; Scheme, Coordinates, Plan, Sources, Computations &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Declare normalization without evaluating a reference star or allocating coordinate factors. <a href="structserif_1_1solver_1_1normalization_1_1_normalization_options.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_1solver.html">serif::solver</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_1solver_1_1normalization.html">serif::solver::normalization</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_1solver_1_1normalization_1_1_reference_scheme.html">serif::solver::normalization::ReferenceScheme</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A custom stellar reference strategy supplies the same typed scales and ordinary failure value. <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:a58791243c886657505170066c10584ab" id="r_a58791243c886657505170066c10584ab"><td class="memTemplParams" colspan="2">template&lt;typename Scheme, typename Coordinates, typename Plan, typename Sources, typename Computations&gt; </td></tr>
<tr class="memitem:a58791243c886657505170066c10584ab"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1normalization.html#a58791243c886657505170066c10584ab">serif::solver::normalization::make_normalization</a> (<a class="el" href="structserif_1_1solver_1_1normalization_1_1_normalization_options.html">NormalizationOptions</a>&lt; Scheme, Coordinates, Plan, Sources, Computations &gt; options)</td></tr>
<tr class="memdesc:a58791243c886657505170066c10584ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Preserve the deduced numerical choices for later preparation with a model and discretization. <br /></td></tr>
<tr class="separator:a58791243c886657505170066c10584ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aabc0313890d07ed3a2e0afd47597dcef" id="r_aabc0313890d07ed3a2e0afd47597dcef"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1normalization.html#aabc0313890d07ed3a2e0afd47597dcef">serif::solver::normalization::make_normalization</a> ()</td></tr>
<tr class="memdesc:aabc0313890d07ed3a2e0afd47597dcef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select the usual dimensionless Lane–Emden reference, taking mass and central density from the model. <br /></td></tr>
<tr class="separator:aabc0313890d07ed3a2e0afd47597dcef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a787fb498a34fbc3def51c8bfddde35" id="r_a1a787fb498a34fbc3def51c8bfddde35"><td class="memItemLeft" align="right" valign="top">std::expected&lt; <a class="el" href="structserif_1_1solver_1_1normalization_1_1_stellar_reference_scales.html">StellarReferenceScales</a>, std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1normalization.html#a1a787fb498a34fbc3def51c8bfddde35">serif::solver::normalization::prepare_reference_scales</a> (const <a class="el" href="structserif_1_1solver_1_1normalization_1_1_lane_emden_approximation.html">LaneEmdenApproximation</a>&lt; <a class="el" href="namespaceserif_1_1dimensions.html#a66499323cee57a1033e7b203a9198c24">dimensions::MassValue</a>, <a class="el" href="namespaceserif_1_1dimensions.html#af7f8c68a704a7bf475c60dbad5f98d78">dimensions::DensityValue</a> &gt; &amp;scheme, <a class="el" href="classserif_1_1dimensions_1_1_quantity_value.html">dimensions::QuantityValue</a>&lt; <a class="el" href="structserif_1_1dimensions_1_1_gravitational_constant.html">dimensions::GravitationalConstant</a> &gt; gravitational_constant)</td></tr>
<tr class="memdesc:a1a787fb498a34fbc3def51c8bfddde35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Derive the shared stellar scales after both dimensional reference inputs have been resolved. <br /></td></tr>
<tr class="separator:a1a787fb498a34fbc3def51c8bfddde35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1e9d275253e074720b819188ef1b8c6" id="r_ac1e9d275253e074720b819188ef1b8c6"><td class="memItemLeft" align="right" valign="top">std::expected&lt; <a class="el" href="structserif_1_1solver_1_1normalization_1_1_stellar_reference_scales.html">StellarReferenceScales</a>, std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1normalization.html#ac1e9d275253e074720b819188ef1b8c6">serif::solver::normalization::prepare_reference_scales</a> (const <a class="el" href="structserif_1_1solver_1_1normalization_1_1_stellar_reference_scales.html">StellarReferenceScales</a> &amp;reference, <a class="el" href="classserif_1_1dimensions_1_1_quantity_value.html">dimensions::QuantityValue</a>&lt; <a class="el" href="structserif_1_1dimensions_1_1_gravitational_constant.html">dimensions::GravitationalConstant</a> &gt; gravitational_constant)</td></tr>
<tr class="memdesc:ac1e9d275253e074720b819188ef1b8c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Use explicitly prepared reference scales through the same graph as estimated references. <br /></td></tr>
<tr class="separator:ac1e9d275253e074720b819188ef1b8c6"><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_61ce9618cc59c903e19fcd7c3ff79031.html">solver</a></li><li class="navelem"><a class="el" href="dir_c8469baf8535e36a5f500f5e7d20760c.html">normalization</a></li><li class="navelem"><a class="el" href="configuration_8hpp.html">configuration.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 View Git Blame Copy Permalink