Emily Boudreaux
6b57738330
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)
199 lines
17 KiB
HTML
199 lines
17 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/relation/validation/runtime.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"> 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&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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&dn=expat.txt MIT */
|
|
$(function(){initNavTree('discretization_2domain_2relation_2validation_2runtime_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> |
|
|
<a href="#namespaces">Namespaces</a> |
|
|
<a href="#enum-members">Enumerations</a> </div>
|
|
<div class="headertitle"><div class="title">runtime.hpp File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>This file contains the runtime validation results for relations in the domain module.
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include <cstdint></code><br />
|
|
<code>#include <optional></code><br />
|
|
</div><div class="textblock"><div class="dynheader">
|
|
Include dependency graph for runtime.hpp:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><iframe scrolling="no" frameborder="0" src="discretization_2domain_2relation_2validation_2runtime_8hpp__incl.svg" width="206" height="140"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></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_2relation_2validation_2runtime_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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structserif_1_1discretization_1_1domain_1_1relation_1_1validation_1_1_relation_validation_result.html">serif::discretization::domain::relation::validation::RelationValidationResult</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Struct representing the result of validating a relation in the domain module. It contains information about the validation failure, if any, and optional diagnostics for specific relation types. <a href="structserif_1_1discretization_1_1domain_1_1relation_1_1validation_1_1_relation_validation_result.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structserif_1_1discretization_1_1domain_1_1relation_1_1validation_1_1_relation_validation_result_1_1_inscribed_diagnostics.html">serif::discretization::domain::relation::validation::RelationValidationResult::InscribedDiagnostics</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Optional diagnostics for the <a class="el" href="structserif_1_1discretization_1_1domain_1_1relation_1_1_inscribed.html" title="Compile time type representing the inscribed relation between two domains or sets....">Inscribed</a> relation type. It contains information about the face ID, inner element ID, adjacent element ID, and adjacent domain ID. <a href="structserif_1_1discretization_1_1domain_1_1relation_1_1validation_1_1_relation_validation_result_1_1_inscribed_diagnostics.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structserif_1_1discretization_1_1domain_1_1relation_1_1validation_1_1_relation_validation_result_1_1_connected_diagnostics.html">serif::discretization::domain::relation::validation::RelationValidationResult::ConnectedDiagnostics</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Optional diagnostics for the <a class="el" href="structserif_1_1discretization_1_1domain_1_1relation_1_1_fully_connected.html" title="Compile time type representing the fully connected relation for a domain or set. This relation states...">FullyConnected</a> relation type. It contains information about the element ID, domain element count, and visited element count. <a href="structserif_1_1discretization_1_1domain_1_1relation_1_1validation_1_1_relation_validation_result_1_1_connected_diagnostics.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structserif_1_1discretization_1_1domain_1_1relation_1_1validation_1_1_relation_validation_result2d933b2660bf71414f66ae9856547ea2.html">serif::discretization::domain::relation::validation::RelationValidationResult::DomainBoundaryDiagnostics</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Optional diagnostics for the <a class="el" href="structserif_1_1discretization_1_1domain_1_1relation_1_1_domain_boundary.html" title="Compile time type representing the domain boundary relation between a boundary and one or two domains...">DomainBoundary</a> relation type. It contains information about the face ID, boundary element ID, expected boundary ID, actual boundary ID, first element ID, second element ID, first domain ID, and second domain ID. <a href="structserif_1_1discretization_1_1domain_1_1relation_1_1validation_1_1_relation_validation_result2d933b2660bf71414f66ae9856547ea2.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </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  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif.html">serif</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace  </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"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace  </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"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1discretization_1_1domain_1_1relation.html">serif::discretization::domain::relation</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation.html">serif::discretization::domain::relation::validation</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:afb547c803b70b3013bc47f86612b950f" id="r_afb547c803b70b3013bc47f86612b950f"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation.html#afb547c803b70b3013bc47f86612b950f">serif::discretization::domain::relation::validation::RelationValidationFailure</a> : std::uint8_t { <br />
|
|
  <a class="el" href="namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation.html#afb547c803b70b3013bc47f86612b950fa6adf97f83acf6453d4a6a4b1070f3754">serif::discretization::domain::relation::validation::None</a>
|
|
, <a class="el" href="namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation.html#afb547c803b70b3013bc47f86612b950fa355d761265a042dc6be71ea792ea20c4">serif::discretization::domain::relation::validation::DomainAbsent</a>
|
|
, <a class="el" href="namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation.html#afb547c803b70b3013bc47f86612b950fa1c14c1cb58bf588d3131c59f92179012">serif::discretization::domain::relation::validation::DomainDisconnected</a>
|
|
, <a class="el" href="namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation.html#afb547c803b70b3013bc47f86612b950faa72a681195224d541f38bd31b03223de">serif::discretization::domain::relation::validation::InnerDomainAbsent</a>
|
|
, <br />
|
|
  <a class="el" href="namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation.html#afb547c803b70b3013bc47f86612b950fa1228b67df9678cf4d1006e94146ca602">serif::discretization::domain::relation::validation::OuterDomainAbsent</a>
|
|
, <a class="el" href="namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation.html#afb547c803b70b3013bc47f86612b950fa0e38db080562dbbdafc7fa5819088f89">serif::discretization::domain::relation::validation::InnerDomainHasNoBoundary</a>
|
|
, <a class="el" href="namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation.html#afb547c803b70b3013bc47f86612b950fa41cc8523b0e010f30a117fb39145199e">serif::discretization::domain::relation::validation::InnerDomainTouchesMeshBoundary</a>
|
|
, <a class="el" href="namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation.html#afb547c803b70b3013bc47f86612b950fa33c56b1aa7d30d6a7bcd2d576a0b4662">serif::discretization::domain::relation::validation::InnerDomainTouchesUnexpectedDomain</a>
|
|
, <br />
|
|
  <a class="el" href="namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation.html#afb547c803b70b3013bc47f86612b950fa5f14a6ab18d4de57ce1ec408c6e79c95">serif::discretization::domain::relation::validation::DomainBoundaryAbsent</a>
|
|
, <a class="el" href="namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation.html#afb547c803b70b3013bc47f86612b950fa9747eaa32e0a514aec0d311617fa419c">serif::discretization::domain::relation::validation::DomainBoundaryTaggedFaceHasWrongTopology</a>
|
|
, <a class="el" href="namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation.html#afb547c803b70b3013bc47f86612b950fa0da6fceb2d57be6d269f9e25c1650e12">serif::discretization::domain::relation::validation::DomainBoundaryTaggedFaceTouchesUnexpectedDomain</a>
|
|
, <a class="el" href="namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation.html#afb547c803b70b3013bc47f86612b950fa331c24d39833e45b04bbea3df0e8ac25">serif::discretization::domain::relation::validation::DomainBoundaryExpectedFaceIsUntagged</a>
|
|
, <br />
|
|
  <a class="el" href="namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation.html#afb547c803b70b3013bc47f86612b950fa6fc65064792d46b5232872e15ea59886">serif::discretization::domain::relation::validation::DomainBoundaryExpectedFaceHasWrongID</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:afb547c803b70b3013bc47f86612b950f"><td class="mdescLeft"> </td><td class="mdescRight">Enum representing the types of validation failures that can occur when validating relations in the domain module. <a href="namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation.html#afb547c803b70b3013bc47f86612b950f">More...</a><br /></td></tr>
|
|
<tr class="separator:afb547c803b70b3013bc47f86612b950f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>This file contains the runtime validation results for relations 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="dir_3e1afeb017c9b96ed8668d5d9a3c288f.html">relation</a></li><li class="navelem"><a class="el" href="dir_be5a85120bd646759a01e0e790f0635a.html">validation</a></li><li class="navelem"><a class="el" href="discretization_2domain_2relation_2validation_2runtime_8hpp.html">runtime.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>
|