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

181 lines
14 KiB
HTML
Raw Permalink 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/backend/mfem/solver/preconditioner/computations/inverse.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('computations_2inverse_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> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">inverse.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;concepts&gt;</code><br />
<code>#include &quot;<a class="el" href="errors_8hpp.html">serif/utils/error/errors.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="block_8hpp.html">serif/solver/preconditioner/recipes/block.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="solver_2preconditioner_2computations_2physical__blocks_8hpp.html">serif/backend/mfem/solver/preconditioner/computations/physical_blocks.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="backend_2mfem_2solver_2preconditioner_2inverse_2diagonal_8hpp.html">serif/backend/mfem/solver/preconditioner/inverse/diagonal.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="backend_2mfem_2solver_2preconditioner_2inverse_2dense_8hpp.html">serif/backend/mfem/solver/preconditioner/inverse/dense.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="amg_8hpp.html">serif/backend/mfem/solver/preconditioner/inverse/amg.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="backend_2mfem_2solver_2preconditioner_2inverse_2sparse__direct_8hpp.html">serif/backend/mfem/solver/preconditioner/inverse/sparse_direct.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="solver_2preconditioner_2strategies_2inverse_2diagonal_8hpp.html">serif/solver/preconditioner/strategies/inverse/diagonal.hpp</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for inverse.hpp:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="computations_2inverse_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="computations_2inverse_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_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_1preconditioner.html">serif::solver::preconditioner</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_1preconditioner_1_1computations.html">serif::solver::preconditioner::computations</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:a11cc41ea1cdbb6deaee475a3b93fd01e" id="r_a11cc41ea1cdbb6deaee475a3b93fd01e"><td class="memTemplParams" colspan="2">template&lt;typename Strategy&gt; </td></tr>
<tr class="memitem:a11cc41ea1cdbb6deaee475a3b93fd01e"><td class="memTemplItemLeft" align="right" valign="top">std::expected&lt; <a class="el" href="structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_inverse.html">backend::mfem::Inverse</a>, <a class="el" href="structserif_1_1solver_1_1preconditioner_1_1_failure.html">Failure</a> &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1preconditioner_1_1computations.html#a11cc41ea1cdbb6deaee475a3b93fd01e">serif::solver::preconditioner::computations::invert_matrix</a> (std::shared_ptr&lt; const ::mfem::SparseMatrix &gt; matrix, const Strategy &amp;strategy)</td></tr>
<tr class="memdesc:a11cc41ea1cdbb6deaee475a3b93fd01e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invert an assembled selected matrix with the chosen dense, sparse direct or AMG backend. <br /></td></tr>
<tr class="separator:a11cc41ea1cdbb6deaee475a3b93fd01e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e68f4ddc06181dc9077cb41a6c795d5" id="r_a4e68f4ddc06181dc9077cb41a6c795d5"><td class="memTemplParams" colspan="2">template&lt;typename Row, typename Field, typename Strategy&gt; </td></tr>
<tr class="memitem:a4e68f4ddc06181dc9077cb41a6c795d5"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1preconditioner_1_1computations.html#a4e68f4ddc06181dc9077cb41a6c795d5">serif::solver::preconditioner::computations::inverse</a> (const <a class="el" href="structserif_1_1solver_1_1preconditioner_1_1_block_preconditioner.html">BlockPreconditioner</a>&lt; Row, Field, Strategy &gt; &amp;choice)</td></tr>
<tr class="memdesc:a4e68f4ddc06181dc9077cb41a6c795d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Declare only the numerical inputs required by this chosen inverse. <br /></td></tr>
<tr class="separator:a4e68f4ddc06181dc9077cb41a6c795d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:afc4d578568cdd7687de4cf6ec35e1a7a" id="r_afc4d578568cdd7687de4cf6ec35e1a7a"><td class="memTemplParams" colspan="2">template&lt;typename Strategy&gt; </td></tr>
<tr class="memitem:afc4d578568cdd7687de4cf6ec35e1a7a"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1preconditioner_1_1computations.html#afc4d578568cdd7687de4cf6ec35e1a7a">serif::solver::preconditioner::computations::needs_diagonal</a> = std::same_as&lt;Strategy, <a class="el" href="structserif_1_1solver_1_1preconditioner_1_1strategies_1_1inverse_1_1_diagonal.html">strategies::inverse::Diagonal</a>&gt;</td></tr>
<tr class="memdesc:afc4d578568cdd7687de4cf6ec35e1a7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Identify the inverse strategies whose setup consumes a physical diagonal. <br /></td></tr>
<tr class="separator:afc4d578568cdd7687de4cf6ec35e1a7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ba4b3dda292223071f5125eb3bc373c" id="r_a7ba4b3dda292223071f5125eb3bc373c"><td class="memTemplParams" colspan="2">template&lt;typename Strategy&gt; </td></tr>
<tr class="memitem:a7ba4b3dda292223071f5125eb3bc373c"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1preconditioner_1_1computations.html#a7ba4b3dda292223071f5125eb3bc373c">serif::solver::preconditioner::computations::needs_matrix</a></td></tr>
<tr class="memdesc:a7ba4b3dda292223071f5125eb3bc373c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Identify strategies requiring an explicitly assembled selected matrix. <br /></td></tr>
<tr class="separator:a7ba4b3dda292223071f5125eb3bc373c"><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_518c5782990baa988ca590b53b43636d.html">solver</a></li><li class="navelem"><a class="el" href="dir_1da60a816fe87925e099d568f38264ad.html">preconditioner</a></li><li class="navelem"><a class="el" href="dir_890edf153782a2d37862b215a77d436c.html">computations</a></li><li class="navelem"><a class="el" href="computations_2inverse_8hpp.html">inverse.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