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)
64 lines
1.8 KiB
Groff
64 lines
1.8 KiB
Groff
.TH "serif::utils::laneemden::IntegrationOptions" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::utils::laneemden::IntegrationOptions \- Dimensionless integration controls; the surface tolerance does not bound the global integration error\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <solution\&.hpp>\fP
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "double \fBstep\fP = 0\&.01"
|
|
.br
|
|
.ti -1c
|
|
.RI "double \fBmaximum_radius\fP = 100\&.0"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::size_t \fBmaximum_steps\fP = 100000"
|
|
.br
|
|
.ti -1c
|
|
.RI "double \fBsurface_tolerance\fP = 1e\-10"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::size_t \fBcentral_series_terms\fP = 12"
|
|
.br
|
|
.in -1c
|
|
.SS "Friends"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "bool \fBoperator==\fP (const \fBIntegrationOptions\fP &, const \fBIntegrationOptions\fP &)=default"
|
|
.br
|
|
.RI "Compare the numerical prescription when tracking reference dependencies\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Dimensionless integration controls; the surface tolerance does not bound the global integration error\&.
|
|
.SH "Friends And Related Symbol Documentation"
|
|
.PP
|
|
.SS "bool operator== (const \fBIntegrationOptions\fP & , const \fBIntegrationOptions\fP & )\fR [friend]\fP"
|
|
|
|
.PP
|
|
Compare the numerical prescription when tracking reference dependencies\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "std::size_t serif::utils::laneemden::IntegrationOptions::central_series_terms = 12"
|
|
|
|
.SS "double serif::utils::laneemden::IntegrationOptions::maximum_radius = 100\&.0"
|
|
|
|
.SS "std::size_t serif::utils::laneemden::IntegrationOptions::maximum_steps = 100000"
|
|
|
|
.SS "double serif::utils::laneemden::IntegrationOptions::step = 0\&.01"
|
|
|
|
.SS "double serif::utils::laneemden::IntegrationOptions::surface_tolerance = 1e\-10"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|