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)
41 lines
4.0 KiB
TeX
41 lines
4.0 KiB
TeX
\doxysection{src/include/serif/model/finite\+\_\+elements.hpp File Reference}
|
|
\hypertarget{model_2finite__elements_8hpp}{}\label{model_2finite__elements_8hpp}\index{src/include/serif/model/finite\_elements.hpp@{src/include/serif/model/finite\_elements.hpp}}
|
|
{\ttfamily \#include "{}serif/backend/mfem/model/finite\+\_\+elements.\+hpp"{}}\newline
|
|
Include dependency graph for finite\+\_\+elements.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{model_2finite__elements_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]{model_2finite__elements_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\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_1geometry}{serif\+::geometry}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation}{serif\+::geometry\+::deformation}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename Owner, utils\+::dependencies\+::\+Is\+Dependency\+Context Bindings$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1model_ac5681e63c50dc5a136eaa699838cf332}{serif\+::model\+::make\+\_\+stellar\+\_\+discretization}} (std\+::shared\+\_\+ptr$<$ Owner $>$ owner, Bindings bindings, const \+::mfem\+::\+Grid\+Function \&compactification, const \mbox{\hyperlink{classserif_1_1mapping_1_1_domain_mapper}{mapping\+::\+Domain\+Mapper}} \&mapper)
|
|
\begin{DoxyCompactList}\small\item\em Retain the supplied resource owner without copying finite-\/element spaces or changing their addresses. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Owner, typename Bindings, typename Domain\+Model$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1model_ade88a3e3fa00b425b3d93ad44b3bb604}{serif\+::model\+::with\+\_\+deformation}} (Stellar\+Discretization$<$ Owner, Bindings $>$ discretization, Domain\+Model model, \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1_1_reference_discretization}{geometry\+::deformation\+::backend\+::mfem\+::\+Reference\+Discretization}} reference)
|
|
\begin{DoxyCompactList}\small\item\em Add an explicit deformation prescription without changing the physical equation definition. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$discretization\+::domain\+::schema\+::\+Is\+Schema Schema = discretization\+::domain\+::schema\+::\+Core\+Envelope\+Vacuum\+Domain\+Schema$>$ \newline
|
|
requires (Schema\+::template contains\+\_\+domain$<$\mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_aa2fd687c5f7b8750fd6980f2a7a77652}{discretization\+::domain\+::\+Stellar\+Domains}}$>$() \&\& Schema\+::template contains\+\_\+domain$<$\mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1_vacuum_domain}{discretization\+::domain\+::\+Vacuum\+Domain}}$>$() \&\& Schema\+::template contains\+\_\+boundary$<$\mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1_stellar_surface_boundary}{discretization\+::domain\+::\+Stellar\+Surface\+Boundary}}$>$() \&\& Schema\+::template contains\+\_\+boundary$<$\mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1_infinity_surface_boundary}{discretization\+::domain\+::\+Infinity\+Surface\+Boundary}}$>$())}\\Reference\+Discretization \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_a4bda42409c67b56f9bc36ea69c7655ee}{serif\+::geometry\+::deformation\+::deformation\+\_\+discretization}} (const \+::mfem\+::\+Finite\+Element\+Space \&scalar\+\_\+space, const \+::mfem\+::\+Finite\+Element\+Space \&displacement\+\_\+space, \+::mfem\+::\+Mesh \&logical\+\_\+mesh)
|
|
\begin{DoxyCompactList}\small\item\em Resolve physical domain names through the schema rather than hard-\/coded MFEM attributes. \end{DoxyCompactList}\end{DoxyCompactItemize}
|