137 lines
4.7 KiB
Groff
137 lines
4.7 KiB
Groff
|
.TH "src/include/serif/utils/serialize/model.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
src/include/serif/utils/serialize/model.hpp
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
\fR#include 'serif/utils/serialize/equations\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/model/state\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/model/stellar_model\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/discretization/blocks/fields\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/utils/dependencies/dependency_context\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
|
||
|
|
.SS "Classes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::utils::serialize::TermIdentity< Term >\fP"
|
||
|
|
.br
|
||
|
|
.RI "Register stable coordinate identities separately from compiler-generated display names\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::utils::serialize::TermIdentity< discretization::blocks::density::mass >\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::utils::serialize::TermIdentity< discretization::blocks::gravity::potential >\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::utils::serialize::TermIdentity< discretization::blocks::displacement::vector >\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::utils::serialize::TermIdentity< discretization::blocks::rotation::angular_velocity >\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::utils::serialize::TermIdentity< discretization::blocks::barotropic_constant::mass_normalization >\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::utils::serialize::TermIdentity< discretization::blocks::surface_deformation::coefficients >\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::utils::serialize::TermIdentity< discretization::blocks::surface_deformation::shape_equilibrium >\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::utils::serialize::TermIdentity< model::GeneratedCoordinateOf< Specification > >\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::utils::serialize::TermIdentity< model::ConstraintOf< Specification > >\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::utils::serialize::Serializer< dependencies::KeyList< Terms\&.\&.\&. > >\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::utils::serialize::Serializer< discretization::blocks::SystemLayout< Values, Residuals > >\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::utils::serialize::Serializer< model::StellarState< Layout > >\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::utils::serialize::Serializer< model::NoShapeForce >\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::utils::serialize::Serializer< model::NoSurfaceCondition >\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::utils::serialize::Serializer< model::EquilibriumEquations< Interior, Shape, Surface > >\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::utils::serialize::Serializer< model::StellarModel< EOS, Definition, types::TypeList< Specifications\&.\&.\&. > > >\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::utils::serialize::Serializer< dependencies::ValueSnapshot >\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::utils::serialize::Serializer< dependencies::Resource< Key, Storage, Policy > >\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::utils::serialize::Serializer< dependencies::DependencyContext< Resources\&.\&.\&. > >\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::utils::serialize::Serializer< dependencies::DependencyContext<> >\fP"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SS "Namespaces"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBserif\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBserif::utils\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBserif::utils::serialize\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBserif::utils::serialize::detail\fP"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SS "Typedefs"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename Model> using \fBserif::utils::serialize::detail::ResolvedEquations\fP = decltype(\fBmodel::resolve_equilibrium_equations\fP(std::declval<const Model&>()))"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename Model> using \fBserif::utils::serialize::detail::OwnedEquations\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename OriginalModel> using \fBserif::utils::serialize::RestoredStellarModel\fP = \fBmodel::StellarModel\fP<typename OriginalModel::EquationOfState, \fBdetail::OwnedEquations\fP<OriginalModel>, typename OriginalModel::SpecificationTypes>"
|
||
|
|
.br
|
||
|
|
.RI "Restore current physics as an explicit composition, without pretending to regenerate a deferred program\&. "
|
||
|
|
.in -1c
|
||
|
|
.SS "Functions"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename Term> \fBNode\fP \fBserif::utils::serialize::term_schema\fP ()"
|
||
|
|
.br
|
||
|
|
.RI "Expose the physical meaning and FE representation of one compiled coordinate\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "\fBResult\fP< void > \fBserif::utils::serialize::validate_schema\fP (const \fBNode\fP &saved, const \fBNode\fP &expected)"
|
||
|
|
.br
|
||
|
|
.RI "A compiled identity must match and must have an explicit persistence registration\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename OriginalModel> \fBResult\fP< \fBRestoredStellarModel\fP< OriginalModel > > \fBserif::utils::serialize::restore_stellar_model\fP (const \fBNode\fP &node)"
|
||
|
|
.br
|
||
|
|
.RI "Reconstruct resolved physics; future changes requiring the original callback remain a separate capability\&. "
|
||
|
|
.in -1c
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|