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)
98 lines
3.7 KiB
Groff
98 lines
3.7 KiB
Groff
.TH "src/include/serif/geometry/surface/compilation.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/geometry/surface/compilation.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'serif/geometry/surface/detail/relations\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/geometry/surface/isobaric\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::geometry::surface::detail::PressureSurfaceDescription< EOS, Bindings, RowQuantity, RelationT, ResolveCarrier >\fP"
|
|
.br
|
|
.RI "Common physical metadata; numerical values and preparation belong to the dependency context and cache\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::geometry::surface::PressureSurfaceFormulation< EOS, Bindings, Carrier >\fP"
|
|
.br
|
|
.RI "The boundary residual is carrier minus the EOS value at prescribed pressure; no carrier quantity is privileged\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::geometry::surface::InversePressureSurfaceFormulation< EOS, Bindings, Relation >\fP"
|
|
.br
|
|
.RI "A selected explicit inverse relation; choosing it requires no numerical EOS inversion\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::geometry::surface::DirectPressureSurfaceFormulation< EOS, Bindings, RowQuantity, Relation >\fP"
|
|
.br
|
|
.RI "Enforce P_EOS(state) - P_surface = 0 without inventing an inverse EOS relation\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::geometry::surface::PressureFieldSurfaceFormulation< EOS, Bindings >\fP"
|
|
.br
|
|
.RI "An existing pressure unknown enforces P - P_surface directly, without evaluating the EOS\&. "
|
|
.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::PressureSurfaceCompilable\fP"
|
|
.br
|
|
.RI "Whether the available state selects exactly one pressure-to-carrier EOS relation\&. "
|
|
.ti -1c
|
|
.RI "concept \fBserif::geometry::surface::DirectPressureSurfaceCompilable\fP"
|
|
.br
|
|
.RI "A direct pressure residual requires an explicitly chosen pressure relation and an input quantity whose equation row it replaces\&. "
|
|
.ti -1c
|
|
.RI "concept \fBserif::geometry::surface::PressureSurfaceFormulationType\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Typedefs"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename EOS, typename Bindings, typename Carrier = void> using \fBserif::geometry::surface::pressure_relation_t\fP = std::tuple_element_t<0, typename \fBdetail::MatchingPressureRelations\fP<std::remove_cvref_t<EOS>, std::remove_cvref_t<Bindings>, Carrier, typename std::remove_cvref_t<EOS>::Relations>::Matches>"
|
|
.br
|
|
.in -1c
|
|
.SS "Variables"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename Candidate> constexpr bool \fBserif::geometry::surface::detail::is_pressure_surface_formulation\fP = false"
|
|
.br
|
|
.ti -1c
|
|
.RI "template<typename EOS, typename Bindings, typename Carrier> constexpr bool \fBserif::geometry::surface::detail::is_pressure_surface_formulation< PressureSurfaceFormulation< EOS, Bindings, Carrier > >\fP = true"
|
|
.br
|
|
.ti -1c
|
|
.RI "template<typename EOS, typename Bindings, typename Relation> constexpr bool \fBserif::geometry::surface::detail::is_pressure_surface_formulation< InversePressureSurfaceFormulation< EOS, Bindings, Relation > >\fP = true"
|
|
.br
|
|
.ti -1c
|
|
.RI "template<typename EOS, typename Bindings, typename RowQuantity, typename Relation> constexpr bool \fBserif::geometry::surface::detail::is_pressure_surface_formulation< DirectPressureSurfaceFormulation< EOS, Bindings, RowQuantity, Relation > >\fP = true"
|
|
.br
|
|
.ti -1c
|
|
.RI "template<typename EOS, typename Bindings> constexpr bool \fBserif::geometry::surface::detail::is_pressure_surface_formulation< PressureFieldSurfaceFormulation< EOS, Bindings > >\fP = true"
|
|
.br
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|