82 lines
2.3 KiB
Groff
82 lines
2.3 KiB
Groff
|
.TH "serif::utils::serialize::TopPolytropeSource" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
serif::utils::serialize::TopPolytropeSource \- Physical samples in a centered frame whose polar axis is the rotation axis\&.
|
||
|
|
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
.PP
|
||
|
|
\fR#include <top\&.hpp>\fP
|
||
|
|
.SS "Public Attributes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "double \fBpolytropic_index\fP {}"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "double \fBgravitational_constant\fP {}"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "double \fBmass\fP {}"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "double \fBangular_velocity\fP {}"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "double \fBcentral_density\fP {}"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "double \fBcentral_enthalpy\fP {}"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "std::function< \fBResult\fP< double >(double mu, double phi)> \fBsurface_radius\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "std::function< \fBResult\fP< double >(double radius, double mu, double phi)> \fBenthalpy\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "std::function< std::size_t()> \fBroundoff_density_clamps\fP"
|
||
|
|
.br
|
||
|
|
.RI "Optional count of explicitly bounded roundoff corrections made by an EOS adapter\&. "
|
||
|
|
.in -1c
|
||
|
|
.SH "Detailed Description"
|
||
|
|
.PP
|
||
|
|
Physical samples in a centered frame whose polar axis is the rotation axis\&.
|
||
|
|
|
||
|
|
|
||
|
|
.PP
|
||
|
|
\fBNote\fP
|
||
|
|
.RS 4
|
||
|
|
Enthalpy is an export conversion of the source EOS, not a primary solver field\&. The callbacks use mu=cos(theta), phi in radians, and physical radius/enthalpy units\&.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SH "Member Data Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "double serif::utils::serialize::TopPolytropeSource::angular_velocity {}"
|
||
|
|
|
||
|
|
.SS "double serif::utils::serialize::TopPolytropeSource::central_density {}"
|
||
|
|
|
||
|
|
.SS "double serif::utils::serialize::TopPolytropeSource::central_enthalpy {}"
|
||
|
|
|
||
|
|
.SS "std::function<\fBResult\fP<double>(double radius, double mu, double phi)> serif::utils::serialize::TopPolytropeSource::enthalpy"
|
||
|
|
|
||
|
|
.SS "double serif::utils::serialize::TopPolytropeSource::gravitational_constant {}"
|
||
|
|
|
||
|
|
.SS "double serif::utils::serialize::TopPolytropeSource::mass {}"
|
||
|
|
|
||
|
|
.SS "double serif::utils::serialize::TopPolytropeSource::polytropic_index {}"
|
||
|
|
|
||
|
|
.SS "std::function<std::size_t()> serif::utils::serialize::TopPolytropeSource::roundoff_density_clamps"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Optional count of explicitly bounded roundoff corrections made by an EOS adapter\&.
|
||
|
|
.SS "std::function<\fBResult\fP<double>(double mu, double phi)> serif::utils::serialize::TopPolytropeSource::surface_radius"
|
||
|
|
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|