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)
This commit is contained in:
2026-11-09 14:09:44 -05:00
parent d9c4919477
commit 6b57738330
32596 changed files with 4155414 additions and 0 deletions

View File

@@ -0,0 +1,65 @@
\doxysection{src/include/serif/discretization/domain/schema/validation/connected.hpp File Reference}
\hypertarget{connected_8hpp}{}\label{connected_8hpp}\index{src/include/serif/discretization/domain/schema/validation/connected.hpp@{src/include/serif/discretization/domain/schema/validation/connected.hpp}}
File containing the specialization of Relation\+Validator for \doxylink{structserif_1_1discretization_1_1domain_1_1schema_1_1validation_1_1_fully_connected}{Fully\+Connected} relations. This relation enforces that a domain is fully connected, meaning that all elements of the domain are reachable from any other element of the domain.
{\ttfamily \#include $<$cstddef$>$}\newline
{\ttfamily \#include $<$optional$>$}\newline
{\ttfamily \#include $<$vector$>$}\newline
{\ttfamily \#include "{}serif/discretization/domain/concepts.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/mesh/topology.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/relation/relations.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/relation/validation/runtime.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/schema/concepts.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/schema/validation/validator.\+hpp"{}}\newline
Include dependency graph for connected.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{connected_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]{connected_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1schema_1_1validation_1_1_relation_validator_3_01_full9139a5096b6954642a7205a90032d6bc}{serif\+::discretization\+::domain\+::schema\+::validation\+::\+Relation\+Validator$<$ Fully\+Connected$<$ Domain\+T $>$ $>$}}
\begin{DoxyCompactList}\small\item\em Specialization of \doxylink{structserif_1_1discretization_1_1domain_1_1schema_1_1validation_1_1_relation_validator}{Relation\+Validator} for \doxylink{structserif_1_1discretization_1_1domain_1_1schema_1_1validation_1_1_fully_connected}{Fully\+Connected} relations. This relation enforces that a domain is fully connected, meaning that all elements of the domain are reachable from any other element of the domain. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1schema_1_1validation_1_1_fully_connected}{serif\+::discretization\+::domain\+::schema\+::validation\+::\+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}\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_1schema}{serif\+::discretization\+::domain\+::schema}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1schema_1_1validation}{serif\+::discretization\+::domain\+::schema\+::validation}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Enumerations}
\begin{DoxyCompactItemize}
\item
enum class \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1schema_1_1validation_afb547c803b70b3013bc47f86612b950f}{serif\+::discretization\+::domain\+::schema\+::validation\+::\+Relation\+Validation\+Failure}}
\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}
File containing the specialization of Relation\+Validator for \doxylink{structserif_1_1discretization_1_1domain_1_1schema_1_1validation_1_1_fully_connected}{Fully\+Connected} relations. This relation enforces that a domain is fully connected, meaning that all elements of the domain are reachable from any other element of the domain.
\begin{DoxyAuthor}{Author}
Emily M. Boudreaux
\end{DoxyAuthor}