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)
61 lines
3.0 KiB
TeX
61 lines
3.0 KiB
TeX
\doxysection{src/include/serif/discretization/domain/ids/lists/lists.hpp File Reference}
|
|
\hypertarget{lists_8hpp}{}\label{lists_8hpp}\index{src/include/serif/discretization/domain/ids/lists/lists.hpp@{src/include/serif/discretization/domain/ids/lists/lists.hpp}}
|
|
|
|
|
|
This file defines the Domain\+IDList and Boundary\+IDList types, specifically these types are used to project down compile time types to runtime values.
|
|
|
|
|
|
{\ttfamily \#include $<$array$>$}\newline
|
|
{\ttfamily \#include $<$cstddef$>$}\newline
|
|
{\ttfamily \#include "{}serif/discretization/domain/ids/validation/concepts.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/misc/std\+\_\+helper/variadic\+\_\+cleaning.\+hpp"{}}\newline
|
|
Include dependency graph for lists.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{lists_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]{lists_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1ids_1_1lists_1_1_domain_i_d_list}{serif\+::discretization\+::domain\+::ids\+::lists\+::\+Domain\+IDList$<$ Domain\+IDTs $>$}}
|
|
\begin{DoxyCompactList}\small\item\em A list of domain IDs in the discretization framework. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1ids_1_1lists_1_1_boundary_i_d_list}{serif\+::discretization\+::domain\+::ids\+::lists\+::\+Boundary\+IDList$<$ Boundary\+IDTs $>$}}
|
|
\begin{DoxyCompactList}\small\item\em A list of boundary IDs in the discretization framework. \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_1ids}{serif\+::discretization\+::domain\+::ids}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1ids_1_1lists}{serif\+::discretization\+::domain\+::ids\+::lists}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename... Ts$>$ }\\consteval std\+::size\+\_\+t \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1ids_1_1lists_a1b57d195e9d643b262222f5d50ed1dd0}{serif\+::discretization\+::domain\+::ids\+::lists\+::\+Count\+Variadic\+Arguments}} () noexcept
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
This file defines the Domain\+IDList and Boundary\+IDList types, specifically these types are used to project down compile time types to runtime values.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|