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)
62 lines
1.7 KiB
Groff
62 lines
1.7 KiB
Groff
.TH "src/include/serif/backend/mfem/shared/reference_tracking.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/backend/mfem/shared/reference_tracking.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <vector>\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::backend::mfem::shared::ReferenceMeshSnapshot\fP"
|
|
.br
|
|
.RI "The external mesh metadata consumed by a graph input\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::backend::mfem::shared::ReferenceSpaceSnapshot\fP"
|
|
.br
|
|
.RI "Identity and revision of the space that gives coefficients their physical meaning\&. "
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBmfem\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::backend\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::backend::mfem\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::backend::mfem::shared\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBReferenceMeshSnapshot\fP \fBserif::backend::mfem::shared::mesh_snapshot\fP (const ::mfem::Mesh *mesh, bool coordinates, bool materials)"
|
|
.br
|
|
.RI "Capture topology and boundary labels, optionally including coordinates and material labels\&. "
|
|
.ti -1c
|
|
.RI "\fBReferenceSpaceSnapshot\fP \fBserif::backend::mfem::shared::space_snapshot\fP (const ::mfem::FiniteElementSpace &space)"
|
|
.br
|
|
.RI "Capture refinement and coefficient layout without copying the finite-element space\&. "
|
|
.ti -1c
|
|
.RI "bool \fBserif::backend::mfem::shared::mesh_matches\fP (const \fBReferenceMeshSnapshot\fP &snapshot, const ::mfem::Mesh *mesh)"
|
|
.br
|
|
.RI "Compare the selected dependencies without allocating another copy of the mesh labels\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|