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

202 lines
20 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/include/serif/equations/contributions.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('equations_2contributions_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="#typedef-members">Typedefs</a> </div>
<div class="headertitle"><div class="title">contributions.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>File containing the Contribution struct. This is effectively a helper struct for authoring equations with fewer lines of boiler-plate. The idea here is that every equation must report certain members so that the backend can inspect at compile time. An author could certainly write these members themselves, but the Contribution struct auto generates those members based on its template parameters. Therefore, by inheriting from the Contribution struct an equation author can avoid writing those members themselves. Note that while this is inheritance it is still a compile-time relation. Contribution does not add any runtime overhead to the equation.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;tuple&gt;</code><br />
<code>#include &lt;type_traits&gt;</code><br />
<code>#include &lt;utility&gt;</code><br />
<code>#include &quot;<a class="el" href="discretization_2blocks_2traits_8hpp.html">serif/discretization/blocks/traits.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="operands_8hpp.html">serif/discretization/forms/operands.hpp</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for contributions.hpp:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="equations_2contributions_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="equations_2contributions_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="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_1equations_1_1_contribution.html">serif::equations::Contribution&lt; TestOperandT, SupportT &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A helper struct for authoring equations with fewer lines of boiler-plate. The idea here is that every equation must report certain members so that the backend can inspect at compile time. An author could certainly write these members themselves, but the <a class="el" href="structserif_1_1equations_1_1_contribution.html" title="A helper struct for authoring equations with fewer lines of boiler-plate. The idea here is that every...">Contribution</a> struct auto generates those members based on its template parameters. Therefore, by inheriting from the <a class="el" href="structserif_1_1equations_1_1_contribution.html" title="A helper struct for authoring equations with fewer lines of boiler-plate. The idea here is that every...">Contribution</a> struct an equation author can avoid writing those members themselves. Note that while this is inheritance it is still a compile-time relation. <a class="el" href="structserif_1_1equations_1_1_contribution.html" title="A helper struct for authoring equations with fewer lines of boiler-plate. The idea here is that every...">Contribution</a> does not add any runtime overhead to the equation. <a href="structserif_1_1equations_1_1_contribution.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_1equations_1_1_test_operand_traits.html">serif::equations::TestOperandTraits&lt; T, typename &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A helper struct to extract the test operand type from a contribution or equation. This is used to determine the test type of an equation or contribution. <a href="structserif_1_1equations_1_1_test_operand_traits.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_1equations_1_1_test_operand_traits_3_01_t_00_01std_1_1void__t_3_01typename_01_t_1_1_test_operand_01_4_01_4.html">serif::equations::TestOperandTraits&lt; T, std::void_t&lt; typename T::TestOperand &gt; &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specialization of <a class="el" href="structserif_1_1equations_1_1_test_operand_traits.html" title="A helper struct to extract the test operand type from a contribution or equation. This is used to det...">TestOperandTraits</a> for types that have a TestOperand member type. This allows us to extract the test operand type from contributions or equations that define a TestOperand type. <a href="structserif_1_1equations_1_1_test_operand_traits_3_01_t_00_01std_1_1void__t_3_01typename_01_t_1_1_test_operand_01_4_01_4.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_1equations_1_1_contribution_support.html">serif::equations::ContributionSupport&lt; T, typename &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper alias to extract the support type for a given contribution. <a href="structserif_1_1equations_1_1_contribution_support.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_1equations_1_1_contribution_support_3_01_t_00_01std_1_1void__t_3_01typename_01_t_1_1_support_01_4_01_4.html">serif::equations::ContributionSupport&lt; T, std::void_t&lt; typename T::Support &gt; &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specialization of <a class="el" href="structserif_1_1equations_1_1_contribution_support.html" title="Helper alias to extract the support type for a given contribution.">ContributionSupport</a> for types that have a Support member type. This allows us to extract the support type from contributions or equations that define a Support type. <a href="structserif_1_1equations_1_1_contribution_support_3_01_t_00_01std_1_1void__t_3_01typename_01_t_1_1_support_01_4_01_4.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_1equations_1_1_contributions.html">serif::equations::Contributions&lt; T, typename &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper struct to pack a list of contributions into a tuple. This is used to define the set of contributions of an equation. <a href="structserif_1_1equations_1_1_contributions.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_1equations_1_1_contribution_tuple.html">serif::equations::ContributionTuple&lt; TupleT, typename &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type representing the contributions of an equation. <a href="structserif_1_1equations_1_1_contribution_tuple.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_1equations_1_1_contribution_tuple_3_01std_1_1tuple_3_01_ts_8_8_8_01_4_00_01std_1_1e282a2c4b2ce56d3b5a3d2dda19385da.html">serif::equations::ContributionTuple&lt; std::tuple&lt; Ts... &gt;, std::void_t&lt; decltype(std::tuple_cat(std::declval&lt; typename Contributions&lt; std::remove_cvref_t&lt; Ts &gt; &gt;::type &gt;()...))&gt; &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specialization of <a class="el" href="structserif_1_1equations_1_1_contribution_tuple.html" title="Type representing the contributions of an equation.">ContributionTuple</a> for tuples of contributions. This allows us to extract the contributions from a tuple of contributions. <a href="structserif_1_1equations_1_1_contribution_tuple_3_01std_1_1tuple_3_01_ts_8_8_8_01_4_00_01std_1_1e282a2c4b2ce56d3b5a3d2dda19385da.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_1equations_1_1_contributions_3_01_t_00_01std_1_1void__t_3_01decltype_07std_1_1decl671b42e5568b3715d07217eb0f34ce32.html">serif::equations::Contributions&lt; T, std::void_t&lt; decltype(std::declval&lt; const T &amp; &gt;().contributions())&gt; &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specialization of <a class="el" href="structserif_1_1equations_1_1_contributions.html" title="Helper struct to pack a list of contributions into a tuple. This is used to define the set of contrib...">Contributions</a> for types that have the contributions() method. <a href="structserif_1_1equations_1_1_contributions_3_01_t_00_01std_1_1void__t_3_01decltype_07std_1_1decl671b42e5568b3715d07217eb0f34ce32.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_1equations.html">serif::equations</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="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ab3b0f61ca51136b0ddf4d868ebdfd8df" id="r_ab3b0f61ca51136b0ddf4d868ebdfd8df"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:ab3b0f61ca51136b0ddf4d868ebdfd8df"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1equations.html#ab3b0f61ca51136b0ddf4d868ebdfd8df">serif::equations::TestOperandOf</a> = <a class="el" href="structserif_1_1equations_1_1_test_operand_traits.html">TestOperandTraits</a>&lt;T&gt;::type</td></tr>
<tr class="memdesc:ab3b0f61ca51136b0ddf4d868ebdfd8df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper alias to extract the test operand type from a contribution or equation. <br /></td></tr>
<tr class="separator:ab3b0f61ca51136b0ddf4d868ebdfd8df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e2dbba73c1ee1b682885f1c178eb9f6" id="r_a7e2dbba73c1ee1b682885f1c178eb9f6"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:a7e2dbba73c1ee1b682885f1c178eb9f6"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1equations.html#a7e2dbba73c1ee1b682885f1c178eb9f6">serif::equations::SupportOf</a> = <a class="el" href="structserif_1_1equations_1_1_contribution_support.html">ContributionSupport</a>&lt;T&gt;::type</td></tr>
<tr class="memdesc:a7e2dbba73c1ee1b682885f1c178eb9f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper alias to extract the support type for a given contribution. <br /></td></tr>
<tr class="separator:a7e2dbba73c1ee1b682885f1c178eb9f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d8c1500d535f29fe360f0ab31ac55e3" id="r_a3d8c1500d535f29fe360f0ab31ac55e3"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:a3d8c1500d535f29fe360f0ab31ac55e3"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1equations.html#a3d8c1500d535f29fe360f0ab31ac55e3">serif::equations::ContributionsOf</a> = <a class="el" href="structserif_1_1equations_1_1_contributions.html">Contributions</a>&lt;std::remove_cvref_t&lt;T&gt;&gt;::type</td></tr>
<tr class="memdesc:a3d8c1500d535f29fe360f0ab31ac55e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper alias to extract the contributions (<a class="el" href="structserif_1_1equations_1_1_test_operand_traits.html">type</a>) of some type T. <br /></td></tr>
<tr class="separator:a3d8c1500d535f29fe360f0ab31ac55e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>File containing the Contribution struct. This is effectively a helper struct for authoring equations with fewer lines of boiler-plate. The idea here is that every equation must report certain members so that the backend can inspect at compile time. An author could certainly write these members themselves, but the Contribution struct auto generates those members based on its template parameters. Therefore, by inheriting from the Contribution struct an equation author can avoid writing those members themselves. Note that while this is inheritance it is still a compile-time relation. Contribution does not add any runtime overhead to the equation. </p>
<dl class="section author"><dt>Author</dt><dd>Emily M. Boudreaux </dd></dl>
</div></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_1cd4bc29af7d9f4b3445a3b3eda8de98.html">equations</a></li><li class="navelem"><a class="el" href="equations_2contributions_8hpp.html">contributions.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>