Files
MeanField_SERiF/docs/man/man3/serif_geometry_surface_AutomaticPressureSurface.3
Emily Boudreaux 6b57738330 docs(docs): built docs
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)
2026-11-09 14:09:44 -05:00

42 lines
2.0 KiB
Groff

.TH "serif::geometry::surface::AutomaticPressureSurface< EOS, AvailableTerms, ActualRows, SolvedTerms, PreferredField >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::geometry::surface::AutomaticPressureSurface< EOS, AvailableTerms, ActualRows, SolvedTerms, PreferredField > \- Compile an isobaric condition from available physical fields, actual equation rows, and the EOS catalog\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <automatic\&.hpp>\fP
.PP
Inherits \fBserif::geometry::surface::detail::SelectedPressureSurface< decltype(detail::select_candidates< 0, std::remove_cvref_t< EOS >, ActualRows, AvailableTerms, void >(detail::thermodynamic_fields(AvailableTerms{})))>\fP\&.
.SS "Additional Inherited Members"
Static Public Attributes inherited from \fBserif::geometry::surface::detail::SelectedPressureSurface< decltype(detail::select_candidates< 0, std::remove_cvref_t< EOS >, ActualRows, AvailableTerms, void >(detail::thermodynamic_fields(AvailableTerms{})))>\fP
.in +1c
.ti -1c
.RI "static constexpr \fBPressureSurfaceSelection\fP \fBstatus\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<typename EOS, utils::dependencies::IsKeyList AvailableTerms, utils::dependencies::IsKeyList ActualRows, utils::dependencies::IsKeyList SolvedTerms = AvailableTerms, typename PreferredField = void>
.br
struct serif::geometry::surface::AutomaticPressureSurface< EOS, AvailableTerms, ActualRows, SolvedTerms, PreferredField >"Compile an isobaric condition from available physical fields, actual equation rows, and the EOS catalog\&.
.PP
\fBNote\fP
.RS 4
This searches declared algebraic relations, never performs inversion, and rejects equal-priority choices\&. Global thermodynamic inputs may opt in with thermodynamic_state = true; units alone do not establish that role\&. An optional preferred field narrows the row search without choosing an EOS relation for the model user\&.
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.