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,54 @@
\doxysection{src/include/serif/discretization/domain/resolver.hpp File Reference}
\hypertarget{resolver_8hpp}{}\label{resolver_8hpp}\index{src/include/serif/discretization/domain/resolver.hpp@{src/include/serif/discretization/domain/resolver.hpp}}
File containing the Domain\+IDResolver and Boundary\+IDResolver structs. These structs are used to resolve the domain and boundary IDs for a given domain or boundary type.
{\ttfamily \#include "{}serif/discretization/domain/concepts.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/ids/lists/concepts.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/ids/lists/lists.\+hpp"{}}\newline
Include dependency graph for resolver.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{resolver_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]{resolver_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1_domain_i_d_resolver_3_01_domain_t_00_01ids_1_1lists_691dc5cdd5bb726ea229a1452241f3d6}{serif\+::discretization\+::domain\+::\+Domain\+IDResolver$<$ Domain\+T, ids\+::lists\+::\+Domain\+IDList$<$ Domain\+IDTs... $>$ $>$}}
\begin{DoxyCompactList}\small\item\em A specialization of the \doxylink{structserif_1_1discretization_1_1domain_1_1_domain_i_d_resolver}{Domain\+IDResolver} struct for a single \doxylink{structserif_1_1discretization_1_1domain_1_1_domain}{Domain} type. This struct is used to resolve the domain ID for a given \doxylink{structserif_1_1discretization_1_1domain_1_1_domain}{Domain} type. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1_domain_i_d_resolver_3_01_domain_set_3_01_domain_ts_87d2a0f186034cba3e08f075159f6c5aa}{serif\+::discretization\+::domain\+::\+Domain\+IDResolver$<$ Domain\+Set$<$ Domain\+Ts... $>$, ids\+::lists\+::\+Domain\+IDList$<$ Domain\+IDTs... $>$ $>$}}
\begin{DoxyCompactList}\small\item\em A specialization of the \doxylink{structserif_1_1discretization_1_1domain_1_1_domain_i_d_resolver}{Domain\+IDResolver} struct for a \doxylink{structserif_1_1discretization_1_1domain_1_1_domain_set}{Domain\+Set} type. This struct is used to resolve the domain IDs for a given \doxylink{structserif_1_1discretization_1_1domain_1_1_domain_set}{Domain\+Set} type. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1_boundary_i_d_resolver_3_01_boundary_t_00_01ids_1_1li2689267af648404251e26798b0b9b3b9}{serif\+::discretization\+::domain\+::\+Boundary\+IDResolver$<$ Boundary\+T, ids\+::lists\+::\+Boundary\+IDList$<$ Boundary\+IDTs... $>$ $>$}}
\begin{DoxyCompactList}\small\item\em A specialization of the \doxylink{structserif_1_1discretization_1_1domain_1_1_boundary_i_d_resolver}{Boundary\+IDResolver} struct for a single \doxylink{structserif_1_1discretization_1_1domain_1_1_boundary}{Boundary} type. This struct is used to resolve the boundary ID for a given \doxylink{structserif_1_1discretization_1_1domain_1_1_boundary}{Boundary} type. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1_boundary_i_d_resolver_3_01_boundary_set_3_01_boundardf0745416ccea48cae2813336cb4fa51}{serif\+::discretization\+::domain\+::\+Boundary\+IDResolver$<$ Boundary\+Set$<$ Boundary\+Ts... $>$, ids\+::lists\+::\+Boundary\+IDList$<$ Boundary\+IDTs... $>$ $>$}}
\begin{DoxyCompactList}\small\item\em A specialization of the \doxylink{structserif_1_1discretization_1_1domain_1_1_boundary_i_d_resolver}{Boundary\+IDResolver} struct for a \doxylink{structserif_1_1discretization_1_1domain_1_1_boundary_set}{Boundary\+Set} type. This struct is used to resolve the boundary IDs for a given \doxylink{structserif_1_1discretization_1_1domain_1_1_boundary_set}{Boundary\+Set} type. \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}}
\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
File containing the Domain\+IDResolver and Boundary\+IDResolver structs. These structs are used to resolve the domain and boundary IDs for a given domain or boundary type.
\begin{DoxyAuthor}{Author}
Emily M. Boudreaux
\end{DoxyAuthor}