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)
63 lines
2.1 KiB
Groff
63 lines
2.1 KiB
Groff
.TH "src/include/serif/equations/central_density.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/equations/central_density.hpp \- Prescribe central density through the continuous enthalpy: h(0) - h_EOS(rho_c) = 0\&. Generally this is not needed; however, in the particular case of an n=3 polytrope with no rotation the central density becomes ill-defined and must be prescribed to avoid a singularity in the solution\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <array>\fP
|
|
.br
|
|
\fR#include <cmath>\fP
|
|
.br
|
|
\fR#include <string_view>\fP
|
|
.br
|
|
\fR#include <utility>\fP
|
|
.br
|
|
\fR#include 'serif/dimensions/type_alias\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/eos/evaluation\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/equations/contributions\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/equations/point\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/utils/error/errors\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "class \fBserif::equations::CentralDensityConstraint< EOST >\fP"
|
|
.br
|
|
.RI "Prescribe central density through the continuous enthalpy: $h(0) - h_{EOS}(\rho_c) = 0$\&. Generally this is not needed; however, in the particular case of an n=3 polytrope with no rotation the central density becomes ill-defined and must be prescribed to avoid a singularity in the solution\&. Note that this equation is not responsible for sorting out what point is the center of the star; rather, this is provided to the evaluate method\&. "
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::equations\fP"
|
|
.br
|
|
.RI "The equations namespace, intended to be, to the best of my design ability, where the vast majority of the actual physics lives\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Prescribe central density through the continuous enthalpy: h(0) - h_EOS(rho_c) = 0\&. Generally this is not needed; however, in the particular case of an n=3 polytrope with no rotation the central density becomes ill-defined and must be prescribed to avoid a singularity in the solution\&.
|
|
|
|
|
|
.PP
|
|
\fBAuthor\fP
|
|
.RS 4
|
|
Emily M\&. Boudreaux
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|