\doxysection{src/include/serif/discretization/quadrature/rules.hpp File Reference}
\hypertarget{rules_8hpp}{}\label{rules_8hpp}\index{src/include/serif/discretization/quadrature/rules.hpp@{src/include/serif/discretization/quadrature/rules.hpp}}


File containing the Rule\+Set class and related types. The Rule\+Set class is used to determine the appropriate order and other relevant information for the integration rule based on a given quadrature query.  


{\ttfamily \#include $<$optional$>$}\newline
{\ttfamily \#include $<$string$>$}\newline
{\ttfamily \#include $<$vector$>$}\newline
{\ttfamily \#include $<$format$>$}\newline
{\ttfamily \#include $<$utility$>$}\newline
{\ttfamily \#include "{}serif/discretization/forms/runtime.\+hpp"{}}\newline
Include dependency graph for rules.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{rules_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]{rules_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item 
struct \mbox{\hyperlink{structserif_1_1discretization_1_1quadrature_1_1_rule_control}{serif\+::discretization\+::quadrature\+::\+Rule\+Control}}
\begin{DoxyCompactList}\small\item\em A struct to control the behavior of a quadrature rule for a given form or role. Rule control always contains boost (default to 0) and may contain some fixed order (think of this as an override). If the fixed order is empty then the quadrature system will determine the order based on the form and role + boost. \end{DoxyCompactList}\item 
struct \mbox{\hyperlink{structserif_1_1discretization_1_1quadrature_1_1_form_rule}{serif\+::discretization\+::quadrature\+::\+Form\+Rule}}
\begin{DoxyCompactList}\small\item\em A struct to represent a form rule, which contains a form descriptor and a rule control. Used to tie some form to a specific quadrature rule control. \end{DoxyCompactList}\item 
class \mbox{\hyperlink{classserif_1_1discretization_1_1quadrature_1_1_rule_set}{serif\+::discretization\+::quadrature\+::\+Rule\+Set}}
\begin{DoxyCompactList}\small\item\em The \doxylink{classserif_1_1discretization_1_1quadrature_1_1_rule_set}{Rule\+Set} class is used to determine the appropriate order and other relevant information for the integration rule based on a given quadrature query. It contains a set of form rules and role controls, as well as a fallback control. \end{DoxyCompactList}\item 
struct \mbox{\hyperlink{structserif_1_1discretization_1_1quadrature_1_1_resolution}{serif\+::discretization\+::quadrature\+::\+Resolution}}
\begin{DoxyCompactList}\small\item\em A struct to hold the resolution of a quadrature query. This contains the base order, boost, and final order of the quadrature rule, as well as a flag indicating whether a fixed order was used. \end{DoxyCompactList}\item 
struct \mbox{\hyperlink{structstd_1_1formatter_3_01serif_1_1discretization_1_1quadrature_1_1_quadrature_role_01_4}{std\+::formatter$<$ serif\+::discretization\+::quadrature\+::\+Quadrature\+Role $>$}}
\begin{DoxyCompactList}\small\item\em Specializations of the std\+::formatter for the Quadrature\+Role, Mapping\+Kind, Rule\+Control, Form\+Rule, and Rule\+Set types. This allows for easy formatting of these types using std\+::format. \end{DoxyCompactList}\item 
struct \mbox{\hyperlink{structstd_1_1formatter_3_01serif_1_1discretization_1_1quadrature_1_1_mapping_kind_01_4}{std\+::formatter$<$ serif\+::discretization\+::quadrature\+::\+Mapping\+Kind $>$}}
\begin{DoxyCompactList}\small\item\em Specializations of the std\+::formatter for the Mapping\+Kind type. This allows for easy formatting of the Mapping\+Kind type using std\+::format. \end{DoxyCompactList}\item 
struct \mbox{\hyperlink{structstd_1_1formatter_3_01serif_1_1discretization_1_1quadrature_1_1_rule_control_01_4}{std\+::formatter$<$ serif\+::discretization\+::quadrature\+::\+Rule\+Control $>$}}
\begin{DoxyCompactList}\small\item\em A specialization of the std\+::formatter for the Rule\+Control type. This allows for easy formatting of the Rule\+Control type using std\+::format. \end{DoxyCompactList}\item 
struct \mbox{\hyperlink{structstd_1_1formatter_3_01serif_1_1discretization_1_1quadrature_1_1_form_rule_01_4}{std\+::formatter$<$ serif\+::discretization\+::quadrature\+::\+Form\+Rule $>$}}
\begin{DoxyCompactList}\small\item\em A specialization of the std\+::formatter for the Form\+Rule type. This allows for easy formatting of the Form\+Rule type using std\+::format. \end{DoxyCompactList}\item 
struct \mbox{\hyperlink{structstd_1_1formatter_3_01serif_1_1discretization_1_1quadrature_1_1_rule_set_01_4}{std\+::formatter$<$ serif\+::discretization\+::quadrature\+::\+Rule\+Set $>$}}
\begin{DoxyCompactList}\small\item\em A specialization of the std\+::formatter for the Rule\+Set type. This allows for easy formatting of the Rule\+Set type 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*{Enumerations}
\begin{DoxyCompactItemize}
\item 
enum class \mbox{\hyperlink{namespaceserif_1_1discretization_1_1quadrature_a2170ba7c65dd986e68afb2cc85f2ad88}{serif\+::discretization\+::quadrature\+::\+Quadrature\+Role}} \{ \mbox{\hyperlink{namespaceserif_1_1discretization_1_1quadrature_a2170ba7c65dd986e68afb2cc85f2ad88a39629fd04651ccd980a12031e92a4bbf}{serif\+::discretization\+::quadrature\+::discretization}}
, \mbox{\hyperlink{namespaceserif_1_1discretization_1_1quadrature_a2170ba7c65dd986e68afb2cc85f2ad88ad0fce4b31a695a89aea9c06e8231f7bf}{serif\+::discretization\+::quadrature\+::preconditioner}}
, \mbox{\hyperlink{namespaceserif_1_1discretization_1_1quadrature_a2170ba7c65dd986e68afb2cc85f2ad88a1b2415052ea497897c757a8069a97686}{serif\+::discretization\+::quadrature\+::diagnostic}}
, \mbox{\hyperlink{namespaceserif_1_1discretization_1_1quadrature_a2170ba7c65dd986e68afb2cc85f2ad88adfa555786d19f339a13e6719241e9d6f}{serif\+::discretization\+::quadrature\+::projection}}
 \}
\begin{DoxyCompactList}\small\item\em An enumeration of the different roles that a quadrature rule can play. \end{DoxyCompactList}\item 
enum class \mbox{\hyperlink{namespaceserif_1_1discretization_1_1quadrature_a41f6d96b8d77bc2944e8b328062e5efa}{serif\+::discretization\+::quadrature\+::\+Mapping\+Kind}} \{ \mbox{\hyperlink{namespaceserif_1_1discretization_1_1quadrature_a41f6d96b8d77bc2944e8b328062e5efaa334c4a4c42fdb79d7ebc3e73b517e6f8}{serif\+::discretization\+::quadrature\+::none}}
, \mbox{\hyperlink{namespaceserif_1_1discretization_1_1quadrature_a41f6d96b8d77bc2944e8b328062e5efaa0877ad41eb90f8787b48ea22b0aea241}{serif\+::discretization\+::quadrature\+::affine}}
, \mbox{\hyperlink{namespaceserif_1_1discretization_1_1quadrature_a41f6d96b8d77bc2944e8b328062e5efaa958153f1b8b96ec4c4eb2147429105d9}{serif\+::discretization\+::quadrature\+::general}}
, \mbox{\hyperlink{namespaceserif_1_1discretization_1_1quadrature_a41f6d96b8d77bc2944e8b328062e5efaab2c6de510d584484d74c9aa9f8fa9f04}{serif\+::discretization\+::quadrature\+::kelvin}}
 \}
\begin{DoxyCompactList}\small\item\em An enumeration of the different mapping kinds that a quadrature rule can have. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
File containing the Rule\+Set class and related types. The Rule\+Set class is used to determine the appropriate order and other relevant information for the integration rule based on a given quadrature query. 

\begin{DoxyAuthor}{Author}
Emily M. Boudreaux 
\end{DoxyAuthor}