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)
59 lines
3.4 KiB
TeX
59 lines
3.4 KiB
TeX
\doxysection{src/include/serif/discretization/blocks/vector\+\_\+view.hpp File Reference}
|
|
\hypertarget{vector__view_8hpp}{}\label{vector__view_8hpp}\index{src/include/serif/discretization/blocks/vector\_view.hpp@{src/include/serif/discretization/blocks/vector\_view.hpp}}
|
|
|
|
|
|
This file includes a class for viewing some System\+Layout as a span of coefficients without copying the underlying storage.
|
|
|
|
|
|
{\ttfamily \#include $<$span$>$}\newline
|
|
{\ttfamily \#include $<$ranges$>$}\newline
|
|
{\ttfamily \#include $<$stdexcept$>$}\newline
|
|
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
|
|
{\ttfamily \#include "{}serif/discretization/blocks/system\+\_\+layout.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/error/errors.\+hpp"{}}\newline
|
|
Include dependency graph for vector\+\_\+view.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{vector__view_8hpp__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
This graph shows which files directly or indirectly include this file\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{vector__view_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
class \mbox{\hyperlink{classserif_1_1discretization_1_1blocks_1_1_block_vector_view}{serif\+::discretization\+::blocks\+::\+Block\+Vector\+View$<$ Kind, Layout, Scalar $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Build a non-\/owning view of a packed layout as a span. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1discretization}{serif\+::discretization}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1blocks}{serif\+::discretization\+::blocks}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Typedefs}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$System\+Layout\+Type Layout, typename Scalar = double$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1discretization_1_1blocks_aaf621ef3cd1e663131647a86d13e5990}{serif\+::discretization\+::blocks\+::\+State\+View}} = \mbox{\hyperlink{classserif_1_1discretization_1_1blocks_1_1_block_vector_view}{Block\+Vector\+View}}$<$\mbox{\hyperlink{namespaceserif_1_1discretization_1_1blocks_aca74ff25d2168fcdec080e03ebc023eaa2063c1608d6e0baf80249c42e2be5804}{Represented\+Value\+Kind\+::value}}, Layout, Scalar$>$
|
|
\begin{DoxyCompactList}\small\item\em A convenient alias for a view of the physical state coefficients. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$System\+Layout\+Type Layout, typename Scalar = double$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1discretization_1_1blocks_a1ee29035ab1c1c9e232b42e92ff8514d}{serif\+::discretization\+::blocks\+::\+Residual\+View}} = \mbox{\hyperlink{classserif_1_1discretization_1_1blocks_1_1_block_vector_view}{Block\+Vector\+View}}$<$\mbox{\hyperlink{namespaceserif_1_1discretization_1_1blocks_aca74ff25d2168fcdec080e03ebc023eaa4db598f63d4aea6a3c8eaddfe5c2b1e9}{Represented\+Value\+Kind\+::residual}}, Layout, Scalar$>$
|
|
\begin{DoxyCompactList}\small\item\em A convenient alias for a view of the residual coefficients. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
This file includes a class for viewing some System\+Layout as a span of coefficients without copying the underlying storage.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|