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)
71 lines
1.8 KiB
Groff
71 lines
1.8 KiB
Groff
.TH "src/include/serif/discretization/blocks/vector_view.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/discretization/blocks/vector_view.hpp \- This file includes a class for viewing some SystemLayout as a span of coefficients without copying the underlying storage\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <span>\fP
|
|
.br
|
|
\fR#include <ranges>\fP
|
|
.br
|
|
\fR#include <stdexcept>\fP
|
|
.br
|
|
\fR#include <type_traits>\fP
|
|
.br
|
|
\fR#include 'serif/discretization/blocks/system_layout\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/utils/error/errors\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "class \fBserif::discretization::blocks::BlockVectorView< Kind, Layout, Scalar >\fP"
|
|
.br
|
|
.RI "Build a non-owning view of a packed layout as a span\&. "
|
|
.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 "Typedefs"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<SystemLayoutType Layout, typename Scalar = double> using \fBserif::discretization::blocks::StateView\fP = \fBBlockVectorView\fP<\fBRepresentedValueKind::value\fP, Layout, Scalar>"
|
|
.br
|
|
.RI "A convenient alias for a view of the physical state coefficients\&. "
|
|
.ti -1c
|
|
.RI "template<SystemLayoutType Layout, typename Scalar = double> using \fBserif::discretization::blocks::ResidualView\fP = \fBBlockVectorView\fP<\fBRepresentedValueKind::residual\fP, Layout, Scalar>"
|
|
.br
|
|
.RI "A convenient alias for a view of the residual coefficients\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
This file includes a class for viewing some SystemLayout as a span of coefficients without copying the underlying storage\&.
|
|
|
|
|
|
.PP
|
|
\fBAuthor\fP
|
|
.RS 4
|
|
Emily M\&. Boudreaux
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|