Emily Boudreaux
6b57738330
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)
93 lines
2.9 KiB
Groff
93 lines
2.9 KiB
Groff
.TH "src/include/serif/backend/mfem/serialize/resources.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/backend/mfem/serialize/resources.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <functional>\fP
|
|
.br
|
|
\fR#include <memory>\fP
|
|
.br
|
|
\fR#include <string>\fP
|
|
.br
|
|
\fR#include <string_view>\fP
|
|
.br
|
|
\fR#include <vector>\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/discretization/resources\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/mapping/domain_mapper\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/geometry/deformation/inputs\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/discretization/dof_map\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/utils/serialize/record\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::backend::mfem::serialize::SaveOptions\fP"
|
|
.br
|
|
.RI "Choose whether reference meshes travel with the archive or are resolved by their content identity\&. "
|
|
.ti -1c
|
|
.RI "class \fBserif::backend::mfem::serialize::ResourceWriter\fP"
|
|
.br
|
|
.RI "Collect shared meshes, collections and spaces once while recording their associations\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::backend::mfem::serialize::Resources\fP"
|
|
.br
|
|
.RI "Own meshes and finite-element resources in reverse dependency order, for creation and archive restoration\&. "
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.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::serialize\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Typedefs"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBserif::backend::mfem::serialize::MeshResolver\fP = std::function<\fButils::serialize::Result\fP<std::string>(std::string_view)>"
|
|
.br
|
|
.RI "Supply native MFEM mesh text for the requested content fingerprint when a mesh was omitted\&. "
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fButils::serialize::Result\fP< \fBResources\fP > \fBserif::backend::mfem::serialize::restore_resources\fP (const \fButils::serialize::Node\fP &node, const \fBMeshResolver\fP &resolver={})"
|
|
.br
|
|
.RI "Reconstruct all resources privately, rejecting changed mesh or coefficient interpretations\&. "
|
|
.ti -1c
|
|
.RI "\fButils::serialize::Result\fP< \fBgeometry::deformation::backend::mfem::ReferenceDiscretization\fP > \fBserif::backend::mfem::serialize::restore_reference\fP (const \fButils::serialize::Node\fP &node, \fBResources\fP &resources)"
|
|
.br
|
|
.RI "Bind the saved reference roles to already restored resources\&. "
|
|
.ti -1c
|
|
.RI "\fButils::serialize::Node\fP \fBserif::backend::mfem::serialize::binding_coordinates\fP (const \fBdiscretization::backend::mfem::DofMap\fP &binding)"
|
|
.br
|
|
.RI "Capture domain support and reduced numbering without storing mutable DofMap internals\&. "
|
|
.ti -1c
|
|
.RI "std::string \fBserif::backend::mfem::serialize::mesh_text\fP (const ::mfem::Mesh &mesh)"
|
|
.br
|
|
.RI "Emit deterministic native mesh text with enough digits to preserve binary64 coordinates\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|