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)
75 lines
6.0 KiB
TeX
75 lines
6.0 KiB
TeX
\doxysection{src/include/serif/backend/mfem/serialize/top.hpp File Reference}
|
|
\hypertarget{backend_2mfem_2serialize_2top_8hpp}{}\label{backend_2mfem_2serialize_2top_8hpp}\index{src/include/serif/backend/mfem/serialize/top.hpp@{src/include/serif/backend/mfem/serialize/top.hpp}}
|
|
{\ttfamily \#include $<$array$>$}\newline
|
|
{\ttfamily \#include $<$cmath$>$}\newline
|
|
{\ttfamily \#include $<$filesystem$>$}\newline
|
|
{\ttfamily \#include $<$memory$>$}\newline
|
|
{\ttfamily \#include $<$numbers$>$}\newline
|
|
{\ttfamily \#include $<$span$>$}\newline
|
|
{\ttfamily \#include $<$string$>$}\newline
|
|
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/discretization/dof\+\_\+map.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/geometry/deformation/computations.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/eos/models/polytropic.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/barotropic\+\_\+density.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/primal\+\_\+gravity.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/geometry/surface/isobaric.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/model/description.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/dependencies/computation\+\_\+cache.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/serialize/top.\+hpp"{}}\newline
|
|
Include dependency graph for top.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{backend_2mfem_2serialize_2top_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=205pt]{backend_2mfem_2serialize_2top_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
class \mbox{\hyperlink{classserif_1_1backend_1_1mfem_1_1serialize_1_1detail_1_1_top_model_sampler}{serif\+::backend\+::mfem\+::serialize\+::detail\+::\+Top\+Model\+Sampler}}
|
|
\begin{DoxyCompactList}\small\item\em Sample copied coefficients on a private deformed geometry; the original state and mesh remain untouched. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1backend}{serif\+::backend}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem}{serif\+::backend\+::mfem}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_1_1serialize}{serif\+::backend\+::mfem\+::serialize}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_1_1serialize_1_1detail}{serif\+::backend\+::mfem\+::serialize\+::detail}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1utils}{serif\+::utils}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1utils_1_1serialize}{serif\+::utils\+::serialize}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename EOS$>$ }\\bool \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_1_1serialize_1_1detail_a626ed4fffd21b9419e919196731f7d65}{serif\+::backend\+::mfem\+::serialize\+::detail\+::top\+\_\+matching\+\_\+polytrope}} (const EOS \&candidate, const \mbox{\hyperlink{classserif_1_1eos_1_1models_1_1_polytrope}{eos\+::models\+::\+Polytrope}} \&physical)
|
|
\begin{DoxyCompactList}\small\item\em Verify the actual closure EOS rather than assuming a borrowed equation uses the model\textquotesingle{}s values. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$model\+::\+Stellar\+Model\+Type Model, typename Finite\+Elements, typename State$>$ }\\\mbox{\hyperlink{namespaceserif_1_1utils_1_1serialize_ace9e0af29889a767ef1c95a09a4b7265}{Result}}$<$ \mbox{\hyperlink{structserif_1_1utils_1_1serialize_1_1_top_export_report}{Top\+Export\+Report}} $>$ \mbox{\hyperlink{namespaceserif_1_1utils_1_1serialize_ac247352aee3417238eda1bf573f1b197}{serif\+::utils\+::serialize\+::export\+\_\+top}} (const std\+::filesystem\+::path \&directory, const Model \&stellar\+\_\+model, const Finite\+Elements \&finite\+\_\+elements, const State \&state, const \mbox{\hyperlink{structserif_1_1utils_1_1serialize_1_1_top_export_options}{Top\+Export\+Options}} \&options=\{\})
|
|
\begin{DoxyCompactList}\small\item\em Export the accepted density and FE surface of a uniformly rotating vacuum polytrope to TOP. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Finite\+Elements, typename Solution$>$ \newline
|
|
requires requires(const Solution\& solution) \{ solution.\+has\+\_\+state(); solution.\+model(); solution.\+state(); \}}\\\mbox{\hyperlink{namespaceserif_1_1utils_1_1serialize_ace9e0af29889a767ef1c95a09a4b7265}{Result}}$<$ \mbox{\hyperlink{structserif_1_1utils_1_1serialize_1_1_top_export_report}{Top\+Export\+Report}} $>$ \mbox{\hyperlink{namespaceserif_1_1utils_1_1serialize_aa5efebebb4fcf770cef7679e0e924627}{serif\+::utils\+::serialize\+::export\+\_\+top}} (const std\+::filesystem\+::path \&directory, const Finite\+Elements \&finite\+\_\+elements, const Solution \&solution, const \mbox{\hyperlink{structserif_1_1utils_1_1serialize_1_1_top_export_options}{Top\+Export\+Options}} \&options=\{\})
|
|
\begin{DoxyCompactList}\small\item\em Export a solver result with the separately owned FE resources that interpret its accepted state. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Variables}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename T$>$ }\\constexpr bool \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_1_1serialize_1_1detail_adb44d596947c90d099959328bdff8951}{serif\+::backend\+::mfem\+::serialize\+::detail\+::top\+\_\+rigid\+\_\+barotrope}} = false
|
|
\item
|
|
{\footnotesize template$<$typename EOS$>$ }\\constexpr bool \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_1_1serialize_1_1detail_ab31b49db042602ca034f4bbb679ec977}{serif\+::backend\+::mfem\+::serialize\+::detail\+::top\+\_\+rigid\+\_\+barotrope$<$ equations\+::\+Barotropic\+Density\+Balance$<$ EOS $>$ $>$}} = true
|
|
\end{DoxyCompactItemize}
|