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)
57 lines
1.8 KiB
Groff
57 lines
1.8 KiB
Groff
.TH "serif::discretization::quadrature::Resolution" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::quadrature::Resolution \- 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\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <rules\&.hpp>\fP
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "int \fBbase_order\fP"
|
|
.br
|
|
.RI "The base order of the quadrature rule, which is determined by the form and role\&. "
|
|
.ti -1c
|
|
.RI "int \fBboost\fP"
|
|
.br
|
|
.RI "The boost to the order of the quadrature rule, generally manually set\&. "
|
|
.ti -1c
|
|
.RI "int \fBorder\fP"
|
|
.br
|
|
.RI "The final order of the quadrature rule, which is the sum of the base order and boost\&. "
|
|
.ti -1c
|
|
.RI "bool \fBused_fixed_order\fP"
|
|
.br
|
|
.RI "A flag indicating whether a fixed order was used\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
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\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "int serif::discretization::quadrature::Resolution::base_order"
|
|
|
|
.PP
|
|
The base order of the quadrature rule, which is determined by the form and role\&.
|
|
.SS "int serif::discretization::quadrature::Resolution::boost"
|
|
|
|
.PP
|
|
The boost to the order of the quadrature rule, generally manually set\&.
|
|
.SS "int serif::discretization::quadrature::Resolution::order"
|
|
|
|
.PP
|
|
The final order of the quadrature rule, which is the sum of the base order and boost\&.
|
|
.SS "bool serif::discretization::quadrature::Resolution::used_fixed_order"
|
|
|
|
.PP
|
|
A flag indicating whether a fixed order was used\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|