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

196 lines
18 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/backend/mfem/geometry/surface/boundary_rows.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('boundary__rows_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="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">boundary_rows.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="nonfinite_8hpp.html">serif/utils/error/nonfinite.hpp</a>&quot;</code><br />
<code>#include &lt;cmath&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
<code>#include &quot;<a class="el" href="boundary__data_8hpp.html">serif/backend/mfem/geometry/surface/boundary_data.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="surface_2linearization_8hpp.html">serif/geometry/surface/linearization.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="backend_2mfem_2shared_2finite_8hpp.html">serif/backend/mfem/shared/finite.hpp</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for boundary_rows.hpp:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="boundary__rows_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="boundary__rows_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="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_1geometry.html">serif::geometry</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_1geometry_1_1surface.html">serif::geometry::surface</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_1geometry_1_1surface_1_1backend.html">serif::geometry::surface::backend</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_1geometry_1_1surface_1_1backend_1_1mfem.html">serif::geometry::surface::backend::mfem</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_1geometry_1_1surface_1_1backend_1_1mfem_1_1detail.html">serif::geometry::surface::backend::mfem::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="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a27fe66a18a71f6fd61205eef47868c39" id="r_a27fe66a18a71f6fd61205eef47868c39"><td class="memTemplParams" colspan="2">template&lt;typename Boundary&gt; </td></tr>
<tr class="memitem:a27fe66a18a71f6fd61205eef47868c39"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem_1_1detail.html#a27fe66a18a71f6fd61205eef47868c39">serif::geometry::surface::backend::mfem::detail::validate_boundary_output</a> (const Boundary &amp;boundary, const ::mfem::Vector &amp;result)</td></tr>
<tr class="memdesc:a27fe66a18a71f6fd61205eef47868c39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check that an action uses the current discretization and the complete residual space. <br /></td></tr>
<tr class="separator:a27fe66a18a71f6fd61205eef47868c39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08671da2b86c96429ce9e40228d0ce76" id="r_a08671da2b86c96429ce9e40228d0ce76"><td class="memTemplParams" colspan="2">template&lt;typename Boundary, typename Linearizations&gt; </td></tr>
<tr class="memitem:a08671da2b86c96429ce9e40228d0ce76"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem_1_1detail.html#a08671da2b86c96429ce9e40228d0ce76">serif::geometry::surface::backend::mfem::detail::validate_boundary_samples</a> (const Boundary &amp;boundary, const Linearizations &amp;linearizations)</td></tr>
<tr class="memdesc:a08671da2b86c96429ce9e40228d0ce76"><td class="mdescLeft">&#160;</td><td class="mdescRight">The accepted graph result contains one local equation for each ordered boundary node. <br /></td></tr>
<tr class="separator:a08671da2b86c96429ce9e40228d0ce76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c68a968577da3435fc0eaa61548b280" id="r_a5c68a968577da3435fc0eaa61548b280"><td class="memTemplParams" colspan="2">template&lt;typename Boundary&gt; </td></tr>
<tr class="memitem:a5c68a968577da3435fc0eaa61548b280"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem_1_1detail.html#a5c68a968577da3435fc0eaa61548b280">serif::geometry::surface::backend::mfem::detail::replace_boundary_rows</a> (const Boundary &amp;boundary, const ::mfem::Vector &amp;values, ::mfem::Vector &amp;result)</td></tr>
<tr class="memdesc:a5c68a968577da3435fc0eaa61548b280"><td class="mdescLeft">&#160;</td><td class="mdescRight">Publish a complete finite action only after all input directions have been read. <br /></td></tr>
<tr class="separator:a5c68a968577da3435fc0eaa61548b280"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3aef217c72feba3437a305bad99dcade" id="r_a3aef217c72feba3437a305bad99dcade"><td class="memTemplParams" colspan="2">template&lt;typename Boundary, typename Linearizations, typename Directions, typename... Terms&gt; </td></tr>
<tr class="memitem:a3aef217c72feba3437a305bad99dcade"><td class="memTemplItemLeft" align="right" valign="top">::mfem::Vector&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem_1_1detail.html#a3aef217c72feba3437a305bad99dcade">serif::geometry::surface::backend::mfem::detail::boundary_jacobian_action</a> (const Boundary &amp;boundary, const Linearizations &amp;linearizations, const Directions &amp;directions, <a class="el" href="structserif_1_1utils_1_1dependencies_1_1_key_list.html">utils::dependencies::KeyList</a>&lt; Terms... &gt;)</td></tr>
<tr class="memdesc:a3aef217c72feba3437a305bad99dcade"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accumulate all physical couplings using the same traces that supplied the EOS state. <br /></td></tr>
<tr class="separator:a3aef217c72feba3437a305bad99dcade"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d791b98d3917126ed88a4278890d84d" id="r_a0d791b98d3917126ed88a4278890d84d"><td class="memTemplParams" colspan="2">template&lt;PressureBoundaryFormulation Formulation, typename Traces&gt; </td></tr>
<tr class="memitem:a0d791b98d3917126ed88a4278890d84d"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem.html#a0d791b98d3917126ed88a4278890d84d">serif::geometry::surface::backend::mfem::apply_residual_rows</a> (const <a class="el" href="structserif_1_1geometry_1_1surface_1_1backend_1_1mfem_1_1_pressure_boundary.html">PressureBoundary</a>&lt; Formulation, Traces &gt; &amp;boundary, const std::vector&lt; <a class="el" href="namespaceserif_1_1geometry_1_1surface.html#a38dcffacd50298452984a55e3c69b83a">SurfaceLinearization</a>&lt; Formulation &gt; &gt; &amp;linearizations, ::mfem::Vector &amp;result)</td></tr>
<tr class="memdesc:a0d791b98d3917126ed88a4278890d84d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Replace selected residual rows with a prepared isobaric equation, preserving all interior rows. <br /></td></tr>
<tr class="separator:a0d791b98d3917126ed88a4278890d84d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae18d2bb830863ac7dc30b6ccb142d241" id="r_ae18d2bb830863ac7dc30b6ccb142d241"><td class="memTemplParams" colspan="2">template&lt;PressureBoundaryFormulation Formulation, typename Traces, utils::dependencies::IsDependencyContext Directions&gt; <br />
requires utils::dependencies::SatisfiesKeyList&lt;typename Directions::Bindings, typename Formulation::StateTerms&gt;</td></tr>
<tr class="memitem:ae18d2bb830863ac7dc30b6ccb142d241"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem.html#ae18d2bb830863ac7dc30b6ccb142d241">serif::geometry::surface::backend::mfem::apply_jacobian_rows</a> (const <a class="el" href="structserif_1_1geometry_1_1surface_1_1backend_1_1mfem_1_1_pressure_boundary.html">PressureBoundary</a>&lt; Formulation, Traces &gt; &amp;boundary, const std::vector&lt; <a class="el" href="namespaceserif_1_1geometry_1_1surface.html#a38dcffacd50298452984a55e3c69b83a">SurfaceLinearization</a>&lt; Formulation &gt; &gt; &amp;linearizations, const Directions &amp;directions, ::mfem::Vector &amp;result)</td></tr>
<tr class="memdesc:ae18d2bb830863ac7dc30b6ccb142d241"><td class="mdescLeft">&#160;</td><td class="mdescRight">Replace full Jacobian rows, including every EOS input; directions may alias the output. <br /></td></tr>
<tr class="separator:ae18d2bb830863ac7dc30b6ccb142d241"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c9b62453a97aab2c9620c449338f8c3" id="r_a9c9b62453a97aab2c9620c449338f8c3"><td class="memTemplParams" colspan="2">template&lt;PressureBoundaryFormulation Formulation, typename Traces&gt; </td></tr>
<tr class="memitem:a9c9b62453a97aab2c9620c449338f8c3"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem.html#a9c9b62453a97aab2c9620c449338f8c3">serif::geometry::surface::backend::mfem::mask_residual_dual</a> (const <a class="el" href="structserif_1_1geometry_1_1surface_1_1backend_1_1mfem_1_1_pressure_boundary.html">PressureBoundary</a>&lt; Formulation, Traces &gt; &amp;boundary, const ::mfem::Vector &amp;dual, ::mfem::Vector &amp;volume_dual)</td></tr>
<tr class="memdesc:a9c9b62453a97aab2c9620c449338f8c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove the replaced rows before applying the volume Jacobian transpose. <br /></td></tr>
<tr class="separator:a9c9b62453a97aab2c9620c449338f8c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4de12dc375935718082ad3f1746ccdd5" id="r_a4de12dc375935718082ad3f1746ccdd5"><td class="memTemplParams" colspan="2">template&lt;typename Term, PressureBoundaryFormulation Formulation, typename Traces&gt; <br />
requires utils::dependencies::BindingsWithBinding&lt;typename Traces::Bindings, Term&gt;</td></tr>
<tr class="memitem:a4de12dc375935718082ad3f1746ccdd5"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem.html#a4de12dc375935718082ad3f1746ccdd5">serif::geometry::surface::backend::mfem::add_jacobian_transpose_rows</a> (const <a class="el" href="structserif_1_1geometry_1_1surface_1_1backend_1_1mfem_1_1_pressure_boundary.html">PressureBoundary</a>&lt; Formulation, Traces &gt; &amp;boundary, const std::vector&lt; <a class="el" href="namespaceserif_1_1geometry_1_1surface.html#a38dcffacd50298452984a55e3c69b83a">SurfaceLinearization</a>&lt; Formulation &gt; &gt; &amp;linearizations, const ::mfem::Vector &amp;dual, ::mfem::Vector &amp;result)</td></tr>
<tr class="memdesc:a4de12dc375935718082ad3f1746ccdd5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add one physical term's constrained-row transpose to its existing volume contribution. <br /></td></tr>
<tr class="separator:a4de12dc375935718082ad3f1746ccdd5"><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_5efd9e6a724a898950c58bd67170566f.html">backend</a></li><li class="navelem"><a class="el" href="dir_f4279ff9f0ade9101a3d0c95da9106b0.html">mfem</a></li><li class="navelem"><a class="el" href="dir_a06a86b96ba8029e601031e1f2191759.html">geometry</a></li><li class="navelem"><a class="el" href="dir_a0a8a2e97c8fae46d51581dbbab926be.html">surface</a></li><li class="navelem"><a class="el" href="boundary__rows_8hpp.html">boundary_rows.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>