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)
67 lines
4.5 KiB
TeX
67 lines
4.5 KiB
TeX
\doxysection{src/include/serif/discretization/quadrature/backend/order.hpp File Reference}
|
|
\hypertarget{order_8hpp}{}\label{order_8hpp}\index{src/include/serif/discretization/quadrature/backend/order.hpp@{src/include/serif/discretization/quadrature/backend/order.hpp}}
|
|
|
|
|
|
File containing the resolve\+\_\+operand\+\_\+order function and related utilities. These are used to determine the static order of an integrator for a given operand or form type.
|
|
|
|
|
|
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
|
|
{\ttfamily \#include "{}serif/discretization/functional\+\_\+space/space.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/discretization/blocks/concepts.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/discretization/forms/operands.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/error/errors.\+hpp"{}}\newline
|
|
Include dependency graph for order.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{order_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]{order_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1quadrature_1_1backend_1_1mfem_1_1_discrete_functional_space_tradada5be57655d7faa5a3d3e542281f2e}{serif\+::discretization\+::quadrature\+::backend\+::mfem\+::\+Discrete\+Functional\+Space\+Traits$<$ functional\+\_\+space\+::\+Discrete\+Functional\+Space$<$ Space\+V, Order\+V, Rank\+V $>$ $>$}}
|
|
\begin{DoxyCompactList}\small\item\em A specialization of the \doxylink{structserif_1_1discretization_1_1quadrature_1_1backend_1_1mfem_1_1_discrete_functional_space_traits}{Discrete\+Functional\+Space\+Traits} struct for a Discrete\+Functional\+Space. This struct is used to extract the functional space traits from a Discrete\+Functional\+Space. \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_1quadrature}{serif\+::discretization\+::quadrature}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1quadrature_1_1backend}{serif\+::discretization\+::quadrature\+::backend}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1quadrature_1_1backend_1_1mfem}{serif\+::discretization\+::quadrature\+::backend\+::mfem}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Typedefs}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$blocks\+::\+Has\+Functional\+Space TermT$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1discretization_1_1quadrature_1_1backend_1_1mfem_ad392d35f154a8fd2f5148569e81db92e}{serif\+::discretization\+::quadrature\+::backend\+::mfem\+::\+Functional\+Space\+Traits}} = \mbox{\hyperlink{structserif_1_1discretization_1_1quadrature_1_1backend_1_1mfem_1_1_discrete_functional_space_traits}{Discrete\+Functional\+Space\+Traits}}$<$typename Term\+T\+::\+Functional\+Space$>$
|
|
\begin{DoxyCompactList}\small\item\em A helper alias to extract the functional space traits from a Discrete\+Functional\+Space. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$forms\+::\+Is\+Operand OperandT$>$ }\\consteval int \mbox{\hyperlink{namespaceserif_1_1discretization_1_1quadrature_1_1backend_1_1mfem_a57b84979ef93418360b7d207fa87858b}{serif\+::discretization\+::quadrature\+::backend\+::mfem\+::resolve\+\_\+operand\+\_\+order}} () noexcept
|
|
\begin{DoxyCompactList}\small\item\em A function to resolve the static order of an MFEM integrator for a given operand type. \end{DoxyCompactList}\item
|
|
int \mbox{\hyperlink{namespaceserif_1_1discretization_1_1quadrature_1_1backend_1_1mfem_a1612811d4942c7f57228605d59644cff}{serif\+::discretization\+::quadrature\+::backend\+::mfem\+::sum\+\_\+dynamic\+\_\+orders}} (const std\+::span$<$ const int $>$ dynamic\+\_\+orders)
|
|
\begin{DoxyCompactList}\small\item\em Sums the dynamic orders in a span of integers. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
File containing the resolve\+\_\+operand\+\_\+order function and related utilities. These are used to determine the static order of an integrator for a given operand or form type.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|