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)
76 lines
2.5 KiB
Groff
76 lines
2.5 KiB
Groff
.TH "src/include/serif/geometry/surface/automatic.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/geometry/surface/automatic.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'serif/geometry/surface/detail/automatic_relations\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::geometry::surface::detail::SelectedPressureSurface< Candidates >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::geometry::surface::detail::SelectedPressureSurface< std::tuple< Candidate > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::geometry::surface::AutomaticPressureSurface< EOS, AvailableTerms, ActualRows, SolvedTerms, PreferredField >\fP"
|
|
.br
|
|
.RI "Compile an isobaric condition from available physical fields, actual equation rows, and the EOS catalog\&. "
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::geometry\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::geometry::surface\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::geometry::surface::detail\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Concepts"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "concept \fBserif::geometry::surface::detail::EligibleSurfaceRow\fP"
|
|
.br
|
|
.RI "Strong boundary enforcement requires an actual solved, scalar H1 equation row\&. "
|
|
.ti -1c
|
|
.RI "concept \fBserif::geometry::surface::AutomaticPressureSurfaceCompilable\fP"
|
|
.br
|
|
.RI "Whether the available equations and numerical backend select one implementable isobaric residual\&. "
|
|
.in -1c
|
|
.SS "Enumerations"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "enum class \fBserif::geometry::surface::PressureSurfaceSelection\fP { \fBserif::geometry::surface::supported\fP, \fBserif::geometry::surface::unavailable\fP, \fBserif::geometry::surface::ambiguous\fP }"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<int Priority, typename EOS, typename Field, typename Fields, typename Rows, typename SolvedTerms, typename PreferredField> consteval auto \fBserif::geometry::surface::detail::field_candidates\fP ()"
|
|
.br
|
|
.RI "Search one precedence level, without asking the EOS for a relation when pressure is already an unknown\&. "
|
|
.ti -1c
|
|
.RI "template<int Priority, typename EOS, typename Rows, typename SolvedTerms, typename PreferredField, typename\&.\&.\&. Fields> consteval auto \fBserif::geometry::surface::detail::select_candidates\fP (\fButils::dependencies::KeyList\fP< Fields\&.\&.\&. > fields)"
|
|
.br
|
|
.RI "Prefer a pressure unknown, then an explicit inverse, then a direct pressure residual\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|