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)
46 lines
3.6 KiB
TeX
46 lines
3.6 KiB
TeX
\doxysection{src/include/serif/backend/mfem/model/computations/physical\+\_\+blocks.hpp File Reference}
|
|
\hypertarget{model_2computations_2physical__blocks_8hpp}{}\label{model_2computations_2physical__blocks_8hpp}\index{src/include/serif/backend/mfem/model/computations/physical\_blocks.hpp@{src/include/serif/backend/mfem/model/computations/physical\_blocks.hpp}}
|
|
{\ttfamily \#include $<$array$>$}\newline
|
|
{\ttfamily \#include $<$limits$>$}\newline
|
|
{\ttfamily \#include $<$tuple$>$}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/model/system.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/model/keys.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/operators/linearized\+\_\+system\+\_\+view.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/dependencies/computation.\+hpp"{}}\newline
|
|
Include dependency graph for physical\+\_\+blocks.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{model_2computations_2physical__blocks_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[height=550pt]{model_2computations_2physical__blocks_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1model}{serif\+::model}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1model_1_1computations}{serif\+::model\+::computations}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1model_1_1computations_1_1detail}{serif\+::model\+::computations\+::detail}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename Layout, typename... Rows, typename... Fields$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1computations_1_1detail_a8ee526b8c650dbdb269632f5ee03e948}{serif\+::model\+::computations\+::detail\+::physical\+\_\+block}} (const \mbox{\hyperlink{classserif_1_1model_1_1backend_1_1mfem_1_1_physical_system}{backend\+::mfem\+::\+Physical\+System}} \&system, const Layout \&layout, \mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_key_list}{utils\+::dependencies\+::\+Key\+List}}$<$ Rows... $>$, \mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_key_list}{utils\+::dependencies\+::\+Key\+List}}$<$ Fields... $>$)
|
|
\begin{DoxyCompactList}\small\item\em Extract selected physical rows and columns in the caller\textquotesingle{}s explicit order. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Block, discretization\+::blocks\+::\+System\+Layout\+Type Layout$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1computations_a0660915b0bac2fc2ce2012e70bcd4e07}{serif\+::model\+::computations\+::physical\+\_\+block}} (const Layout \&layout)
|
|
\begin{DoxyCompactList}\small\item\em Publish a requested physical block from the same physical root used for residual and Jacobian actions. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$discretization\+::blocks\+::\+System\+Layout\+Type Layout, typename... Blocks$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1computations_a4ff124ec28d7784bd444fee234bad18e}{serif\+::model\+::computations\+::make\+\_\+physical\+\_\+block\+\_\+computations}} (const Layout \&layout, \mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_key_list}{utils\+::dependencies\+::\+Key\+List}}$<$ Blocks... $>$)
|
|
\begin{DoxyCompactList}\small\item\em Supply precisely the requested physical couplings to existing preconditioner computations. \end{DoxyCompactList}\end{DoxyCompactItemize}
|