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)
64 lines
5.0 KiB
TeX
64 lines
5.0 KiB
TeX
\doxysection{src/include/serif/discretization/domain/relation/relations.hpp File Reference}
|
|
\hypertarget{discretization_2domain_2relation_2relations_8hpp}{}\label{discretization_2domain_2relation_2relations_8hpp}\index{src/include/serif/discretization/domain/relation/relations.hpp@{src/include/serif/discretization/domain/relation/relations.hpp}}
|
|
|
|
|
|
This file defines compile time tags for the relations that can be declared about a mesh in the domain module. These are ultimately used to define a constrained mesh schema.
|
|
|
|
|
|
{\ttfamily \#include $<$string\+\_\+view$>$}\newline
|
|
{\ttfamily \#include "{}serif/discretization/domain/concepts.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/misc/concepts/numeric.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/misc/std\+\_\+helper/variadic\+\_\+cleaning.\+hpp"{}}\newline
|
|
Include dependency graph for relations.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{discretization_2domain_2relation_2relations_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_2relations_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1relation_1_1_domain_relation}{serif\+::discretization\+::domain\+::relation\+::\+Domain\+Relation}}
|
|
\begin{DoxyCompactList}\small\item\em Base class for all relations in the domain module. This class is used to define compile-\/time tags for relations that can be declared about a mesh. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1relation_1_1_inscribed}{serif\+::discretization\+::domain\+::relation\+::\+Inscribed$<$ A, B $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Compile time type representing the inscribed relation between two domains or sets. This relation states that every face of the inner domain (A) that is not interior to A borders the outer domain (B). \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1relation_1_1_fully_connected}{serif\+::discretization\+::domain\+::relation\+::\+Fully\+Connected$<$ A $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Compile time type representing the fully connected relation for a domain or set. This relation states that the domain is a single connected blob of elements, not two separate pieces. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1relation_1_1_domain_boundary}{serif\+::discretization\+::domain\+::relation\+::\+Domain\+Boundary$<$ Boundary\+T, Domain\+Ts $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Compile time type representing the domain boundary relation between a boundary and one or two domains. This relation states that the boundary is exactly the surface between the specified domains. We enforce here that the size of the Domain\+Ts pack is either one or two, as a boundary can only be associated with one or two domains. If it is one domain then the boundary is the surface of that domain, if it is two domains then the boundary is the interface between those two domains. \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}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename... Ts$>$ }\\consteval std\+::size\+\_\+t \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1relation_a1b57d195e9d643b262222f5d50ed1dd0}{serif\+::discretization\+::domain\+::relation\+::\+Count\+Variadic\+Arguments}} () noexcept
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
This file defines compile time tags for the relations that can be declared about a mesh in the domain module. These are ultimately used to define a constrained mesh schema.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|
|
Each relation must hold for a mesh to be considered valid for a given schema. This is intended to resolve some particular class of bug I imagine where a lively young astronomer confidently rolls up to SERiF with a new mesh in hand and a dream in their heart and then spend the next year trying to sort out esoteric errors. The idea here is that once a mesh gets through this system it should be provably at least good enough to be able to run some math against. That is not to say this validates the quality of a mesh, this system is not meant for that; rather, it is to say it lets be confident that the invariants we expect of a mesh are actually true.
|