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)
77 lines
2.0 KiB
Groff
77 lines
2.0 KiB
Groff
.TH "src/include/serif/discretization/blocks/base.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/discretization/blocks/base.hpp \- This file provides the base classes for residual and value blocks in the discretization framework\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::discretization::blocks::block\fP"
|
|
.br
|
|
.RI "Base class for all block types in the discretization framework\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::discretization::blocks::residual_block_base\fP"
|
|
.br
|
|
.RI "Base class for residual blocks, derived from block\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::discretization::blocks::value_block_base\fP"
|
|
.br
|
|
.RI "Base class for value blocks, derived from block\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::discretization::blocks::residual_block< index_value >\fP"
|
|
.br
|
|
.RI "Final class for residual blocks with a fixed index, derived from \fBresidual_block_base\fP\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::discretization::blocks::value_block< index_value >\fP"
|
|
.br
|
|
.RI "Final class for value blocks with a fixed index, derived from \fBvalue_block_base\fP\&. "
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::discretization\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::discretization::blocks\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Enumerations"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "enum class \fBserif::discretization::blocks::RepresentedValueKind\fP { \fBserif::discretization::blocks::value\fP, \fBserif::discretization::blocks::residual\fP }"
|
|
.br
|
|
.RI "Enum representing the kind of value a block represents, either a physical quantity (value) or a residual (residual)\&. "
|
|
.in -1c
|
|
.SS "Variables"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "constexpr int \fBserif::discretization::blocks::DYNAMIC_BLOCK_SIZE\fP = \-1"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
This file provides the base classes for residual and value blocks in the discretization framework\&.
|
|
|
|
|
|
.PP
|
|
\fBAuthor\fP
|
|
.RS 4
|
|
Emily M\&. Boudreaux
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|