Files
MeanField_SERiF/docs/latex/query_8hpp.tex

59 lines
4.1 KiB
TeX
Raw Normal View History

\doxysection{src/include/serif/discretization/quadrature/query.hpp File Reference}
\hypertarget{query_8hpp}{}\label{query_8hpp}\index{src/include/serif/discretization/quadrature/query.hpp@{src/include/serif/discretization/quadrature/query.hpp}}
File containing the Query struct. This struct is used to represent a quadrature query, which contains all the information needed to determine the appropriate order and other relevant information for the integration rule.
{\ttfamily \#include $<$format$>$}\newline
{\ttfamily \#include $<$string$>$}\newline
{\ttfamily \#include "{}serif/discretization/quadrature/rules.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/physical\+\_\+domains.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/forms/form\+\_\+traits.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/forms/runtime.\+hpp"{}}\newline
Include dependency graph for query.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{query_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]{query_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1discretization_1_1quadrature_1_1_query}{serif\+::discretization\+::quadrature\+::\+Query}}
\begin{DoxyCompactList}\small\item\em The \doxylink{structserif_1_1discretization_1_1quadrature_1_1_query}{Query} struct is used to represent a quadrature query, which contains all the information needed to determine the appropriate order and other relevant information for the integration rule. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structstd_1_1formatter_3_01serif_1_1discretization_1_1quadrature_1_1_query_01_4}{std\+::formatter$<$ serif\+::discretization\+::quadrature\+::\+Query $>$}}
\begin{DoxyCompactList}\small\item\em A specialization of the std\+::formatter for the Query struct. This allows for easy formatting of Query objects using std\+::format. \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}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$forms\+::\+Form FormT$>$ }\\constexpr \mbox{\hyperlink{structserif_1_1discretization_1_1quadrature_1_1_query}{Query}} \mbox{\hyperlink{namespaceserif_1_1discretization_1_1quadrature_a24dd0addeeb7b9ea7cd8fbc12c4a7ac0}{serif\+::discretization\+::quadrature\+::make\+\_\+query}} (const \mbox{\hyperlink{namespaceserif_1_1discretization_1_1quadrature_a2170ba7c65dd986e68afb2cc85f2ad88}{Quadrature\+Role}} role, const \mbox{\hyperlink{classserif_1_1discretization_1_1domain_1_1_domain_or_set}{domain\+::\+Domain\+Or\+Set}} domain, const \mbox{\hyperlink{namespaceserif_1_1discretization_1_1quadrature_a41f6d96b8d77bc2944e8b328062e5efa}{Mapping\+Kind}} mapping, const int trial\+Order, const int test\+Order, const int coefficient\+Order, const int geometry\+Weight\+Order, const std\+::optional$<$ int $>$ base\+Order=std\+::nullopt) noexcept
\begin{DoxyCompactList}\small\item\em A helper function to create a \doxylink{structserif_1_1discretization_1_1quadrature_1_1_query}{Query} object for a given form type. This function is used to simplify the creation of \doxylink{structserif_1_1discretization_1_1quadrature_1_1_query}{Query} objects by automatically filling in the form descriptor and other relevant information. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
File containing the Query struct. This struct is used to represent a quadrature query, which contains all the information needed to determine the appropriate order and other relevant information for the integration rule.
\begin{DoxyAuthor}{Author}
Emily M. Boudreaux
\end{DoxyAuthor}