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)
47 lines
4.4 KiB
TeX
47 lines
4.4 KiB
TeX
\doxysection{src/include/serif/backend/mfem/model/inputs.hpp File Reference}
|
|
\hypertarget{model_2inputs_8hpp}{}\label{model_2inputs_8hpp}\index{src/include/serif/backend/mfem/model/inputs.hpp@{src/include/serif/backend/mfem/model/inputs.hpp}}
|
|
{\ttfamily \#include "{}serif/model/plan.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/operators/volume\+\_\+inputs.\+hpp"{}}\newline
|
|
Include dependency graph for inputs.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{model_2inputs_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_2inputs_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*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename Discretization, typename Coefficients, typename... Terms$>$ }\\void \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_1_1detail_ae9c0f9389fb9983b00f7e2887a487fd6}{serif\+::model\+::backend\+::mfem\+::detail\+::validate\+\_\+coefficient\+\_\+owners}} (const Discretization \&discretization, const Coefficients \&coefficients, \mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_key_list}{utils\+::dependencies\+::\+Key\+List}}$<$ Terms... $>$)
|
|
\begin{DoxyCompactList}\small\item\em Accepted actions may borrow only bindings retained by the declared discretization owner. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Discretization, typename Coefficients, typename... Equations, typename... Fields$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_1_1detail_a367825ed99eea95d5a357b6c7b565dfb}{serif\+::model\+::backend\+::mfem\+::detail\+::model\+\_\+inputs}} (const Discretization \&discretization, const Coefficients \&coefficients, \mbox{\hyperlink{structserif_1_1utils_1_1types_1_1_type_list}{utils\+::types\+::\+Type\+List}}$<$ Equations... $>$, \mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_key_list}{utils\+::dependencies\+::\+Key\+List}}$<$ Fields... $>$)
|
|
\begin{DoxyCompactList}\small\item\em Bind common physical coefficients once and keep equation-\/specific metadata distinct. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Executable\+Interior\+Equations Registry, typename Discretization, typename Coefficients$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_afa71c8cca2f9272780f390b5287956bd}{serif\+::model\+::backend\+::mfem\+::make\+\_\+model\+\_\+inputs}} (const Discretization \&discretization, const Coefficients \&coefficients)
|
|
\begin{DoxyCompactList}\small\item\em Supply the same physical coefficient resources to all explicitly listed interior equations. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Executable\+Interior\+Equations Registry, typename Discretization, typename Coefficients$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_a110a5a6390df36404e975de402d93ebc}{serif\+::model\+::backend\+::mfem\+::make\+\_\+model\+\_\+inputs}} (const Discretization \&discretization, const Coefficients \&coefficients, const \+::mfem\+::\+Vector \&displacement)
|
|
\begin{DoxyCompactList}\small\item\em Prepare an interior system with a prescribed displacement field, without adding displacement unknowns. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Registry, typename Discretization, typename Coefficients$>$ }\\void \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_a191c36c007ef249b13f831c263af829c}{serif\+::model\+::backend\+::mfem\+::make\+\_\+model\+\_\+inputs}} (const Discretization \&, const Coefficients \&, const \+::mfem\+::\+Vector \&\&)=delete
|
|
\begin{DoxyCompactList}\small\item\em Reject a displacement temporary whose coefficients would expire before graph preparation. \end{DoxyCompactList}\end{DoxyCompactItemize}
|