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)
50 lines
2.9 KiB
TeX
50 lines
2.9 KiB
TeX
\doxysection{src/include/serif/backend/mfem/model/equilibrium\+\_\+evaluator.hpp File Reference}
|
|
\hypertarget{equilibrium__evaluator_8hpp}{}\label{equilibrium__evaluator_8hpp}\index{src/include/serif/backend/mfem/model/equilibrium\_evaluator.hpp@{src/include/serif/backend/mfem/model/equilibrium\_evaluator.hpp}}
|
|
{\ttfamily \#include $<$expected$>$}\newline
|
|
{\ttfamily \#include $<$span$>$}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/model/binding.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/model/failure.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/model/state.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/model/preconditioning/computations.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/shared/finite.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/dependencies/computation\+\_\+cache.\+hpp"{}}\newline
|
|
Include dependency graph for equilibrium\+\_\+evaluator.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{equilibrium__evaluator_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]{equilibrium__evaluator_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
class \mbox{\hyperlink{classserif_1_1model_1_1backend_1_1mfem_1_1_equilibrium_evaluator}{serif\+::model\+::backend\+::mfem\+::\+Equilibrium\+Evaluator$<$ Bound, Graph, Inputs, Additional\+Inputs, Result\+Key, Evaluation\+Services, Linear\+Services, Observers $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Evaluate explicit stellar candidates using one reusable dependency cache. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\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_1backend}{serif\+::model\+::backend}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem}{serif\+::model\+::backend\+::mfem}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_1_1detail}{serif\+::model\+::backend\+::mfem\+::detail}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename Bound, typename Coefficients, typename Geometry$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_1_1detail_ac66a7e936009fec60c65d4bdf70b15ef}{serif\+::model\+::backend\+::mfem\+::detail\+::candidate\+\_\+inputs}} (const Bound \&bound, const Coefficients \&coefficients, const Geometry \&geometry)
|
|
\begin{DoxyCompactList}\small\item\em Use one shape-\/view input schema for both packed states and external coefficient containers. \end{DoxyCompactList}\end{DoxyCompactItemize}
|