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)
69 lines
2.1 KiB
Groff
69 lines
2.1 KiB
Groff
.TH "serif::eos::relations::Relation< Output, Inputs >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::eos::relations::Relation< Output, Inputs > \- A struct to represent a relation between physical quantities\&. This is used to define the relations that an EOS model supports\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <catalog\&.hpp>\fP
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBOutputQuantity\fP = Output"
|
|
.br
|
|
.RI "The output quantity of the relation\&. "
|
|
.ti -1c
|
|
.RI "using \fBInputQuantities\fP = \fBdimensions::QuantityList\fP<Inputs\&.\&.\&.>"
|
|
.br
|
|
.RI "The input quantities of the relation\&. "
|
|
.in -1c
|
|
.SS "Static Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "static constexpr std::size_t \fBinputCount\fP = \fBCountVariadicArguments\fP<Inputs\&.\&.\&.>()"
|
|
.br
|
|
.RI "The number of input quantities in the relation\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<typename Output, typename\&.\&.\&. Inputs>
|
|
.br
|
|
struct serif::eos::relations::Relation< Output, Inputs >"A struct to represent a relation between physical quantities\&. This is used to define the relations that an EOS model supports\&.
|
|
|
|
|
|
.PP
|
|
\fBTemplate Parameters\fP
|
|
.RS 4
|
|
\fIOutput\fP The output quantity of the relation\&.
|
|
.br
|
|
\fIInputs\fP The input quantities of the relation\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "template<typename Output, typename\&.\&.\&. Inputs> using \fBserif::eos::relations::Relation\fP< Output, Inputs >::InputQuantities = \fBdimensions::QuantityList\fP<Inputs\&.\&.\&.>"
|
|
|
|
.PP
|
|
The input quantities of the relation\&.
|
|
.SS "template<typename Output, typename\&.\&.\&. Inputs> using \fBserif::eos::relations::Relation\fP< Output, Inputs >::OutputQuantity = Output"
|
|
|
|
.PP
|
|
The output quantity of the relation\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "template<typename Output, typename\&.\&.\&. Inputs> std::size_t \fBserif::eos::relations::Relation\fP< Output, Inputs >::inputCount = \fBCountVariadicArguments\fP<Inputs\&.\&.\&.>()\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
.PP
|
|
The number of input quantities in the relation\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|