Files
MeanField_SERiF/docs/man/man3/serif_utils_laneemden_PhysicalScales.3

65 lines
2.1 KiB
Groff
Raw Normal View History

.TH "serif::utils::laneemden::PhysicalScales" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::utils::laneemden::PhysicalScales \- A physical conversion of one finite-radius dimensionless polytrope, in the caller's consistent units\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <scaling\&.hpp>\fP
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "double \fBn\fP"
.br
.ti -1c
.RI "double \fBradial_scale\fP"
.br
.ti -1c
.RI "\fBdimensions::QuantityValue\fP< \fBdimensions::Mass\fP > \fBmass\fP"
.br
.ti -1c
.RI "\fBdimensions::QuantityValue\fP< \fBdimensions::Length\fP > \fBradius\fP"
.br
.ti -1c
.RI "\fBdimensions::QuantityValue\fP< \fBdimensions::MassDensity\fP > \fBcentral_density\fP"
.br
.ti -1c
.RI "\fBdimensions::QuantityValue\fP< \fBdimensions::SpecificEnthalpy\fP > \fBcentral_enthalpy\fP"
.br
.ti -1c
.RI "\fBdimensions::QuantityValue\fP< \fBdimensions::GravitationalConstant\fP > \fBgravitational_constant\fP"
.br
.ti -1c
.RI "std::optional< double > \fBpolytropic_constant\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
A physical conversion of one finite-radius dimensionless polytrope, in the caller's consistent units\&.
.SH "Member Data Documentation"
.PP
.SS "\fBdimensions::QuantityValue\fP<\fBdimensions::MassDensity\fP> serif::utils::laneemden::PhysicalScales::central_density"
.SS "\fBdimensions::QuantityValue\fP<\fBdimensions::SpecificEnthalpy\fP> serif::utils::laneemden::PhysicalScales::central_enthalpy"
.SS "\fBdimensions::QuantityValue\fP<\fBdimensions::GravitationalConstant\fP> serif::utils::laneemden::PhysicalScales::gravitational_constant"
.SS "\fBdimensions::QuantityValue\fP<\fBdimensions::Mass\fP> serif::utils::laneemden::PhysicalScales::mass"
.SS "double serif::utils::laneemden::PhysicalScales::n"
.SS "std::optional<double> serif::utils::laneemden::PhysicalScales::polytropic_constant"
.SS "double serif::utils::laneemden::PhysicalScales::radial_scale"
.SS "\fBdimensions::QuantityValue\fP<\fBdimensions::Length\fP> serif::utils::laneemden::PhysicalScales::radius"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.