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)
126 lines
6.3 KiB
Groff
126 lines
6.3 KiB
Groff
.TH "serif::eos" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::eos
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBmodels\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBrelations\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "class \fBEOSEvaluationError\fP"
|
|
.br
|
|
.RI "An exception class to represent errors that occur during the evaluation of an EOS model\&. This class inherits from std::domain_error and is used to provide a more specific exception type for EOS evaluation errors\&. "
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<dimensions::ThermodynamicQuantityType OutputQ, models::EOSModel EOS, dimensions::QuantityValueType\&.\&.\&. InputValues>
|
|
.br
|
|
requires models::EOSSupportingRelation<EOS, \fBrelations::Relation\fP<OutputQ, \fBdimensions::QuantityOfT\fP<InputValues>\&.\&.\&.>>constexpr \fBdimensions::QuantityValue\fP< OutputQ > \fBevaluate\fP (const EOS &eos, const InputValues\&.\&.\&. inputValues) noexcept(noexcept(eos\&.evaluate(\fBrelations::Relation\fP< OutputQ, \fBdimensions::QuantityOfT\fP< InputValues >\&.\&.\&. >{}, inputValues\&.\&.\&.)))"
|
|
.br
|
|
.RI "Evaluates a relation for a given EOS model\&. This function is used to evaluate relations for a given EOS model\&. "
|
|
.ti -1c
|
|
.RI "template<dimensions::ThermodynamicQuantityType OutputQ, dimensions::ThermodynamicQuantityType InputQ, models::EOSModel EOS, dimensions::QuantityValueType\&.\&.\&. InputValues>
|
|
.br
|
|
requires models::EOSSupportingPartialDerivative<EOS, \fBrelations::Relation\fP<OutputQ, \fBdimensions::QuantityOfT\fP<InputValues>\&.\&.\&.>, InputQ>constexpr \fBdimensions::PartialDerivative\fP< OutputQ, InputQ > \fBpartial_derivative\fP (const EOS &eos, const InputValues\&.\&.\&. inputValues) noexcept(noexcept(eos\&.partial_derivative(\fBrelations::Relation\fP< OutputQ, \fBdimensions::QuantityOfT\fP< InputValues >\&.\&.\&. >{}, \fBdimensions::WithRespectTo\fP< InputQ >{}, inputValues\&.\&.\&.)))"
|
|
.br
|
|
.RI "Evaluates a partial derivative of a relation for a given EOS model\&. This function is used to evaluate partial derivatives of relations for a given EOS model\&. "
|
|
.ti -1c
|
|
.RI "template<dimensions::ThermodynamicQuantityType OutputQ, dimensions::ThermodynamicQuantityType FirstInput, dimensions::ThermodynamicQuantityType SecondInput, models::EOSModel EOS, dimensions::QuantityValueType\&.\&.\&. InputValues>
|
|
.br
|
|
requires models::EOSSupportingSecondPartialDerivative<EOS, \fBrelations::Relation\fP<OutputQ, \fBdimensions::QuantityOfT\fP<InputValues>\&.\&.\&.>, FirstInput, SecondInput>constexpr \fBdimensions::SecondPartialDerivative\fP< OutputQ, FirstInput, SecondInput > \fBsecond_partial_derivative\fP (const EOS &eos, const InputValues\&.\&.\&. inputValues) noexcept(noexcept(eos\&.second_partial_derivative(\fBrelations::Relation\fP< OutputQ, \fBdimensions::QuantityOfT\fP< InputValues >\&.\&.\&. >{}, \fBdimensions::WithRespectTo\fP< FirstInput >{}, \fBdimensions::WithRespectTo\fP< SecondInput >{}, inputValues\&.\&.\&.)))"
|
|
.br
|
|
.RI "Dispatch an analytic second partial without imposing an EOS-specific state\&. "
|
|
.in -1c
|
|
.SH "Function Documentation"
|
|
.PP
|
|
.SS "template<dimensions::ThermodynamicQuantityType OutputQ, models::EOSModel EOS, dimensions::QuantityValueType\&.\&.\&. InputValues>
|
|
.br
|
|
requires models::EOSSupportingRelation<EOS, \fBrelations::Relation\fP<OutputQ, \fBdimensions::QuantityOfT\fP<InputValues>\&.\&.\&.>>\fBdimensions::QuantityValue\fP< OutputQ > serif::eos::evaluate (const EOS & eos, const InputValues\&.\&.\&. inputValues)\fR [nodiscard]\fP, \fR [constexpr]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Evaluates a relation for a given EOS model\&. This function is used to evaluate relations for a given EOS model\&.
|
|
.PP
|
|
\fBTemplate Parameters\fP
|
|
.RS 4
|
|
\fIOutputQ\fP The output quantity type to evaluate\&.
|
|
.br
|
|
\fIInputValues\fP The input values to use for evaluation\&.
|
|
.RE
|
|
.PP
|
|
\fBParameters\fP
|
|
.RS 4
|
|
\fIeos\fP The EOS model instance to use for evaluation\&.
|
|
.br
|
|
\fIinputValues\fP The input values to use for evaluation\&.
|
|
.RE
|
|
.PP
|
|
\fBReturns\fP
|
|
.RS 4
|
|
The result of the evaluation\&.
|
|
.RE
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
this is generally the function you want to call to evaluate a model as it will automatically dispatch to the correct relation\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SS "template<dimensions::ThermodynamicQuantityType OutputQ, dimensions::ThermodynamicQuantityType InputQ, models::EOSModel EOS, dimensions::QuantityValueType\&.\&.\&. InputValues>
|
|
.br
|
|
requires models::EOSSupportingPartialDerivative<EOS, \fBrelations::Relation\fP<OutputQ, \fBdimensions::QuantityOfT\fP<InputValues>\&.\&.\&.>, InputQ>\fBdimensions::PartialDerivative\fP< OutputQ, InputQ > serif::eos::partial_derivative (const EOS & eos, const InputValues\&.\&.\&. inputValues)\fR [nodiscard]\fP, \fR [constexpr]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Evaluates a partial derivative of a relation for a given EOS model\&. This function is used to evaluate partial derivatives of relations for a given EOS model\&.
|
|
.PP
|
|
\fBTemplate Parameters\fP
|
|
.RS 4
|
|
\fIOutputQ\fP The output quantity type to evaluate\&.
|
|
.br
|
|
\fIInputQ\fP The input quantity type to take the partial derivative with respect to\&.
|
|
.br
|
|
\fIInputValues\fP The input values to use for evaluation\&.
|
|
.RE
|
|
.PP
|
|
\fBParameters\fP
|
|
.RS 4
|
|
\fIeos\fP The EOS model instance to use for evaluation\&.
|
|
.br
|
|
\fIinputValues\fP The input values to use for evaluation\&.
|
|
.RE
|
|
.PP
|
|
\fBReturns\fP
|
|
.RS 4
|
|
The result of the evaluation\&.
|
|
.RE
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
this is generally the function you want to call to evaluate a model's partial derivative as it will automatically dispatch to the correct relation and partial derivative\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SS "template<dimensions::ThermodynamicQuantityType OutputQ, dimensions::ThermodynamicQuantityType FirstInput, dimensions::ThermodynamicQuantityType SecondInput, models::EOSModel EOS, dimensions::QuantityValueType\&.\&.\&. InputValues>
|
|
.br
|
|
requires models::EOSSupportingSecondPartialDerivative<EOS, \fBrelations::Relation\fP<OutputQ, \fBdimensions::QuantityOfT\fP<InputValues>\&.\&.\&.>, FirstInput, SecondInput>\fBdimensions::SecondPartialDerivative\fP< OutputQ, FirstInput, SecondInput > serif::eos::second_partial_derivative (const EOS & eos, const InputValues\&.\&.\&. inputValues)\fR [nodiscard]\fP, \fR [constexpr]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Dispatch an analytic second partial without imposing an EOS-specific state\&.
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|