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)
60 lines
4.9 KiB
TeX
60 lines
4.9 KiB
TeX
\doxysection{src/include/serif/discretization/forms/form\+\_\+traits.hpp File Reference}
|
|
\hypertarget{form__traits_8hpp}{}\label{form__traits_8hpp}\index{src/include/serif/discretization/forms/form\_traits.hpp@{src/include/serif/discretization/forms/form\_traits.hpp}}
|
|
|
|
|
|
Compile-\/time traits for forms, used to extract types and properties from template parameters.
|
|
|
|
|
|
{\ttfamily \#include "{}serif/discretization/forms/concept.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/discretization/forms/forms.\+hpp"{}}\newline
|
|
Include dependency graph for form\+\_\+traits.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{form__traits_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]{form__traits_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_form_traits}{serif\+::discretization\+::forms\+::\+Form\+Traits$<$ Form\+T $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Compile-\/time traits for forms, used to extract types and properties from template parameters. This struct is specialized for each form type to provide specific traits such as trial and test order reductions. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_form_traits_3_01mass_3_01_trial_t_00_01_test_t_01_4_01_4}{serif\+::discretization\+::forms\+::\+Form\+Traits$<$ mass$<$ Trial\+T, Test\+T $>$ $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Specialization of \doxylink{structserif_1_1discretization_1_1forms_1_1_form_traits}{Form\+Traits} for the mass form, which has no order reduction for either trial or test terms. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_form_traits_3_01divergence_3_01_trial_t_00_01_test_t_01_4_01_4}{serif\+::discretization\+::forms\+::\+Form\+Traits$<$ divergence$<$ Trial\+T, Test\+T $>$ $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Specialization of \doxylink{structserif_1_1discretization_1_1forms_1_1_form_traits}{Form\+Traits} for the divergence form, which has an order reduction of 1, to satisfy the Inf-\/\+Sup condition, for the trial term and no order reduction for the test term. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_form_traits_3_01source_3_01_trial_t_00_01_test_t_01_4_01_4}{serif\+::discretization\+::forms\+::\+Form\+Traits$<$ source$<$ Trial\+T, Test\+T $>$ $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Specialization of \doxylink{structserif_1_1discretization_1_1forms_1_1_form_traits}{Form\+Traits} for the source form, which has no order reduction for either trial or test terms. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_form_traits_3_01force_3_01_trial_t_00_01_test_t_01_4_01_4}{serif\+::discretization\+::forms\+::\+Form\+Traits$<$ force$<$ Trial\+T, Test\+T $>$ $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Specialization of \doxylink{structserif_1_1discretization_1_1forms_1_1_form_traits}{Form\+Traits} for the force form, which has no order reduction for either trial or test terms. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_form_traits_3_01boundary__flux_3_01_trial_t_00_01_test_t_01_4_01_4}{serif\+::discretization\+::forms\+::\+Form\+Traits$<$ boundary\+\_\+flux$<$ Trial\+T, Test\+T $>$ $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Specialization of \doxylink{structserif_1_1discretization_1_1forms_1_1_form_traits}{Form\+Traits} for the \doxylink{structserif_1_1discretization_1_1forms_1_1boundary__flux}{boundary\+\_\+flux} form, which has no order reduction for either trial or test terms. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_form_traits_3_01projection_3_01_trial_t_00_01_test_t_01_4_01_4}{serif\+::discretization\+::forms\+::\+Form\+Traits$<$ projection$<$ Trial\+T, Test\+T $>$ $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Specialization of \doxylink{structserif_1_1discretization_1_1forms_1_1_form_traits}{Form\+Traits} for the projection form, which has no order reduction for either trial or test terms. \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_1forms}{serif\+::discretization\+::forms}}
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
Compile-\/time traits for forms, used to extract types and properties from template parameters.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|