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)
84 lines
3.1 KiB
Groff
84 lines
3.1 KiB
Groff
.TH "serif::discretization::reconstruction::SurfacePowerProfile" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::reconstruction::SurfacePowerProfile \- Complete nodal basis whose homogeneous surface trace spans t^n times degree-(p-1) polynomials\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <surface_power\&.hpp>\fP
|
|
.PP
|
|
Inherits \fBserif::discretization::reconstruction::RadialProfile\fP\&.
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBSurfacePowerProfile\fP (double \fBdensity_exponent\fP)"
|
|
.br
|
|
.RI "Require a finite exponent with a finite density gradient at the surface\&. "
|
|
.ti -1c
|
|
.RI "std::string_view \fBname\fP () const noexcept override"
|
|
.br
|
|
.RI "Return the stable numerical-form name\&. "
|
|
.ti -1c
|
|
.RI "double \fBdensity_exponent\fP () const noexcept"
|
|
.br
|
|
.RI "Return the density's leading surface exponent, rather than the weight's exponent\&. "
|
|
.ti -1c
|
|
.RI "void \fBevaluate\fP (std::span< const double > nodes, double inward_coordinate, std::span< double > values, std::span< double > derivatives) const override"
|
|
.br
|
|
.RI "Evaluate the complete lifting rho_s + sum_i psi_i (rho_i-rho_s), including analytic endpoint limits\&. "
|
|
.in -1c
|
|
|
|
Public Member Functions inherited from \fBserif::discretization::reconstruction::RadialProfile\fP
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "virtual \fB~RadialProfile\fP ()=default"
|
|
.br
|
|
.RI "Release a profile through its immutable shared owner\&. "
|
|
.in -1c
|
|
.SS "Private Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "double \fBm_exponent\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Complete nodal basis whose homogeneous surface trace spans t^n times degree-(p-1) polynomials\&.
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "serif::discretization::reconstruction::SurfacePowerProfile::SurfacePowerProfile (double density_exponent)\fR [inline]\fP, \fR [explicit]\fP"
|
|
|
|
.PP
|
|
Require a finite exponent with a finite density gradient at the surface\&.
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "double serif::discretization::reconstruction::SurfacePowerProfile::density_exponent () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Return the density's leading surface exponent, rather than the weight's exponent\&.
|
|
.SS "void serif::discretization::reconstruction::SurfacePowerProfile::evaluate (std::span< const double > nodes, double inward_coordinate, std::span< double > values, std::span< double > derivatives) const\fR [inline]\fP, \fR [override]\fP, \fR [virtual]\fP"
|
|
|
|
.PP
|
|
Evaluate the complete lifting rho_s + sum_i psi_i (rho_i-rho_s), including analytic endpoint limits\&.
|
|
.PP
|
|
Implements \fBserif::discretization::reconstruction::RadialProfile\fP\&.
|
|
.SS "std::string_view serif::discretization::reconstruction::SurfacePowerProfile::name () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [override]\fP, \fR [virtual]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Return the stable numerical-form name\&.
|
|
.PP
|
|
Implements \fBserif::discretization::reconstruction::RadialProfile\fP\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "double serif::discretization::reconstruction::SurfacePowerProfile::m_exponent\fR [private]\fP"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|