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)
58 lines
1.9 KiB
Groff
58 lines
1.9 KiB
Groff
.TH "serif::discretization::reconstruction::SurfacePower< TermT >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::reconstruction::SurfacePower< TermT > \- Request density proportional to inward distance raised to density_exponent near a vacuum surface\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <surface_power\&.hpp>\fP
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBTerm\fP = TermT"
|
|
.br
|
|
.in -1c
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "double \fBdensity_exponent\fP {1\&.0}"
|
|
.br
|
|
.ti -1c
|
|
.RI "\fBSurfaceRegion\fP \fBregion\fP {\fBSurfaceAdjacent\fP<>{}}"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<typename TermT>
|
|
.br
|
|
struct serif::discretization::reconstruction::SurfacePower< TermT >"Request density proportional to inward distance raised to density_exponent near a vacuum surface\&.
|
|
|
|
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
Coefficients remain physical nodal densities\&. For a Qp element with zero surface trace, the reconstructed space is t^n P_(p-1) radially and ordinary Qp tangentially; t runs from zero on the surface face to one on the inner face\&. Deeper elements are unchanged\&. The exponent is n (not n-1) for a vacuum polytrope\&. A finite-pressure or general EOS surface needs a separately validated profile; this request does not infer it from an EOS\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "template<typename TermT> using \fBserif::discretization::reconstruction::SurfacePower\fP< TermT >::Term = TermT"
|
|
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "template<typename TermT> double \fBserif::discretization::reconstruction::SurfacePower\fP< TermT >::density_exponent {1\&.0}"
|
|
|
|
.SS "template<typename TermT> \fBSurfaceRegion\fP \fBserif::discretization::reconstruction::SurfacePower\fP< TermT >::region {\fBSurfaceAdjacent\fP<>{}}"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|