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,40 @@
.TH "serif::discretization::quadrature::FormRule" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::discretization::quadrature::FormRule \- A struct to represent a form rule, which contains a form descriptor and a rule control\&. Used to tie some form to a specific quadrature rule control\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <rules\&.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 "\fBRuleControl\fP \fBcontrol\fP"
.br
.RI "The rule control for the form being queried\&. This contains the fixed order and boost for the quadrature rule\&. "
.in -1c
.SH "Detailed Description"
.PP
A struct to represent a form rule, which contains a form descriptor and a rule control\&. Used to tie some form to a specific quadrature rule control\&.
.SH "Member Data Documentation"
.PP
.SS "\fBRuleControl\fP serif::discretization::quadrature::FormRule::control"
.PP
The rule control for the form being queried\&. This contains the fixed order and boost for the quadrature rule\&.
.SS "\fBforms::FormDescriptor\fP serif::discretization::quadrature::FormRule::form"
.PP
The form descriptor for the form being queried\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.