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)
103 lines
4.4 KiB
Groff
103 lines
4.4 KiB
Groff
.TH "src/include/serif/discretization/quadrature/rules.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/discretization/quadrature/rules.hpp \- File containing the RuleSet class and related types\&. The RuleSet class is used to determine the appropriate order and other relevant information for the integration rule based on a given quadrature query\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <optional>\fP
|
|
.br
|
|
\fR#include <string>\fP
|
|
.br
|
|
\fR#include <vector>\fP
|
|
.br
|
|
\fR#include <format>\fP
|
|
.br
|
|
\fR#include <utility>\fP
|
|
.br
|
|
\fR#include 'serif/discretization/forms/runtime\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::discretization::quadrature::RuleControl\fP"
|
|
.br
|
|
.RI "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\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::discretization::quadrature::FormRule\fP"
|
|
.br
|
|
.RI "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\&. "
|
|
.ti -1c
|
|
.RI "class \fBserif::discretization::quadrature::RuleSet\fP"
|
|
.br
|
|
.RI "The \fBRuleSet\fP 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\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::discretization::quadrature::Resolution\fP"
|
|
.br
|
|
.RI "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\&. "
|
|
.ti -1c
|
|
.RI "struct \fBstd::formatter< serif::discretization::quadrature::QuadratureRole >\fP"
|
|
.br
|
|
.RI "Specializations of the std::formatter for the QuadratureRole, MappingKind, RuleControl, FormRule, and RuleSet types\&. This allows for easy formatting of these types using std::format\&. "
|
|
.ti -1c
|
|
.RI "struct \fBstd::formatter< serif::discretization::quadrature::MappingKind >\fP"
|
|
.br
|
|
.RI "Specializations of the std::formatter for the MappingKind type\&. This allows for easy formatting of the MappingKind type using std::format\&. "
|
|
.ti -1c
|
|
.RI "struct \fBstd::formatter< serif::discretization::quadrature::RuleControl >\fP"
|
|
.br
|
|
.RI "A specialization of the std::formatter for the RuleControl type\&. This allows for easy formatting of the RuleControl type using std::format\&. "
|
|
.ti -1c
|
|
.RI "struct \fBstd::formatter< serif::discretization::quadrature::FormRule >\fP"
|
|
.br
|
|
.RI "A specialization of the std::formatter for the FormRule type\&. This allows for easy formatting of the FormRule type using std::format\&. "
|
|
.ti -1c
|
|
.RI "struct \fBstd::formatter< serif::discretization::quadrature::RuleSet >\fP"
|
|
.br
|
|
.RI "A specialization of the std::formatter for the RuleSet type\&. This allows for easy formatting of the RuleSet type using std::format\&. "
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::discretization\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::discretization::quadrature\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Enumerations"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "enum class \fBserif::discretization::quadrature::QuadratureRole\fP { \fBserif::discretization::quadrature::discretization\fP, \fBserif::discretization::quadrature::preconditioner\fP, \fBserif::discretization::quadrature::diagnostic\fP, \fBserif::discretization::quadrature::projection\fP }"
|
|
.br
|
|
.RI "An enumeration of the different roles that a quadrature rule can play\&. "
|
|
.ti -1c
|
|
.RI "enum class \fBserif::discretization::quadrature::MappingKind\fP { \fBserif::discretization::quadrature::none\fP, \fBserif::discretization::quadrature::affine\fP, \fBserif::discretization::quadrature::general\fP, \fBserif::discretization::quadrature::kelvin\fP }"
|
|
.br
|
|
.RI "An enumeration of the different mapping kinds that a quadrature rule can have\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
File containing the RuleSet class and related types\&. The RuleSet class is used to determine the appropriate order and other relevant information for the integration rule based on a given quadrature query\&.
|
|
|
|
|
|
.PP
|
|
\fBAuthor\fP
|
|
.RS 4
|
|
Emily M\&. Boudreaux
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|