Files

63 lines
3.1 KiB
Groff
Raw Permalink Normal View History

.TH "src/include/serif/geometry/surface/detail/batches.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/geometry/surface/detail/batches.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <array>\fP
.br
\fR#include 'serif/geometry/surface/detail/evaluation\&.hpp'\fP
.br
\fR#include 'serif/geometry/surface/samples\&.hpp'\fP
.br
.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 "Functions"
.in +1c
.ti -1c
.RI "template<typename\&.\&.\&. Terms> std::expected< std::size_t, \fBSurfaceFailure\fP > \fBserif::geometry::surface::detail::surface_sample_count\fP (const \fBBoundaryValues\fP< Terms > &\&.\&.\&. columns)"
.br
.RI "All EOS columns must describe the same ordered, nonempty set of boundary points\&. "
.ti -1c
.RI "template<PressureSurfaceFormulationType Formulation, typename\&.\&.\&. Terms> \fBSurfacePoint\fP< Formulation > \fBserif::geometry::surface::detail::surface_point\fP (const std::size_t sample, const \fBBoundaryValues\fP< Terms > &\&.\&.\&. columns)"
.br
.RI "Assemble the conventional equation point from typed columns; no mesh assumptions enter the physical calculation\&. "
.ti -1c
.RI "template<typename Value, typename Evaluate> std::expected< std::vector< Value >, \fBSurfaceFailure\fP > \fBserif::geometry::surface::detail::collect_surface_samples\fP (std::size_t count, Evaluate evaluate)"
.br
.RI "Collect one ordered batch, attaching the first failure's sample index before any result is published\&. "
.ti -1c
.RI "template<PressureSurfaceFormulationType Formulation, typename\&.\&.\&. Terms> std::expected< std::vector< \fBSurfaceEOSResponse\fP< Formulation > >, \fBSurfaceFailure\fP > \fBserif::geometry::surface::detail::evaluate_response_samples\fP (const typename Formulation::EquationOfState &equation_of_state, const \fBdimensions::PressureValue\fP pressure, const \fBBoundaryValues\fP< Terms > &\&.\&.\&. columns)"
.br
.RI "Evaluate the EOS once per state sample, or once for a genuinely pressure-only relation\&. "
.ti -1c
.RI "template<PressureSurfaceFormulationType Formulation> std::expected< std::vector< \fBSurfaceLinearization\fP< Formulation > >, \fBSurfaceFailure\fP > \fBserif::geometry::surface::detail::linearize_carrier_samples\fP (const std::vector< \fBSurfaceEOSResponse\fP< Formulation > > &responses, const \fBBoundaryValues\fP< typename Formulation::CarrierTerm > &carrier)"
.br
.RI "Broadcast only a pressure-only relation; every state-dependent carrier sample needs its own response\&. "
.ti -1c
.RI "template<PressureSurfaceFormulationType Formulation> std::expected< std::vector< \fBSurfaceLinearization\fP< Formulation > >, \fBSurfaceFailure\fP > \fBserif::geometry::surface::detail::linearize_pressure_samples\fP (const \fBIsobaricSurface\fP &condition, const std::vector< \fBSurfaceEOSResponse\fP< Formulation > > &responses)"
.br
.RI "Changing prescribed pressure reuses all values and partials of a direct-pressure EOS relation\&. "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.