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

84 lines
3.1 KiB
Groff
Raw Normal View History

.TH "serif::backend::mfem::serialize::detail" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::backend::mfem::serialize::detail
.SH SYNOPSIS
.br
.PP
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBError\fP"
.br
.RI "Identify the component or field that could not be saved or reconstructed\&. "
.ti -1c
.RI "struct \fBOwnedBindings\fP"
.br
.ti -1c
.RI "class \fBTopModelSampler\fP"
.br
.RI "Sample copied coefficients on a private deformed geometry; the original state and mesh remain untouched\&. "
.in -1c
.SS "Typedefs"
.in +1c
.ti -1c
.RI "template<typename T> using \fBResult\fP"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "template<typename Schema> \fButils::serialize::Node\fP \fBdomain_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 > \fBrestore_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 EOS> bool \fBtop_matching_polytrope\fP (const EOS &candidate, const \fBeos::models::Polytrope\fP &physical)"
.br
.RI "Verify the actual closure EOS rather than assuming a borrowed equation uses the model's values\&. "
.in -1c
.SS "Variables"
.in +1c
.ti -1c
.RI "template<typename T> constexpr bool \fBtop_rigid_barotrope\fP = false"
.br
.ti -1c
.RI "template<typename EOS> constexpr bool \fBtop_rigid_barotrope< equations::BarotropicDensityBalance< EOS > >\fP = true"
.br
.in -1c
.SH "Typedef Documentation"
.PP
.SS "template<typename T> using \fBserif::utils::serialize::Result\fP"
.SH "Function Documentation"
.PP
.SS "template<typename Schema> \fButils::serialize::Node\fP serif::backend::mfem::serialize::detail::domain_schema ()\fR [nodiscard]\fP"
.PP
Record semantic domain and boundary labels, independent of live mesh addresses\&.
.SS "template<typename Key, typename Context, typename Keys> \fButils::serialize::Result\fP< void > serif::backend::mfem::serialize::detail::restore_binding (const \fButils::serialize::Node\fP & node, \fBOwnedBindings\fP< Context, Keys > & owner)\fR [nodiscard]\fP"
.PP
Restore one typed term only after checking its scientific identity and reduced numbering\&.
.SS "template<typename EOS> bool serif::backend::mfem::serialize::detail::top_matching_polytrope (const EOS & candidate, const \fBeos::models::Polytrope\fP & physical)\fR [nodiscard]\fP"
.PP
Verify the actual closure EOS rather than assuming a borrowed equation uses the model's values\&.
.SH "Variable Documentation"
.PP
.SS "template<typename T> bool serif::backend::mfem::serialize::detail::top_rigid_barotrope = false\fR [inline]\fP, \fR [constexpr]\fP"
.SS "template<typename EOS> bool \fBserif::backend::mfem::serialize::detail::top_rigid_barotrope\fP< \fBequations::BarotropicDensityBalance\fP< EOS > > = true\fR [inline]\fP, \fR [constexpr]\fP"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.