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)
93 lines
2.2 KiB
Groff
93 lines
2.2 KiB
Groff
.TH "serif::geometry::surface::DirectPressureSurfaceFormulation< EOS, Bindings, RowQuantity, Relation >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::geometry::surface::DirectPressureSurfaceFormulation< EOS, Bindings, RowQuantity, Relation > \- Enforce P_EOS(state) - P_surface = 0 without inventing an inverse EOS relation\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <compilation\&.hpp>\fP
|
|
.PP
|
|
Inherits \fBserif::geometry::surface::detail::PressureSurfaceDescription< EOS, Bindings, RowQuantity, Relation, false >\fP\&.
|
|
.SS "Additional Inherited Members"
|
|
|
|
|
|
Public Types inherited from \fBserif::geometry::surface::detail::PressureSurfaceDescription< EOS, Bindings, RowQuantity, Relation, false >\fP
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBEquationOfState\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBStateBindings\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBRelation\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBPhysicalQuantity\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBResidualQuantity\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBCarrierQuantity\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBCarrierTerm\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBTest\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBSupport\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBEOSStateQuantities\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBStateQuantities\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBStateTerms\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBEOSStateTerms\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBOperands\fP"
|
|
.br
|
|
.in -1c
|
|
|
|
Static Public Attributes inherited from \fBserif::geometry::surface::detail::PressureSurfaceDescription< EOS, Bindings, RowQuantity, Relation, false >\fP
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "static constexpr bool \fBresolves_carrier\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "static constexpr bool \fBuses_eos\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<typename EOS, typename Bindings, typename RowQuantity, typename \fBRelation\fP>
|
|
.br
|
|
requires DirectPressureSurfaceCompilable<EOS, Bindings, RowQuantity, \fBRelation\fP>
|
|
.br
|
|
struct serif::geometry::surface::DirectPressureSurfaceFormulation< EOS, Bindings, RowQuantity, Relation >"Enforce P_EOS(state) - P_surface = 0 without inventing an inverse EOS relation\&.
|
|
|
|
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
The explicit row and relation make the choice of residual, units, and Newton scaling visible\&.
|
|
.RE
|
|
.PP
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|