docs(docs): built docs

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)
This commit is contained in:
2026-11-09 14:09:44 -05:00
parent d9c4919477
commit 6b57738330
32596 changed files with 4155414 additions and 0 deletions

View File

@@ -0,0 +1,59 @@
.TH "src/include/serif/backend/mfem/discretization/term_binding.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/discretization/term_binding.hpp \- A runtime binding between some term descriptor and its MFEM finite-element space\&. This is used to project down the compile time term descriptors into runtime reinterpretations which can then be used to extract out things like the list of dofs, the element support, and the mesh\&.
.SH SYNOPSIS
.br
.PP
\fR#include <algorithm>\fP
.br
\fR#include 'serif/discretization/blocks/traits\&.hpp'\fP
.br
\fR#include 'serif/discretization/domain/schema/concepts\&.hpp'\fP
.br
\fR#include 'serif/backend/mfem/discretization/dof_map\&.hpp'\fP
.br
\fR#include 'serif/utils/error/errors\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "class \fBserif::discretization::backend::mfem::TermBinding< TermT, SchemaT >\fP"
.br
.RI "A runtime binding between a term descriptor and its MFEM finite-element space\&. This is used to project down the compile time term descriptors into runtime reinterpretations which can then be used to extract things like the list of dofs, the element support, and the mesh\&. Note that this is a child of \fBDofMap\fP, therefor all term bindings are also dof maps\&. "
.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::backend\fP"
.br
.ti -1c
.RI "namespace \fBserif::discretization::backend::mfem\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
A runtime binding between some term descriptor and its MFEM finite-element space\&. This is used to project down the compile time term descriptors into runtime reinterpretations which can then be used to extract out things like the list of dofs, the element support, and the mesh\&.
.PP
\fBAuthor\fP
.RS 4
Emily M\&. Boudreaux
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.