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)
46 lines
1.2 KiB
Groff
46 lines
1.2 KiB
Groff
.TH "src/include/serif/geometry/deformation/geometry_inspection.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/geometry/deformation/geometry_inspection.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <cmath>\fP
|
|
.br
|
|
\fR#include <cstddef>\fP
|
|
.br
|
|
\fR#include <limits>\fP
|
|
.br
|
|
\fR#include <vector>\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::geometry::deformation::DeformationGeometryReport\fP"
|
|
.br
|
|
.RI "Report the smallest sampled determinant of the computational deformation, det(I + grad_X u)\&. This includes stellar and vacuum computational elements, before exterior compactification\&. Positive samples do not prove positivity between samples or at additional physics quadrature points\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::geometry::deformation::ValidatedDisplacement\fP"
|
|
.br
|
|
.RI "Own a generated displacement only after its sampled computational geometry has passed validation\&. "
|
|
.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::deformation\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|