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)
43 lines
3.2 KiB
TeX
43 lines
3.2 KiB
TeX
\doxysection{src/include/serif/backend/mfem/solver/equilibrium.hpp File Reference}
|
|
\hypertarget{backend_2mfem_2solver_2equilibrium_8hpp}{}\label{backend_2mfem_2solver_2equilibrium_8hpp}\index{src/include/serif/backend/mfem/solver/equilibrium.hpp@{src/include/serif/backend/mfem/solver/equilibrium.hpp}}
|
|
{\ttfamily \#include "{}serif/backend/mfem/solver/nonlinear/stellar\+\_\+problem.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/solver/preconditioner/default\+\_\+preconditioners.\+hpp"{}}\newline
|
|
Include dependency graph for equilibrium.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{backend_2mfem_2solver_2equilibrium_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=270pt]{backend_2mfem_2solver_2equilibrium_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\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_1backend}{serif\+::solver\+::backend}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1backend_1_1mfem}{serif\+::solver\+::backend\+::mfem}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1backend_1_1mfem_1_1detail}{serif\+::solver\+::backend\+::mfem\+::detail}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1backend_1_1mfem_1_1detail_ae40ccbabcb21a9bd5d59b6156bf0d7da}{serif\+::solver\+::backend\+::mfem\+::detail\+::solver\+\_\+computations}} (const auto \&strategies)
|
|
\begin{DoxyCompactList}\small\item\em Add selected immutable solver data to the model\textquotesingle{}s existing dependency graph. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Model, typename Finite\+Elements, typename Normalization, typename Preconditioner, typename Layout$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1backend_1_1mfem_1_1detail_afded634f5ef02936957783b501dcf053}{serif\+::solver\+::backend\+::mfem\+::detail\+::with\+\_\+default\+\_\+preconditioner}} (\mbox{\hyperlink{structserif_1_1model_1_1_discretization_options}{model\+::\+Discretization\+Options}}$<$ Model, Finite\+Elements, Normalization, Preconditioner $>$ configuration, const Layout \&layout)
|
|
\begin{DoxyCompactList}\small\item\em Select the readable default registry only when the caller has not supplied a recipe. \end{DoxyCompactList}\item
|
|
auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1backend_1_1mfem_a91dc4b07e287f3a5346200f1a22db508}{serif\+::solver\+::backend\+::mfem\+::make\+\_\+observed\+\_\+stellar\+\_\+problem}} (auto configuration, const auto \&state, const auto \&strategies, \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_volume_options}{operators\+::backend\+::mfem\+::\+Volume\+Options}} volume\+\_\+options, auto prescribed, auto observer\+\_\+factory, const auto \&... geometry)
|
|
\begin{DoxyCompactList}\small\item\em Construct one evaluator/cache and bind fixed or moving geometry for an equilibrium solve. \end{DoxyCompactList}\end{DoxyCompactItemize}
|