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

187 lines
19 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/discretization/fields_meanfield.cpp 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('fields__meanfield_8cpp.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="#namespaces">Namespaces</a> &#124;
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle"><div class="title">fields_meanfield.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<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="blocks_8hpp.html">serif/discretization/blocks/blocks.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="discretization_2forms_2runtime_8hpp.html">serif/discretization/forms/runtime.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="backend_2mfem_2discretization_2quadrature_2order_8hpp.html">serif/backend/mfem/discretization/quadrature/order.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="point_8hpp.html">serif/equations/point.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 />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for fields_meanfield.cpp:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="fields__meanfield_8cpp__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="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_1compile__time__checks.html">serif::compile_time_checks</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_1compile__time__checks_1_1fields__meanfield.html">serif::compile_time_checks::fields_meanfield</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:a304f08b6c15bfec4059c468f931b1c07" id="r_a304f08b6c15bfec4059c468f931b1c07"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#a304f08b6c15bfec4059c468f931b1c07">serif::compile_time_checks::fields_meanfield::Density</a> = blocks::density::mass</td></tr>
<tr class="separator:a304f08b6c15bfec4059c468f931b1c07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb9b366add2a5f25ca616716b078eb73" id="r_adb9b366add2a5f25ca616716b078eb73"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#adb9b366add2a5f25ca616716b078eb73">serif::compile_time_checks::fields_meanfield::Potential</a> = blocks::gravity::potential</td></tr>
<tr class="separator:adb9b366add2a5f25ca616716b078eb73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afea6cde56a3043b59244b4bca67e0669" id="r_afea6cde56a3043b59244b4bca67e0669"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#afea6cde56a3043b59244b4bca67e0669">serif::compile_time_checks::fields_meanfield::Displacement</a> = blocks::displacement::vector</td></tr>
<tr class="separator:afea6cde56a3043b59244b4bca67e0669"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6f320adf030e020e7b089bb905c2b81" id="r_af6f320adf030e020e7b089bb905c2b81"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#af6f320adf030e020e7b089bb905c2b81">serif::compile_time_checks::fields_meanfield::Constant</a> = blocks::barotropic_constant::mass_normalization</td></tr>
<tr class="separator:af6f320adf030e020e7b089bb905c2b81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83225a343bc3a5fa32f4f48c74674416" id="r_a83225a343bc3a5fa32f4f48c74674416"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#a83225a343bc3a5fa32f4f48c74674416">serif::compile_time_checks::fields_meanfield::AngularVelocity</a> = blocks::rotation::angular_velocity</td></tr>
<tr class="separator:a83225a343bc3a5fa32f4f48c74674416"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb93a5ab0cba6fb84ff913e4197be4de" id="r_acb93a5ab0cba6fb84ff913e4197be4de"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#acb93a5ab0cba6fb84ff913e4197be4de">serif::compile_time_checks::fields_meanfield::ScalarL2</a> = spaces::DiscreteFunctionalSpace&lt;spaces::L2, 2, 0&gt;</td></tr>
<tr class="separator:acb93a5ab0cba6fb84ff913e4197be4de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a975007328dfad276e7fbed50ce7ebbed" id="r_a975007328dfad276e7fbed50ce7ebbed"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#a975007328dfad276e7fbed50ce7ebbed">serif::compile_time_checks::fields_meanfield::VectorH1</a> = spaces::DiscreteFunctionalSpace&lt;spaces::H1, 3, 1&gt;</td></tr>
<tr class="separator:a975007328dfad276e7fbed50ce7ebbed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44675014c354a2c2cc0402dda781c51c" id="r_a44675014c354a2c2cc0402dda781c51c"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#a44675014c354a2c2cc0402dda781c51c">serif::compile_time_checks::fields_meanfield::VectorRT</a> = spaces::DiscreteFunctionalSpace&lt;spaces::Hdiv, 2, 1&gt;</td></tr>
<tr class="separator:a44675014c354a2c2cc0402dda781c51c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a1e3d7bf6259aa4240d15d3e29fa53a" id="r_a7a1e3d7bf6259aa4240d15d3e29fa53a"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#a7a1e3d7bf6259aa4240d15d3e29fa53a">serif::compile_time_checks::fields_meanfield::VectorND</a> = spaces::DiscreteFunctionalSpace&lt;spaces::Hcurl, 2, 1&gt;</td></tr>
<tr class="separator:a7a1e3d7bf6259aa4240d15d3e29fa53a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc7d0a768b397f3dba11c1d26a3e9692" id="r_adc7d0a768b397f3dba11c1d26a3e9692"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#adc7d0a768b397f3dba11c1d26a3e9692">serif::compile_time_checks::fields_meanfield::GradientOperand</a> = forms::Operand&lt;<a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#a304f08b6c15bfec4059c468f931b1c07">Density</a>, forms::Operation::Gradient&gt;</td></tr>
<tr class="separator:adc7d0a768b397f3dba11c1d26a3e9692"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4fab316c39b4201fe84dfd88c34024f" id="r_ab4fab316c39b4201fe84dfd88c34024f"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#ab4fab316c39b4201fe84dfd88c34024f">serif::compile_time_checks::fields_meanfield::DivergenceOperand</a> = forms::Operand&lt;<a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#afea6cde56a3043b59244b4bca67e0669">Displacement</a>, forms::Operation::Divergence&gt;</td></tr>
<tr class="separator:ab4fab316c39b4201fe84dfd88c34024f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a916a158c391c80387c723a030ea87e01" id="r_a916a158c391c80387c723a030ea87e01"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#a916a158c391c80387c723a030ea87e01">serif::compile_time_checks::fields_meanfield::Keys</a> = dependencies::Bindings&lt;dependencies::Binding&lt;int, int&gt;, dependencies::Binding&lt;double, double&gt;, dependencies::Binding&lt;char, char&gt;&gt;</td></tr>
<tr class="separator:a916a158c391c80387c723a030ea87e01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc9f94359c39a0f90d474f6220532f1f" id="r_adc9f94359c39a0f90d474f6220532f1f"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#adc9f94359c39a0f90d474f6220532f1f">serif::compile_time_checks::fields_meanfield::DensityOperand</a> = forms::Operand&lt;<a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#a304f08b6c15bfec4059c468f931b1c07">Density</a>&gt;</td></tr>
<tr class="separator:adc9f94359c39a0f90d474f6220532f1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63da1770863aebfc6e9e746079271640" id="r_a63da1770863aebfc6e9e746079271640"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#a63da1770863aebfc6e9e746079271640">serif::compile_time_checks::fields_meanfield::DisplacementOperand</a> = forms::Operand&lt;<a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#afea6cde56a3043b59244b4bca67e0669">Displacement</a>&gt;</td></tr>
<tr class="separator:a63da1770863aebfc6e9e746079271640"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a709cbc68c6465a86bbb50b2e66f5bbae" id="r_a709cbc68c6465a86bbb50b2e66f5bbae"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#a709cbc68c6465a86bbb50b2e66f5bbae">serif::compile_time_checks::fields_meanfield::DivergenceSample</a> = forms::Operand&lt;<a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#afea6cde56a3043b59244b4bca67e0669">Displacement</a>, forms::Operation::Divergence&gt;</td></tr>
<tr class="separator:a709cbc68c6465a86bbb50b2e66f5bbae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb361d14c4004da157041d50ac714220" id="r_abb361d14c4004da157041d50ac714220"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#abb361d14c4004da157041d50ac714220">serif::compile_time_checks::fields_meanfield::PotentialOperand</a> = forms::Operand&lt;<a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#adb9b366add2a5f25ca616716b078eb73">Potential</a>&gt;</td></tr>
<tr class="separator:abb361d14c4004da157041d50ac714220"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94910d06b3750daf9976b757c2c36604" id="r_a94910d06b3750daf9976b757c2c36604"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#a94910d06b3750daf9976b757c2c36604">serif::compile_time_checks::fields_meanfield::OrderedSamples</a> = <a class="el" href="structserif_1_1equations_1_1_operand_values.html">equations::OperandValues</a>&lt;<a class="el" href="structserif_1_1utils_1_1types_1_1_type_list.html">utils::types::TypeList</a>&lt;<a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#adc9f94359c39a0f90d474f6220532f1f">DensityOperand</a>, <a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#a63da1770863aebfc6e9e746079271640">DisplacementOperand</a>, <a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#a709cbc68c6465a86bbb50b2e66f5bbae">DivergenceSample</a>, <a class="el" href="namespaceserif_1_1compile__time__checks_1_1fields__meanfield.html#abb361d14c4004da157041d50ac714220">PotentialOperand</a>&gt;&gt;</td></tr>
<tr class="separator:a94910d06b3750daf9976b757c2c36604"><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_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_3cfa701da308848783cbfc48c580ef0c.html">discretization</a></li><li class="navelem"><a class="el" href="fields__meanfield_8cpp.html">fields_meanfield.cpp</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>