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)
97 lines
5.1 KiB
Groff
97 lines
5.1 KiB
Groff
.TH "src/include/serif/eos/relations/traits.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/eos/relations/traits.hpp \- File containing traits for the eos relations module\&. These traits are used to determine if a type is a valid thermodynamic relation or a valid relation catalog\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'serif/eos/relations/catalog\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::eos::relations::CatalogContainsRelation< Catalog, RelationT >\fP"
|
|
.br
|
|
.RI "A trait to determine if a catalog contains a given relation\&. This is the default false specialization\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::eos::relations::CatalogContainsRelation< RelationCatalog< Relations\&.\&.\&. >, RelationT >\fP"
|
|
.br
|
|
.RI "A specialization of the \fBCatalogContainsRelation\fP trait for a \fBRelationCatalog\fP\&. This trait is used to determine if a \fBRelationCatalog\fP contains a given relation\&. This is true so long as any of the relations in the catalog match the relation type being checked for\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::eos::relations::RelationContainsInput< RelationT, Quantity >\fP"
|
|
.br
|
|
.RI "A trait to determine if a relation contains a given input quantity\&. This is the default false specialization\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::eos::relations::RelationContainsInput< Relation< Output, Inputs\&.\&.\&. >, Quantity >\fP"
|
|
.br
|
|
.RI "A specialization of the \fBRelationContainsInput\fP trait for a \fBRelation\fP\&. This trait is used to determine if a \fBRelation\fP contains a given input quantity\&. This is true so long as any of the input quantities in the relation match the quantity type being checked for\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::eos::relations::IsThermodynamicRelation< RelationCandidate >\fP"
|
|
.br
|
|
.RI "A trait to determine if a type is a valid thermodynamic relation\&. This is the default false specialization\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::eos::relations::IsThermodynamicRelation< Relation< Output, Inputs\&.\&.\&. > >\fP"
|
|
.br
|
|
.RI "A specialization of the \fBIsThermodynamicRelation\fP trait for a \fBRelation\fP\&. This trait is used to determine if a \fBRelation\fP is a valid thermodynamic relation\&. A relation is considered valid if its output quantity and all of its input quantities are valid thermodynamic quantities, and if all of its input quantities are unique types\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::eos::relations::IsValidRelationCatalog< CandidateCatalog >\fP"
|
|
.br
|
|
.RI "A trait to determine if a type is a valid relation catalog\&. This is the default false specialization\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::eos::relations::IsValidRelationCatalog< RelationCatalog< Relations\&.\&.\&. > >\fP"
|
|
.br
|
|
.RI "A specialization of the \fBIsValidRelationCatalog\fP trait for a \fBRelationCatalog\fP\&. This trait is used to determine if a \fBRelationCatalog\fP is a valid relation catalog\&. A relation catalog is considered valid if it contains at least one relation, if all of its relations are valid thermodynamic relations, and if all of its relations are unique types\&. "
|
|
.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 "Variables"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename Catalog, typename RelationT> constexpr bool \fBserif::eos::relations::relation_catalog_contains_relation_v\fP = \fBCatalogContainsRelation\fP<std::remove_cv_t<Catalog>, std::remove_cv_t<RelationT>>::value"
|
|
.br
|
|
.RI "A trait to determine if a catalog contains a given relation\&. This is a helper variable template that simplifies the usage of the \fBCatalogContainsRelation\fP trait\&. "
|
|
.ti -1c
|
|
.RI "template<typename RelationT, typename Quantity> constexpr bool \fBserif::eos::relations::relation_contains_input_v\fP = \fBRelationContainsInput\fP<std::remove_cv_t<RelationT>, std::remove_cv_t<Quantity>>::value"
|
|
.br
|
|
.RI "A trait to determine if a relation contains a given input quantity\&. This is a helper variable template that simplifies the usage of the \fBRelationContainsInput\fP trait\&. "
|
|
.ti -1c
|
|
.RI "template<typename RelationCandidate> constexpr bool \fBserif::eos::relations::is_thermodynamic_relation_v\fP = \fBIsThermodynamicRelation\fP<RelationCandidate>::value"
|
|
.br
|
|
.RI "A trait to determine if a relation is a valid thermodynamic relation\&. This is a helper variable template that simplifies the usage of the \fBIsThermodynamicRelation\fP trait\&. "
|
|
.ti -1c
|
|
.RI "template<typename CatalogCandidate> constexpr bool \fBserif::eos::relations::is_valid_relation_catalog_v\fP = \fBIsValidRelationCatalog\fP<CatalogCandidate>::value"
|
|
.br
|
|
.RI "A trait to determine if a catalog is a valid relation catalog\&. This is a helper variable template that simplifies the usage of the \fBIsValidRelationCatalog\fP trait\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
File containing traits for the eos relations module\&. These traits are used to determine if a type is a valid thermodynamic relation or a valid relation catalog\&.
|
|
|
|
|
|
.PP
|
|
\fBAuthor\fP
|
|
.RS 4
|
|
Emily M\&. Boudreaux
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|