58 lines
3.8 KiB
TeX
58 lines
3.8 KiB
TeX
|
\doxysection{src/include/serif/discretization/blocks/base.hpp File Reference}
|
||
|
|
\hypertarget{base_8hpp}{}\label{base_8hpp}\index{src/include/serif/discretization/blocks/base.hpp@{src/include/serif/discretization/blocks/base.hpp}}
|
||
|
|
|
||
|
|
|
||
|
|
This file provides the base classes for residual and value blocks in the discretization framework.
|
||
|
|
|
||
|
|
|
||
|
|
This graph shows which files directly or indirectly include this file\+:
|
||
|
|
\nopagebreak
|
||
|
|
\begin{figure}[H]
|
||
|
|
\begin{center}
|
||
|
|
\leavevmode
|
||
|
|
\includegraphics[width=350pt]{base_8hpp__dep__incl}
|
||
|
|
\end{center}
|
||
|
|
\end{figure}
|
||
|
|
\doxysubsubsection*{Classes}
|
||
|
|
\begin{DoxyCompactItemize}
|
||
|
|
\item
|
||
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1block}{serif\+::discretization\+::blocks\+::block}}
|
||
|
|
\begin{DoxyCompactList}\small\item\em Base class for all block types in the discretization framework. \end{DoxyCompactList}\item
|
||
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1residual__block__base}{serif\+::discretization\+::blocks\+::residual\+\_\+block\+\_\+base}}
|
||
|
|
\begin{DoxyCompactList}\small\item\em Base class for residual blocks, derived from block. \end{DoxyCompactList}\item
|
||
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1value__block__base}{serif\+::discretization\+::blocks\+::value\+\_\+block\+\_\+base}}
|
||
|
|
\begin{DoxyCompactList}\small\item\em Base class for value blocks, derived from block. \end{DoxyCompactList}\item
|
||
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1residual__block}{serif\+::discretization\+::blocks\+::residual\+\_\+block$<$ index\+\_\+value $>$}}
|
||
|
|
\begin{DoxyCompactList}\small\item\em Final class for residual blocks with a fixed index, derived from \doxylink{structserif_1_1discretization_1_1blocks_1_1residual__block__base}{residual\+\_\+block\+\_\+base}. \end{DoxyCompactList}\item
|
||
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1value__block}{serif\+::discretization\+::blocks\+::value\+\_\+block$<$ index\+\_\+value $>$}}
|
||
|
|
\begin{DoxyCompactList}\small\item\em Final class for value blocks with a fixed index, derived from \doxylink{structserif_1_1discretization_1_1blocks_1_1value__block__base}{value\+\_\+block\+\_\+base}. \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*{Enumerations}
|
||
|
|
\begin{DoxyCompactItemize}
|
||
|
|
\item
|
||
|
|
enum class \mbox{\hyperlink{namespaceserif_1_1discretization_1_1blocks_aca74ff25d2168fcdec080e03ebc023ea}{serif\+::discretization\+::blocks\+::\+Represented\+Value\+Kind}} \{ \mbox{\hyperlink{namespaceserif_1_1discretization_1_1blocks_aca74ff25d2168fcdec080e03ebc023eaa2063c1608d6e0baf80249c42e2be5804}{serif\+::discretization\+::blocks\+::value}}
|
||
|
|
, \mbox{\hyperlink{namespaceserif_1_1discretization_1_1blocks_aca74ff25d2168fcdec080e03ebc023eaa4db598f63d4aea6a3c8eaddfe5c2b1e9}{serif\+::discretization\+::blocks\+::residual}}
|
||
|
|
\}
|
||
|
|
\begin{DoxyCompactList}\small\item\em Enum representing the kind of value a block represents, either a physical quantity (value) or a residual (residual). \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||
|
|
\doxysubsubsection*{Variables}
|
||
|
|
\begin{DoxyCompactItemize}
|
||
|
|
\item
|
||
|
|
constexpr int \mbox{\hyperlink{namespaceserif_1_1discretization_1_1blocks_a8eaaa61c301de12ca7a32a728e39e986}{serif\+::discretization\+::blocks\+::\+DYNAMIC\+\_\+\+BLOCK\+\_\+\+SIZE}} = -\/1
|
||
|
|
\end{DoxyCompactItemize}
|
||
|
|
|
||
|
|
|
||
|
|
\doxysubsection{Detailed Description}
|
||
|
|
This file provides the base classes for residual and value blocks in the discretization framework.
|
||
|
|
|
||
|
|
\begin{DoxyAuthor}{Author}
|
||
|
|
Emily M. Boudreaux
|
||
|
|
\end{DoxyAuthor}
|