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)
797 lines
63 KiB
XML
797 lines
63 KiB
XML
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
|
|
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.13.2" xml:lang="en-US">
|
|
<compounddef id="namespaceserif_1_1utils_1_1serialize" kind="namespace" language="C++">
|
|
<compoundname>serif::utils::serialize</compoundname>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_entry" prot="public">serif::utils::serialize::Entry</innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_enum_serializer" prot="public">serif::utils::serialize::EnumSerializer</innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_error" prot="public">serif::utils::serialize::Error</innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_field" prot="public">serif::utils::serialize::Field</innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_member" prot="public">serif::utils::serialize::Member</innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_named_member" prot="public">serif::utils::serialize::NamedMember</innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_node" prot="public">serif::utils::serialize::Node</innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_pack" prot="public">serif::utils::serialize::Pack</innerclass>
|
|
<innerclass refid="classserif_1_1utils_1_1serialize_1_1_reader" prot="public">serif::utils::serialize::Reader</innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_read_options" prot="public">serif::utils::serialize::ReadOptions</innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_recipe_serializer" prot="public">serif::utils::serialize::RecipeSerializer</innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_schema_serializer" prot="public">serif::utils::serialize::SchemaSerializer</innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer" prot="public">serif::utils::serialize::Serializer</innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01char_0f_size_0e_4" prot="public">serif::utils::serialize::Serializer< char[Size]></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01dependencies_1_1_binding_3_01_key_00_01_target_01_4_01_4" prot="public">serif::utils::serialize::Serializer< dependencies::Binding< Key, Target > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01dependencies_1_1_bindings_3_01_bindings_8_8_8_01_4_01_4" prot="public">serif::utils::serialize::Serializer< dependencies::Bindings< Bindings... > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01dependencies_1_1_dependency_context_3_01_resources_8_8_8_01_4_01_4" prot="public">serif::utils::serialize::Serializer< dependencies::DependencyContext< Resources... > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01dependencies_1_1_dependency_context_3_4_01_4" prot="public">serif::utils::serialize::Serializer< dependencies::DependencyContext<> ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01dependencies_1_1_key_list_3_01_terms_8_8_8_01_4_01_4" prot="public">serif::utils::serialize::Serializer< dependencies::KeyList< Terms... > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01dependencies_1_1_resource_3_01_key_00_01_storage_00_01_policy_01_4_01_4" prot="public">serif::utils::serialize::Serializer< dependencies::Resource< Key, Storage, Policy > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01dependencies_1_1_value_snapshot_01_4" prot="public">serif::utils::serialize::Serializer< dependencies::ValueSnapshot ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01dimensions_1_1_quantity_value_3_01_quantity_01_4_01_4" prot="public">serif::utils::serialize::Serializer< dimensions::QuantityValue< Quantity > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01discretization_1_1blocks_1_1_system_layout_0ff134e806ae8fabb2824d65ab96ab41" prot="public">serif::utils::serialize::Serializer< discretization::blocks::SystemLayout< Values, Residuals > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01discretization_1_1quadrature_1_1_policy_01_4" prot="public">serif::utils::serialize::Serializer< discretization::quadrature::Policy ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01discretization_1_1quadrature_1_1_rule_control_01_4" prot="public">serif::utils::serialize::Serializer< discretization::quadrature::RuleControl ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01discretization_1_1quadrature_1_1_rule_set_01_4" prot="public">serif::utils::serialize::Serializer< discretization::quadrature::RuleSet ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01eos_1_1models_1_1_polytrope_01_4" prot="public">serif::utils::serialize::Serializer< eos::models::Polytrope ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01equations_1_1_angular_momentum_constraint_01_4" prot="public">serif::utils::serialize::Serializer< equations::AngularMomentumConstraint ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01equations_1_1_barotropic_density_balance_3_01_e_o_s_01_4_01_4" prot="public">serif::utils::serialize::Serializer< equations::BarotropicDensityBalance< EOS > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01equations_1_1_barycenter_constraint_3_01_axis_00_01_row_01_4_01_4" prot="public">serif::utils::serialize::Serializer< equations::BarycenterConstraint< Axis, Row > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01equations_1_1_equation_registry_3_01_equations_8_8_8_01_4_01_4" prot="public">serif::utils::serialize::Serializer< equations::EquationRegistry< Equations... > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01equations_1_1_mass_normalization_01_4" prot="public">serif::utils::serialize::Serializer< equations::MassNormalization ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01equations_1_1_point_mass_companion_01_4" prot="public">serif::utils::serialize::Serializer< equations::PointMassCompanion ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01equations_1_1_primal_poisson_balance_01_4" prot="public">serif::utils::serialize::Serializer< equations::PrimalPoissonBalance ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01equations_1_1_surface_potential_balance_01_4" prot="public">serif::utils::serialize::Serializer< equations::SurfacePotentialBalance ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01geometry_1_1deformation_1_1_domain_deformatfca458f28e7e3e0b42d8a4d880ba00cb" prot="public">serif::utils::serialize::Serializer< geometry::deformation::DomainDeformation< Surface, Interior, Vacuum > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01geometry_1_1deformation_1_1_fixed_infinity_radial_extension_01_4" prot="public">serif::utils::serialize::Serializer< geometry::deformation::FixedInfinityRadialExtension ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01geometry_1_1deformation_1_1_geometry_step_limit_01_4" prot="public">serif::utils::serialize::Serializer< geometry::deformation::GeometryStepLimit ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01geometry_1_1deformation_1_1keys_1_1_surface_metric_01_4" prot="public">serif::utils::serialize::Serializer< geometry::deformation::keys::SurfaceMetric ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01geometry_1_1deformation_1_1_nodal_radial_surface_01_4" prot="public">serif::utils::serialize::Serializer< geometry::deformation::NodalRadialSurface ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01geometry_1_1deformation_1_1_power_law_radial_extension_01_4" prot="public">serif::utils::serialize::Serializer< geometry::deformation::PowerLawRadialExtension ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01geometry_1_1deformation_1_1_spherical_harmonic_surface_01_4" prot="public">serif::utils::serialize::Serializer< geometry::deformation::SphericalHarmonicSurface ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01geometry_1_1surface_1_1_isobaric_surface_01_4" prot="public">serif::utils::serialize::Serializer< geometry::surface::IsobaricSurface ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01laneemden_1_1_integration_options_01_4" prot="public">serif::utils::serialize::Serializer< laneemden::IntegrationOptions ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01model_1_1backend_1_1mfem_1_1_stellar_discree159e3517b28c4c8168613dfca6fe92a" prot="public">serif::utils::serialize::Serializer< model::backend::mfem::StellarDiscretization< Owner, Bindings, Deformation > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01model_1_1_discretization_options_3_01_model6067d6d29d8c7435c40c1c6cda543675" prot="public">serif::utils::serialize::Serializer< model::DiscretizationOptions< Model, FiniteElements, Normalization, Preconditioner > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01model_1_1_eos_reference_3_01_e_o_s_01_4_01_4" prot="public">serif::utils::serialize::Serializer< model::EosReference< EOS > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01model_1_1_equilibrium_equations_3_01_interif5348cc482fa0837731ef29e43caf9e1" prot="public">serif::utils::serialize::Serializer< model::EquilibriumEquations< Interior, Shape, Surface > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01model_1_1_fixed_angular_momentum_01_4" prot="public">serif::utils::serialize::Serializer< model::FixedAngularMomentum ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01model_1_1_fixed_total_mass_01_4" prot="public">serif::utils::serialize::Serializer< model::FixedTotalMass ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01model_1_1normalization_1_1_surface_rows_01_4" prot="public">serif::utils::serialize::Serializer< model::normalization::SurfaceRows ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01model_1_1_no_shape_force_01_4" prot="public">serif::utils::serialize::Serializer< model::NoShapeForce ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01model_1_1_no_surface_condition_01_4" prot="public">serif::utils::serialize::Serializer< model::NoSurfaceCondition ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01model_1_1preconditioning_1_1_none_01_4" prot="public">serif::utils::serialize::Serializer< model::preconditioning::None ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01model_1_1_stellar_model_3_01_e_o_s_00_01_de66a561ce84ebc1ad4f2655cbafe05d29" prot="public">serif::utils::serialize::Serializer< model::StellarModel< EOS, Definition, types::TypeList< Specifications... > > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01model_1_1_stellar_state_3_01_layout_01_4_01_4" prot="public">serif::utils::serialize::Serializer< model::StellarState< Layout > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01_node_01_4" prot="public">serif::utils::serialize::Serializer< Node ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01operators_1_1backend_1_1mfem_1_1_volume_options_01_4" prot="public">serif::utils::serialize::Serializer< operators::backend::mfem::VolumeOptions ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1_backtracking_01_4" prot="public">serif::utils::serialize::Serializer< solver::Backtracking ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1linear_1_1_control_01_4" prot="public">serif::utils::serialize::Serializer< solver::linear::Control ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1linear_1_1_f_g_m_r_e_s_01_4" prot="public">serif::utils::serialize::Serializer< solver::linear::FGMRES ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1linear_1_1_report_01_4" prot="public">serif::utils::serialize::Serializer< solver::linear::Report ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1linear_1_1_status_01_4" prot="public">serif::utils::serialize::Serializer< solver::linear::Status ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1_metric_evaluation_01_4" prot="public">serif::utils::serialize::Serializer< solver::MetricEvaluation ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1_newton_01_4" prot="public">serif::utils::serialize::Serializer< solver::Newton ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1_newton_checkpoint_3_01_state_01_4_01_4" prot="public">serif::utils::serialize::Serializer< solver::NewtonCheckpoint< State > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1_newton_progress_01_4" prot="public">serif::utils::serialize::Serializer< solver::NewtonProgress ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1normalization_1_1_automatic_plan_01_4" prot="public">serif::utils::serialize::Serializer< solver::normalization::AutomaticPlan ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1normalization_1_1_diagonal_normalization_01_4" prot="public">serif::utils::serialize::Serializer< solver::normalization::DiagonalNormalization ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1normalization_1_1_dimensionless_01_4" prot="public">serif::utils::serialize::Serializer< solver::normalization::Dimensionless ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1normalization_1_1_dimensionless_r5cccab2fd1f566ce0d4cd0c4272c0de8" prot="public">serif::utils::serialize::Serializer< solver::normalization::DimensionlessRieszCoordinate< Quantity, Metric, Geometry > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1normalization_1_1_from_model_01_4" prot="public">serif::utils::serialize::Serializer< solver::normalization::FromModel ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1normalization_1_1_identity_coordinate_01_4" prot="public">serif::utils::serialize::Serializer< solver::normalization::IdentityCoordinate ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1normalization_1_1_lane_emden_appr280bda78ea4050d0ff8b72e64d00b94a" prot="public">serif::utils::serialize::Serializer< solver::normalization::LaneEmdenApproximation< Mass, Density > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1normalization_1_1_normalization_o6acc76af4c0fbc1dccb396f0a7cb69c5" prot="public">serif::utils::serialize::Serializer< solver::normalization::NormalizationOptions< Scheme, Coordinates, Plan, Sources, Computations > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1normalization_1_1_normalization_p405753c19e233a35f6ab15d812b35123" prot="public">serif::utils::serialize::Serializer< solver::normalization::NormalizationPlan< Values, Residuals > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1normalization_1_1_physical_riesz_adabf6970471703d441b80d61686d40f" prot="public">serif::utils::serialize::Serializer< solver::normalization::PhysicalRieszCoordinate< Quantity, Metric > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1normalization_1_1_reference_volume_metric_3_01_term_01_4_01_4" prot="public">serif::utils::serialize::Serializer< solver::normalization::ReferenceVolumeMetric< Term > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1normalization_1_1_stellar_reference_scales_01_4" prot="public">serif::utils::serialize::Serializer< solver::normalization::StellarReferenceScales ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1normalization_1_1_unit_metric_01_4" prot="public">serif::utils::serialize::Serializer< solver::normalization::UnitMetric ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1normalization_1_1_with_point_rows7f253a21848d4633f0a601821f4c7a4e" prot="public">serif::utils::serialize::Serializer< solver::normalization::WithPointRows< Volume, Quantity, Selection > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1_normalized_residual_metric_01_4" prot="public">serif::utils::serialize::Serializer< solver::NormalizedResidualMetric ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1preconditioner_1_1_block_precondi8332ef5e96df07be9da235c2e3175838" prot="public">serif::utils::serialize::Serializer< solver::preconditioner::BlockPreconditioner< Row, Field, Strategy > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1preconditioner_1_1_bordered_preco61576a59daf50c7dd924da92bf2d3074" prot="public">serif::utils::serialize::Serializer< solver::preconditioner::BorderedPreconditioner< Fields, Constraints > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1preconditioner_1_1_coupled_precon5f86489d6a54160e4f32d710885530a8" prot="public">serif::utils::serialize::Serializer< solver::preconditioner::CoupledPreconditioner< First, Second, Policy > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1preconditioner_1_1strategies_1_1c749e8d76ab33c4221418ab091a95767f" prot="public">serif::utils::serialize::Serializer< solver::preconditioner::strategies::coupling::SecondThenFirst ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1preconditioner_1_1strategies_1_1inverse_1_1_dense_direct_01_4" prot="public">serif::utils::serialize::Serializer< solver::preconditioner::strategies::inverse::DenseDirect ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1preconditioner_1_1strategies_1_1inverse_1_1_diagonal_01_4" prot="public">serif::utils::serialize::Serializer< solver::preconditioner::strategies::inverse::Diagonal ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1preconditioner_1_1strategies_1_1inverse_1_1_fixed_a_m_g_01_4" prot="public">serif::utils::serialize::Serializer< solver::preconditioner::strategies::inverse::FixedAMG ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1preconditioner_1_1strategies_1_1inverse_1_1_sparse_direct_01_4" prot="public">serif::utils::serialize::Serializer< solver::preconditioner::strategies::inverse::SparseDirect ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1_solve_diagnostics_01_4" prot="public">serif::utils::serialize::Serializer< solver::SolveDiagnostics ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1_solve_result_3_01_state_00_01_system_00_01_model_01_4_01_4" prot="public">serif::utils::serialize::Serializer< solver::SolveResult< State, System, Model > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1_solver_options_3_01_metric_00_013ca3bdcad21963925dfd88948dd19ab4" prot="public">serif::utils::serialize::Serializer< solver::SolverOptions< Metric, Strategies, Linear > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1_solve_status_01_4" prot="public">serif::utils::serialize::Serializer< solver::SolveStatus ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01solver_1_1_standard_newton_01_4" prot="public">serif::utils::serialize::Serializer< solver::StandardNewton ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01std_1_1array_3_01_t_00_01_size_01_4_01_4" prot="public">serif::utils::serialize::Serializer< std::array< T, Size > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01std_1_1optional_3_01_t_01_4_01_4" prot="public">serif::utils::serialize::Serializer< std::optional< T > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01std_1_1string_01_4" prot="public">serif::utils::serialize::Serializer< std::string ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01std_1_1string__view_01_4" prot="public">serif::utils::serialize::Serializer< std::string_view ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01std_1_1tuple_3_01_t_8_8_8_01_4_01_4" prot="public">serif::utils::serialize::Serializer< std::tuple< T... > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01std_1_1vector_3_01_t_01_4_01_4" prot="public">serif::utils::serialize::Serializer< std::vector< T > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_serializer_3_01_t_01_4" prot="public">serif::utils::serialize::Serializer< T ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_struct_serializer" prot="public">serif::utils::serialize::StructSerializer</innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_term_identity" prot="public">serif::utils::serialize::TermIdentity</innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_term_identity_3_01discretization_1_1blocks_1_1barotropic__89bc695dfd6145b8157982b62f74f600" prot="public">serif::utils::serialize::TermIdentity< discretization::blocks::barotropic_constant::mass_normalization ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_term_identity_3_01discretization_1_1blocks_1_1density_1_1mass_01_4" prot="public">serif::utils::serialize::TermIdentity< discretization::blocks::density::mass ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_term_identity_3_01discretization_1_1blocks_1_1displacement_1_1vector_01_4" prot="public">serif::utils::serialize::TermIdentity< discretization::blocks::displacement::vector ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_term_identity_3_01discretization_1_1blocks_1_1gravity_1_1potential_01_4" prot="public">serif::utils::serialize::TermIdentity< discretization::blocks::gravity::potential ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_term_identity_3_01discretization_1_1blocks_1_1rotation_1_1angular__velocity_01_4" prot="public">serif::utils::serialize::TermIdentity< discretization::blocks::rotation::angular_velocity ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_term_identity_3_01discretization_1_1blocks_1_1surface__deformation_1_1coefficients_01_4" prot="public">serif::utils::serialize::TermIdentity< discretization::blocks::surface_deformation::coefficients ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_term_identity_3_01discretization_1_1blocks_1_1surface__def9d4d4c300051a0fc97927e0b7b8e5806" prot="public">serif::utils::serialize::TermIdentity< discretization::blocks::surface_deformation::shape_equilibrium ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_term_identity_3_01model_1_1_constraint_of_3_01_specification_01_4_01_4" prot="public">serif::utils::serialize::TermIdentity< model::ConstraintOf< Specification > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_term_identity_3_01model_1_1_generated_coordinate_of_3_01_specification_01_4_01_4" prot="public">serif::utils::serialize::TermIdentity< model::GeneratedCoordinateOf< Specification > ></innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_top_export_options" prot="public">serif::utils::serialize::TopExportOptions</innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_top_export_report" prot="public">serif::utils::serialize::TopExportReport</innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_top_polytrope_source" prot="public">serif::utils::serialize::TopPolytropeSource</innerclass>
|
|
<innerclass refid="structserif_1_1utils_1_1serialize_1_1_write_options" prot="public">serif::utils::serialize::WriteOptions</innerclass>
|
|
<innernamespace refid="namespaceserif_1_1utils_1_1serialize_1_1detail">serif::utils::serialize::detail</innernamespace>
|
|
<sectiondef kind="enum">
|
|
<memberdef kind="enum" id="namespaceserif_1_1utils_1_1serialize_1af59ceea5df9600e1e8c0e762e6b08c99" prot="public" static="no" strong="yes">
|
|
<type></type>
|
|
<name>Format</name>
|
|
<qualifiedname>serif::utils::serialize::Format</qualifiedname>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1serialize_1af59ceea5df9600e1e8c0e762e6b08c99a9d7183f16acce70658f686ae7f1a4d20" prot="public">
|
|
<name>binary</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1serialize_1af59ceea5df9600e1e8c0e762e6b08c99a1cb251ec0d568de6a929b520c4aed8d1" prot="public">
|
|
<name>text</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<briefdescription>
|
|
<para>Both encodings share the same component schemas and indexed, sectioned file layout. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/serialize/archive.hpp" line="16" column="5" bodyfile="src/include/serif/utils/serialize/archive.hpp" bodystart="16" bodyend="16"/>
|
|
</memberdef>
|
|
<memberdef kind="enum" id="namespaceserif_1_1utils_1_1serialize_1a02674e30cfb576e300d365827de17279" prot="public" static="no" strong="yes">
|
|
<type></type>
|
|
<name>VersionTolerance</name>
|
|
<qualifiedname>serif::utils::serialize::VersionTolerance</qualifiedname>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1serialize_1a02674e30cfb576e300d365827de17279ae79a3672fcb675134bb57abd3e0dfae3" prot="public">
|
|
<name>same_major</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1serialize_1a02674e30cfb576e300d365827de17279a3b7efa09444a31c5d58596e5bbf87d47" prot="public">
|
|
<name>exact</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="namespaceserif_1_1utils_1_1serialize_1a02674e30cfb576e300d365827de17279a100b8cad7cf2a56f6df78f171f97a1ec" prot="public">
|
|
<name>any</name>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
</enumvalue>
|
|
<briefdescription>
|
|
<para>Application-version compatibility is separate from file-format and component-schema compatibility. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/serialize/archive.hpp" line="19" column="5" bodyfile="src/include/serif/utils/serialize/archive.hpp" bodystart="19" bodyend="19"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="typedef">
|
|
<memberdef kind="typedef" id="namespaceserif_1_1utils_1_1serialize_1af0afd5aacbd77b40205164c3ec2cf423" prot="public" static="no">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename OriginalModel</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type><ref refid="classserif_1_1model_1_1_stellar_model" kindref="compound">model::StellarModel</ref>< typename OriginalModel::EquationOfState, <ref refid="namespaceserif_1_1utils_1_1serialize_1_1detail_1a331361f70fa27188f1a1679faa827273" kindref="member">detail::OwnedEquations</ref>< OriginalModel >, typename OriginalModel::SpecificationTypes ></type>
|
|
<definition>using serif::utils::serialize::RestoredStellarModel = model::StellarModel<typename OriginalModel::EquationOfState, detail::OwnedEquations<OriginalModel>, typename OriginalModel::SpecificationTypes></definition>
|
|
<argsstring></argsstring>
|
|
<name>RestoredStellarModel</name>
|
|
<qualifiedname>serif::utils::serialize::RestoredStellarModel</qualifiedname>
|
|
<briefdescription>
|
|
<para>Restore current physics as an explicit composition, without pretending to regenerate a deferred program. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/serialize/model.hpp" line="198" column="5" bodyfile="src/include/serif/utils/serialize/model.hpp" bodystart="198" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="typedef" id="namespaceserif_1_1utils_1_1serialize_1ace9e0af29889a767ef1c95a09a4b7265" prot="public" static="no">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename T</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>std::expected< T, <ref refid="structserif_1_1utils_1_1serialize_1_1_error" kindref="compound">Error</ref> ></type>
|
|
<definition>using serif::utils::serialize::Result = std::expected<T, Error></definition>
|
|
<argsstring></argsstring>
|
|
<name>Result</name>
|
|
<qualifiedname>serif::utils::serialize::Result</qualifiedname>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/serialize/record.hpp" line="30" column="5" bodyfile="src/include/serif/utils/serialize/record.hpp" bodystart="30" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="typedef" id="namespaceserif_1_1utils_1_1serialize_1a76d9829ffc510737a78d63b06f115861" prot="public" static="no">
|
|
<type>std::variant< std::monostate, bool, std::int64_t, std::uint64_t, double, std::string, std::vector< double >, std::vector< std::int64_t >, std::vector< std::uint64_t > ></type>
|
|
<definition>using serif::utils::serialize::Value = std::variant<std::monostate, bool, std::int64_t, std::uint64_t, double, std::string,
|
|
std::vector<double>, std::vector<std::int64_t>, std::vector<std::uint64_t>></definition>
|
|
<argsstring></argsstring>
|
|
<name>Value</name>
|
|
<qualifiedname>serif::utils::serialize::Value</qualifiedname>
|
|
<briefdescription>
|
|
<para>Portable scientific data; runtime pointers and computational caches have no representation here. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/serialize/record.hpp" line="33" column="5" bodyfile="src/include/serif/utils/serialize/record.hpp" bodystart="33" bodyend="-1"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="func">
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1serialize_1ac247352aee3417238eda1bf573f1b197" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>model::StellarModelType</type>
|
|
<declname>Model</declname>
|
|
<defname>Model</defname>
|
|
</param>
|
|
<param>
|
|
<type>typename FiniteElements</type>
|
|
</param>
|
|
<param>
|
|
<type>typename State</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type><ref refid="namespaceserif_1_1utils_1_1serialize_1ace9e0af29889a767ef1c95a09a4b7265" kindref="member">Result</ref>< <ref refid="structserif_1_1utils_1_1serialize_1_1_top_export_report" kindref="compound">TopExportReport</ref> ></type>
|
|
<definition>Result< TopExportReport > serif::utils::serialize::export_top</definition>
|
|
<argsstring>(const std::filesystem::path &directory, const Model &stellar_model, const FiniteElements &finite_elements, const State &state, const TopExportOptions &options={})</argsstring>
|
|
<name>export_top</name>
|
|
<qualifiedname>serif::utils::serialize::export_top</qualifiedname>
|
|
<param>
|
|
<type>const std::filesystem::path &</type>
|
|
<declname>directory</declname>
|
|
</param>
|
|
<param>
|
|
<type>const Model &</type>
|
|
<declname>stellar_model</declname>
|
|
</param>
|
|
<param>
|
|
<type>const FiniteElements &</type>
|
|
<declname>finite_elements</declname>
|
|
</param>
|
|
<param>
|
|
<type>const State &</type>
|
|
<declname>state</declname>
|
|
</param>
|
|
<param>
|
|
<type>const <ref refid="structserif_1_1utils_1_1serialize_1_1_top_export_options" kindref="compound">TopExportOptions</ref> &</type>
|
|
<declname>options</declname>
|
|
<defval>{}</defval>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Export the accepted density and FE surface of a uniformly rotating vacuum polytrope to TOP. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para><simplesect kind="note"><para>StellarModel owns physics, while finite_elements and state supply its numerical realization. Enthalpy is derived only for this external file format; it is not introduced as a SERiF unknown. The native TOP polytrope reader does not represent general EOS or finite-pressure surfaces. </para>
|
|
</simplesect>
|
|
</para>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/backend/mfem/serialize/top.hpp" line="72" column="13" bodyfile="src/include/serif/backend/mfem/serialize/top.hpp" bodystart="72" bodyend="167"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1serialize_1aa5efebebb4fcf770cef7679e0e924627" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename FiniteElements</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Solution</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type><ref refid="namespaceserif_1_1utils_1_1serialize_1ace9e0af29889a767ef1c95a09a4b7265" kindref="member">Result</ref>< <ref refid="structserif_1_1utils_1_1serialize_1_1_top_export_report" kindref="compound">TopExportReport</ref> ></type>
|
|
<definition>Result< TopExportReport > serif::utils::serialize::export_top</definition>
|
|
<argsstring>(const std::filesystem::path &directory, const FiniteElements &finite_elements, const Solution &solution, const TopExportOptions &options={})</argsstring>
|
|
<name>export_top</name>
|
|
<qualifiedname>serif::utils::serialize::export_top</qualifiedname>
|
|
<param>
|
|
<type>const std::filesystem::path &</type>
|
|
<declname>directory</declname>
|
|
</param>
|
|
<param>
|
|
<type>const FiniteElements &</type>
|
|
<declname>finite_elements</declname>
|
|
</param>
|
|
<param>
|
|
<type>const Solution &</type>
|
|
<declname>solution</declname>
|
|
</param>
|
|
<param>
|
|
<type>const <ref refid="structserif_1_1utils_1_1serialize_1_1_top_export_options" kindref="compound">TopExportOptions</ref> &</type>
|
|
<declname>options</declname>
|
|
<defval>{}</defval>
|
|
</param>
|
|
<requiresclause>requires(const Solution& solution) { solution.has_state(); solution.model(); solution.state(); } </requiresclause>
|
|
<briefdescription>
|
|
<para>Export a solver result with the separately owned FE resources that interpret its accepted state. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/backend/mfem/serialize/top.hpp" line="172" column="13" bodyfile="src/include/serif/backend/mfem/serialize/top.hpp" bodystart="172" bodyend="178"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1serialize_1ab93715bd271d15568badc8f1d5423271" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename T</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type><ref refid="structserif_1_1utils_1_1serialize_1_1_field" kindref="compound">Field</ref></type>
|
|
<definition>Field serif::utils::serialize::named</definition>
|
|
<argsstring>(std::string name, const T &value)</argsstring>
|
|
<name>named</name>
|
|
<qualifiedname>serif::utils::serialize::named</qualifiedname>
|
|
<param>
|
|
<type>std::string</type>
|
|
<declname>name</declname>
|
|
</param>
|
|
<param>
|
|
<type>const T &</type>
|
|
<declname>value</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Assign an explicit top-level name, for example when storing two stars in the same archive. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/serialize/archive.hpp" line="58" column="12" bodyfile="src/include/serif/utils/serialize/archive.hpp" bodystart="58" bodyend="58"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1serialize_1a7f4727c3a8f5b10ed46c149785bd8c82" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>void</type>
|
|
<definition>void serif::utils::serialize::add_component</definition>
|
|
<argsstring>(Pack &pack, Field component)</argsstring>
|
|
<name>add_component</name>
|
|
<qualifiedname>serif::utils::serialize::add_component</qualifiedname>
|
|
<param>
|
|
<type><ref refid="structserif_1_1utils_1_1serialize_1_1_pack" kindref="compound">Pack</ref> &</type>
|
|
<declname>pack</declname>
|
|
</param>
|
|
<param>
|
|
<type><ref refid="structserif_1_1utils_1_1serialize_1_1_field" kindref="compound">Field</ref></type>
|
|
<declname>component</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Insert a component while rejecting conflicting definitions of the same named object. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/lib/serif/utils/serialize/archive.cpp" line="224" column="10" bodyfile="src/lib/serif/utils/serialize/archive.cpp" bodystart="224" bodyend="238" declfile="src/include/serif/utils/serialize/archive.hpp" declline="61" declcolumn="10"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1serialize_1ad8a45ed21a6cf9a7ca63582a18526f9b" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename...</type>
|
|
<declname>T</declname>
|
|
<defname>T</defname>
|
|
</param>
|
|
</templateparamlist>
|
|
<type><ref refid="structserif_1_1utils_1_1serialize_1_1_pack" kindref="compound">Pack</ref></type>
|
|
<definition>Pack serif::utils::serialize::pack</definition>
|
|
<argsstring>(const T &... values)</argsstring>
|
|
<name>pack</name>
|
|
<qualifiedname>serif::utils::serialize::pack</qualifiedname>
|
|
<param>
|
|
<type>const T &...</type>
|
|
<declname>values</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Capture every supplied component; unregistered nested types remain visible as unsupported entries. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/serialize/archive.hpp" line="65" column="11" bodyfile="src/include/serif/utils/serialize/archive.hpp" bodystart="65" bodyend="79"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1serialize_1a53de7b4a0d01bed188ef53fbeb4c3e7e" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type><ref refid="namespaceserif_1_1utils_1_1serialize_1ace9e0af29889a767ef1c95a09a4b7265" kindref="member">Result</ref>< void ></type>
|
|
<definition>Result< void > serif::utils::serialize::write</definition>
|
|
<argsstring>(const std::filesystem::path &path, const Pack &contents, const WriteOptions &options={})</argsstring>
|
|
<name>write</name>
|
|
<qualifiedname>serif::utils::serialize::write</qualifiedname>
|
|
<param>
|
|
<type>const std::filesystem::path &</type>
|
|
<declname>path</declname>
|
|
</param>
|
|
<param>
|
|
<type>const <ref refid="structserif_1_1utils_1_1serialize_1_1_pack" kindref="compound">Pack</ref> &</type>
|
|
<declname>contents</declname>
|
|
</param>
|
|
<param>
|
|
<type>const <ref refid="structserif_1_1utils_1_1serialize_1_1_write_options" kindref="compound">WriteOptions</ref> &</type>
|
|
<declname>options</declname>
|
|
<defval>{}</defval>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Write a complete temporary file and atomically replace the destination only after it closes successfully. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/lib/serif/utils/serialize/archive.cpp" line="240" column="12" bodyfile="src/lib/serif/utils/serialize/archive.cpp" bodystart="240" bodyend="305" declfile="src/include/serif/utils/serialize/archive.hpp" declline="82" declcolumn="13"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1serialize_1a57bf01379dd9f09662f2eca940c2287a" prot="public" static="no" nodiscard="yes" constexpr="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename Owner</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Value</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>auto</type>
|
|
<definition>auto serif::utils::serialize::member_field</definition>
|
|
<argsstring>(std::string_view name, Value Owner::*pointer)</argsstring>
|
|
<name>member_field</name>
|
|
<qualifiedname>serif::utils::serialize::member_field</qualifiedname>
|
|
<param>
|
|
<type>std::string_view</type>
|
|
<declname>name</declname>
|
|
</param>
|
|
<param>
|
|
<type><ref refid="namespaceserif_1_1utils_1_1serialize_1a76d9829ffc510737a78d63b06f115861" kindref="member">Value</ref> Owner::*</type>
|
|
<declname>pointer</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Deduce a member's stored type from its ordinary C++ declaration. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/serialize/components.hpp" line="20" column="21" bodyfile="src/include/serif/utils/serialize/components.hpp" bodystart="20" bodyend="22"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1serialize_1a2467d2dec6186bb040f634a1320c279a" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename Term</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type><ref refid="structserif_1_1utils_1_1serialize_1_1_node" kindref="compound">Node</ref></type>
|
|
<definition>Node serif::utils::serialize::term_schema</definition>
|
|
<argsstring>()</argsstring>
|
|
<name>term_schema</name>
|
|
<qualifiedname>serif::utils::serialize::term_schema</qualifiedname>
|
|
<briefdescription>
|
|
<para>Expose the physical meaning and FE representation of one compiled coordinate. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/serialize/model.hpp" line="38" column="11" bodyfile="src/include/serif/utils/serialize/model.hpp" bodystart="38" bodyend="73"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1serialize_1ab00ec68c8966b7783b811342ba3202a5" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
|
|
<type><ref refid="namespaceserif_1_1utils_1_1serialize_1ace9e0af29889a767ef1c95a09a4b7265" kindref="member">Result</ref>< void ></type>
|
|
<definition>Result< void > serif::utils::serialize::validate_schema</definition>
|
|
<argsstring>(const Node &saved, const Node &expected)</argsstring>
|
|
<name>validate_schema</name>
|
|
<qualifiedname>serif::utils::serialize::validate_schema</qualifiedname>
|
|
<param>
|
|
<type>const <ref refid="structserif_1_1utils_1_1serialize_1_1_node" kindref="compound">Node</ref> &</type>
|
|
<declname>saved</declname>
|
|
</param>
|
|
<param>
|
|
<type>const <ref refid="structserif_1_1utils_1_1serialize_1_1_node" kindref="compound">Node</ref> &</type>
|
|
<declname>expected</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>A compiled identity must match and must have an explicit persistence registration. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/serialize/model.hpp" line="76" column="19" bodyfile="src/include/serif/utils/serialize/model.hpp" bodystart="76" bodyend="87"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1serialize_1ad8c80c4dc17552d1b312b26428b20ccd" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename OriginalModel</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type><ref refid="namespaceserif_1_1utils_1_1serialize_1ace9e0af29889a767ef1c95a09a4b7265" kindref="member">Result</ref>< <ref refid="namespaceserif_1_1utils_1_1serialize_1af0afd5aacbd77b40205164c3ec2cf423" kindref="member">RestoredStellarModel</ref>< OriginalModel > ></type>
|
|
<definition>Result< RestoredStellarModel< OriginalModel > > serif::utils::serialize::restore_stellar_model</definition>
|
|
<argsstring>(const Node &node)</argsstring>
|
|
<name>restore_stellar_model</name>
|
|
<qualifiedname>serif::utils::serialize::restore_stellar_model</qualifiedname>
|
|
<param>
|
|
<type>const <ref refid="structserif_1_1utils_1_1serialize_1_1_node" kindref="compound">Node</ref> &</type>
|
|
<declname>node</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Reconstruct resolved physics; future changes requiring the original callback remain a separate capability. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/serialize/model.hpp" line="202" column="13" bodyfile="src/include/serif/utils/serialize/model.hpp" bodystart="202" bodyend="209"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1serialize_1a4ea480fabb9d06528d01b26691fa80ec" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename T</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type><ref refid="structserif_1_1utils_1_1serialize_1_1_node" kindref="compound">Node</ref></type>
|
|
<definition>Node serif::utils::serialize::encode</definition>
|
|
<argsstring>(const T &value)</argsstring>
|
|
<name>encode</name>
|
|
<qualifiedname>serif::utils::serialize::encode</qualifiedname>
|
|
<param>
|
|
<type>const T &</type>
|
|
<declname>value</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Produce data when a serializer exists, otherwise record the missing capability explicitly. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/serialize/record.hpp" line="66" column="11" bodyfile="src/include/serif/utils/serialize/record.hpp" bodystart="66" bodyend="72"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1serialize_1abb3b906587e8c2950b461d615bba7606" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename T</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type><ref refid="namespaceserif_1_1utils_1_1serialize_1ace9e0af29889a767ef1c95a09a4b7265" kindref="member">Result</ref>< T ></type>
|
|
<definition>Result< T > serif::utils::serialize::decode</definition>
|
|
<argsstring>(const Node &node)</argsstring>
|
|
<name>decode</name>
|
|
<qualifiedname>serif::utils::serialize::decode</qualifiedname>
|
|
<param>
|
|
<type>const <ref refid="structserif_1_1utils_1_1serialize_1_1_node" kindref="compound">Node</ref> &</type>
|
|
<declname>node</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Translate invalid saved parameters into a value error at the reconstruction boundary. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/serialize/record.hpp" line="76" column="13" bodyfile="src/include/serif/utils/serialize/record.hpp" bodystart="76" bodyend="96"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1serialize_1a73c789fd95f83d2f547facf07bc3ea79" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename T</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type><ref refid="structserif_1_1utils_1_1serialize_1_1_field" kindref="compound">Field</ref></type>
|
|
<definition>Field serif::utils::serialize::field</definition>
|
|
<argsstring>(std::string name, const T &value)</argsstring>
|
|
<name>field</name>
|
|
<qualifiedname>serif::utils::serialize::field</qualifiedname>
|
|
<param>
|
|
<type>std::string</type>
|
|
<declname>name</declname>
|
|
</param>
|
|
<param>
|
|
<type>const T &</type>
|
|
<declname>value</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Encode one named field of a component. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/serialize/record.hpp" line="106" column="12" bodyfile="src/include/serif/utils/serialize/record.hpp" bodystart="106" bodyend="108"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1serialize_1accd9d8a1543b90311f64896a155c6e1c" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename...</type>
|
|
<declname>Fields</declname>
|
|
<defname>Fields</defname>
|
|
</param>
|
|
</templateparamlist>
|
|
<type><ref refid="structserif_1_1utils_1_1serialize_1_1_node" kindref="compound">Node</ref></type>
|
|
<definition>Node serif::utils::serialize::object</definition>
|
|
<argsstring>(std::string_view type, Fields... fields)</argsstring>
|
|
<name>object</name>
|
|
<qualifiedname>serif::utils::serialize::object</qualifiedname>
|
|
<param>
|
|
<type>std::string_view</type>
|
|
<declname>type</declname>
|
|
</param>
|
|
<param>
|
|
<type>Fields...</type>
|
|
<declname>fields</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Compose a component from its independently serialized fields. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/serialize/record.hpp" line="112" column="11" bodyfile="src/include/serif/utils/serialize/record.hpp" bodystart="112" bodyend="116"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1serialize_1a019c595419bddb41b7a05042e2f6d611" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename T</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type><ref refid="structserif_1_1utils_1_1serialize_1_1_member" kindref="compound">Member</ref>< T ></type>
|
|
<definition>Member< T > serif::utils::serialize::member</definition>
|
|
<argsstring>(std::string_view name)</argsstring>
|
|
<name>member</name>
|
|
<qualifiedname>serif::utils::serialize::member</qualifiedname>
|
|
<param>
|
|
<type>std::string_view</type>
|
|
<declname>name</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Describe one field to read_object without a separate temporary variable. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/serialize/record.hpp" line="127" column="13" bodyfile="src/include/serif/utils/serialize/record.hpp" bodystart="127" bodyend="129"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1serialize_1a21172de2e2f37c8797a238eb0bdaea30" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename T</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type><ref refid="namespaceserif_1_1utils_1_1serialize_1ace9e0af29889a767ef1c95a09a4b7265" kindref="member">Result</ref>< T ></type>
|
|
<definition>Result< T > serif::utils::serialize::read_field</definition>
|
|
<argsstring>(const Node &node, std::string_view name)</argsstring>
|
|
<name>read_field</name>
|
|
<qualifiedname>serif::utils::serialize::read_field</qualifiedname>
|
|
<param>
|
|
<type>const <ref refid="structserif_1_1utils_1_1serialize_1_1_node" kindref="compound">Node</ref> &</type>
|
|
<declname>node</declname>
|
|
</param>
|
|
<param>
|
|
<type>std::string_view</type>
|
|
<declname>name</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Read a required field and retain its full path in any diagnostic. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/serialize/record.hpp" line="133" column="13" bodyfile="src/include/serif/utils/serialize/record.hpp" bodystart="133" bodyend="143"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1serialize_1adb5114bee6aa1ea6612b96babf0ae8c2" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename Construct</type>
|
|
</param>
|
|
<param>
|
|
<type>typename...</type>
|
|
<declname>Members</declname>
|
|
<defname>Members</defname>
|
|
</param>
|
|
</templateparamlist>
|
|
<type><ref refid="namespaceserif_1_1utils_1_1serialize_1ace9e0af29889a767ef1c95a09a4b7265" kindref="member">Result</ref>< std::invoke_result_t< Construct, typename Members::Type... > ></type>
|
|
<definition>Result< std::invoke_result_t< Construct, typename Members::Type... > > serif::utils::serialize::read_object</definition>
|
|
<argsstring>(const Node &node, std::string_view type, Construct construct, Members... members)</argsstring>
|
|
<name>read_object</name>
|
|
<qualifiedname>serif::utils::serialize::read_object</qualifiedname>
|
|
<param>
|
|
<type>const <ref refid="structserif_1_1utils_1_1serialize_1_1_node" kindref="compound">Node</ref> &</type>
|
|
<declname>node</declname>
|
|
</param>
|
|
<param>
|
|
<type>std::string_view</type>
|
|
<declname>type</declname>
|
|
</param>
|
|
<param>
|
|
<type>Construct</type>
|
|
<declname>construct</declname>
|
|
</param>
|
|
<param>
|
|
<type>Members...</type>
|
|
<declname>members</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Construct a component only after every required field has decoded successfully. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/utils/serialize/record.hpp" line="147" column="11" bodyfile="src/include/serif/utils/serialize/record.hpp" bodystart="147" bodyend="165"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1serialize_1ad1fa896c36b9c32ff4b8bdb8660cba33" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>std::string</type>
|
|
<definition>std::string serif::utils::serialize::fingerprint</definition>
|
|
<argsstring>(std::string_view bytes)</argsstring>
|
|
<name>fingerprint</name>
|
|
<qualifiedname>serif::utils::serialize::fingerprint</qualifiedname>
|
|
<param>
|
|
<type>std::string_view</type>
|
|
<declname>bytes</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Versioned content identity for accidental corruption and resource matching; not a cryptographic signature. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/lib/serif/utils/serialize/format.cpp" line="13" column="17" bodyfile="src/lib/serif/utils/serialize/format.cpp" bodystart="13" bodyend="23" declfile="src/include/serif/utils/serialize/record.hpp" declline="358" declcolumn="18"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1utils_1_1serialize_1a2e0edf5820600e4b31b47f2a0a3fe183" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type><ref refid="namespaceserif_1_1utils_1_1serialize_1ace9e0af29889a767ef1c95a09a4b7265" kindref="member">Result</ref>< <ref refid="structserif_1_1utils_1_1serialize_1_1_top_export_report" kindref="compound">TopExportReport</ref> ></type>
|
|
<definition>Result< TopExportReport > serif::utils::serialize::export_top</definition>
|
|
<argsstring>(const std::filesystem::path &path, const TopPolytropeSource &source, const TopExportOptions &options={})</argsstring>
|
|
<name>export_top</name>
|
|
<qualifiedname>serif::utils::serialize::export_top</qualifiedname>
|
|
<param>
|
|
<type>const std::filesystem::path &</type>
|
|
<declname>path</declname>
|
|
</param>
|
|
<param>
|
|
<type>const <ref refid="structserif_1_1utils_1_1serialize_1_1_top_polytrope_source" kindref="compound">TopPolytropeSource</ref> &</type>
|
|
<declname>source</declname>
|
|
</param>
|
|
<param>
|
|
<type>const <ref refid="structserif_1_1utils_1_1serialize_1_1_top_export_options" kindref="compound">TopExportOptions</ref> &</type>
|
|
<declname>options</declname>
|
|
<defval>{}</defval>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Atomically publish a new TOP model directory, refusing to overwrite any destination. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para><simplesect kind="note"><para>Projects the source surface and pressure-derived enthalpy at common surface-fitted zeta coordinates. Only equatorially symmetric axisymmetric vacuum polytropes with n>=1 are supported. TOP chooses Gamma1 in its equation set, separately from these files. </para>
|
|
</simplesect>
|
|
</para>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/lib/serif/utils/serialize/top.cpp" line="152" column="8" bodyfile="src/lib/serif/utils/serialize/top.cpp" bodystart="152" bodyend="424" declfile="src/include/serif/utils/serialize/top.hpp" declline="62" declcolumn="13"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<location file="src/include/serif/backend/mfem/serialize/discretization.hpp" line="220" column="1"/>
|
|
</compounddef>
|
|
</doxygen>
|