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)
62 lines
7.3 KiB
TeX
62 lines
7.3 KiB
TeX
\doxysection{src/include/serif/backend/mfem/model/finite\+\_\+elements.hpp File Reference}
|
|
\hypertarget{backend_2mfem_2model_2finite__elements_8hpp}{}\label{backend_2mfem_2model_2finite__elements_8hpp}\index{src/include/serif/backend/mfem/model/finite\_elements.hpp@{src/include/serif/backend/mfem/model/finite\_elements.hpp}}
|
|
{\ttfamily \#include "{}serif/backend/mfem/discretization/resources.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/discretization/term\+\_\+binding.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/model/discretization.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/model/equilibrium\+\_\+plan.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/model/mesh\+\_\+options.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/model/stellar\+\_\+model.\+hpp"{}}\newline
|
|
Include dependency graph for finite\+\_\+elements.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{backend_2mfem_2model_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]{backend_2mfem_2model_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_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_reconstruction_specification}{serif\+::model\+::backend\+::mfem\+::detail\+::\+Reconstruction\+Specification}}
|
|
\begin{DoxyCompactList}\small\item\em Recognize a field-\/specific reconstruction request without prescribing its numerical form. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{structserif_1_1discretization_1_1backend_1_1mfem_1_1_resources}{discretization\+::backend\+::mfem\+::\+Resources}} \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_a53aa28e4e506639de07ca182755e9a69}{serif\+::model\+::backend\+::mfem\+::make\+\_\+stellar\+\_\+resources}} (const \mbox{\hyperlink{structserif_1_1model_1_1_stellar_mesh_options}{Stellar\+Mesh\+Options}} \&options)
|
|
\begin{DoxyCompactList}\small\item\em Generate physical and logical meshes with the standard core/envelope/vacuum labels. \end{DoxyCompactList}\item
|
|
\+::mfem\+::\+Finite\+Element\+Space \& \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_ad614b94744a7d65c72ab8f24bebaf96c}{serif\+::model\+::backend\+::mfem\+::make\+\_\+space}} (\mbox{\hyperlink{structserif_1_1discretization_1_1backend_1_1mfem_1_1_resources}{discretization\+::backend\+::mfem\+::\+Resources}} \&resources, std\+::unique\+\_\+ptr$<$\+::mfem\+::\+Finite\+Element\+Collection $>$ collection, int components, int ordering=\+::mfem\+::\+Ordering\+::by\+NODES)
|
|
\begin{DoxyCompactList}\small\item\em Share identical collections and spaces, retaining native coefficient numbering and storage. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Owner, typename... Terms, Reconstruction\+Specification Specification$>$ }\\void \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_1_1detail_abeccb976035cb25493914d48891be156}{serif\+::model\+::backend\+::mfem\+::detail\+::apply\+\_\+reconstruction}} (Owner \&owner, \mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_key_list}{utils\+::dependencies\+::\+Key\+List}}$<$ Terms... $>$, const Specification \&specification)
|
|
\begin{DoxyCompactList}\small\item\em Attach a requested numerical interpretation while the bindings still have a single mutable owner. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Reconstruction\+Specification... Specifications$>$ }\\void \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_1_1detail_a1884e65ec7a1ce57decf1ff277d369b9}{serif\+::model\+::backend\+::mfem\+::detail\+::validate\+\_\+reconstruction\+\_\+requests}} ()
|
|
\begin{DoxyCompactList}\small\item\em Reject duplicate field requests before constructing any finite elements. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$discretization\+::blocks\+::\+Spatial\+Term Term$>$ }\\\+::mfem\+::\+Finite\+Element\+Space \& \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_1_1detail_ae84cc3521a195a469cd2e61aaeaeb59b}{serif\+::model\+::backend\+::mfem\+::detail\+::term\+\_\+space}} (\mbox{\hyperlink{structserif_1_1discretization_1_1backend_1_1mfem_1_1_resources}{discretization\+::backend\+::mfem\+::\+Resources}} \&resources)
|
|
\begin{DoxyCompactList}\small\item\em Construct only representations supported by Term\+Binding, directly from the term\textquotesingle{}s compile-\/time descriptor. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename... Terms, Reconstruction\+Specification... Specifications$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_1_1detail_a3949983bb2d08c6bd64c48b9be434410}{serif\+::model\+::backend\+::mfem\+::detail\+::make\+\_\+bindings}} (const \mbox{\hyperlink{structserif_1_1model_1_1_stellar_mesh_options}{Stellar\+Mesh\+Options}} \&options, \mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_key_list}{utils\+::dependencies\+::\+Key\+List}}$<$ Terms... $>$ keys, const Specifications \&... specifications)
|
|
\begin{DoxyCompactList}\small\item\em Own precisely the model\textquotesingle{}s coefficients plus displacement geometry; no particular thermodynamic field is required. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Stellar\+Model\+Type Model, detail\+::\+Reconstruction\+Specification... Specifications$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_a957b7cc29cef504ee596ecd10ae9dae4}{serif\+::model\+::backend\+::mfem\+::make\+\_\+stellar\+\_\+discretization}} (const Model \&, const \mbox{\hyperlink{structserif_1_1model_1_1_stellar_mesh_options}{Stellar\+Mesh\+Options}} \&options=\{\}, const Specifications \&... specifications)
|
|
\begin{DoxyCompactList}\small\item\em Create an owning fixed-\/geometry discretization using the physical model\textquotesingle{}s term descriptors. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Stellar\+Model\+Type Model, typename Surface, typename Interior, typename Vacuum, detail\+::\+Reconstruction\+Specification... Specifications$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_a6e332633866ad76b543792e85da84523}{serif\+::model\+::backend\+::mfem\+::make\+\_\+stellar\+\_\+discretization}} (const Model \&model, const \mbox{\hyperlink{structserif_1_1model_1_1_stellar_mesh_options}{Stellar\+Mesh\+Options}} \&options, \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_domain_deformation}{geometry\+::deformation\+::\+Domain\+Deformation}}$<$ Surface, Interior, Vacuum $>$ deformation, const Specifications \&... specifications)
|
|
\begin{DoxyCompactList}\small\item\em Add a moving surface with reference companions chosen from displacement geometry, independently of EOS variables. \end{DoxyCompactList}\end{DoxyCompactItemize}
|