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)
59 lines
4.8 KiB
TeX
59 lines
4.8 KiB
TeX
\doxysection{src/include/serif/backend/mfem/model/binding.hpp File Reference}
|
|
\hypertarget{backend_2mfem_2model_2binding_8hpp}{}\label{backend_2mfem_2model_2binding_8hpp}\index{src/include/serif/backend/mfem/model/binding.hpp@{src/include/serif/backend/mfem/model/binding.hpp}}
|
|
{\ttfamily \#include $<$cstddef$>$}\newline
|
|
{\ttfamily \#include $<$memory$>$}\newline
|
|
{\ttfamily \#include $<$tuple$>$}\newline
|
|
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
|
|
{\ttfamily \#include $<$utility$>$}\newline
|
|
{\ttfamily \#include "{}serif/model/equilibrium\+\_\+plan.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/model/inputs.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/geometry/surface/pressure\+\_\+boundary.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/geometry/deformation/inputs.\+hpp"{}}\newline
|
|
Include dependency graph for binding.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{backend_2mfem_2model_2binding_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_2binding_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1model_1_1backend_1_1mfem_1_1_bound_model}{serif\+::model\+::backend\+::mfem\+::\+Bound\+Model$<$ Model, Description\+T, Discretization, Boundary, Plan\+T $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Retain physical descriptions and all numerical bindings behind one stable owner. \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*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$utils\+::dependencies\+::\+Is\+Key\+List Prescribed = utils\+::dependencies\+::\+Key\+List$<$$>$, typename Model, typename Discretization, typename Coefficients$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_a47fdec392d2d8ccee79d11772b6100b0}{serif\+::model\+::backend\+::mfem\+::bind\+\_\+model\+\_\+definition}} (std\+::shared\+\_\+ptr$<$ const Model $>$ model, std\+::shared\+\_\+ptr$<$ const Discretization $>$ discretization, const Coefficients \&coefficients)
|
|
\begin{DoxyCompactList}\small\item\em Compile selections explicitly while leaving thermodynamic and equation evaluation to the graph. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename EOS$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_1_1detail_adb7c36d586e61ca51022f02d27abed2c}{serif\+::model\+::backend\+::mfem\+::detail\+::equation\+\_\+of\+\_\+state\+\_\+input}} (const EOS \&eos)
|
|
\begin{DoxyCompactList}\small\item\em Track immutable physics with a policy type independent of the caller\textquotesingle{}s field ordering. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Geometry$>$ }\\std\+::size\+\_\+t \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_1_1detail_a08acc4b74ba8c22e26c6270b6a9242a5}{serif\+::model\+::backend\+::mfem\+::detail\+::geometry\+\_\+size}} (const Geometry \&coefficients)
|
|
\begin{DoxyCompactList}\small\item\em Count either backend displacement coefficients or independent surface coefficients. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Bound, typename Coefficients, typename Geometry$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_aed78cdbae2d289a84a97ae254bec99e4}{serif\+::model\+::backend\+::mfem\+::equilibrium\+\_\+inputs}} (const Bound \&bound, const Coefficients \&coefficients, const Geometry \&geometry\+\_\+coefficients)
|
|
\begin{DoxyCompactList}\small\item\em Build one input schema from an ordinary physical state and the selected geometry coordinates. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Plan, typename Discretization, typename Geometry$>$ }\\Plan\+::\+Layout \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_a34a92e84f64faf3aeb569d146e06af76}{serif\+::model\+::backend\+::mfem\+::equilibrium\+\_\+layout}} (const Discretization \&discretization, const Geometry \&geometry\+\_\+coefficients)
|
|
\begin{DoxyCompactList}\small\item\em Resolve physical block sizes, including the explicitly supplied independent shape count. \end{DoxyCompactList}\end{DoxyCompactItemize}
|