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)
175 lines
5.9 KiB
Groff
175 lines
5.9 KiB
Groff
.TH "src/include/serif/utils/serialize/numerics.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/utils/serialize/numerics.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'serif/utils/serialize/model\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/model/configured_discretization\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/solver/normalization/configuration\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/solver/normalization/diagonal\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/solver/normalization/plan\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/solver/preconditioner/default_preconditioners\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/solver/nonlinear/options\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/quadrature/policy\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/model/normalization/plan\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/geometry/deformation/computations\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< model::DiscretizationOptions< Model, FiniteElements, Normalization, Preconditioner > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::RecipeSerializer< T >\fP"
|
|
.br
|
|
.RI "Preserve the selected equation/unknown identities in every composed inverse\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::Newton >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::Backtracking >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::linear::Control >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::linear::FGMRES >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::NormalizedResidualMetric >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::StandardNewton >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< laneemden::IntegrationOptions >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::normalization::FromModel >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::normalization::AutomaticPlan >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::normalization::Dimensionless >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::normalization::StellarReferenceScales >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::normalization::UnitMetric >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::normalization::IdentityCoordinate >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< model::preconditioning::None >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::preconditioner::strategies::inverse::Diagonal >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::preconditioner::strategies::inverse::DenseDirect >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::preconditioner::strategies::inverse::FixedAMG >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::preconditioner::strategies::inverse::SparseDirect >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::preconditioner::strategies::coupling::SecondThenFirst >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::SolverOptions< Metric, Strategies, Linear > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::normalization::LaneEmdenApproximation< Mass, Density > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::normalization::NormalizationOptions< Scheme, Coordinates, Plan, Sources, Computations > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::preconditioner::BlockPreconditioner< Row, Field, Strategy > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::preconditioner::CoupledPreconditioner< First, Second, Policy > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::preconditioner::BorderedPreconditioner< Fields, Constraints > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::normalization::DiagonalNormalization >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::SchemaSerializer< T >\fP"
|
|
.br
|
|
.RI "Reconstruct stateless typed numerical declarations only when all their identities match\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::normalization::ReferenceVolumeMetric< Term > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< geometry::deformation::keys::SurfaceMetric >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< model::normalization::SurfaceRows >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::normalization::WithPointRows< Volume, Quantity, Selection > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::normalization::PhysicalRieszCoordinate< Quantity, Metric > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::normalization::DimensionlessRieszCoordinate< Quantity, Metric, Geometry > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< dependencies::Binding< Key, Target > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< dependencies::Bindings< Bindings\&.\&.\&. > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< solver::normalization::NormalizationPlan< Values, Residuals > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< discretization::quadrature::RuleControl >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< discretization::quadrature::RuleSet >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::utils::serialize::Serializer< discretization::quadrature::Policy >\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
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|