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

77 lines
2.5 KiB
Groff
Raw Normal View History

.TH "serif::geometry::deformation::GeometryStepLimit" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::geometry::deformation::GeometryStepLimit \- Geometry-only bound at the supplied sample points, with a location for the first obstruction\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <geometry_step\&.hpp>\fP
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "double \fBstep\fP {0\&.0}"
.br
.ti -1c
.RI "double \fBboundary_step\fP {0\&.0}"
.br
.ti -1c
.RI "double \fBminimum_determinant_at_accepted\fP {std::numeric_limits<double>::infinity()}"
.br
.ti -1c
.RI "double \fBminimum_determinant_at_maximum\fP {std::numeric_limits<double>::infinity()}"
.br
.ti -1c
.RI "double \fBlimiting_point_determinant_at_step\fP {0\&.0}"
.br
.ti -1c
.RI "std::size_t \fBsampled_point_count\fP {0}"
.br
.ti -1c
.RI "bool \fBlimited_by_geometry\fP {false}"
.br
.ti -1c
.RI "int \fBlimiting_element\fP {\-1}"
.br
.ti -1c
.RI "int \fBlimiting_rule\fP {\-1}"
.br
.ti -1c
.RI "int \fBlimiting_point\fP {\-1}"
.br
.in -1c
.SH "Detailed Description"
.PP
Geometry-only bound at the supplied sample points, with a location for the first obstruction\&.
The determinant is that of the physical map relative to the reference mesh\&. This does not bound unsampled points, thermodynamic admissibility, or a nonlinear trajectory in shape coefficients\&. A boundary at maximum_step still applies fraction_to_boundary\&. An unrestricted step does not\&.
.SH "Member Data Documentation"
.PP
.SS "double serif::geometry::deformation::GeometryStepLimit::boundary_step {0\&.0}"
.SS "bool serif::geometry::deformation::GeometryStepLimit::limited_by_geometry {false}"
.SS "int serif::geometry::deformation::GeometryStepLimit::limiting_element {\-1}"
.SS "int serif::geometry::deformation::GeometryStepLimit::limiting_point {\-1}"
.SS "double serif::geometry::deformation::GeometryStepLimit::limiting_point_determinant_at_step {0\&.0}"
.SS "int serif::geometry::deformation::GeometryStepLimit::limiting_rule {\-1}"
.SS "double serif::geometry::deformation::GeometryStepLimit::minimum_determinant_at_accepted {std::numeric_limits<double>::infinity()}"
.SS "double serif::geometry::deformation::GeometryStepLimit::minimum_determinant_at_maximum {std::numeric_limits<double>::infinity()}"
.SS "std::size_t serif::geometry::deformation::GeometryStepLimit::sampled_point_count {0}"
.SS "double serif::geometry::deformation::GeometryStepLimit::step {0\&.0}"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.