Files
MeanField_SERiF/docs/man/man3/serif_geometry_surface_SurfaceFailure.3

40 lines
1.0 KiB
Groff
Raw Permalink Normal View History

.TH "serif::geometry::surface::SurfaceFailure" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::geometry::surface::SurfaceFailure \- A rejected thermodynamic candidate, with a sample index when evaluating a boundary batch\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <linearization\&.hpp>\fP
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBSurfaceFailureReason\fP \fBreason\fP"
.br
.ti -1c
.RI "std::string_view \fBmessage\fP"
.br
.ti -1c
.RI "std::size_t \fBsample\fP = std::numeric_limits<std::size_t>::max()"
.br
.in -1c
.SH "Detailed Description"
.PP
A rejected thermodynamic candidate, with a sample index when evaluating a boundary batch\&.
.SH "Member Data Documentation"
.PP
.SS "std::string_view serif::geometry::surface::SurfaceFailure::message"
.SS "\fBSurfaceFailureReason\fP serif::geometry::surface::SurfaceFailure::reason"
.SS "std::size_t serif::geometry::surface::SurfaceFailure::sample = std::numeric_limits<std::size_t>::max()"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.