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)
65 lines
2.9 KiB
Groff
65 lines
2.9 KiB
Groff
.TH "serif::discretization::blocks::barotropic_constant" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::blocks::barotropic_constant \- This field holds the effective potential level on the stellar isobar\&. The level is solved together with the fixed total mass\&. The \fBbarotropic_constant\fP name is retained as an internal coordinate identity\&. In the density formulation its value is Us, the gravitational potential minus the centrifugal potential on the surface; it is not the polytropic EOS constant K\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <fields\&.hpp>\fP
|
|
.PP
|
|
Inherits \fBserif::discretization::blocks::field\fP\&.
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBmass_normalization\fP"
|
|
.br
|
|
.RI "The value of this global scalar is the effective surface-potential level Us\&. Its paired residual enforces the prescribed total mass\&. The surface equation supplies the dependence on Us, while the mass equation integrates the density over the star\&. "
|
|
.in -1c
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBTerms\fP = \fButils::types::TypeList\fP<\fBmass_normalization\fP>"
|
|
.br
|
|
.RI "Type list of terms for compile time reflection and iteration over the terms of the field\&. "
|
|
.in -1c
|
|
.SS "Static Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "static constexpr std::string_view \fBname\fP = \fBmeta::type_name\fP<\fBbarotropic_constant\fP>()"
|
|
.br
|
|
.RI "Compile time reflected name of the field\&. "
|
|
.ti -1c
|
|
.RI "static constexpr \fBmass_normalization\fP \fBmass_normalization_term\fP {}"
|
|
.br
|
|
.RI "Static constexpr instance of the \fBmass_normalization\fP term\&. This is used to access the term in the discretization\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
This field holds the effective potential level on the stellar isobar\&. The level is solved together with the fixed total mass\&. The \fBbarotropic_constant\fP name is retained as an internal coordinate identity\&. In the density formulation its value is Us, the gravitational potential minus the centrifugal potential on the surface; it is not the polytropic EOS constant K\&.
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "using \fBserif::discretization::blocks::barotropic_constant::Terms\fP = \fButils::types::TypeList\fP<\fBmass_normalization\fP>"
|
|
|
|
.PP
|
|
Type list of terms for compile time reflection and iteration over the terms of the field\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "\fBmass_normalization\fP serif::discretization::blocks::barotropic_constant::mass_normalization_term {}\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
.PP
|
|
Static constexpr instance of the \fBmass_normalization\fP term\&. This is used to access the term in the discretization\&.
|
|
.SS "std::string_view serif::discretization::blocks::barotropic_constant::name = \fBmeta::type_name\fP<\fBbarotropic_constant\fP>()\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
.PP
|
|
Compile time reflected name of the field\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|