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)
62 lines
3.7 KiB
TeX
62 lines
3.7 KiB
TeX
\doxysection{src/include/serif/discretization/blocks/traits.hpp File Reference}
|
|
\hypertarget{discretization_2blocks_2traits_8hpp}{}\label{discretization_2blocks_2traits_8hpp}\index{src/include/serif/discretization/blocks/traits.hpp@{src/include/serif/discretization/blocks/traits.hpp}}
|
|
|
|
|
|
Compile-\/time traits for fields and terms, used to extract types and properties from template parameters.
|
|
|
|
|
|
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
|
|
{\ttfamily \#include "{}serif/discretization/blocks/concepts.\+hpp"{}}\newline
|
|
Include dependency graph for traits.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{discretization_2blocks_2traits_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_2blocks_2traits_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1_spatial_term_traits}{serif\+::discretization\+::blocks\+::\+Spatial\+Term\+Traits$<$ Term\+T $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Helper struct representing the traits of some spatial term type, including its functional space, support, family, order, and rank. \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_1blocks}{serif\+::discretization\+::blocks}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Concepts}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1discretization_1_1blocks_1_1_scalar_trace_term}{serif\+::discretization\+::blocks\+::\+Scalar\+Trace\+Term}}
|
|
\begin{DoxyCompactList}\small\item\em A unique scalar boundary value is available for continuous scalar fields and scalar globals. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Typedefs}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$Has\+Functional\+Space TermT$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1discretization_1_1blocks_a8b16d088f59cff9d40cd84eebd53d3b1}{serif\+::discretization\+::blocks\+::\+Functional\+Space\+Of}} = std\+::remove\+\_\+cvref\+\_\+t$<$TermT$>$\+::\+Functional\+Space
|
|
\begin{DoxyCompactList}\small\item\em Extract the functional space type associated with a given term type. Will have a type of whatever Term\+T\+::\+Functional\+Space is. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Has\+Support TermT$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1discretization_1_1blocks_aba18df102a90506f2263dc6395e3f975}{serif\+::discretization\+::blocks\+::\+Support\+Of}} = std\+::remove\+\_\+cvref\+\_\+t$<$TermT$>$\+::\+Support
|
|
\begin{DoxyCompactList}\small\item\em Extract the support type associated with a given term type. Will have a type of whatever Term\+T\+::\+Support is. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Has\+Quantity TermT$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1discretization_1_1blocks_aef1a0354784f797bfa87d2369652b5cb}{serif\+::discretization\+::blocks\+::\+Quantity\+Of}} = std\+::remove\+\_\+cvref\+\_\+t$<$TermT$>$\+::\+Quantity
|
|
\begin{DoxyCompactList}\small\item\em Extract the quantity type associated with a given term type. Will have a type of whatever Term\+T\+::\+Quantity is. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
Compile-\/time traits for fields and terms, used to extract types and properties from template parameters.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|