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)
26 lines
771 B
Groff
26 lines
771 B
Groff
.TH "serif::eos::models::EOSModel" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::eos::models::EOSModel \- A concept to determine if a type is an equation of state model\&. A type is a valid EOSModel if it satisfies the is_equation_of_state_model_v trait\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <concepts\&.hpp>\fP
|
|
.SH "Concept definition"
|
|
.PP
|
|
|
|
.nf
|
|
template<typename EOSCandidate>
|
|
concept serif::eos::models::EOSModel = is_equation_of_state_model_v<EOSCandidate>
|
|
.PP
|
|
.fi
|
|
.SH "Detailed Description"
|
|
.PP
|
|
A concept to determine if a type is an equation of state model\&. A type is a valid EOSModel if it satisfies the is_equation_of_state_model_v trait\&.
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|