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)
55 lines
1.9 KiB
Groff
55 lines
1.9 KiB
Groff
.TH "serif::dimensions::runtime" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::dimensions::runtime
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBRuntimeQuantityValue\fP"
|
|
.br
|
|
.RI "Runtime resolved type for a quantity value\&. This holds both an ID and a value\&. This is the runtime equivalent to a \fBQuantityValue\fP\&. Note that where these differ is that \fBQuantityValue\fP is built with template types\&. This allows the compiler to resolve it to a plain numeric type and still do optimizations That is generally not the case with \fBRuntimeQuantityValue\fP\&. "
|
|
.ti -1c
|
|
.RI "struct \fBRuntimeRelationDescriptor\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "class \fBThermodynamicQuantityID\fP"
|
|
.br
|
|
.RI "Runtime resolvable ID for a thermodynamic quantity\&. Used in conjunction with concepts to resolve compile time thermodynamic types to runtime values\&. "
|
|
.in -1c
|
|
.SS "Concepts"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "concept \fBRuntimeIdentifiedThermodynamicQuantity\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Variables"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<RuntimeIdentifiedThermodynamicQuantity Quantity> constexpr \fBThermodynamicQuantityID\fP \fBthermodynamicQuantityID\fP {std::string_view{Quantity::identifier}}"
|
|
.br
|
|
.RI "Extract a compile time identifier from a thermodynamic quantity and project it into a runtime string_view\&. "
|
|
.in -1c
|
|
.SH "Variable Documentation"
|
|
.PP
|
|
.SS "template<RuntimeIdentifiedThermodynamicQuantity Quantity> \fBThermodynamicQuantityID\fP serif::dimensions::runtime::thermodynamicQuantityID {std::string_view{Quantity::identifier}}\fR [inline]\fP, \fR [constexpr]\fP"
|
|
|
|
.PP
|
|
Extract a compile time identifier from a thermodynamic quantity and project it into a runtime string_view\&.
|
|
.PP
|
|
\fBTemplate Parameters\fP
|
|
.RS 4
|
|
\fIQuantity\fP Type which \fBRuntimeIdentifiedThermodynamicQuantity\fP allows
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|