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

205 lines
18 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/solver/continuation/driver.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('driver_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="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">driver.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;memory&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
<code>#include &quot;<a class="el" href="solver_2continuation_2options_8hpp.html">serif/solver/continuation/options.hpp</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for driver.hpp:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="driver_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"><iframe scrolling="no" frameborder="0" src="driver_8hpp__dep__incl.svg" width="422" height="230"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></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_1continuation_1_1_correction_controls.html">serif::solver::continuation::CorrectionControls</a></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_1continuation_1_1_stage_record.html">serif::solver::continuation::StageRecord&lt; Count &gt;</a></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_1continuation_1_1_result.html">serif::solver::continuation::Result&lt; Report, Count &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retain the last converged physical state separately from the requested endpoint and failed candidates. <a href="structserif_1_1solver_1_1continuation_1_1_result.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_1continuation_1_1_starting_star.html">serif::solver::continuation::StartingStar&lt; Model, State &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A supplied physical anchor still requires fresh qualification at the continuation tolerance. <a href="structserif_1_1solver_1_1continuation_1_1_starting_star.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_1continuation.html">serif::solver::continuation</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_1continuation_1_1detail.html">serif::solver::continuation::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="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a0445e530123f4dd3f14954eafeaeb516" id="r_a0445e530123f4dd3f14954eafeaeb516"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1continuation.html#a0445e530123f4dd3f14954eafeaeb516">serif::solver::continuation::Status</a> { <br />
&#160;&#160;<a class="el" href="namespaceserif_1_1solver_1_1continuation.html#a0445e530123f4dd3f14954eafeaeb516a47252c72fe050aa193e34680c008a090">serif::solver::continuation::target_reached</a>
, <a class="el" href="namespaceserif_1_1solver_1_1continuation.html#a0445e530123f4dd3f14954eafeaeb516a3b37da8ec952c032b770374dbc6235c1">serif::solver::continuation::starting_star_failed</a>
, <a class="el" href="namespaceserif_1_1solver_1_1continuation.html#a0445e530123f4dd3f14954eafeaeb516acc37d00e5e12d2c8308851308b845222">serif::solver::continuation::attempt_limit</a>
, <a class="el" href="namespaceserif_1_1solver_1_1continuation.html#a0445e530123f4dd3f14954eafeaeb516ab46e5f037ad909fb47d91de634c95004">serif::solver::continuation::work_limit</a>
, <br />
&#160;&#160;<a class="el" href="namespaceserif_1_1solver_1_1continuation.html#a0445e530123f4dd3f14954eafeaeb516a43c09831647cc3d85b480f8815f0eef7">serif::solver::continuation::no_progress</a>
, <a class="el" href="namespaceserif_1_1solver_1_1continuation.html#a0445e530123f4dd3f14954eafeaeb516a53dbaf63161eadde6786ab8baa54a3e5">serif::solver::continuation::invalid_model</a>
<br />
}</td></tr>
<tr class="separator:a0445e530123f4dd3f14954eafeaeb516"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0b82e9c6b756ec2095a5ea1df5f768e" id="r_ae0b82e9c6b756ec2095a5ea1df5f768e"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1continuation.html#ae0b82e9c6b756ec2095a5ea1df5f768e">serif::solver::continuation::StageDisposition</a> { <a class="el" href="namespaceserif_1_1solver_1_1continuation.html#ae0b82e9c6b756ec2095a5ea1df5f768ea7de33615d7fbc1cb7bc608d12f1993d2">serif::solver::continuation::converged</a>
, <a class="el" href="namespaceserif_1_1solver_1_1continuation.html#ae0b82e9c6b756ec2095a5ea1df5f768ea21f518858f05ad9436d04f274f2de0ab">serif::solver::continuation::not_converged</a>
, <a class="el" href="namespaceserif_1_1solver_1_1continuation.html#ae0b82e9c6b756ec2095a5ea1df5f768ea53dbaf63161eadde6786ab8baa54a3e5">serif::solver::continuation::invalid_model</a>
}</td></tr>
<tr class="separator:ae0b82e9c6b756ec2095a5ea1df5f768e"><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:ad3de2a878384415f7120cc064c723d4f" id="r_ad3de2a878384415f7120cc064c723d4f"><td class="memTemplParams" colspan="2">template&lt;typename <a class="el" href="classserif_1_1solver_1_1continuation_1_1_family.html">Family</a>&gt; </td></tr>
<tr class="memitem:ad3de2a878384415f7120cc064c723d4f"><td class="memTemplItemLeft" align="right" valign="top">std::vector&lt; typename Family::Coordinates &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1continuation_1_1detail.html#ad3de2a878384415f7120cc064c723d4f">serif::solver::continuation::detail::starting_candidates</a> (const <a class="el" href="classserif_1_1solver_1_1continuation_1_1_family.html">Family</a> &amp;family, const <a class="el" href="structserif_1_1solver_1_1continuation_1_1_options.html">Options</a>&lt; <a class="el" href="classserif_1_1solver_1_1continuation_1_1_family.html">Family</a> &gt; &amp;options)</td></tr>
<tr class="memdesc:ad3de2a878384415f7120cc064c723d4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Try bounded simpler starting models, unless the user explicitly fixed the starting coordinates. <br /></td></tr>
<tr class="separator:ad3de2a878384415f7120cc064c723d4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a559f8cf10ed2895254c8a895718cec9e" id="r_a559f8cf10ed2895254c8a895718cec9e"><td class="memTemplParams" colspan="2">template&lt;typename Report, std::size_t Count&gt; </td></tr>
<tr class="memitem:a559f8cf10ed2895254c8a895718cec9e"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1continuation_1_1detail.html#a559f8cf10ed2895254c8a895718cec9e">serif::solver::continuation::detail::record</a> (<a class="el" href="structserif_1_1solver_1_1continuation_1_1_result.html">Result</a>&lt; Report, Count &gt; &amp;result, <a class="el" href="structserif_1_1solver_1_1continuation_1_1_stage_record.html">StageRecord</a>&lt; Count &gt; stage, std::size_t maximum)</td></tr>
<tr class="memdesc:a559f8cf10ed2895254c8a895718cec9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bound diagnostic storage while retaining total work and the newest stage. <br /></td></tr>
<tr class="separator:a559f8cf10ed2895254c8a895718cec9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add798956874a0248752eabf98cc12b4b" id="r_add798956874a0248752eabf98cc12b4b"><td class="memTemplParams" colspan="2">template&lt;typename <a class="el" href="classserif_1_1solver_1_1continuation_1_1_family.html">Family</a>, typename State, typename Corrector&gt; </td></tr>
<tr class="memitem:add798956874a0248752eabf98cc12b4b"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1continuation.html#add798956874a0248752eabf98cc12b4b">serif::solver::continuation::run</a> (const <a class="el" href="classserif_1_1solver_1_1continuation_1_1_family.html">Family</a> &amp;family, const State &amp;initial_state, Corrector &amp;&amp;correct, <a class="el" href="structserif_1_1solver_1_1continuation_1_1_options.html">Options</a>&lt; <a class="el" href="classserif_1_1solver_1_1continuation_1_1_family.html">Family</a> &gt; options, double absolute_tolerance)</td></tr>
<tr class="memdesc:add798956874a0248752eabf98cc12b4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Follow a physical family using owning correction results and physical state transfer. <br /></td></tr>
<tr class="separator:add798956874a0248752eabf98cc12b4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4090eedeabb4c30d029eb370a1188f44" id="r_a4090eedeabb4c30d029eb370a1188f44"><td class="memTemplParams" colspan="2">template&lt;typename <a class="el" href="classserif_1_1solver_1_1continuation_1_1_family.html">Family</a>, typename Model, typename State, typename Corrector&gt; </td></tr>
<tr class="memitem:a4090eedeabb4c30d029eb370a1188f44"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1continuation.html#a4090eedeabb4c30d029eb370a1188f44">serif::solver::continuation::run</a> (const <a class="el" href="classserif_1_1solver_1_1continuation_1_1_family.html">Family</a> &amp;family, const <a class="el" href="structserif_1_1solver_1_1continuation_1_1_starting_star.html">StartingStar</a>&lt; Model, State &gt; &amp;<a class="el" href="namespaceserif_1_1solver.html#a6fa8bbc306fbf990b16ade9fb7771464acc51b81974287ab79cef9e94fe778cc9">initial</a>, Corrector &amp;&amp;correct, <a class="el" href="structserif_1_1solver_1_1continuation_1_1_options.html">Options</a>&lt; <a class="el" href="classserif_1_1solver_1_1continuation_1_1_family.html">Family</a> &gt; options, double absolute_tolerance)</td></tr>
<tr class="memdesc:a4090eedeabb4c30d029eb370a1188f44"><td class="mdescLeft">&#160;</td><td class="mdescRight">Qualify a supplied star afresh after checking every physical family input. <br /></td></tr>
<tr class="separator:a4090eedeabb4c30d029eb370a1188f44"><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_bce7c05c39197a8317701929f54b3141.html">continuation</a></li><li class="navelem"><a class="el" href="driver_8hpp.html">driver.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