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)
36 lines
1.2 KiB
Groff
36 lines
1.2 KiB
Groff
.TH "serif::eos::models::StructureSeedEOS" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::eos::models::StructureSeedEOS \- A concept to determine if a type is an equation of state model that can be used in the current SERiF seed initialization system\&. This is satisfied for types that are both valid EOSModels and which also support the relation for computing specific enthalpy from density\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <concepts\&.hpp>\fP
|
|
.SH "Concept definition"
|
|
.PP
|
|
|
|
.nf
|
|
template<typename EOSCandidate>
|
|
concept serif::eos::models::StructureSeedEOS = EOSModel<EOSCandidate> &&
|
|
EOSSupportingRelation<EOSCandidate, relations::SpecificEnthalpyFromDensity>
|
|
.PP
|
|
.fi
|
|
.SH "Detailed Description"
|
|
.PP
|
|
A concept to determine if a type is an equation of state model that can be used in the current SERiF seed initialization system\&. This is satisfied for types that are both valid EOSModels and which also support the relation for computing specific enthalpy from density\&.
|
|
|
|
|
|
.PP
|
|
\fBTodo\fP
|
|
.RS 4
|
|
A future more general version of this code will need a more general seeding system\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|