Files
MeanField_SERiF/docs/man/man3/serif_discretization_reconstruction_SurfaceAdjacent.3
Emily Boudreaux 6b57738330 docs(docs): built docs
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)
2026-11-09 14:09:44 -05:00

47 lines
1.5 KiB
Groff

.TH "serif::discretization::reconstruction::SurfaceAdjacent< BoundaryT >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::discretization::reconstruction::SurfaceAdjacent< BoundaryT > \- Select material elements touching a typed boundary, resolved through the mesh schema\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <surface_power\&.hpp>\fP
.PP
Inherits \fBserif::discretization::reconstruction::SurfaceRegion\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "constexpr \fBSurfaceAdjacent\fP ()"
.br
.RI "Retain the scientific boundary name without exposing a mesh attribute\&. "
.in -1c
.SS "Additional Inherited Members"
Public Attributes inherited from \fBserif::discretization::reconstruction::SurfaceRegion\fP
.in +1c
.ti -1c
.RI "std::string_view \fBboundary_name\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<typename BoundaryT = domain::StellarSurfaceBoundary>
.br
struct serif::discretization::reconstruction::SurfaceAdjacent< BoundaryT >"Select material elements touching a typed boundary, resolved through the mesh schema\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<typename BoundaryT = domain::StellarSurfaceBoundary> \fBserif::discretization::reconstruction::SurfaceAdjacent\fP< BoundaryT >::SurfaceAdjacent ()\fR [inline]\fP, \fR [constexpr]\fP"
.PP
Retain the scientific boundary name without exposing a mesh attribute\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.