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)
41 lines
1002 B
Groff
41 lines
1002 B
Groff
.TH "serif::dimensions::Opacity" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::dimensions::Opacity \- Dimension of \fBOpacity\fP\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <dimensions\&.hpp>\fP
|
|
.PP
|
|
Inherits \fBserif::dimensions::PhysicalQuantity\fP\&.
|
|
.SS "Static Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "static constexpr std::string_view \fBidentifier\fP = 'opacity'"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Dimension of \fBOpacity\fP\&.
|
|
|
|
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
we are not currently using this in the code since we are still using a polytropic eos\&. However, when we actually get to using this we will likely want to break this out into more specific and meaningful opacity dimensions (RMO, per unit wavelength, etc\&.\&.\&.)
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "std::string_view serif::dimensions::Opacity::identifier = 'opacity'\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|