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)
113 lines
3.4 KiB
Groff
113 lines
3.4 KiB
Groff
.TH "serif::discretization::quadrature::Query" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::quadrature::Query \- 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\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <query\&.hpp>\fP
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBforms::FormDescriptor\fP \fBform\fP"
|
|
.br
|
|
.RI "The form descriptor for the form being queried\&. "
|
|
.ti -1c
|
|
.RI "\fBQuadratureRole\fP \fBrole\fP = \fBQuadratureRole::discretization\fP"
|
|
.br
|
|
.RI "The role of the quadrature rule\&. "
|
|
.ti -1c
|
|
.RI "\fBdomain::DomainOrSet\fP \fBdomain\fP = \fBdomain::AllDomains\fP{}"
|
|
.br
|
|
.RI "The domain or set of domains for which we are trying to resolve an MFEM integration rule\&. "
|
|
.ti -1c
|
|
.RI "\fBMappingKind\fP \fBmapping\fP = \fBMappingKind::none\fP"
|
|
.br
|
|
.RI "The mapping kind of the quadrature rule\&. "
|
|
.ti -1c
|
|
.RI "int \fBtrial_order\fP = 0"
|
|
.br
|
|
.RI "The order of the trial space\&. "
|
|
.ti -1c
|
|
.RI "int \fBtest_order\fP = 0"
|
|
.br
|
|
.RI "The order of the test space\&. "
|
|
.ti -1c
|
|
.RI "int \fBcoefficient_order\fP = 0"
|
|
.br
|
|
.RI "The order of the coefficient space\&. "
|
|
.ti -1c
|
|
.RI "int \fBgeometry_weight_order\fP = 0"
|
|
.br
|
|
.RI "The order of the geometry weight\&. "
|
|
.ti -1c
|
|
.RI "int \fBtrial_order_reduction\fP = 0"
|
|
.br
|
|
.RI "The reduction in the order of the trial space\&. "
|
|
.ti -1c
|
|
.RI "int \fBtest_order_reduction\fP = 0"
|
|
.br
|
|
.RI "The reduction in the order of the test space\&. "
|
|
.ti -1c
|
|
.RI "std::optional< int > \fBbase_order\fP"
|
|
.br
|
|
.RI "The base order for the quadrature rule\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
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\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "std::optional<int> serif::discretization::quadrature::Query::base_order"
|
|
|
|
.PP
|
|
The base order for the quadrature rule\&.
|
|
.SS "int serif::discretization::quadrature::Query::coefficient_order = 0"
|
|
|
|
.PP
|
|
The order of the coefficient space\&.
|
|
.SS "\fBdomain::DomainOrSet\fP serif::discretization::quadrature::Query::domain = \fBdomain::AllDomains\fP{}"
|
|
|
|
.PP
|
|
The domain or set of domains for which we are trying to resolve an MFEM integration rule\&.
|
|
.SS "\fBforms::FormDescriptor\fP serif::discretization::quadrature::Query::form"
|
|
|
|
.PP
|
|
The form descriptor for the form being queried\&.
|
|
.SS "int serif::discretization::quadrature::Query::geometry_weight_order = 0"
|
|
|
|
.PP
|
|
The order of the geometry weight\&.
|
|
.SS "\fBMappingKind\fP serif::discretization::quadrature::Query::mapping = \fBMappingKind::none\fP"
|
|
|
|
.PP
|
|
The mapping kind of the quadrature rule\&.
|
|
.SS "\fBQuadratureRole\fP serif::discretization::quadrature::Query::role = \fBQuadratureRole::discretization\fP"
|
|
|
|
.PP
|
|
The role of the quadrature rule\&.
|
|
.SS "int serif::discretization::quadrature::Query::test_order = 0"
|
|
|
|
.PP
|
|
The order of the test space\&.
|
|
.SS "int serif::discretization::quadrature::Query::test_order_reduction = 0"
|
|
|
|
.PP
|
|
The reduction in the order of the test space\&.
|
|
.SS "int serif::discretization::quadrature::Query::trial_order = 0"
|
|
|
|
.PP
|
|
The order of the trial space\&.
|
|
.SS "int serif::discretization::quadrature::Query::trial_order_reduction = 0"
|
|
|
|
.PP
|
|
The reduction in the order of the trial space\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|