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)
44 lines
4.3 KiB
TeX
44 lines
4.3 KiB
TeX
\doxysection{src/include/serif/model/backend/mfem/equilibrium.hpp File Reference}
|
|
\hypertarget{equilibrium_8hpp}{}\label{equilibrium_8hpp}\index{src/include/serif/model/backend/mfem/equilibrium.hpp@{src/include/serif/model/backend/mfem/equilibrium.hpp}}
|
|
{\ttfamily \#include $<$expected$>$}\newline
|
|
{\ttfamily \#include "{}serif/model/backend/mfem/binding.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/model/backend/mfem/configured\+\_\+discretization.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/model/normalization/computations.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/model/backend/mfem/discretization.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/model/backend/mfem/failure.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/model/backend/mfem/problem.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/model/graph.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/model/execution\+\_\+validation.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/model/stellar\+\_\+model.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/checks/finite.\+hpp"{}}\newline
|
|
Include dependency graph for equilibrium.\+hpp\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{equilibrium_8hpp__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
class \mbox{\hyperlink{classserif_1_1model_1_1backend_1_1mfem_1_1_stellar_equilibrium}{serif\+::model\+::backend\+::mfem\+::\+Stellar\+Equilibrium$<$ Bound, Problem, Additional\+Inputs, Prepared\+Key $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Execute one immutable physical definition against explicit candidate fields and geometry. \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}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$utils\+::dependencies\+::\+Is\+Key\+List Prescribed = utils\+::dependencies\+::\+Key\+List$<$$>$, utils\+::dependencies\+::\+Is\+Bindings Specification\+Map = Default\+Specification\+Bindings, utils\+::dependencies\+::\+Is\+Key\+List Explicit\+Zero\+Couplings = utils\+::dependencies\+::\+Key\+List$<$$>$, Stellar\+Model\+Type Model, typename Discretization, typename Coefficients, typename Geometry$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_aeebf423f33a0836e029a7f3b42c590b5}{serif\+::model\+::backend\+::mfem\+::bind\+\_\+stellar\+\_\+model}} (Model model, Discretization discretization, const Coefficients \&coefficients, const Geometry \&geometry, \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_volume_options}{operators\+::backend\+::mfem\+::\+Volume\+Options}} options=\{\})
|
|
\begin{DoxyCompactList}\small\item\em Bind explicitly selected equilibrium equations without evaluating a candidate or starting a solve. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$utils\+::dependencies\+::\+Is\+Key\+List Prescribed = utils\+::dependencies\+::\+Key\+List$<$$>$, utils\+::dependencies\+::\+Is\+Bindings Specification\+Map = Default\+Specification\+Bindings, utils\+::dependencies\+::\+Is\+Key\+List Explicit\+Zero\+Couplings = utils\+::dependencies\+::\+Key\+List$<$$>$, Stellar\+Model\+Type Model, typename Discretization, typename Options, typename Coefficients, typename Geometry$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_afc0b06b403d8cb9ff16f5620f23664dc}{serif\+::model\+::backend\+::mfem\+::bind\+\_\+stellar\+\_\+model}} (\mbox{\hyperlink{structserif_1_1model_1_1backend_1_1mfem_1_1_configured_discretization}{Configured\+Discretization}}$<$ Model, Discretization, Options $>$ configuration, const Coefficients \&coefficients, const Geometry \&geometry, \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_volume_options}{operators\+::backend\+::mfem\+::\+Volume\+Options}} options=\{\})
|
|
\begin{DoxyCompactList}\small\item\em Bind the configured star and prepare its physical and normalized systems in one dependency graph. \end{DoxyCompactList}\end{DoxyCompactItemize}
|