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)
41 lines
844 B
Groff
41 lines
844 B
Groff
.TH "serif::eos::models::PolytropeParameters" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::eos::models::PolytropeParameters \- A struct to hold the parameters for a polytropic equation of state\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <polytropic\&.hpp>\fP
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "double \fBn\fP"
|
|
.br
|
|
.RI "Polytropic index\&. "
|
|
.ti -1c
|
|
.RI "double \fBK\fP"
|
|
.br
|
|
.RI "Polytropic constant\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
A struct to hold the parameters for a polytropic equation of state\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "double serif::eos::models::PolytropeParameters::K"
|
|
|
|
.PP
|
|
Polytropic constant\&.
|
|
.SS "double serif::eos::models::PolytropeParameters::n"
|
|
|
|
.PP
|
|
Polytropic index\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|