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)
65 lines
1.8 KiB
Groff
65 lines
1.8 KiB
Groff
.TH "src/include/serif/geometry/surface/linearization.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/geometry/surface/linearization.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <cstddef>\fP
|
|
.br
|
|
\fR#include <limits>\fP
|
|
.br
|
|
\fR#include <string_view>\fP
|
|
.br
|
|
\fR#include 'serif/equations/point\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/geometry/surface/compilation\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::geometry::surface::SurfaceFailure\fP"
|
|
.br
|
|
.RI "A rejected thermodynamic candidate, with a sample index when evaluating a boundary batch\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::geometry::surface::SurfaceEOSResponse< Formulation >\fP"
|
|
.br
|
|
.RI "An EOS value and all of its local derivatives, evaluated together at one state\&. "
|
|
.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
|
|
.in -1c
|
|
.SS "Typedefs"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<PressureSurfaceFormulationType Formulation> using \fBserif::geometry::surface::SurfacePoint\fP = \fBequations::EquationPoint\fP<typename Formulation::Operands>"
|
|
.br
|
|
.ti -1c
|
|
.RI "template<PressureSurfaceFormulationType Formulation> using \fBserif::geometry::surface::SurfaceLinearization\fP = \fBequations::PointLinearization\fP<typename Formulation::Operands>"
|
|
.br
|
|
.in -1c
|
|
.SS "Enumerations"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "enum class \fBserif::geometry::surface::SurfaceFailureReason\fP { \fBserif::geometry::surface::non_finite_state\fP, \fBserif::geometry::surface::non_finite_eos_response\fP, \fBserif::geometry::surface::non_finite_linearization\fP, \fBserif::geometry::surface::inconsistent_sample_count\fP, \fBserif::geometry::surface::empty_surface\fP }"
|
|
.br
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|