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)
63 lines
4.6 KiB
TeX
63 lines
4.6 KiB
TeX
\doxysection{src/include/serif/discretization/domain/ids/concepts.hpp File Reference}
|
|
\hypertarget{discretization_2domain_2ids_2concepts_8hpp}{}\label{discretization_2domain_2ids_2concepts_8hpp}\index{src/include/serif/discretization/domain/ids/concepts.hpp@{src/include/serif/discretization/domain/ids/concepts.hpp}}
|
|
|
|
|
|
This file defines concepts for domain and boundary IDs in the discretization framework. These are specifically used to validate that a type is a valid Domain\+ID or Boundary\+ID.
|
|
|
|
|
|
{\ttfamily \#include "{}serif/discretization/domain/ids/boundary.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/discretization/domain/ids/domain.\+hpp"{}}\newline
|
|
Include dependency graph for concepts.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{discretization_2domain_2ids_2concepts_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_2ids_2concepts_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\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}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Concepts}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1discretization_1_1domain_1_1ids_1_1_is_domain_i_d}{serif\+::discretization\+::domain\+::ids\+::\+Is\+Domain\+ID}}
|
|
\begin{DoxyCompactList}\small\item\em Concept for types that are domain IDs in the discretization framework. To be a domain ID a type must satisfy the is\+\_\+domain\+\_\+id\+\_\+v trait. \end{DoxyCompactList}\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1discretization_1_1domain_1_1ids_1_1_is_boundary_i_d}{serif\+::discretization\+::domain\+::ids\+::\+Is\+Boundary\+ID}}
|
|
\begin{DoxyCompactList}\small\item\em Concept for types that are boundary IDs in the discretization framework. To be a boundary ID a type must satisfy the is\+\_\+boundary\+\_\+id\+\_\+v trait. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Variables}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename T$>$ }\\constexpr bool \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1ids_a2f730b21aad38b96623c29ad17de5ee7}{serif\+::discretization\+::domain\+::ids\+::is\+\_\+domain\+\_\+id\+\_\+v}} = false
|
|
\begin{DoxyCompactList}\small\item\em Trait to determine if a type is a domain ID. Defaults to false for all types. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Is\+Domain DomainT, int Identifier\+Value$>$ }\\constexpr bool \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1ids_ac0caa62d3dfe150000573f197fcfed47}{serif\+::discretization\+::domain\+::ids\+::is\+\_\+domain\+\_\+id\+\_\+v$<$ Domain\+ID$<$ Domain\+T, Identifier\+Value $>$ $>$}} = true
|
|
\begin{DoxyCompactList}\small\item\em Trait to determine if a type is a domain ID. Specialization which is true for valid \doxylink{structserif_1_1discretization_1_1domain_1_1ids_1_1_domain_i_d}{Domain\+ID} types. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename T$>$ }\\constexpr bool \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1ids_a39924cd7bc633ee7d3929bb468a0e33d}{serif\+::discretization\+::domain\+::ids\+::is\+\_\+boundary\+\_\+id\+\_\+v}} = false
|
|
\begin{DoxyCompactList}\small\item\em Trait to determine if a type is a boundary ID. Defaults to false for all types. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Is\+Boundary BoundaryT, int Identifier\+Value$>$ }\\constexpr bool \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1ids_a870d5689efb58154907b1f97d2da3121}{serif\+::discretization\+::domain\+::ids\+::is\+\_\+boundary\+\_\+id\+\_\+v$<$ Boundary\+ID$<$ Boundary\+T, Identifier\+Value $>$ $>$}} = true
|
|
\begin{DoxyCompactList}\small\item\em Trait to determine if a type is a boundary ID. Specialization which is true for valid \doxylink{structserif_1_1discretization_1_1domain_1_1ids_1_1_boundary_i_d}{Boundary\+ID} types. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
This file defines concepts for domain and boundary IDs in the discretization framework. These are specifically used to validate that a type is a valid Domain\+ID or Boundary\+ID.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|