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,68 @@
.TH "serif::backend::mfem::shared::ReferenceMeshSnapshot" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::backend::mfem::shared::ReferenceMeshSnapshot \- The external mesh metadata consumed by a graph input\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <reference_tracking\&.hpp>\fP
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "const ::mfem::Mesh * \fBidentity\fP {}"
.br
.ti -1c
.RI "long \fBsequence\fP {\-1}"
.br
.ti -1c
.RI "long \fBnodes_sequence\fP {\-1}"
.br
.ti -1c
.RI "int \fBvertices\fP {}"
.br
.ti -1c
.RI "int \fBelements\fP {}"
.br
.ti -1c
.RI "std::vector< int > \fBelement_attributes\fP"
.br
.ti -1c
.RI "std::vector< int > \fBboundary_attributes\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
The external mesh metadata consumed by a graph input\&.
.PP
\fBNote\fP
.RS 4
MFEM resources can change outside the computational graph\&. Their revisions and labels must therefore be captured at its boundary; graph invalidation then owns reuse\&. A negative node revision and an empty material list exclude those dependencies\&.
.RE
.PP
.SH "Member Data Documentation"
.PP
.SS "std::vector<int> serif::backend::mfem::shared::ReferenceMeshSnapshot::boundary_attributes"
.SS "std::vector<int> serif::backend::mfem::shared::ReferenceMeshSnapshot::element_attributes"
.SS "int serif::backend::mfem::shared::ReferenceMeshSnapshot::elements {}"
.SS "const ::mfem::Mesh* serif::backend::mfem::shared::ReferenceMeshSnapshot::identity {}"
.SS "long serif::backend::mfem::shared::ReferenceMeshSnapshot::nodes_sequence {\-1}"
.SS "long serif::backend::mfem::shared::ReferenceMeshSnapshot::sequence {\-1}"
.SS "int serif::backend::mfem::shared::ReferenceMeshSnapshot::vertices {}"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.