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)
32 lines
2.7 KiB
TeX
32 lines
2.7 KiB
TeX
\doxysection{src/include/serif/discretization/blocks Directory Reference}
|
|
\hypertarget{dir_6e13d9f65eef4cc189aba4b3a2a1a384}{}\label{dir_6e13d9f65eef4cc189aba4b3a2a1a384}\index{src/include/serif/discretization/blocks Directory Reference@{src/include/serif/discretization/blocks Directory Reference}}
|
|
Directory dependency graph for blocks\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{dir_6e13d9f65eef4cc189aba4b3a2a1a384_dep}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Files}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
file \mbox{\hyperlink{base_8hpp}{base.\+hpp}}
|
|
\begin{DoxyCompactList}\small\item\em This file provides the base classes for residual and value blocks in the discretization framework. \end{DoxyCompactList}\item
|
|
file \mbox{\hyperlink{blocks_8hpp}{blocks.\+hpp}}
|
|
\item
|
|
file \mbox{\hyperlink{discretization_2blocks_2concepts_8hpp}{concepts.\+hpp}}
|
|
\begin{DoxyCompactList}\small\item\em This file defines concepts for blocks in the discretization framework. \end{DoxyCompactList}\item
|
|
file \mbox{\hyperlink{fields_8hpp}{fields.\+hpp}}
|
|
\begin{DoxyCompactList}\small\item\em Define the fields and their associated terms for the discretization. This is a key file to understand if you are to understand SERiF\textquotesingle{}s numerics. Each of these field types should contain all the information needed for the compiler to generate the correct. \end{DoxyCompactList}\item
|
|
file \mbox{\hyperlink{discretization_2blocks_2keys_8hpp}{keys.\+hpp}}
|
|
\begin{DoxyCompactList}\small\item\em Keys for the shared layout of a discretized state and residual in a block-\/structured system. \end{DoxyCompactList}\item
|
|
file \mbox{\hyperlink{discretization_2blocks_2runtime_8hpp}{runtime.\+hpp}}
|
|
\begin{DoxyCompactList}\small\item\em Runtime descriptors for fields and terms, used to project compile time types into runtime values. \end{DoxyCompactList}\item
|
|
file \mbox{\hyperlink{system__layout_8hpp}{system\+\_\+layout.\+hpp}}
|
|
\begin{DoxyCompactList}\small\item\em 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. \end{DoxyCompactList}\item
|
|
file \mbox{\hyperlink{discretization_2blocks_2traits_8hpp}{traits.\+hpp}}
|
|
\begin{DoxyCompactList}\small\item\em Compile-\/time traits for fields and terms, used to extract types and properties from template parameters. \end{DoxyCompactList}\item
|
|
file \mbox{\hyperlink{vector__view_8hpp}{vector\+\_\+view.\+hpp}}
|
|
\begin{DoxyCompactList}\small\item\em This file includes a class for viewing some System\+Layout as a span of coefficients without copying the underlying storage. \end{DoxyCompactList}\end{DoxyCompactItemize}
|