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)
99 lines
3.9 KiB
Groff
99 lines
3.9 KiB
Groff
.TH "src/include/serif/backend/mfem/discretization/quadrature/mfem_resolver.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/backend/mfem/discretization/quadrature/mfem_resolver.hpp \- File containing the MFEMResolver class\&. This class is used to resolve the appropriate MFEM integration rule for a given quadrature context\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <span>\fP
|
|
.br
|
|
\fR#include <format>\fP
|
|
.br
|
|
\fR#include <unordered_map>\fP
|
|
.br
|
|
\fR#include 'mfem/fem/geom\&.hpp'\fP
|
|
.br
|
|
\fR#include 'mfem/fem/intrules\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/quadrature/rules\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/discretization/quadrature/order\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/domain/concepts\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/quadrature/policy\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/quadrature/query\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/discretization/quadrature/concepts\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/discretization/quadrature/configure\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/discretization/quadrature/mfem_static_order\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/utils/format/strings\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::discretization::quadrature::backend::mfem::MFEMQuadratureContext\fP"
|
|
.br
|
|
.RI "The \fBMFEMQuadratureContext\fP struct is used to describe the context in which we are trying to resolve an MFEM integration rule\&. This includes the geometry type, the order of the geometry weight, any dynamic orders, the domain or set of domains, and the mapping kind\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::discretization::quadrature::backend::mfem::MFEMRule\fP"
|
|
.br
|
|
.RI "The \fBMFEMRule\fP struct is used to describe the result of resolving an MFEM integration rule\&. This includes the resolution (which contains the order and any other relevant information) and a pointer to the integration rule itself\&. "
|
|
.ti -1c
|
|
.RI "class \fBserif::discretization::quadrature::backend::mfem::MFEMResolver\fP"
|
|
.br
|
|
.RI "The \fBMFEMResolver\fP class is used to resolve the appropriate MFEM integration rule for a given quadrature context\&. It uses a policy to determine the appropriate order and other relevant information for the integration rule\&. "
|
|
.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
|
|
.ti -1c
|
|
.RI "namespace \fBserif::discretization::quadrature::backend\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::discretization::quadrature::backend::mfem\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
File containing the MFEMResolver class\&. This class is used to resolve the appropriate MFEM integration rule for a given quadrature context\&.
|
|
|
|
|
|
.PP
|
|
\fBAuthor\fP
|
|
.RS 4
|
|
Emily M\&. Boudreaux
|
|
.RE
|
|
.PP
|
|
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
We may want to consider renaming this file to runtime to stick to convention\&. The reason I did not initially is that this is more specific than pure runtime projection of compile time invariants (which is what most of the other files named runtime\&.hpp do)\&. Something to think about\&.
|
|
|
|
.PP
|
|
You will see \fBmfem\fP throughout\&. This is an important syntax to use here since MFEM's code lives in the mfem namespace; however, we also have code living in an mfem namespace\&. Outside of translation units that include using namespace \fBserif::discretization::quadrature::backend\fP and outside of the \fBserif::discretization::quadrature::backend::mfem\fP namespace itself these two things do not conflict\&. However, in those two cases there is a degeneracy the compiler cannot resolve between mfem:: and mfem::\&. Using \fBmfem\fP explicitly tells the compiler that we are looking from the root of the namespace tree not the current namespace\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|