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)
65 lines
2.2 KiB
Groff
65 lines
2.2 KiB
Groff
.TH "serif::model::StellarSurfaceRefinementOptions" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::model::StellarSurfaceRefinementOptions \- Add mesh resolution at the stellar interface before creating field spaces\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <mesh_options\&.hpp>\fP
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "int \fBlevels\fP {0}"
|
|
.br
|
|
.RI "Additional isotropic levels on both sides of the entire stellar surface\&. "
|
|
.ti -1c
|
|
.RI "int \fBequatorial_levels\fP {0}"
|
|
.br
|
|
.RI "Additional latitude splits in closed rings around the rotation axis\&. "
|
|
.ti -1c
|
|
.RI "double \fBequatorial_half_angle_degrees\fP {15\&.0}"
|
|
.br
|
|
.RI "Minimum half-width of the resolved equatorial band, in degrees; 0 < angle <= 35\&. "
|
|
.ti -1c
|
|
.RI "int \fBradial_levels\fP {0}"
|
|
.br
|
|
.RI "Additional radial halvings of the stellar-side surface shell only; angular surface faces are unchanged\&. "
|
|
.ti -1c
|
|
.RI "std::array< double, 3 > \fBaxis\fP {0\&.0, 0\&.0, 1\&.0}"
|
|
.br
|
|
.RI "Align the mesh's polar direction with this finite nonzero axis through the stellar center\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Add mesh resolution at the stellar interface before creating field spaces\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "std::array<double, 3> serif::model::StellarSurfaceRefinementOptions::axis {0\&.0, 0\&.0, 1\&.0}"
|
|
|
|
.PP
|
|
Align the mesh's polar direction with this finite nonzero axis through the stellar center\&.
|
|
.SS "double serif::model::StellarSurfaceRefinementOptions::equatorial_half_angle_degrees {15\&.0}"
|
|
|
|
.PP
|
|
Minimum half-width of the resolved equatorial band, in degrees; 0 < angle <= 35\&.
|
|
.SS "int serif::model::StellarSurfaceRefinementOptions::equatorial_levels {0}"
|
|
|
|
.PP
|
|
Additional latitude splits in closed rings around the rotation axis\&.
|
|
.SS "int serif::model::StellarSurfaceRefinementOptions::levels {0}"
|
|
|
|
.PP
|
|
Additional isotropic levels on both sides of the entire stellar surface\&.
|
|
.SS "int serif::model::StellarSurfaceRefinementOptions::radial_levels {0}"
|
|
|
|
.PP
|
|
Additional radial halvings of the stellar-side surface shell only; angular surface faces are unchanged\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|