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)
73 lines
4.8 KiB
TeX
73 lines
4.8 KiB
TeX
\doxysection{src/include/serif/discretization/blocks/system\+\_\+layout.hpp File Reference}
|
|
\hypertarget{system__layout_8hpp}{}\label{system__layout_8hpp}\index{src/include/serif/discretization/blocks/system\_layout.hpp@{src/include/serif/discretization/blocks/system\_layout.hpp}}
|
|
|
|
|
|
Describe the independently ordered physical state and residual coordinates of a discrete system. This is an accounting layer to keep index offsets straight in memory.
|
|
|
|
|
|
{\ttfamily \#include $<$array$>$}\newline
|
|
{\ttfamily \#include $<$cstddef$>$}\newline
|
|
{\ttfamily \#include $<$span$>$}\newline
|
|
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
|
|
{\ttfamily \#include "{}serif/discretization/blocks/base.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/dependencies/key\+\_\+list\+\_\+operations.\+hpp"{}}\newline
|
|
Include dependency graph for system\+\_\+layout.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{system__layout_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]{system__layout_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1_system_layout}{serif\+::discretization\+::blocks\+::\+System\+Layout$<$ Values\+T, Residuals\+T $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Describe the independently ordered physical state and residual coordinates of a discrete system. \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}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1blocks_1_1detail}{serif\+::discretization\+::blocks\+::detail}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Concepts}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1discretization_1_1blocks_1_1_system_layout_type}{serif\+::discretization\+::blocks\+::\+System\+Layout\+Type}}
|
|
\begin{DoxyCompactList}\small\item\em Compile time check for a System\+Layout type, e.\+g. System\+Layout$<$\+Values, Residuals$>$. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
std\+::size\+\_\+t \mbox{\hyperlink{namespaceserif_1_1discretization_1_1blocks_a946d6244b79cf4fad47d07fb97db32e1}{serif\+::discretization\+::blocks\+::checked\+\_\+block\+\_\+size}} (std\+::span$<$ const std\+::size\+\_\+t $>$ sizes)
|
|
\begin{DoxyCompactList}\small\item\em Sum some memory span with checking for if any element is too large to fit in a size\+\_\+t. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$System\+Layout\+Type Layout, typename Size\+Resolver$>$ }\\constexpr std\+::remove\+\_\+cvref\+\_\+t$<$ Layout $>$ \mbox{\hyperlink{namespaceserif_1_1discretization_1_1blocks_a71adc03af28a2984d945fdf54a8cee2e}{serif\+::discretization\+::blocks\+::make\+\_\+system\+\_\+layout}} (const Size\+Resolver \&size)
|
|
\begin{DoxyCompactList}\small\item\em Build both coordinate orderings from the same physical size resolver. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Variables}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename Candidate$>$ }\\constexpr bool \mbox{\hyperlink{namespaceserif_1_1discretization_1_1blocks_1_1detail_a51c70ebc5bd5c92bfca8f31d7c9ba849}{serif\+::discretization\+::blocks\+::detail\+::is\+\_\+system\+\_\+layout}} = false
|
|
\begin{DoxyCompactList}\small\item\em Default false specialization for is\+\_\+system\+\_\+layout, specialized to true for \doxylink{structserif_1_1discretization_1_1blocks_1_1_system_layout}{System\+Layout$<$\+Values, Residuals$>$}. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Values, typename Residuals$>$ }\\constexpr bool \mbox{\hyperlink{namespaceserif_1_1discretization_1_1blocks_1_1detail_ab9bfb61324bc7792f7cd2227ee5388c2}{serif\+::discretization\+::blocks\+::detail\+::is\+\_\+system\+\_\+layout$<$ System\+Layout$<$ Values, Residuals $>$ $>$}} = true
|
|
\begin{DoxyCompactList}\small\item\em True specialization for is\+\_\+system\+\_\+layout, specialized to true for \doxylink{structserif_1_1discretization_1_1blocks_1_1_system_layout}{System\+Layout$<$\+Values, Residuals$>$}. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
Describe the independently ordered physical state and residual coordinates of a discrete system. This is an accounting layer to keep index offsets straight in memory.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|