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)
73 lines
2.5 KiB
Groff
73 lines
2.5 KiB
Groff
.TH "src/include/serif/model/normalization/reference.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
.ad l
|
||
.nh
|
||
.SH NAME
|
||
src/include/serif/model/normalization/reference.hpp
|
||
.SH SYNOPSIS
|
||
.br
|
||
.PP
|
||
\fR#include <utility>\fP
|
||
.br
|
||
\fR#include 'serif/model/description\&.hpp'\fP
|
||
.br
|
||
\fR#include 'serif/solver/normalization/configuration\&.hpp'\fP
|
||
.br
|
||
|
||
.SS "Namespaces"
|
||
|
||
.in +1c
|
||
.ti -1c
|
||
.RI "namespace \fBserif\fP"
|
||
.br
|
||
.ti -1c
|
||
.RI "namespace \fBserif::model\fP"
|
||
.br
|
||
.ti -1c
|
||
.RI "namespace \fBserif::model::normalization\fP"
|
||
.br
|
||
.ti -1c
|
||
.RI "namespace \fBserif::model::normalization::detail\fP"
|
||
.br
|
||
.in -1c
|
||
.SS "Concepts"
|
||
|
||
.in +1c
|
||
.ti -1c
|
||
.RI "concept \fBserif::model::normalization::detail::ReferenceAvailable\fP"
|
||
.br
|
||
.RI "Explicit reference values take precedence over model defaults without changing physical prescriptions\&. "
|
||
.ti -1c
|
||
.RI "concept \fBserif::model::normalization::ReferenceResolvable\fP"
|
||
.br
|
||
.RI "Check model-provided reference requirements before instantiating numerical preparation\&. "
|
||
.in -1c
|
||
.SS "Functions"
|
||
|
||
.in +1c
|
||
.ti -1c
|
||
.RI "template<typename Specification, typename Source, typename Model>
|
||
.br
|
||
requires ReferenceAvailable<Source, Model, Specification>auto \fBserif::model::normalization::detail::reference_value\fP (const Source &source, const Model &model)"
|
||
.br
|
||
.RI "Resolve a typed reference source only when its model default is available\&. "
|
||
.ti -1c
|
||
.RI "template<typename Mass, typename Density, StellarModelType Model>
|
||
.br
|
||
requires detail::ReferenceAvailable<Mass, Model, \fBFixedTotalMass\fP> && std::same_as<Density, \fBdimensions::DensityValue\fP>auto \fBserif::model::normalization::resolve_reference\fP (const \fBsolver::normalization::LaneEmdenApproximation\fP< Mass, Density > &scheme, const Model &model)"
|
||
.br
|
||
.RI "Resolve the Lane–Emden reference from explicit inputs or the model's mass target; no model prescribes central density\&. "
|
||
.ti -1c
|
||
.RI "template<solver::normalization::ReferenceScheme Scheme, StellarModelType Model> Scheme \fBserif::model::normalization::resolve_reference\fP (const Scheme &scheme, const Model &)"
|
||
.br
|
||
.RI "Explicit or custom reference schemes need no model-specific defaults\&. "
|
||
.ti -1c
|
||
.RI "template<typename Options, StellarModelType Model>
|
||
.br
|
||
requires ReferenceResolvable<Options, Model>auto \fBserif::model::normalization::resolve_configuration\fP (Options options, const Model &model)"
|
||
.br
|
||
.RI "Freeze resolved reference choices while retaining the deduced coordinate and plan types\&. "
|
||
.in -1c
|
||
.SH "Author"
|
||
.PP
|
||
Generated automatically by Doxygen for SERiF from the source code\&.
|