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)
57 lines
2.5 KiB
TeX
57 lines
2.5 KiB
TeX
\doxysection{src/include/serif/equations/concepts.hpp File Reference}
|
|
\hypertarget{equations_2concepts_8hpp}{}\label{equations_2concepts_8hpp}\index{src/include/serif/equations/concepts.hpp@{src/include/serif/equations/concepts.hpp}}
|
|
|
|
|
|
Concepts for equations, contributions, and pointwise evaluation.
|
|
|
|
|
|
{\ttfamily \#include $<$concepts$>$}\newline
|
|
{\ttfamily \#include $<$string\+\_\+view$>$}\newline
|
|
{\ttfamily \#include "{}serif/equations/contributions.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/point.\+hpp"{}}\newline
|
|
Include dependency graph for concepts.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{equations_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]{equations_2concepts_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1equations_1_1_valid_contributions}{serif\+::equations\+::\+Valid\+Contributions$<$ Row\+T, Tuple\+T $>$}}
|
|
\begin{DoxyCompactList}\small\item\em A compile-\/time check to ensure that a tuple of contributions is valid for a given residual row type. This is the default false specialization. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1equations_1_1_valid_contributions_3_01_row_t_00_01std_1_1tuple_3_01_c_8_8_8_01_4_01_4}{serif\+::equations\+::\+Valid\+Contributions$<$ Row\+T, std\+::tuple$<$ C... $>$ $>$}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1equations}{serif\+::equations}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Concepts}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1equations_1_1_point_equation}{serif\+::equations\+::\+Point\+Equation}}
|
|
\begin{DoxyCompactList}\small\item\em A concept that defines the requirements for a pointwise equation. \end{DoxyCompactList}\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1equations_1_1_equation}{serif\+::equations\+::\+Equation}}
|
|
\begin{DoxyCompactList}\small\item\em A concept that defines the requirements for a valid SERiF equation. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
Concepts for equations, contributions, and pointwise evaluation.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|