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

225 lines
20 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/discretization/domain/concepts.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('discretization_2domain_2concepts_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> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">concepts.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>File containing concepts for the domain module. These concepts are used to constrain template parameters in the domain module.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;cstddef&gt;</code><br />
<code>#include &lt;string_view&gt;</code><br />
<code>#include &lt;span&gt;</code><br />
<code>#include &lt;array&gt;</code><br />
<code>#include &lt;format&gt;</code><br />
<code>#include &lt;numeric&gt;</code><br />
<code>#include &quot;<a class="el" href="discretization_2domain_2types_8hpp.html">serif/discretization/domain/types.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="cleaning_8hpp.html">serif/utils/misc/std_helper/cleaning.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="variadic__cleaning_8hpp.html">serif/utils/misc/std_helper/variadic_cleaning.hpp</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for concepts.hpp:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="discretization_2domain_2concepts_8hpp__incl.svg" width="100%" height="460"><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="discretization_2domain_2concepts_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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structserif_1_1discretization_1_1domain_1_1_domain_set.html">serif::discretization::domain::DomainSet&lt; DomainTs &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="el" href="structserif_1_1discretization_1_1domain_1_1_domain_set.html" title="A DomainSet is a collection of domains. It is used to group multiple domains together for convenience...">DomainSet</a> is a collection of domains. It is used to group multiple domains together for convenience. <a href="structserif_1_1discretization_1_1domain_1_1_domain_set.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_1domain_1_1_domain_or_set.html">serif::discretization::domain::DomainOrSet</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="el" href="classserif_1_1discretization_1_1domain_1_1_domain_or_set.html" title="A DomainOrSet is a type that can represent either a single domain or a set of domains.">DomainOrSet</a> is a type that can represent either a single domain or a set of domains. <a href="classserif_1_1discretization_1_1domain_1_1_domain_or_set.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structserif_1_1discretization_1_1domain_1_1_boundary_set.html">serif::discretization::domain::BoundarySet&lt; BoundaryTs &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="el" href="structserif_1_1discretization_1_1domain_1_1_boundary_set.html" title="A BoundarySet is a collection of boundaries. It is used to group multiple boundaries together for con...">BoundarySet</a> is a collection of boundaries. It is used to group multiple boundaries together for convenience. <a href="structserif_1_1discretization_1_1domain_1_1_boundary_set.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structserif_1_1discretization_1_1domain_1_1_domain_or_set_list.html">serif::discretization::domain::DomainOrSetList&lt; DomainTs &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A list of <a class="el" href="classserif_1_1discretization_1_1domain_1_1_domain_or_set.html" title="A DomainOrSet is a type that can represent either a single domain or a set of domains.">DomainOrSet</a> types. <a href="structserif_1_1discretization_1_1domain_1_1_domain_or_set_list.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structstd_1_1formatter_3_01serif_1_1discretization_1_1domain_1_1_domain_or_set_01_4.html">std::formatter&lt; serif::discretization::domain::DomainOrSet &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specialization of std::formatter for DomainOrSet. This allows us to use std::format to format DomainOrSet objects. <a href="structstd_1_1formatter_3_01serif_1_1discretization_1_1domain_1_1_domain_or_set_01_4.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_1domain.html">serif::discretization::domain</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_1domain_1_1_is_domain.html">serif::discretization::domain::IsDomain</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">&lt; <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_1discretization_1_1domain_1_1_is_boundary.html">serif::discretization::domain::IsBoundary</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A Boundary is a surface in the mesh. It is a base class for all boundary types. <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_1discretization_1_1domain_1_1_is_domain_set.html">serif::discretization::domain::IsDomainSet</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A concept to determine if a type is a DomainSet. A type is a DomainSet if it satisfies the is_domain_set_v trait. <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_1discretization_1_1domain_1_1_is_domain_or_set.html">serif::discretization::domain::IsDomainOrSet</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A concept to determine if a type is a DomainOrSet. A type is a DomainOrSet if it is either a Domain or a DomainSet. <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_1discretization_1_1domain_1_1_domain_is_identified_by.html">serif::discretization::domain::DomainIsIdentifiedBy</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A concept to determine if a Domain type is identified by a DomainID type. A Domain type is identified by a DomainID type if the DomainID's domain_type is the same as the Domain type. <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_1discretization_1_1domain_1_1_boundary_is_identified_by.html">serif::discretization::domain::BoundaryIsIdentifiedBy</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A concept to determine if a Boundary type is identified by a BoundaryID type. A Boundary type is identified by a BoundaryID type if the BoundaryID's boundary_type is the same as the Boundary type. <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:a1b57d195e9d643b262222f5d50ed1dd0" id="r_a1b57d195e9d643b262222f5d50ed1dd0"><td class="memTemplParams" colspan="2">template&lt;typename... Ts&gt; </td></tr>
<tr class="memitem:a1b57d195e9d643b262222f5d50ed1dd0"><td class="memTemplItemLeft" align="right" valign="top">consteval std::size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1discretization_1_1domain.html#a1b57d195e9d643b262222f5d50ed1dd0">serif::discretization::domain::CountVariadicArguments</a> () noexcept</td></tr>
<tr class="memdesc:a1b57d195e9d643b262222f5d50ed1dd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">&lt; <br /></td></tr>
<tr class="separator:a1b57d195e9d643b262222f5d50ed1dd0"><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:af79faa141025275717dc28e8b3244c31" id="r_af79faa141025275717dc28e8b3244c31"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:af79faa141025275717dc28e8b3244c31"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1discretization_1_1domain.html#af79faa141025275717dc28e8b3244c31">serif::discretization::domain::is_domain_set_v</a> = false</td></tr>
<tr class="memdesc:af79faa141025275717dc28e8b3244c31"><td class="mdescLeft">&#160;</td><td class="mdescRight">A trait to determine if a type is a <a class="el" href="structserif_1_1discretization_1_1domain_1_1_domain_set.html" title="A DomainSet is a collection of domains. It is used to group multiple domains together for convenience...">DomainSet</a>. This is the default false specialization. <br /></td></tr>
<tr class="separator:af79faa141025275717dc28e8b3244c31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8cecaf8fc81e98a8e5fb613c8eca8be" id="r_af8cecaf8fc81e98a8e5fb613c8eca8be"><td class="memTemplParams" colspan="2">template&lt;IsDomain... DomainTs&gt; </td></tr>
<tr class="memitem:af8cecaf8fc81e98a8e5fb613c8eca8be"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1discretization_1_1domain.html#af8cecaf8fc81e98a8e5fb613c8eca8be">serif::discretization::domain::is_domain_set_v&lt; DomainSet&lt; DomainTs... &gt; &gt;</a> = true</td></tr>
<tr class="memdesc:af8cecaf8fc81e98a8e5fb613c8eca8be"><td class="mdescLeft">&#160;</td><td class="mdescRight">A trait to determine if a type is a <a class="el" href="structserif_1_1discretization_1_1domain_1_1_domain_set.html" title="A DomainSet is a collection of domains. It is used to group multiple domains together for convenience...">DomainSet</a>. This is the true specialization for <a class="el" href="structserif_1_1discretization_1_1domain_1_1_domain_set.html" title="A DomainSet is a collection of domains. It is used to group multiple domains together for convenience...">DomainSet</a> types. <br /></td></tr>
<tr class="separator:af8cecaf8fc81e98a8e5fb613c8eca8be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e9d22ad04a3b00122f90cb5ceea35e9" id="r_a5e9d22ad04a3b00122f90cb5ceea35e9"><td class="memTemplParams" colspan="2">template&lt;class Child, class Parent&gt; </td></tr>
<tr class="memitem:a5e9d22ad04a3b00122f90cb5ceea35e9"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1discretization_1_1domain.html#a5e9d22ad04a3b00122f90cb5ceea35e9">serif::discretization::domain::AIsBaseClassOfB</a></td></tr>
<tr class="separator:a5e9d22ad04a3b00122f90cb5ceea35e9"><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 concepts for the domain module. These concepts are used to constrain template parameters in the domain module. </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_7fd1bd470eaeb2bcec2963effbdf83df.html">discretization</a></li><li class="navelem"><a class="el" href="dir_6161f5b3f9e6a96adb8caf7d1db1a4dd.html">domain</a></li><li class="navelem"><a class="el" href="discretization_2domain_2concepts_8hpp.html">concepts.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>