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)
57 lines
1.6 KiB
Groff
57 lines
1.6 KiB
Groff
.TH "src/lib/serif/eos/models/polytropic.cpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/lib/serif/eos/models/polytropic.cpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'serif/eos/models/polytropic\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/utils/misc/finite\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/eos/exceptions\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/utils/error/codes\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::eos\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::eos::models\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Enumerations"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "enum class \fBserif::eos::models::SERiFErrorCode\fP "
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename ExceptionType, errors::SERiFErrorCode ErrorCode, concepts::IsNumeric Scalar> void \fBserif::eos::models::validate_finite\fP (const Scalar value)"
|
|
.br
|
|
.ti -1c
|
|
.RI "template<typename ExceptionType, errors::SERiFErrorCode ErrorCode, concepts::IsComparableToNumeric Scalar> void \fBserif::eos::models::validate_greater_than\fP (const Scalar value, const Scalar predicate)"
|
|
.br
|
|
.ti -1c
|
|
.RI "template<typename ExceptionType, errors::SERiFErrorCode ErrorCode, concepts::IsComparableToNumeric Scalar> void \fBserif::eos::models::validate_less_than\fP (const Scalar value, const Scalar predicate)"
|
|
.br
|
|
.ti -1c
|
|
.RI "template<typename ExceptionType, errors::SERiFErrorCode ErrorCode, concepts::IsComparableToNumeric Scalar> void \fBserif::eos::models::validate_nonnegativity\fP (const Scalar value)"
|
|
.br
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|