Files
MeanField_SERiF/docs/man/man3/serif_backend_mfem_serialize_ResourceWriter.3

127 lines
4.5 KiB
Groff
Raw Permalink Normal View History

.TH "serif::backend::mfem::serialize::ResourceWriter" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::backend::mfem::serialize::ResourceWriter \- Collect shared meshes, collections and spaces once while recording their associations\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <resources\&.hpp>\fP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBResourceWriter\fP (\fBSaveOptions\fP options={})"
.br
.RI "Select whether each distinct mesh is embedded\&. "
.ti -1c
.RI "std::uint64_t \fBmesh\fP (const ::mfem::Mesh &value)"
.br
.RI "Record one mesh and return its archive index\&. "
.ti -1c
.RI "std::uint64_t \fBspace\fP (const ::mfem::FiniteElementSpace &value)"
.br
.RI "Record one fixed-order space and return its archive index\&. "
.ti -1c
.RI "void \fBmapping\fP (const ::mfem::GridFunction &compactification, const \fBserif::mapping::DomainMapper\fP &mapper)"
.br
.RI "Record field geometry, compactification and mapping inputs\&. "
.ti -1c
.RI "\fButils::serialize::Node\fP \fBreference\fP (const \fBgeometry::deformation::backend::mfem::ReferenceDiscretization\fP &value)"
.br
.RI "Record the paired spaces and mesh used to interpret shape coefficients\&. "
.ti -1c
.RI "\fButils::serialize::Node\fP \fBfinish\fP () &&"
.br
.RI "Move the complete resource record into its containing discretization\&. "
.in -1c
.SS "Private Member Functions"
.in +1c
.ti -1c
.RI "std::uint64_t \fBcollection\fP (const ::mfem::FiniteElementCollection &value)"
.br
.RI "Share collection identity because deformation companions require the same collection object\&. "
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "\fBSaveOptions\fP \fBm_options\fP"
.br
.ti -1c
.RI "\fButils::serialize::Node\fP \fBm_record\fP"
.br
.ti -1c
.RI "std::vector< const ::mfem::Mesh * > \fBm_meshes\fP"
.br
.ti -1c
.RI "std::vector< const ::mfem::FiniteElementCollection * > \fBm_collections\fP"
.br
.ti -1c
.RI "std::vector< const ::mfem::FiniteElementSpace * > \fBm_spaces\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Collect shared meshes, collections and spaces once while recording their associations\&.
.PP
\fBNote\fP
.RS 4
Pointer identity is used only during writing; the archive contains numbered references\&.
.RE
.PP
.SH "Constructor & Destructor Documentation"
.PP
.SS "serif::backend::mfem::serialize::ResourceWriter::ResourceWriter (\fBSaveOptions\fP options = \fR{}\fP)\fR [explicit]\fP"
.PP
Select whether each distinct mesh is embedded\&.
.SH "Member Function Documentation"
.PP
.SS "std::uint64_t serif::backend::mfem::serialize::ResourceWriter::collection (const ::mfem::FiniteElementCollection & value)\fR [nodiscard]\fP, \fR [private]\fP"
.PP
Share collection identity because deformation companions require the same collection object\&.
.SS "\fButils::serialize::Node\fP serif::backend::mfem::serialize::ResourceWriter::finish () &&\fR [nodiscard]\fP"
.PP
Move the complete resource record into its containing discretization\&.
.SS "void serif::backend::mfem::serialize::ResourceWriter::mapping (const ::mfem::GridFunction & compactification, const \fBserif::mapping::DomainMapper\fP & mapper)"
.PP
Record field geometry, compactification and mapping inputs\&.
.SS "std::uint64_t serif::backend::mfem::serialize::ResourceWriter::mesh (const ::mfem::Mesh & value)\fR [nodiscard]\fP"
.PP
Record one mesh and return its archive index\&.
.SS "\fButils::serialize::Node\fP serif::backend::mfem::serialize::ResourceWriter::reference (const \fBgeometry::deformation::backend::mfem::ReferenceDiscretization\fP & value)\fR [nodiscard]\fP"
.PP
Record the paired spaces and mesh used to interpret shape coefficients\&.
.SS "std::uint64_t serif::backend::mfem::serialize::ResourceWriter::space (const ::mfem::FiniteElementSpace & value)\fR [nodiscard]\fP"
.PP
Record one fixed-order space and return its archive index\&.
.SH "Member Data Documentation"
.PP
.SS "std::vector<const ::mfem::FiniteElementCollection*> serif::backend::mfem::serialize::ResourceWriter::m_collections\fR [private]\fP"
.SS "std::vector<const ::mfem::Mesh*> serif::backend::mfem::serialize::ResourceWriter::m_meshes\fR [private]\fP"
.SS "\fBSaveOptions\fP serif::backend::mfem::serialize::ResourceWriter::m_options\fR [private]\fP"
.SS "\fButils::serialize::Node\fP serif::backend::mfem::serialize::ResourceWriter::m_record\fR [private]\fP"
.SS "std::vector<const ::mfem::FiniteElementSpace*> serif::backend::mfem::serialize::ResourceWriter::m_spaces\fR [private]\fP"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.