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)
49 lines
3.8 KiB
TeX
49 lines
3.8 KiB
TeX
\doxysection{src/include/serif/operators/backend/mfem/linearized\+\_\+block.hpp File Reference}
|
|
\hypertarget{linearized__block_8hpp}{}\label{linearized__block_8hpp}\index{src/include/serif/operators/backend/mfem/linearized\_block.hpp@{src/include/serif/operators/backend/mfem/linearized\_block.hpp}}
|
|
{\ttfamily \#include $<$functional$>$}\newline
|
|
{\ttfamily \#include $<$memory$>$}\newline
|
|
{\ttfamily \#include $<$vector$>$}\newline
|
|
{\ttfamily \#include "{}mfem/linalg/operator.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}mfem/linalg/sparsemat.\+hpp"{}}\newline
|
|
Include dependency graph for linearized\+\_\+block.\+hpp\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{linearized__block_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__block_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
class \mbox{\hyperlink{classserif_1_1operators_1_1backend_1_1mfem_1_1_linearized_block}{serif\+::operators\+::backend\+::mfem\+::\+Linearized\+Block}}
|
|
\begin{DoxyCompactList}\small\item\em An accepted physical block with optional efficient diagonal and sparse assembly operations. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1operators}{serif\+::operators}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend}{serif\+::operators\+::backend}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem}{serif\+::operators\+::backend\+::mfem}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
std\+::vector$<$ double $>$ \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_a5ef0b3193bc6ca1e337d8ed922960680}{serif\+::operators\+::backend\+::mfem\+::checked\+\_\+diagonal}} (const \mbox{\hyperlink{classserif_1_1operators_1_1backend_1_1mfem_1_1_linearized_block}{Linearized\+Block}} \&block)
|
|
\begin{DoxyCompactList}\small\item\em Extract a diagonal and reject a callback that violates its declared physical block dimensions. \end{DoxyCompactList}\item
|
|
std\+::shared\+\_\+ptr$<$ const \+::mfem\+::\+Sparse\+Matrix $>$ \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_ae93623d73baa33d63a7bc8c2ee93b042}{serif\+::operators\+::backend\+::mfem\+::checked\+\_\+assembly}} (const \mbox{\hyperlink{classserif_1_1operators_1_1backend_1_1mfem_1_1_linearized_block}{Linearized\+Block}} \&block)
|
|
\begin{DoxyCompactList}\small\item\em Assemble a non-\/null finalized sparse matrix whose dimensions match its declared physical action. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classserif_1_1operators_1_1backend_1_1mfem_1_1_linearized_block}{Linearized\+Block}} \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_ab2fbcb6d59eb098097b55cb1cb04b3d9}{serif\+::operators\+::backend\+::mfem\+::linearized\+\_\+block}} (std\+::shared\+\_\+ptr$<$ const \+::mfem\+::\+Sparse\+Matrix $>$ matrix)
|
|
\begin{DoxyCompactList}\small\item\em Retain an already assembled physical block without copying its matrix. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classserif_1_1operators_1_1backend_1_1mfem_1_1_linearized_block}{Linearized\+Block}} \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_a1b7659c01f21795060536948565eb3a8}{serif\+::operators\+::backend\+::mfem\+::linearized\+\_\+block}} (std\+::shared\+\_\+ptr$<$ const \+::mfem\+::\+Dense\+Matrix $>$ matrix)
|
|
\begin{DoxyCompactList}\small\item\em Retain a small assembled physical block, such as a generated scalar constraint. \end{DoxyCompactList}\end{DoxyCompactItemize}
|