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.4 KiB
TeX
49 lines
3.4 KiB
TeX
\doxysection{src/lib/serif/backend/mfem/solver/preconditioner/inverse/direct\+\_\+lu.hpp File Reference}
|
|
\hypertarget{direct__lu_8hpp}{}\label{direct__lu_8hpp}\index{src/lib/serif/backend/mfem/solver/preconditioner/inverse/direct\_lu.hpp@{src/lib/serif/backend/mfem/solver/preconditioner/inverse/direct\_lu.hpp}}
|
|
{\ttfamily \#include $<$memory$>$}\newline
|
|
Include dependency graph for direct\+\_\+lu.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=217pt]{direct__lu_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]{direct__lu_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
class \mbox{\hyperlink{classserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1detail_1_1_direct_l_u_pattern}{serif\+::solver\+::preconditioner\+::backend\+::mfem\+::detail\+::\+Direct\+LUPattern}}
|
|
\begin{DoxyCompactList}\small\item\em Symbolic analysis (fill-\/reducing ordering) of one sparsity pattern, shared by the numeric factorizations of every matrix with that pattern. Implemented by the backend chosen with the sparse\+\_\+direct Meson option (\doxylink{direct__lu__accelerate_8cpp}{direct\+\_\+lu\+\_\+accelerate.\+cpp}, \doxylink{direct__lu__umfpack_8cpp}{direct\+\_\+lu\+\_\+umfpack.\+cpp} or \doxylink{direct__lu__none_8cpp}{direct\+\_\+lu\+\_\+none.\+cpp}). \end{DoxyCompactList}\item
|
|
class \mbox{\hyperlink{classserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1detail_1_1_direct_l_u}{serif\+::solver\+::preconditioner\+::backend\+::mfem\+::detail\+::\+Direct\+LU}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1solver}{serif\+::solver}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner}{serif\+::solver\+::preconditioner}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend}{serif\+::solver\+::preconditioner\+::backend}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem}{serif\+::solver\+::preconditioner\+::backend\+::mfem}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1detail}{serif\+::solver\+::preconditioner\+::backend\+::mfem\+::detail}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
const char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1detail_a97b4f86072adcca456c16c02e3e5b555}{serif\+::solver\+::preconditioner\+::backend\+::mfem\+::detail\+::direct\+\_\+lu\+\_\+backend}} () noexcept
|
|
\begin{DoxyCompactList}\small\item\em The compiled backend\+: "{}accelerate"{}, "{}umfpack"{} or "{}none"{}. \end{DoxyCompactList}\item
|
|
bool \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1detail_aa819cbc100505f678b3685e0e4527fc3}{serif\+::solver\+::preconditioner\+::backend\+::mfem\+::detail\+::direct\+\_\+lu\+\_\+available}} () noexcept
|
|
\begin{DoxyCompactList}\small\item\em True when the compiled backend can factor on this machine (Accelerate also needs mac\+OS 15.\+5 at run time). \end{DoxyCompactList}\end{DoxyCompactItemize}
|