Files
MeanField_SERiF/docs/man/man3/scales.hpp.3

64 lines
1.9 KiB
Groff
Raw Normal View History

.TH "src/include/serif/solver/normalization/scales.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/solver/normalization/scales.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <cmath>\fP
.br
\fR#include <concepts>\fP
.br
\fR#include <expected>\fP
.br
\fR#include <string>\fP
.br
\fR#include 'serif/dimensions/dimensions\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBserif::solver::normalization::StellarReferenceScales\fP"
.br
.RI "Fixed reference scales used throughout a solve, independent of its candidate state\&. "
.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::StellarScaleQuantity\fP"
.br
.RI "Quantities whose characteristic scales follow from reference mass, radius, and G alone\&. "
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "std::expected< \fBStellarReferenceScales\fP, std::string > \fBserif::solver::normalization::prepare_stellar_reference_scales\fP (\fBdimensions::QuantityValue\fP< \fBdimensions::Mass\fP > mass, \fBdimensions::QuantityValue\fP< \fBdimensions::Length\fP > radius, \fBdimensions::QuantityValue\fP< \fBdimensions::GravitationalConstant\fP > gravitational_constant=\fBdimensions::QuantityValue\fP< \fBdimensions::GravitationalConstant\fP >{1\&.0})"
.br
.RI "Derive gravitational stellar scales from a finite, positive reference mass, radius, and G\&. "
.ti -1c
.RI "template<StellarScaleQuantity Quantity> \fBdimensions::QuantityValue\fP< Quantity > \fBserif::solver::normalization::characteristic_scale\fP (const \fBStellarReferenceScales\fP &scales, Quantity)"
.br
.RI "Select a typed scale; temperature and other unrelated quantities require an explicit prescription\&. "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.