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,56 @@
.TH "serif::discretization::quadrature::RoleControls" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::discretization::quadrature::RoleControls \- A struct to hold the rule controls for each quadrature role\&. This is used to group the rule controls together for convenience\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <rules\&.hpp>\fP
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBRuleControl\fP \fBdiscretization\fP"
.br
.RI "The rule control for the discretization role\&. "
.ti -1c
.RI "\fBRuleControl\fP \fBpreconditioner\fP"
.br
.RI "The rule control for the preconditioner role\&. "
.ti -1c
.RI "\fBRuleControl\fP \fBdiagnostic\fP"
.br
.RI "The rule control for the diagnostic role\&. "
.ti -1c
.RI "\fBRuleControl\fP \fBprojection\fP"
.br
.RI "The rule control for the projection role\&. "
.in -1c
.SH "Detailed Description"
.PP
A struct to hold the rule controls for each quadrature role\&. This is used to group the rule controls together for convenience\&.
.SH "Member Data Documentation"
.PP
.SS "\fBRuleControl\fP serif::discretization::quadrature::RoleControls::diagnostic"
.PP
The rule control for the diagnostic role\&.
.SS "\fBRuleControl\fP serif::discretization::quadrature::RoleControls::discretization"
.PP
The rule control for the discretization role\&.
.SS "\fBRuleControl\fP serif::discretization::quadrature::RoleControls::preconditioner"
.PP
The rule control for the preconditioner role\&.
.SS "\fBRuleControl\fP serif::discretization::quadrature::RoleControls::projection"
.PP
The rule control for the projection role\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.