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

94 lines
3.6 KiB
Groff
Raw Normal View History

.TH "serif::solver::normalization::StellarReferenceScales" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::solver::normalization::StellarReferenceScales \- Fixed reference scales used throughout a solve, independent of its candidate state\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <scales\&.hpp>\fP
.SS "Public Attributes"
.in +1c
.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::GravitationalConstant\fP > \fBgravitational_constant\fP"
.br
.ti -1c
.RI "\fBdimensions::QuantityValue\fP< \fBdimensions::MassDensity\fP > \fBdensity\fP"
.br
.ti -1c
.RI "\fBdimensions::QuantityValue\fP< \fBdimensions::Acceleration\fP > \fBacceleration\fP"
.br
.ti -1c
.RI "\fBdimensions::QuantityValue\fP< \fBdimensions::InverseTimeSquared\fP > \fBinverse_time_squared\fP"
.br
.ti -1c
.RI "\fBdimensions::QuantityValue\fP< \fBdimensions::SpecificEnergy\fP > \fBspecific_energy\fP"
.br
.ti -1c
.RI "\fBdimensions::QuantityValue\fP< \fBdimensions::Pressure\fP > \fBpressure\fP"
.br
.ti -1c
.RI "\fBdimensions::QuantityValue\fP< \fBdimensions::AngularVelocity\fP > \fBangular_velocity\fP"
.br
.ti -1c
.RI "\fBdimensions::QuantityValue\fP< \fBdimensions::AngularMomentum\fP > \fBangular_momentum\fP"
.br
.ti -1c
.RI "\fBdimensions::QuantityValue\fP< \fBdimensions::Force\fP > \fBforce\fP"
.br
.in -1c
.SS "Friends"
.in +1c
.ti -1c
.RI "bool \fBoperator==\fP (const \fBStellarReferenceScales\fP &, const \fBStellarReferenceScales\fP &)=default"
.br
.RI "Compare reference values for dependency snapshot invalidation\&. "
.in -1c
.SH "Detailed Description"
.PP
Fixed reference scales used throughout a solve, independent of its candidate state\&.
.SH "Friends And Related Symbol Documentation"
.PP
.SS "bool operator== (const \fBStellarReferenceScales\fP & , const \fBStellarReferenceScales\fP & )\fR [friend]\fP"
.PP
Compare reference values for dependency snapshot invalidation\&.
.SH "Member Data Documentation"
.PP
.SS "\fBdimensions::QuantityValue\fP<\fBdimensions::Acceleration\fP> serif::solver::normalization::StellarReferenceScales::acceleration"
.SS "\fBdimensions::QuantityValue\fP<\fBdimensions::AngularMomentum\fP> serif::solver::normalization::StellarReferenceScales::angular_momentum"
.SS "\fBdimensions::QuantityValue\fP<\fBdimensions::AngularVelocity\fP> serif::solver::normalization::StellarReferenceScales::angular_velocity"
.SS "\fBdimensions::QuantityValue\fP<\fBdimensions::MassDensity\fP> serif::solver::normalization::StellarReferenceScales::density"
.SS "\fBdimensions::QuantityValue\fP<\fBdimensions::Force\fP> serif::solver::normalization::StellarReferenceScales::force"
.SS "\fBdimensions::QuantityValue\fP<\fBdimensions::GravitationalConstant\fP> serif::solver::normalization::StellarReferenceScales::gravitational_constant"
.SS "\fBdimensions::QuantityValue\fP<\fBdimensions::InverseTimeSquared\fP> serif::solver::normalization::StellarReferenceScales::inverse_time_squared"
.SS "\fBdimensions::QuantityValue\fP<\fBdimensions::Mass\fP> serif::solver::normalization::StellarReferenceScales::mass"
.SS "\fBdimensions::QuantityValue\fP<\fBdimensions::Pressure\fP> serif::solver::normalization::StellarReferenceScales::pressure"
.SS "\fBdimensions::QuantityValue\fP<\fBdimensions::Length\fP> serif::solver::normalization::StellarReferenceScales::radius"
.SS "\fBdimensions::QuantityValue\fP<\fBdimensions::SpecificEnergy\fP> serif::solver::normalization::StellarReferenceScales::specific_energy"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.