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)
96 lines
3.4 KiB
Groff
96 lines
3.4 KiB
Groff
.TH "src/include/serif/solver/normalization/configuration.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
.ad l
|
||
.nh
|
||
.SH NAME
|
||
src/include/serif/solver/normalization/configuration.hpp
|
||
.SH SYNOPSIS
|
||
.br
|
||
.PP
|
||
\fR#include <concepts>\fP
|
||
.br
|
||
\fR#include <expected>\fP
|
||
.br
|
||
\fR#include <string>\fP
|
||
.br
|
||
\fR#include <tuple>\fP
|
||
.br
|
||
\fR#include <utility>\fP
|
||
.br
|
||
\fR#include 'serif/dimensions/type_alias\&.hpp'\fP
|
||
.br
|
||
\fR#include 'serif/solver/normalization/scales\&.hpp'\fP
|
||
.br
|
||
\fR#include 'serif/utils/dependencies/dependency_context\&.hpp'\fP
|
||
.br
|
||
\fR#include 'serif/utils/laneemden/laneemden\&.hpp'\fP
|
||
.br
|
||
|
||
.SS "Classes"
|
||
|
||
.in +1c
|
||
.ti -1c
|
||
.RI "struct \fBserif::solver::normalization::FromModel\fP"
|
||
.br
|
||
.RI "Obtain a reference value from the corresponding descriptive model prescription\&. "
|
||
.ti -1c
|
||
.RI "struct \fBserif::solver::normalization::AutomaticPlan\fP"
|
||
.br
|
||
.RI "Derive the coordinate rules from the selected fields, equations and boundary formulation\&. "
|
||
.ti -1c
|
||
.RI "struct \fBserif::solver::normalization::Dimensionless\fP"
|
||
.br
|
||
.RI "Remove physical and geometric units from the solver's coordinates and norms\&. "
|
||
.ti -1c
|
||
.RI "struct \fBserif::solver::normalization::LaneEmdenApproximation< Mass, CentralDensity >\fP"
|
||
.br
|
||
.RI "Estimate a reference radius from a Lane–Emden shape, mass and central density\&. "
|
||
.ti -1c
|
||
.RI "struct \fBserif::solver::normalization::NormalizationOptions< Scheme, Coordinates, Plan, Sources, Computations >\fP"
|
||
.br
|
||
.RI "Declare normalization without evaluating a reference star or allocating coordinate factors\&. "
|
||
.in -1c
|
||
.SS "Namespaces"
|
||
|
||
.in +1c
|
||
.ti -1c
|
||
.RI "namespace \fBserif\fP"
|
||
.br
|
||
.ti -1c
|
||
.RI "namespace \fBserif::solver\fP"
|
||
.br
|
||
.ti -1c
|
||
.RI "namespace \fBserif::solver::normalization\fP"
|
||
.br
|
||
.in -1c
|
||
.SS "Concepts"
|
||
|
||
.in +1c
|
||
.ti -1c
|
||
.RI "concept \fBserif::solver::normalization::ReferenceScheme\fP"
|
||
.br
|
||
.RI "A custom stellar reference strategy supplies the same typed scales and ordinary failure value\&. "
|
||
.in -1c
|
||
.SS "Functions"
|
||
|
||
.in +1c
|
||
.ti -1c
|
||
.RI "template<typename Scheme, typename Coordinates, typename Plan, typename Sources, typename Computations> auto \fBserif::solver::normalization::make_normalization\fP (\fBNormalizationOptions\fP< Scheme, Coordinates, Plan, Sources, Computations > options)"
|
||
.br
|
||
.RI "Preserve the deduced numerical choices for later preparation with a model and discretization\&. "
|
||
.ti -1c
|
||
.RI "auto \fBserif::solver::normalization::make_normalization\fP ()"
|
||
.br
|
||
.RI "Select the usual dimensionless Lane–Emden reference; supply its central density before resolving it against a model\&. "
|
||
.ti -1c
|
||
.RI "std::expected< \fBStellarReferenceScales\fP, std::string > \fBserif::solver::normalization::prepare_reference_scales\fP (const \fBLaneEmdenApproximation\fP< \fBdimensions::MassValue\fP, \fBdimensions::DensityValue\fP > &scheme, \fBdimensions::QuantityValue\fP< \fBdimensions::GravitationalConstant\fP > gravitational_constant)"
|
||
.br
|
||
.RI "Derive the shared stellar scales after both dimensional reference inputs have been resolved\&. "
|
||
.ti -1c
|
||
.RI "std::expected< \fBStellarReferenceScales\fP, std::string > \fBserif::solver::normalization::prepare_reference_scales\fP (const \fBStellarReferenceScales\fP &reference, \fBdimensions::QuantityValue\fP< \fBdimensions::GravitationalConstant\fP > gravitational_constant)"
|
||
.br
|
||
.RI "Use explicitly prepared reference scales through the same graph as estimated references\&. "
|
||
.in -1c
|
||
.SH "Author"
|
||
.PP
|
||
Generated automatically by Doxygen for SERiF from the source code\&.
|