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)
50 lines
1.7 KiB
Groff
50 lines
1.7 KiB
Groff
.TH "serif::discretization::blocks::detail" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::blocks::detail
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.SS "Variables"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename Candidate> constexpr bool \fBis_system_layout\fP = false"
|
|
.br
|
|
.RI "Default false specialization for is_system_layout, specialized to true for \fBSystemLayout<Values, Residuals>\fP\&. "
|
|
.ti -1c
|
|
.RI "template<typename Values, typename Residuals> constexpr bool \fBis_system_layout< SystemLayout< Values, Residuals > >\fP = true"
|
|
.br
|
|
.RI "True specialization for is_system_layout, specialized to true for \fBSystemLayout<Values, Residuals>\fP\&. "
|
|
.in -1c
|
|
.SH "Variable Documentation"
|
|
.PP
|
|
.SS "template<typename Candidate> bool serif::discretization::blocks::detail::is_system_layout = false\fR [inline]\fP, \fR [constexpr]\fP"
|
|
|
|
.PP
|
|
Default false specialization for is_system_layout, specialized to true for \fBSystemLayout<Values, Residuals>\fP\&.
|
|
.PP
|
|
\fBTemplate Parameters\fP
|
|
.RS 4
|
|
\fICandidate\fP The type to check for being a \fBSystemLayout\fP\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SS "template<typename Values, typename Residuals> bool \fBserif::discretization::blocks::detail::is_system_layout\fP< \fBSystemLayout\fP< Values, Residuals > > = true\fR [inline]\fP, \fR [constexpr]\fP"
|
|
|
|
.PP
|
|
True specialization for is_system_layout, specialized to true for \fBSystemLayout<Values, Residuals>\fP\&.
|
|
.PP
|
|
\fBTemplate Parameters\fP
|
|
.RS 4
|
|
\fIValues\fP The KeyList of physical coordinates represented in the state vector\&.
|
|
.br
|
|
\fIResiduals\fP The KeyList of physical coordinates represented in the residual vector\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|