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)
64 lines
1.7 KiB
Groff
64 lines
1.7 KiB
Groff
.TH "src/include/serif/eos/relations/catalog.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/eos/relations/catalog.hpp \- File containing the Relation and RelationCatalog structs\&. These structs are used to represent relations between physical quantities and to group them into catalogs for use in EOS models\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'serif/utils/misc/concepts/type_uniqueness\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/utils/misc/std_helper/variadic_cleaning\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/dimensions/quantities\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::eos::relations::Relation< Output, Inputs >\fP"
|
|
.br
|
|
.RI "A struct to represent a relation between physical quantities\&. This is used to define the relations that an EOS model supports\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::eos::relations::RelationCatalog< Relations >\fP"
|
|
.br
|
|
.RI "A struct to represent a catalog of relations between physical quantities\&. This is used to group relations for use in EOS models\&. "
|
|
.in -1c
|
|
.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::relations\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename\&.\&.\&. Ts> consteval std::size_t \fBserif::eos::relations::CountVariadicArguments\fP () noexcept"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
File containing the Relation and RelationCatalog structs\&. These structs are used to represent relations between physical quantities and to group them into catalogs for use in EOS models\&.
|
|
|
|
|
|
.PP
|
|
\fBAuthor\fP
|
|
.RS 4
|
|
Emily M\&. Boudreaux
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|