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)
74 lines
2.5 KiB
Groff
74 lines
2.5 KiB
Groff
.TH "serif::solver::continuation::PreservePressureAtReferenceDensity" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::solver::continuation::PreservePressureAtReferenceDensity \- Vary K with n to preserve pressure at one explicitly selected physical reference density\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <polytropic\&.hpp>\fP
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBOutputParameter\fP = \fBPolytropicConstant\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBDependencyParameters\fP = \fBParameterList\fP<\fBPolytropicIndex\fP>"
|
|
.br
|
|
.in -1c
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBPreservePressureAtReferenceDensity\fP (\fBdimensions::DensityValue\fP density)"
|
|
.br
|
|
.RI "Validate a positive finite thermodynamic pressure anchor\&. "
|
|
.ti -1c
|
|
.RI "template<model::StellarModelType Model>
|
|
.br
|
|
requires Model::templatecontains_specification< \fBeos::models::Polytrope\fP > auto \fBbind\fP (const Model &target) const"
|
|
.br
|
|
.RI "Freeze target values into an owning law whose exact endpoint retains the original K\&. "
|
|
.in -1c
|
|
.SS "Private Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBdimensions::DensityValue\fP \fBm_density\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Vary K with n to preserve pressure at one explicitly selected physical reference density\&.
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "using \fBserif::solver::continuation::PreservePressureAtReferenceDensity::DependencyParameters\fP = \fBParameterList\fP<\fBPolytropicIndex\fP>"
|
|
|
|
.SS "using \fBserif::solver::continuation::PreservePressureAtReferenceDensity::OutputParameter\fP = \fBPolytropicConstant\fP"
|
|
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "serif::solver::continuation::PreservePressureAtReferenceDensity::PreservePressureAtReferenceDensity (\fBdimensions::DensityValue\fP density)\fR [inline]\fP, \fR [explicit]\fP"
|
|
|
|
.PP
|
|
Validate a positive finite thermodynamic pressure anchor\&.
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "template<model::StellarModelType Model>
|
|
.br
|
|
requires Model::templatecontains_specification< \fBeos::models::Polytrope\fP > auto serif::solver::continuation::PreservePressureAtReferenceDensity::bind (const Model & target) const\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Freeze target values into an owning law whose exact endpoint retains the original K\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "\fBdimensions::DensityValue\fP serif::solver::continuation::PreservePressureAtReferenceDensity::m_density\fR [private]\fP"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|