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)
65 lines
2.1 KiB
Groff
65 lines
2.1 KiB
Groff
.TH "serif::discretization::blocks::central_density" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::blocks::central_density \- field used to inject a border row used to enforce a central density constraint
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <fields\&.hpp>\fP
|
|
.PP
|
|
Inherits \fBserif::discretization::blocks::field\fP\&.
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBborder\fP"
|
|
.br
|
|
.RI "The border term represents the border row used to enforce a central density constraint\&. This is a global scalar as it is a single value over the entire domain\&. "
|
|
.in -1c
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBTerms\fP = \fButils::types::TypeList\fP<\fBborder\fP>"
|
|
.br
|
|
.RI "Type list of terms for compile time reflection and iteration over the terms of the field\&. "
|
|
.in -1c
|
|
.SS "Static Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "static constexpr std::string_view \fBname\fP = \fBmeta::type_name\fP<\fBcentral_density\fP>()"
|
|
.br
|
|
.RI "Compile time reflected name of the field\&. "
|
|
.ti -1c
|
|
.RI "static constexpr \fBborder\fP \fBborder_term\fP {}"
|
|
.br
|
|
.RI "Static constexpr instance of the border term\&. This is used to access the term in the discretization\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
field used to inject a border row used to enforce a central density constraint
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "using \fBserif::discretization::blocks::central_density::Terms\fP = \fButils::types::TypeList\fP<\fBborder\fP>"
|
|
|
|
.PP
|
|
Type list of terms for compile time reflection and iteration over the terms of the field\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "\fBborder\fP serif::discretization::blocks::central_density::border_term {}\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
.PP
|
|
Static constexpr instance of the border term\&. This is used to access the term in the discretization\&.
|
|
.SS "std::string_view serif::discretization::blocks::central_density::name = \fBmeta::type_name\fP<\fBcentral_density\fP>()\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
.PP
|
|
Compile time reflected name of the field\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|