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)
91 lines
3.0 KiB
Groff
91 lines
3.0 KiB
Groff
.TH "src/include/serif/backend/mfem/serialize/discretization.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/backend/mfem/serialize/discretization.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <optional>\fP
|
|
.br
|
|
\fR#include <tuple>\fP
|
|
.br
|
|
\fR#include <type_traits>\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/model/discretization\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/serialize/resources\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/utils/serialize/model\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/utils/serialize/physics\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< model::backend::mfem::StellarDiscretization< Owner, Bindings, Deformation > >\fP"
|
|
.br
|
|
.RI "Integrate native discretizations into packs while keeping application-owner reconstruction explicit\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::backend::mfem::serialize::detail::OwnedBindings< Context, Keys >\fP"
|
|
.br
|
|
.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
|
|
.ti -1c
|
|
.RI "namespace \fBserif::backend::mfem::serialize::detail\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::utils\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::utils::serialize\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Typedefs"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename Original> using \fBserif::backend::mfem::serialize::RestoredDiscretization\fP"
|
|
.br
|
|
.RI "Retain all compile-time physical choices while replacing an opaque user owner with archive-owned resources\&. "
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename Schema> \fButils::serialize::Node\fP \fBserif::backend::mfem::serialize::detail::domain_schema\fP ()"
|
|
.br
|
|
.RI "Record semantic domain and boundary labels, independent of live mesh addresses\&. "
|
|
.ti -1c
|
|
.RI "template<typename Key, typename Context, typename Keys> \fButils::serialize::Result\fP< void > \fBserif::backend::mfem::serialize::detail::restore_binding\fP (const \fButils::serialize::Node\fP &node, \fBOwnedBindings\fP< Context, Keys > &owner)"
|
|
.br
|
|
.RI "Restore one typed term only after checking its scientific identity and reduced numbering\&. "
|
|
.ti -1c
|
|
.RI "template<typename Owner, typename Bindings, typename Deformation> \fButils::serialize::Node\fP \fBserif::backend::mfem::serialize::save_discretization\fP (const \fBmodel::backend::mfem::StellarDiscretization\fP< Owner, Bindings, Deformation > &value, \fBSaveOptions\fP options={})"
|
|
.br
|
|
.RI "Save physical FE interpretation and numerical geometry, excluding caches and the application's opaque owner\&. "
|
|
.ti -1c
|
|
.RI "template<typename Original> \fButils::serialize::Result\fP< \fBRestoredDiscretization\fP< Original > > \fBserif::backend::mfem::serialize::restore_discretization\fP (const \fButils::serialize::Node\fP &node, const \fBMeshResolver\fP &resolver={})"
|
|
.br
|
|
.RI "Recreate a typed discretization with its own meshes, spaces and mapping inputs\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|