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)
56 lines
4.0 KiB
TeX
56 lines
4.0 KiB
TeX
\doxysection{src/include/serif/backend/mfem/model/state.hpp File Reference}
|
|
\hypertarget{backend_2mfem_2model_2state_8hpp}{}\label{backend_2mfem_2model_2state_8hpp}\index{src/include/serif/backend/mfem/model/state.hpp@{src/include/serif/backend/mfem/model/state.hpp}}
|
|
{\ttfamily \#include $<$array$>$}\newline
|
|
{\ttfamily \#include $<$limits$>$}\newline
|
|
{\ttfamily \#include "{}serif/model/plan.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/model/state.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/discretization/term\+\_\+coefficients.\+hpp"{}}\newline
|
|
Include dependency graph for state.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{backend_2mfem_2model_2state_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]{backend_2mfem_2model_2state_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
class \mbox{\hyperlink{classserif_1_1model_1_1backend_1_1mfem_1_1detail_1_1_state_coefficients_3_01_discretization_00_044d28989c19bc1c1c57a48d1b3391006}{serif\+::model\+::backend\+::mfem\+::detail\+::\+State\+Coefficients$<$ Discretization, Layout, Prescribed, utils\+::dependencies\+::\+Key\+List$<$ Fields... $>$ $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Borrow an owning state\textquotesingle{}s fields for one synchronous equation evaluation. \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*{Concepts}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1model_1_1backend_1_1mfem_1_1detail_1_1_coefficient_input}{serif\+::model\+::backend\+::mfem\+::detail\+::\+Coefficient\+Input}}
|
|
\begin{DoxyCompactList}\small\item\em Recognize a field view by its physical identity and backend coefficient representation. \end{DoxyCompactList}\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1model_1_1backend_1_1mfem_1_1detail_1_1_prescribed_inputs_for}{serif\+::model\+::backend\+::mfem\+::detail\+::\+Prescribed\+Inputs\+For}}
|
|
\begin{DoxyCompactList}\small\item\em Prescribed views must supply every unsolved input and cannot duplicate a solved coordinate. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename Inputs, typename... Terms$>$ }\\consteval bool \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_1_1detail_af8b15b9d66dca2db283a852d7adee9aa}{serif\+::model\+::backend\+::mfem\+::detail\+::coefficient\+\_\+inputs}} (\mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_key_list}{utils\+::dependencies\+::\+Key\+List}}$<$ Terms... $>$)
|
|
\begin{DoxyCompactList}\small\item\em Check required fields before entering evaluation, including during compile-\/time API detection. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Discretization, typename Layout, typename Prescribed$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_1_1detail_a43bea265f7ca82aa0ddba452cd15282f}{serif\+::model\+::backend\+::mfem\+::detail\+::state\+\_\+coefficients}} (const Discretization \&discretization, const \mbox{\hyperlink{structserif_1_1model_1_1_stellar_state}{Stellar\+State}}$<$ Layout $>$ \&state, const Prescribed \&prescribed)
|
|
\begin{DoxyCompactList}\small\item\em Keep surface coordinates in the state while exposing only ordinary fields to volume equations. \end{DoxyCompactList}\end{DoxyCompactItemize}
|