Files
MeanField_SERiF/docs/html/boundary__trace_8hpp.html

193 lines
16 KiB
HTML
Raw Normal View History

<!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/discretization/boundary_trace.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__trace_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="#concepts">Concepts</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">boundary_trace.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>File containing the definition of the restricted dof space for a scalar boundary trace. Note in FEM a trace is a restriction on a function to the boundary of a domain. Therefore, This file contains the definitions for getting the DOFs at the boundary of a scalar field.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;memory&gt;</code><br />
<code>#include &lt;utility&gt;</code><br />
<code>#include &quot;mfem/linalg/sparsemat.hpp&quot;</code><br />
<code>#include &quot;<a class="el" href="dof__selection_8hpp.html">serif/backend/mfem/discretization/dof_selection.hpp</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for boundary_trace.hpp:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="boundary__trace_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__trace_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">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classserif_1_1discretization_1_1backend_1_1mfem_1_1_scalar_boundary_trace.html">serif::discretization::backend::mfem::ScalarBoundaryTrace</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An immutable scalar interpolation operator from supported coefficients to selected residual nodes. <a href="classserif_1_1discretization_1_1backend_1_1mfem_1_1_scalar_boundary_trace.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_1discretization.html">serif::discretization</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_1discretization_1_1backend.html">serif::discretization::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_1discretization_1_1backend_1_1mfem.html">serif::discretization::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_1discretization_1_1backend_1_1mfem_1_1detail.html">serif::discretization::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="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_1discretization_1_1backend_1_1mfem_1_1_boundary_trace_term.html">serif::discretization::backend::mfem::BoundaryTraceTerm</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Concept Limiting the input term to either a global scalar term or a spatial term of rank 0 in the H1 family. Outside of H1, the trace is a vector (e.g. the normal trace for a H(div) field or the tangential trace for a H(curl) field). Further, for higher rank H1 fields the trace is a tensor. <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="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ac0719d69343bbf19f9c3d6273c69736f" id="r_ac0719d69343bbf19f9c3d6273c69736f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classserif_1_1discretization_1_1backend_1_1mfem_1_1_scalar_boundary_trace.html">ScalarBoundaryTrace</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1discretization_1_1backend_1_1mfem_1_1detail.html#ac0719d69343bbf19f9c3d6273c69736f">serif::discretization::backend::mfem::detail::build_boundary_trace</a> (std::shared_ptr&lt; const <a class="el" href="classserif_1_1discretization_1_1backend_1_1mfem_1_1_dof_selection.html">DofSelection</a> &gt; rows, const <a class="el" href="classserif_1_1discretization_1_1backend_1_1mfem_1_1_dof_map.html">DofMap</a> &amp;input, const ::mfem::FiniteElementSpace *input_space)</td></tr>
<tr class="memdesc:ac0719d69343bbf19f9c3d6273c69736f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct one interpolation operator in the selected residual-node ordering. <br /></td></tr>
<tr class="separator:ac0719d69343bbf19f9c3d6273c69736f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf9041e682100fb2b68269bc58564a77" id="r_aaf9041e682100fb2b68269bc58564a77"><td class="memTemplParams" colspan="2">template&lt;BoundaryTraceTerm TermT, domain::schema::IsSchema SchemaT&gt; </td></tr>
<tr class="memitem:aaf9041e682100fb2b68269bc58564a77"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classserif_1_1discretization_1_1backend_1_1mfem_1_1_scalar_boundary_trace.html">ScalarBoundaryTrace</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1discretization_1_1backend_1_1mfem.html#aaf9041e682100fb2b68269bc58564a77">serif::discretization::backend::mfem::make_boundary_trace</a> (std::shared_ptr&lt; const <a class="el" href="classserif_1_1discretization_1_1backend_1_1mfem_1_1_dof_selection.html">DofSelection</a> &gt; rows, const <a class="el" href="classserif_1_1discretization_1_1backend_1_1mfem_1_1_term_binding.html">TermBinding</a>&lt; TermT, SchemaT &gt; &amp;input)</td></tr>
<tr class="memdesc:aaf9041e682100fb2b68269bc58564a77"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sample a continuous scalar field at the selected nodal H1 residual points. <br /></td></tr>
<tr class="separator:aaf9041e682100fb2b68269bc58564a77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4a98b89b1efb0ebdeb6d1fc2beda6ae" id="r_ab4a98b89b1efb0ebdeb6d1fc2beda6ae"><td class="memTemplParams" colspan="2">template&lt;BoundaryTraceTerm TermT, domain::schema::IsSchema SchemaT&gt; </td></tr>
<tr class="memitem:ab4a98b89b1efb0ebdeb6d1fc2beda6ae"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classserif_1_1discretization_1_1backend_1_1mfem_1_1_scalar_boundary_trace.html">ScalarBoundaryTrace</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1discretization_1_1backend_1_1mfem.html#ab4a98b89b1efb0ebdeb6d1fc2beda6ae">serif::discretization::backend::mfem::make_boundary_trace</a> (std::shared_ptr&lt; const <a class="el" href="classserif_1_1discretization_1_1backend_1_1mfem_1_1_dof_selection.html">DofSelection</a> &gt;, <a class="el" href="classserif_1_1discretization_1_1backend_1_1mfem_1_1_term_binding.html">TermBinding</a>&lt; TermT, SchemaT &gt; &amp;&amp;)=delete</td></tr>
<tr class="memdesc:ab4a98b89b1efb0ebdeb6d1fc2beda6ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">A trace borrows its input binding, so temporaries cannot supply its coefficient ordering. <br /></td></tr>
<tr class="separator:ab4a98b89b1efb0ebdeb6d1fc2beda6ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01137a1155cba1fb16ed3478b63f133e" id="r_a01137a1155cba1fb16ed3478b63f133e"><td class="memTemplParams" colspan="2">template&lt;BoundaryTraceTerm TermT, domain::schema::IsSchema SchemaT&gt; </td></tr>
<tr class="memitem:a01137a1155cba1fb16ed3478b63f133e"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classserif_1_1discretization_1_1backend_1_1mfem_1_1_scalar_boundary_trace.html">ScalarBoundaryTrace</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1discretization_1_1backend_1_1mfem.html#a01137a1155cba1fb16ed3478b63f133e">serif::discretization::backend::mfem::make_boundary_trace</a> (std::shared_ptr&lt; const <a class="el" href="classserif_1_1discretization_1_1backend_1_1mfem_1_1_dof_selection.html">DofSelection</a> &gt;, const <a class="el" href="classserif_1_1discretization_1_1backend_1_1mfem_1_1_term_binding.html">TermBinding</a>&lt; TermT, SchemaT &gt; &amp;&amp;)=delete</td></tr>
<tr class="memdesc:a01137a1155cba1fb16ed3478b63f133e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Const temporary bindings have the same lifetime restriction. <br /></td></tr>
<tr class="separator:a01137a1155cba1fb16ed3478b63f133e"><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 definition of the restricted dof space for a scalar boundary trace. Note in FEM a trace is a restriction on a function to the boundary of a domain. Therefore, This file contains the definitions for getting the DOFs at the boundary of a scalar field. </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_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_7f477ac1f4073d80fe2cf961b8371c78.html">discretization</a></li><li class="navelem"><a class="el" href="boundary__trace_8hpp.html">boundary_trace.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>