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)
40 lines
1.1 KiB
Groff
40 lines
1.1 KiB
Groff
.TH "serif::geometry::deformation::GeometryStepOptions" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::geometry::deformation::GeometryStepOptions \- Numerical controls for keeping a straight volume-displacement step above a Jacobian determinant floor\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <geometry_step\&.hpp>\fP
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "double \fBmaximum_step\fP {1\&.0}"
|
|
.br
|
|
.ti -1c
|
|
.RI "double \fBdeterminant_floor\fP {0\&.0}"
|
|
.br
|
|
.ti -1c
|
|
.RI "double \fBfraction_to_boundary\fP {0\&.9}"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Numerical controls for keeping a straight volume-displacement step above a Jacobian determinant floor\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "double serif::geometry::deformation::GeometryStepOptions::determinant_floor {0\&.0}"
|
|
|
|
.SS "double serif::geometry::deformation::GeometryStepOptions::fraction_to_boundary {0\&.9}"
|
|
|
|
.SS "double serif::geometry::deformation::GeometryStepOptions::maximum_step {1\&.0}"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|