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)
27 lines
2.2 KiB
TeX
27 lines
2.2 KiB
TeX
\doxysection{src/include/serif/discretization/domain/schema Directory Reference}
|
|
\hypertarget{dir_7b6b02e44376e7a2aed0058a673ab2c3}{}\label{dir_7b6b02e44376e7a2aed0058a673ab2c3}\index{src/include/serif/discretization/domain/schema Directory Reference@{src/include/serif/discretization/domain/schema Directory Reference}}
|
|
Directory dependency graph for schema\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=300pt]{dir_7b6b02e44376e7a2aed0058a673ab2c3_dep}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Directories}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
directory \mbox{\hyperlink{dir_a26d87ba5f59f73a9f6d6d452de60988}{validation}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Files}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
file \mbox{\hyperlink{discretization_2domain_2schema_2concepts_8hpp}{concepts.\+hpp}}
|
|
\begin{DoxyCompactList}\small\item\em File containing the concept for a schema, which is a collection of relations that describe the relationships between domains and boundaries in a mesh. \end{DoxyCompactList}\item
|
|
file \mbox{\hyperlink{domain__schema_8hpp}{domain\+\_\+schema.\+hpp}}
|
|
\begin{DoxyCompactList}\small\item\em File containing the Domain\+Schema class. The idea here is to prevent a class of bugs wherein the user or developer things that their mesh is valid but there is some subtle difference between their mesh and what we expect. Domain\+Schema lets us define the particular traits a mesh must have to be valid (e.\+g. must have a particular set of domain and boundary IDs, those must correspond to a particular set of topological relations). Then the first things that happens when a mesh is loaded is that it is validated against this schema. \end{DoxyCompactList}\item
|
|
file \mbox{\hyperlink{schemas_8hpp}{schemas.\+hpp}}
|
|
\begin{DoxyCompactList}\small\item\em File containing the primary domain schema for SERiF. This is a three-\/domain, two-\/boundary schema that is used to validate meshes that are loaded into SERiF. \end{DoxyCompactList}\item
|
|
file \mbox{\hyperlink{discretization_2domain_2schema_2traits_8hpp}{traits.\+hpp}}
|
|
\begin{DoxyCompactList}\small\item\em File containing the is\+\_\+schema\+\_\+v trait. This trait is used to determine if a type is a Domain\+Schema. \end{DoxyCompactList}\end{DoxyCompactItemize}
|