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)
79 lines
8.0 KiB
TeX
79 lines
8.0 KiB
TeX
\doxysection{src/include/serif/discretization/domain/relation/validation/runtime.hpp File Reference}
|
|
\hypertarget{discretization_2domain_2relation_2validation_2runtime_8hpp}{}\label{discretization_2domain_2relation_2validation_2runtime_8hpp}\index{src/include/serif/discretization/domain/relation/validation/runtime.hpp@{src/include/serif/discretization/domain/relation/validation/runtime.hpp}}
|
|
|
|
|
|
This file contains the runtime validation results for relations in the domain module.
|
|
|
|
|
|
{\ttfamily \#include $<$cstdint$>$}\newline
|
|
{\ttfamily \#include $<$optional$>$}\newline
|
|
Include dependency graph for runtime.\+hpp\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=226pt]{discretization_2domain_2relation_2validation_2runtime_8hpp__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
This graph shows which files directly or indirectly include this file\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{discretization_2domain_2relation_2validation_2runtime_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1relation_1_1validation_1_1_relation_validation_result}{serif\+::discretization\+::domain\+::relation\+::validation\+::\+Relation\+Validation\+Result}}
|
|
\begin{DoxyCompactList}\small\item\em 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. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1relation_1_1validation_1_1_relation_validation_result_1_1_inscribed_diagnostics}{serif\+::discretization\+::domain\+::relation\+::validation\+::\+Relation\+Validation\+Result\+::\+Inscribed\+Diagnostics}}
|
|
\begin{DoxyCompactList}\small\item\em Optional diagnostics for the \doxylink{structserif_1_1discretization_1_1domain_1_1relation_1_1_inscribed}{Inscribed} relation type. It contains information about the face ID, inner element ID, adjacent element ID, and adjacent domain ID. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1relation_1_1validation_1_1_relation_validation_result_1_1_connected_diagnostics}{serif\+::discretization\+::domain\+::relation\+::validation\+::\+Relation\+Validation\+Result\+::\+Connected\+Diagnostics}}
|
|
\begin{DoxyCompactList}\small\item\em Optional diagnostics for the \doxylink{structserif_1_1discretization_1_1domain_1_1relation_1_1_fully_connected}{Fully\+Connected} relation type. It contains information about the element ID, domain element count, and visited element count. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1relation_1_1validation_1_1_relation_validation_result2d933b2660bf71414f66ae9856547ea2}{serif\+::discretization\+::domain\+::relation\+::validation\+::\+Relation\+Validation\+Result\+::\+Domain\+Boundary\+Diagnostics}}
|
|
\begin{DoxyCompactList}\small\item\em Optional diagnostics for the \doxylink{structserif_1_1discretization_1_1domain_1_1relation_1_1_domain_boundary}{Domain\+Boundary} 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. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1discretization}{serif\+::discretization}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain}{serif\+::discretization\+::domain}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1relation}{serif\+::discretization\+::domain\+::relation}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation}{serif\+::discretization\+::domain\+::relation\+::validation}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Enumerations}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
enum class \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation_afb547c803b70b3013bc47f86612b950f}{serif\+::discretization\+::domain\+::relation\+::validation\+::\+Relation\+Validation\+Failure}} \+: std\+::uint8\+\_\+t \{ \newline
|
|
\mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation_afb547c803b70b3013bc47f86612b950fa6adf97f83acf6453d4a6a4b1070f3754}{serif\+::discretization\+::domain\+::relation\+::validation\+::\+None}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation_afb547c803b70b3013bc47f86612b950fa355d761265a042dc6be71ea792ea20c4}{serif\+::discretization\+::domain\+::relation\+::validation\+::\+Domain\+Absent}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation_afb547c803b70b3013bc47f86612b950fa1c14c1cb58bf588d3131c59f92179012}{serif\+::discretization\+::domain\+::relation\+::validation\+::\+Domain\+Disconnected}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation_afb547c803b70b3013bc47f86612b950faa72a681195224d541f38bd31b03223de}{serif\+::discretization\+::domain\+::relation\+::validation\+::\+Inner\+Domain\+Absent}}
|
|
, \newline
|
|
\mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation_afb547c803b70b3013bc47f86612b950fa1228b67df9678cf4d1006e94146ca602}{serif\+::discretization\+::domain\+::relation\+::validation\+::\+Outer\+Domain\+Absent}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation_afb547c803b70b3013bc47f86612b950fa0e38db080562dbbdafc7fa5819088f89}{serif\+::discretization\+::domain\+::relation\+::validation\+::\+Inner\+Domain\+Has\+No\+Boundary}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation_afb547c803b70b3013bc47f86612b950fa41cc8523b0e010f30a117fb39145199e}{serif\+::discretization\+::domain\+::relation\+::validation\+::\+Inner\+Domain\+Touches\+Mesh\+Boundary}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation_afb547c803b70b3013bc47f86612b950fa33c56b1aa7d30d6a7bcd2d576a0b4662}{serif\+::discretization\+::domain\+::relation\+::validation\+::\+Inner\+Domain\+Touches\+Unexpected\+Domain}}
|
|
, \newline
|
|
\mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation_afb547c803b70b3013bc47f86612b950fa5f14a6ab18d4de57ce1ec408c6e79c95}{serif\+::discretization\+::domain\+::relation\+::validation\+::\+Domain\+Boundary\+Absent}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation_afb547c803b70b3013bc47f86612b950fa9747eaa32e0a514aec0d311617fa419c}{serif\+::discretization\+::domain\+::relation\+::validation\+::\+Domain\+Boundary\+Tagged\+Face\+Has\+Wrong\+Topology}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation_afb547c803b70b3013bc47f86612b950fa0da6fceb2d57be6d269f9e25c1650e12}{serif\+::discretization\+::domain\+::relation\+::validation\+::\+Domain\+Boundary\+Tagged\+Face\+Touches\+Unexpected\+Domain}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation_afb547c803b70b3013bc47f86612b950fa331c24d39833e45b04bbea3df0e8ac25}{serif\+::discretization\+::domain\+::relation\+::validation\+::\+Domain\+Boundary\+Expected\+Face\+Is\+Untagged}}
|
|
, \newline
|
|
\mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1relation_1_1validation_afb547c803b70b3013bc47f86612b950fa6fc65064792d46b5232872e15ea59886}{serif\+::discretization\+::domain\+::relation\+::validation\+::\+Domain\+Boundary\+Expected\+Face\+Has\+Wrong\+ID}}
|
|
\}
|
|
\begin{DoxyCompactList}\small\item\em Enum representing the types of validation failures that can occur when validating relations in the domain module. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
This file contains the runtime validation results for relations in the domain module.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|