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)
71 lines
2.5 KiB
Groff
71 lines
2.5 KiB
Groff
.TH "src/include/serif/discretization/quadrature/query.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
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\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <format>\fP
|
|
.br
|
|
\fR#include <string>\fP
|
|
.br
|
|
\fR#include 'serif/discretization/quadrature/rules\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/domain/physical_domains\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/forms/form_traits\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/forms/runtime\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::discretization::quadrature::Query\fP"
|
|
.br
|
|
.RI "The \fBQuery\fP 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\&. "
|
|
.ti -1c
|
|
.RI "struct \fBstd::formatter< serif::discretization::quadrature::Query >\fP"
|
|
.br
|
|
.RI "A specialization of the std::formatter for the Query struct\&. This allows for easy formatting of Query objects 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 "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<forms::Form FormT> constexpr \fBQuery\fP \fBserif::discretization::quadrature::make_query\fP (const \fBQuadratureRole\fP role, const \fBdomain::DomainOrSet\fP domain, const \fBMappingKind\fP mapping, const int trialOrder, const int testOrder, const int coefficientOrder, const int geometryWeightOrder, const std::optional< int > baseOrder=std::nullopt) noexcept"
|
|
.br
|
|
.RI "A helper function to create a \fBQuery\fP object for a given form type\&. This function is used to simplify the creation of \fBQuery\fP objects by automatically filling in the form descriptor and other relevant information\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
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\&.
|
|
|
|
|
|
.PP
|
|
\fBAuthor\fP
|
|
.RS 4
|
|
Emily M\&. Boudreaux
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|