MeanField_SERiF/docs/html/family_8hpp.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/include/serif/solver/continuation/family.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('family_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">family.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;algorithm&gt;</code><br />
<code>#include &lt;cmath&gt;</code><br />
<code>#include &lt;functional&gt;</code><br />
<code>#include &lt;limits&gt;</code><br />
<code>#include &lt;optional&gt;</code><br />
<code>#include &lt;tuple&gt;</code><br />
<code>#include &lt;utility&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
<code>#include &quot;<a class="el" href="parameters_8hpp.html">serif/solver/continuation/parameters.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="stellar__model_8hpp.html">serif/model/stellar_model.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="errors_8hpp.html">serif/utils/error/errors.hpp</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for family.hpp:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="family_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="family_8hpp__dep__incl.svg" width="463" height="407"><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_parameter_law.html">serif::solver::continuation::ParameterLaw&lt; Output, Dependencies, Function &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_1detail_1_1_contained_3_01_parameter_list_3_01_parameterad20030d35747949989b5cceaad3ac98.html">serif::solver::continuation::detail::Contained&lt; ParameterList&lt; Parameters... &gt;, Superset &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_1detail_1_1_family_traits_3_01_parameter_list_3_01_seleca84d4a2e97805079c11da47f93a933f9.html">serif::solver::continuation::detail::FamilyTraits&lt; ParameterList&lt; Selected... &gt;, std::tuple&lt; Laws... &gt; &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_1detail_1_1_all_identified_3_01utils_1_1types_1_1_type_l25fb8683eeff2665fdc6fb6dfdadefac.html">serif::solver::continuation::detail::AllIdentified&lt; utils::types::TypeList&lt; Specifications... &gt; &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_1detail_1_1_copy_equations.html">serif::solver::continuation::detail::CopyEquations</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classserif_1_1solver_1_1continuation_1_1_bound_family_3_01_model_00_01_parameter_list_3_01_selec59bdc15c834ea037ddf5937bdf68e98f.html">serif::solver::continuation::BoundFamily&lt; Model, ParameterList&lt; Selected... &gt;, std::tuple&lt; Laws... &gt;, EquationFactory &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Own target physics and construct fresh family members without a mesh, evaluator, or mutable solve context.  <a href="classserif_1_1solver_1_1continuation_1_1_bound_family_3_01_model_00_01_parameter_list_3_01_selec59bdc15c834ea037ddf5937bdf68e98f.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_bound_family_3_01_model_00_01_parameter_list_3_01_sele82c3c82160605e9d9f82731d5217d9d6.html">serif::solver::continuation::BoundFamily&lt; Model, ParameterList&lt; Selected... &gt;, std::tuple&lt; Laws... &gt;, EquationFactory &gt;::Values</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classserif_1_1solver_1_1continuation_1_1_family.html">serif::solver::continuation::Family&lt; Selected, Laws &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Own a reusable physical family definition before selecting a target model.  <a href="classserif_1_1solver_1_1continuation_1_1_family.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="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_1continuation_1_1detail_1_1_law_definition.html">serif::solver::continuation::detail::LawDefinition</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_1continuation_1_1detail_1_1_bindable_family.html">serif::solver::continuation::detail::BindableFamily</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="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a94545ae3cf626e6588d86471528374aa" id="r_a94545ae3cf626e6588d86471528374aa"><td class="memTemplParams" colspan="2">template&lt;PhysicalParameter... Parameters&gt; </td></tr>
<tr class="memitem:a94545ae3cf626e6588d86471528374aa"><td class="memTemplItemLeft" align="right" valign="top">constexpr auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1continuation.html#a94545ae3cf626e6588d86471528374aa">serif::solver::continuation::depends_on</a> (Parameters...) noexcept</td></tr>
<tr class="memdesc:a94545ae3cf626e6588d86471528374aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name only independent physical inputs to a dependent law.  <br /></td></tr>
<tr class="separator:a94545ae3cf626e6588d86471528374aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8ea0ff2be2d8ea3a909962a87e25482" id="r_ab8ea0ff2be2d8ea3a909962a87e25482"><td class="memTemplParams" colspan="2">template&lt;typename Function&gt; </td></tr>
<tr class="memitem:ab8ea0ff2be2d8ea3a909962a87e25482"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1continuation_1_1detail.html#ab8ea0ff2be2d8ea3a909962a87e25482">serif::solver::continuation::detail::callable_valid</a> (const Function &amp;value)</td></tr>
<tr class="memdesc:ab8ea0ff2be2d8ea3a909962a87e25482"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reject null callable pointers even when a public aggregate bypasses its factory.  <br /></td></tr>
<tr class="separator:ab8ea0ff2be2d8ea3a909962a87e25482"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf610de8c5f0b0e7e5c077065f2cc564" id="r_adf610de8c5f0b0e7e5c077065f2cc564"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1continuation_1_1detail.html#adf610de8c5f0b0e7e5c077065f2cc564">serif::solver::continuation::detail::values_agree</a> (double first, double second) noexcept</td></tr>
<tr class="memdesc:adf610de8c5f0b0e7e5c077065f2cc564"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compare independently evaluated physical laws without an absolute unit-dependent tolerance.  <br /></td></tr>
<tr class="separator:adf610de8c5f0b0e7e5c077065f2cc564"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acdca66277c7359b90443cc02ffe3cf52" id="r_acdca66277c7359b90443cc02ffe3cf52"><td class="memTemplParams" colspan="2">template&lt;typename Law, typename Model&gt; </td></tr>
<tr class="memitem:acdca66277c7359b90443cc02ffe3cf52"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1continuation_1_1detail.html#acdca66277c7359b90443cc02ffe3cf52">serif::solver::continuation::detail::bind_law</a> (Law &amp;&amp;value, const Model &amp;target)</td></tr>
<tr class="memdesc:acdca66277c7359b90443cc02ffe3cf52"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bind target-dependent laws once, owning all resulting captures.  <br /></td></tr>
<tr class="separator:acdca66277c7359b90443cc02ffe3cf52"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f421e0cf94425828a241416a97e6290" id="r_a6f421e0cf94425828a241416a97e6290"><td class="memTemplParams" colspan="2">template&lt;PhysicalParameter Output, PhysicalParameter... Inputs, typename Function&gt; <br />
requires utils::dependencies::IsKeyList&lt;<a class="el" href="namespaceserif_1_1solver_1_1continuation.html#af4abf5dbb21b2d1032b766c80c2138d4">ParameterList</a>&lt;Inputs...&gt;&gt; &amp;&amp; std::invocable&lt;const std::remove_cvref_t&lt;Function&gt;&amp;, typename Inputs::Value...&gt; &amp;&amp; std::same_as&lt;std::remove_cvref_t&lt;std::invoke_result_t&lt;const std::remove_cvref_t&lt;Function&gt;&amp;, typename Inputs::Value...&gt;&gt;, typename Output::Value&gt;</td></tr>
<tr class="memitem:a6f421e0cf94425828a241416a97e6290"><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#a6f421e0cf94425828a241416a97e6290">serif::solver::continuation::law</a> (Output, <a class="el" href="namespaceserif_1_1solver_1_1continuation.html#af4abf5dbb21b2d1032b766c80c2138d4">ParameterList</a>&lt; Inputs... &gt;, Function &amp;&amp;function)</td></tr>
<tr class="memdesc:a6f421e0cf94425828a241416a97e6290"><td class="mdescLeft">&#160;</td><td class="mdescRight">Own a typed law, including move-only captures; its inputs are selected coordinates rather than other laws.  <br /></td></tr>
<tr class="separator:a6f421e0cf94425828a241416a97e6290"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6b0f634b5c0bda27b5b2f9e816c3ff2" id="r_ae6b0f634b5c0bda27b5b2f9e816c3ff2"><td class="memTemplParams" colspan="2">template&lt;PhysicalParameter... Parameters&gt; <br />
requires (sizeof...(Parameters) &gt; 0) &amp;&amp; utils::dependencies::IsKeyList&lt;<a class="el" href="namespaceserif_1_1solver_1_1continuation.html#af4abf5dbb21b2d1032b766c80c2138d4">ParameterList</a>&lt;Parameters...&gt;&gt;</td></tr>
<tr class="memitem:ae6b0f634b5c0bda27b5b2f9e816c3ff2"><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#ae6b0f634b5c0bda27b5b2f9e816c3ff2">serif::solver::continuation::in</a> (Parameters...)</td></tr>
<tr class="memdesc:ae6b0f634b5c0bda27b5b2f9e816c3ff2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select independent physical coordinates with duplicate detection at compile time.  <br /></td></tr>
<tr class="separator:ae6b0f634b5c0bda27b5b2f9e816c3ff2"><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="family_8hpp.html">family.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>