Files
MeanField_SERiF/docs/man/man3/serif_discretization_reconstruction_RadialProfile.3

66 lines
2.5 KiB
Groff
Raw Permalink Normal View History

.TH "serif::discretization::reconstruction::RadialProfile" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::discretization::reconstruction::RadialProfile \- One-dimensional nodal reconstruction, evaluated only while preparing reference operators\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <surface_power\&.hpp>\fP
.PP
Inherited by \fBserif::discretization::reconstruction::SurfacePowerProfile\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "virtual \fB~RadialProfile\fP ()=default"
.br
.RI "Release a profile through its immutable shared owner\&. "
.ti -1c
.RI "virtual std::string_view \fBname\fP () const noexcept=0"
.br
.RI "Identify the numerical form in diagnostics and archive validation\&. "
.ti -1c
.RI "virtual void \fBevaluate\fP (std::span< const double > nodes, double inward_coordinate, std::span< double > values, std::span< double > derivatives) const =0"
.br
.RI "Evaluate every radial nodal function and its inward-coordinate derivative\&. "
.in -1c
.SH "Detailed Description"
.PP
One-dimensional nodal reconstruction, evaluated only while preparing reference operators\&.
.PP
\fBNote\fP
.RS 4
A new form supplies nodal values and inward derivatives, including both endpoints\&. The complete basis must reproduce constants and have compatible traces\&. Its archive codec and admissibility certificate must be added explicitly before it can be used in a saved solve\&.
.RE
.PP
.SH "Constructor & Destructor Documentation"
.PP
.SS "virtual serif::discretization::reconstruction::RadialProfile::~RadialProfile ()\fR [virtual]\fP, \fR [default]\fP"
.PP
Release a profile through its immutable shared owner\&.
.SH "Member Function Documentation"
.PP
.SS "virtual void serif::discretization::reconstruction::RadialProfile::evaluate (std::span< const double > nodes, double inward_coordinate, std::span< double > values, std::span< double > derivatives) const\fR [pure virtual]\fP"
.PP
Evaluate every radial nodal function and its inward-coordinate derivative\&.
.PP
Implemented in \fBserif::discretization::reconstruction::SurfacePowerProfile\fP\&.
.SS "virtual std::string_view serif::discretization::reconstruction::RadialProfile::name () const\fR [nodiscard]\fP, \fR [pure virtual]\fP, \fR [noexcept]\fP"
.PP
Identify the numerical form in diagnostics and archive validation\&.
.PP
Implemented in \fBserif::discretization::reconstruction::SurfacePowerProfile\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.