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)
81 lines
2.2 KiB
Groff
81 lines
2.2 KiB
Groff
.TH "src/include/serif/utils/laneemden/solution.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
.ad l
|
||
.nh
|
||
.SH NAME
|
||
src/include/serif/utils/laneemden/solution.hpp
|
||
.SH SYNOPSIS
|
||
.br
|
||
.PP
|
||
\fR#include <cstddef>\fP
|
||
.br
|
||
\fR#include <expected>\fP
|
||
.br
|
||
\fR#include <optional>\fP
|
||
.br
|
||
\fR#include <string>\fP
|
||
.br
|
||
\fR#include <string_view>\fP
|
||
.br
|
||
\fR#include <vector>\fP
|
||
.br
|
||
\fR#include <format>\fP
|
||
.br
|
||
\fR#include 'serif/utils/error/errors\&.hpp'\fP
|
||
.br
|
||
|
||
.SS "Classes"
|
||
|
||
.in +1c
|
||
.ti -1c
|
||
.RI "struct \fBserif::utils::laneemden::IntegrationOptions\fP"
|
||
.br
|
||
.RI "Dimensionless integration controls; the surface tolerance does not bound the global integration error\&. "
|
||
.ti -1c
|
||
.RI "struct \fBserif::utils::laneemden::Sample\fP"
|
||
.br
|
||
.RI "The regular Lane–Emden solution and its first derivative at one dimensionless radius\&. "
|
||
.ti -1c
|
||
.RI "struct \fBserif::utils::laneemden::Solution\fP"
|
||
.br
|
||
.RI "A regular profile, ending at its first zero or the requested integration radius\&. "
|
||
.ti -1c
|
||
.RI "struct \fBstd::formatter< serif::utils::laneemden::IntegrationOptions >\fP"
|
||
.br
|
||
.ti -1c
|
||
.RI "struct \fBstd::formatter< serif::utils::laneemden::Sample >\fP"
|
||
.br
|
||
.RI "Select all sample values, or one named component with :xi, :theta, or :derivative\&. "
|
||
.ti -1c
|
||
.RI "struct \fBstd::formatter< serif::utils::laneemden::Solution >\fP"
|
||
.br
|
||
.RI "Describe the solution while applying one shared selection to its profile and optional surface sample\&. "
|
||
.in -1c
|
||
.SS "Namespaces"
|
||
|
||
.in +1c
|
||
.ti -1c
|
||
.RI "namespace \fBserif\fP"
|
||
.br
|
||
.ti -1c
|
||
.RI "namespace \fBserif::utils\fP"
|
||
.br
|
||
.ti -1c
|
||
.RI "namespace \fBserif::utils::laneemden\fP"
|
||
.br
|
||
.in -1c
|
||
.SS "Functions"
|
||
|
||
.in +1c
|
||
.ti -1c
|
||
.RI "std::expected< \fBSolution\fP, std::string > \fBserif::utils::laneemden::solve\fP (double n, \fBIntegrationOptions\fP options={})"
|
||
.br
|
||
.RI "Integrate theta'' + 2 theta'/xi + theta^n = 0 from the regular center\&. "
|
||
.ti -1c
|
||
.RI "std::expected< \fBSample\fP, std::string > \fBserif::utils::laneemden::evaluate\fP (const \fBSolution\fP &solution, double xi)"
|
||
.br
|
||
.RI "Evaluate a solved dimensionless profile with cubic Hermite interpolation, without extrapolation\&. "
|
||
.in -1c
|
||
.SH "Author"
|
||
.PP
|
||
Generated automatically by Doxygen for SERiF from the source code\&.
|