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)
28 lines
1.3 KiB
Groff
28 lines
1.3 KiB
Groff
.TH "serif::eos::models::BarotropicClosureEOS" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::eos::models::BarotropicClosureEOS \- A concept to determine if an EOS type can be used as a barotropic closure in the current SERiF system\&. This is satisfied for types that are valid EOS models, support the relation for computing density from specific enthalpy, and support the partial derivative of that relation with respect to specific enthalpy\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <concepts\&.hpp>\fP
|
|
.SH "Concept definition"
|
|
.PP
|
|
|
|
.nf
|
|
template<typename EOSCandidate>
|
|
concept serif::eos::models::BarotropicClosureEOS = EOSModel<EOSCandidate> &&
|
|
EOSSupportingRelation<EOSCandidate, relations::DensityFromSpecificEnthalpy> &&
|
|
EOSSupportingPartialDerivative<EOSCandidate, relations::DensityFromSpecificEnthalpy, dimensions::SpecificEnthalpy>
|
|
.PP
|
|
.fi
|
|
.SH "Detailed Description"
|
|
.PP
|
|
A concept to determine if an EOS type can be used as a barotropic closure in the current SERiF system\&. This is satisfied for types that are valid EOS models, support the relation for computing density from specific enthalpy, and support the partial derivative of that relation with respect to specific enthalpy\&.
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|