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)
41 lines
2.4 KiB
TeX
41 lines
2.4 KiB
TeX
\doxysection{src/include/serif/operators/linearized\+\_\+system\+\_\+view.hpp File Reference}
|
|
\hypertarget{linearized__system__view_8hpp}{}\label{linearized__system__view_8hpp}\index{src/include/serif/operators/linearized\_system\_view.hpp@{src/include/serif/operators/linearized\_system\_view.hpp}}
|
|
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
|
|
{\ttfamily \#include "{}serif/discretization/blocks/system\+\_\+layout.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/dependencies/dependency\+\_\+context.\+hpp"{}}\newline
|
|
Include dependency graph for linearized\+\_\+system\+\_\+view.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{linearized__system__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]{linearized__system__view_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1operators_1_1_physical_block}{serif\+::operators\+::\+Physical\+Block$<$ Rows\+T, Values\+T $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Identify a physical Jacobian block by its equation rows and unknown coordinates. \end{DoxyCompactList}\item
|
|
class \mbox{\hyperlink{classserif_1_1operators_1_1_linearized_system_view}{serif\+::operators\+::\+Linearized\+System\+View$<$ Layout, Blocks $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Borrow an accepted collection of physical blocks and its independently ordered system layout. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1operators}{serif\+::operators}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$discretization\+::blocks\+::\+System\+Layout\+Type Layout, utils\+::dependencies\+::\+Is\+Dependency\+Context Blocks$>$ }\\\mbox{\hyperlink{namespaceserif_1_1operators_a923b82a601cec82833d0802e71b8108e}{serif\+::operators\+::\+Linearized\+System\+View}} (const Layout \&, const Blocks \&) -\/$>$ Linearized\+System\+View$<$ Layout, Blocks $>$
|
|
\begin{DoxyCompactList}\small\item\em Infer canonical owner types while retaining the explicit borrowing lifetime checks. \end{DoxyCompactList}\end{DoxyCompactItemize}
|