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

199 lines
17 KiB
HTML
Raw 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/geometry/deformation/actions.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"/>
</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('actions_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="#concepts">Concepts</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">actions.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;algorithm&gt;</code><br />
<code>#include &lt;concepts&gt;</code><br />
<code>#include &lt;span&gt;</code><br />
<code>#include &quot;<a class="el" href="failure_8hpp.html">serif/geometry/deformation/failure.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="action__storage_8hpp.html">serif/geometry/deformation/detail/action_storage.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="spaces_8hpp.html">serif/geometry/deformation/spaces.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="geometry_2deformation_2workspace_8hpp.html">serif/geometry/deformation/workspace.hpp</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for actions.hpp:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="actions_8hpp__incl.svg" width="100%" height="527"><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="actions_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_1deformation.html">serif::geometry::deformation</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_1geometry_1_1deformation_1_1_deformation_dimensions.html">serif::geometry::deformation::DeformationDimensions</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Matching lengths never replace the physical meanings of the input and output spaces. <br /></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_1geometry_1_1deformation_1_1_linear_deformation_map.html">serif::geometry::deformation::LinearDeformationMap</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fixed maps provide just forward and transpose actions with caller-owned scratch. <br /></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_1geometry_1_1deformation_1_1_differentiable_deformation_map.html">serif::geometry::deformation::DifferentiableDeformationMap</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Nonlinear maps explicitly provide every term needed by a Newton force pullback. <br /></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_1geometry_1_1deformation_1_1_deformation_map.html">serif::geometry::deformation::DeformationMap</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:aa3ab7cc89a2262523938808363fda865" id="r_aa3ab7cc89a2262523938808363fda865"><td class="memTemplParams" colspan="2">template&lt;DeformationMap Map&gt; </td></tr>
<tr class="memitem:aa3ab7cc89a2262523938808363fda865"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="namespaceserif_1_1geometry_1_1deformation.html#ae1f99a74025eac52e6ff4a4b77fb41c6">DeformationWorkspace</a>&lt; Map &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1geometry_1_1deformation.html#aa3ab7cc89a2262523938808363fda865">serif::geometry::deformation::make_deformation_workspace</a> (const Map &amp;map)</td></tr>
<tr class="memdesc:aa3ab7cc89a2262523938808363fda865"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate action scratch explicitly, once per independent caller. <br /></td></tr>
<tr class="separator:aa3ab7cc89a2262523938808363fda865"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad539328115ca03a435d339f2c551a21b" id="r_ad539328115ca03a435d339f2c551a21b"><td class="memTemplParams" colspan="2">template&lt;DeformationMap Map&gt; </td></tr>
<tr class="memitem:ad539328115ca03a435d339f2c551a21b"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="namespaceserif_1_1geometry_1_1deformation.html#a08306ee593c172f4877facc061e98f97">DeformationStatus</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1geometry_1_1deformation.html#ad539328115ca03a435d339f2c551a21b">serif::geometry::deformation::build_displacement</a> (const Map &amp;map, std::span&lt; const double &gt; parameters, std::span&lt; double &gt; displacement, <a class="el" href="namespaceserif_1_1geometry_1_1deformation.html#ae1f99a74025eac52e6ff4a4b77fb41c6">DeformationWorkspace</a>&lt; Map &gt; &amp;workspace)</td></tr>
<tr class="memdesc:ad539328115ca03a435d339f2c551a21b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Evaluate physical displacement with caller-owned output and scratch. All action outputs must be disjoint from their inputs. Workspace storage is reserved for the map and must not supply public input or output spans. <br /></td></tr>
<tr class="separator:ad539328115ca03a435d339f2c551a21b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47622764fd6178445526c8b3d984a6b2" id="r_a47622764fd6178445526c8b3d984a6b2"><td class="memTemplParams" colspan="2">template&lt;DeformationMap Map&gt; </td></tr>
<tr class="memitem:a47622764fd6178445526c8b3d984a6b2"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="namespaceserif_1_1geometry_1_1deformation.html#a08306ee593c172f4877facc061e98f97">DeformationStatus</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1geometry_1_1deformation.html#a47622764fd6178445526c8b3d984a6b2">serif::geometry::deformation::apply_jacobian</a> (const Map &amp;map, std::span&lt; const double &gt; parameters, std::span&lt; const double &gt; direction, std::span&lt; double &gt; displacement_direction, <a class="el" href="namespaceserif_1_1geometry_1_1deformation.html#ae1f99a74025eac52e6ff4a4b77fb41c6">DeformationWorkspace</a>&lt; Map &gt; &amp;workspace)</td></tr>
<tr class="memdesc:a47622764fd6178445526c8b3d984a6b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Linear maps reuse their primal action; nonlinear maps supply their exact tangent. <br /></td></tr>
<tr class="separator:a47622764fd6178445526c8b3d984a6b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28c839bb898ee76ac62ceaddadcba6b1" id="r_a28c839bb898ee76ac62ceaddadcba6b1"><td class="memTemplParams" colspan="2">template&lt;DeformationMap Map&gt; </td></tr>
<tr class="memitem:a28c839bb898ee76ac62ceaddadcba6b1"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="namespaceserif_1_1geometry_1_1deformation.html#a08306ee593c172f4877facc061e98f97">DeformationStatus</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1geometry_1_1deformation.html#a28c839bb898ee76ac62ceaddadcba6b1">serif::geometry::deformation::apply_jacobian_transpose</a> (const Map &amp;map, std::span&lt; const double &gt; parameters, std::span&lt; const double &gt; displacement_dual, std::span&lt; double &gt; parameter_dual, <a class="el" href="namespaceserif_1_1geometry_1_1deformation.html#ae1f99a74025eac52e6ff4a4b77fb41c6">DeformationWorkspace</a>&lt; Map &gt; &amp;workspace)</td></tr>
<tr class="memdesc:a28c839bb898ee76ac62ceaddadcba6b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transfer virtual work from the displacement field to its independent shape coefficients. <br /></td></tr>
<tr class="separator:a28c839bb898ee76ac62ceaddadcba6b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5738813c140911a0c9ec69eec58af8e7" id="r_a5738813c140911a0c9ec69eec58af8e7"><td class="memTemplParams" colspan="2">template&lt;DeformationMap Map&gt; </td></tr>
<tr class="memitem:a5738813c140911a0c9ec69eec58af8e7"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="namespaceserif_1_1geometry_1_1deformation.html#a08306ee593c172f4877facc061e98f97">DeformationStatus</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1geometry_1_1deformation.html#a5738813c140911a0c9ec69eec58af8e7">serif::geometry::deformation::apply_pullback_derivative</a> (const Map &amp;map, std::span&lt; const double &gt; parameters, std::span&lt; const double &gt; direction, std::span&lt; const double &gt; displacement_dual, std::span&lt; double &gt; parameter_dual, <a class="el" href="namespaceserif_1_1geometry_1_1deformation.html#ae1f99a74025eac52e6ff4a4b77fb41c6">DeformationWorkspace</a>&lt; Map &gt; &amp;workspace)</td></tr>
<tr class="memdesc:a5738813c140911a0c9ec69eec58af8e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Differentiate the transpose at fixed dual; zero is justified only for a declared linear map. <br /></td></tr>
<tr class="separator:a5738813c140911a0c9ec69eec58af8e7"><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:a6947f0057c614e85f67ad79f50a11606" id="r_a6947f0057c614e85f67ad79f50a11606"><td class="memTemplParams" colspan="2">template&lt;typename Map&gt; </td></tr>
<tr class="memitem:a6947f0057c614e85f67ad79f50a11606"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1geometry_1_1deformation.html#a6947f0057c614e85f67ad79f50a11606">serif::geometry::deformation::is_linear_deformation</a></td></tr>
<tr class="memdesc:a6947f0057c614e85f67ad79f50a11606"><td class="mdescLeft">&#160;</td><td class="mdescRight">Linearity is an explicit property of the mathematics, independent of its action interface. <br /></td></tr>
<tr class="separator:a6947f0057c614e85f67ad79f50a11606"><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_afafc166fe2ea9700a3140fe454efa1d.html">geometry</a></li><li class="navelem"><a class="el" href="dir_2e095eeaef83a6faaaa668f548cd1d95.html">deformation</a></li><li class="navelem"><a class="el" href="actions_8hpp.html">actions.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