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)
43 lines
909 B
Groff
43 lines
909 B
Groff
.TH "src/lib/serif/model/specifications.cpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/lib/serif/model/specifications.cpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <algorithm>\fP
|
|
.br
|
|
\fR#include <cmath>\fP
|
|
.br
|
|
\fR#include <stdexcept>\fP
|
|
.br
|
|
\fR#include 'serif/model/specifications/fixed_angular_momentum\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/model/specifications/fixed_total_mass\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/utils/error/errors\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::model\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "static void \fBserif::model::validate_target\fP (double value, bool zero_allowed, std::string_view name)"
|
|
.br
|
|
.RI "Validate a dimensional scalar target before storing a physical prescription\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|