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.6 KiB
Groff
64 lines
1.6 KiB
Groff
.TH "serif::model::StellarMeshOptions" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::model::StellarMeshOptions \- Resolve a spherical stellar interior and a compactified exterior on a curved reference mesh\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <mesh_options\&.hpp>\fP
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBdimensions::LengthValue\fP \fBradius\fP {1\&.0}"
|
|
.br
|
|
.ti -1c
|
|
.RI "double \fBcore_radius_fraction\fP {0\&.25}"
|
|
.br
|
|
.ti -1c
|
|
.RI "double \fBinfinity_radius_fraction\fP {4\&.0}"
|
|
.br
|
|
.ti -1c
|
|
.RI "int \fBrefinement\fP {0}"
|
|
.br
|
|
.ti -1c
|
|
.RI "int \fBgeometry_order\fP {6}"
|
|
.br
|
|
.ti -1c
|
|
.RI "\fBStellarSurfaceRefinementOptions\fP \fBsurface_refinement\fP {}"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Resolve a spherical stellar interior and a compactified exterior on a curved reference mesh\&.
|
|
|
|
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
Field approximation orders come from the model's term types\&. Geometry order controls only the mesh; its default resolves the coarse spherical boundary for radial seed projection\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "double serif::model::StellarMeshOptions::core_radius_fraction {0\&.25}"
|
|
|
|
.SS "int serif::model::StellarMeshOptions::geometry_order {6}"
|
|
|
|
.SS "double serif::model::StellarMeshOptions::infinity_radius_fraction {4\&.0}"
|
|
|
|
.SS "\fBdimensions::LengthValue\fP serif::model::StellarMeshOptions::radius {1\&.0}"
|
|
|
|
.SS "int serif::model::StellarMeshOptions::refinement {0}"
|
|
|
|
.SS "\fBStellarSurfaceRefinementOptions\fP serif::model::StellarMeshOptions::surface_refinement {}"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|