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)
69 lines
9.4 KiB
TeX
69 lines
9.4 KiB
TeX
\doxysection{src/include/serif/backend/mfem/operators/volume\+\_\+inputs.hpp File Reference}
|
|
\hypertarget{volume__inputs_8hpp}{}\label{volume__inputs_8hpp}\index{src/include/serif/backend/mfem/operators/volume\_inputs.hpp@{src/include/serif/backend/mfem/operators/volume\_inputs.hpp}}
|
|
{\ttfamily \#include "{}serif/backend/mfem/operators/volume\+\_\+data.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/discretization/coefficient\+\_\+tracking.\+hpp"{}}\newline
|
|
Include dependency graph for volume\+\_\+inputs.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{volume__inputs_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]{volume__inputs_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_metadata_tracking}{serif\+::operators\+::backend\+::mfem\+::\+Metadata\+Tracking}}
|
|
\begin{DoxyCompactList}\small\item\em Validate external mesh resources before the graph compares their metadata. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_displacement_coefficients}{serif\+::operators\+::backend\+::mfem\+::\+Displacement\+Coefficients}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_compactification_coefficients}{serif\+::operators\+::backend\+::mfem\+::\+Compactification\+Coefficients}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_coefficient_tracking}{serif\+::operators\+::backend\+::mfem\+::\+Coefficient\+Tracking}}
|
|
\begin{DoxyCompactList}\small\item\em Track coefficient values using an owned snapshot and the identity of their binding. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1operators}{serif\+::operators}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend}{serif\+::operators\+::backend}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem}{serif\+::operators\+::backend\+::mfem}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Typedefs}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_a22d24d720887e36f8f644825efd527be}{serif\+::operators\+::backend\+::mfem\+::\+Mesh\+And\+Coefficient\+Bindings}} = \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1volume__keys_1_1_scoped}{volume\+\_\+keys\+::\+Scoped}}$<$void$>$\+::\+Bindings
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename TestT, typename SchemaT$>$ }\\void \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_ab7552fe569ef673db3da582a89ed1cbd}{serif\+::operators\+::backend\+::mfem\+::validate\+\_\+volume\+\_\+discretization}} (const \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_volume_discretization}{Volume\+Discretization}}$<$ TestT, SchemaT $>$ \&discretization)
|
|
\begin{DoxyCompactList}\small\item\em Check borrowed mesh objects before sampling or applying accepted results. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Volume\+Equation EquationT, typename Scope = void, typename SchemaT, typename CoefficientsT, typename... Columns$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_a3a15884ed5e0837d7a8b1ffcc37322d9}{serif\+::operators\+::backend\+::mfem\+::make\+\_\+volume\+\_\+binding\+\_\+input}} (const \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_volume_discretization}{Volume\+Discretization}}$<$ typename Equation\+T\+::\+Test, SchemaT $>$ \&discretization, const CoefficientsT \&term\+\_\+coefficients, \mbox{\hyperlink{structserif_1_1utils_1_1types_1_1_type_list}{utils\+::types\+::\+Type\+List}}$<$ Columns... $>$)
|
|
\begin{DoxyCompactList}\small\item\em Validate one equation\textquotesingle{}s bindings without constructing duplicate coefficient resources. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Volume\+Equation EquationT, typename Scope = void, typename SchemaT, typename CoefficientsT$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_a9408a1ccdc9446d30b19ec8437d52952}{serif\+::operators\+::backend\+::mfem\+::make\+\_\+volume\+\_\+binding\+\_\+input}} (const \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_volume_discretization}{Volume\+Discretization}}$<$ typename Equation\+T\+::\+Test, SchemaT $>$ \&discretization, const CoefficientsT \&term\+\_\+coefficients)
|
|
\begin{DoxyCompactList}\small\item\em Share equation metadata with a model\textquotesingle{}s common physical coefficient context. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Volume\+Equation EquationT, typename Scope = void, typename SchemaT, typename CoefficientsT, typename... Columns$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_a1f65d326d1b5344aa7dcfdeff2f5a1cf}{serif\+::operators\+::backend\+::mfem\+::make\+\_\+volume\+\_\+inputs}} (const \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_volume_discretization}{Volume\+Discretization}}$<$ typename Equation\+T\+::\+Test, SchemaT $>$ \&discretization, const CoefficientsT \&term\+\_\+coefficients, \mbox{\hyperlink{structserif_1_1utils_1_1types_1_1_type_list}{utils\+::types\+::\+Type\+List}}$<$ Columns... $>$ columns)
|
|
\begin{DoxyCompactList}\small\item\em Supply precisely the consumed terms for a standalone equation. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Volume\+Equation EquationT, typename Scope = void, typename SchemaT, typename CoefficientsT$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_a5676ff865e3a1e0f31a805b61f29646b}{serif\+::operators\+::backend\+::mfem\+::make\+\_\+volume\+\_\+inputs}} (const \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_volume_discretization}{Volume\+Discretization}}$<$ typename Equation\+T\+::\+Test, SchemaT $>$ \&discretization, const CoefficientsT \&term\+\_\+coefficients)
|
|
\begin{DoxyCompactList}\small\item\em Bind equation and reference inputs when displacement will be produced inside the dependency graph. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Volume\+Equation EquationT, typename Scope = void, typename SchemaT, typename CoefficientsT, typename... Columns$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_a571e45f970427498005c180d93460083}{serif\+::operators\+::backend\+::mfem\+::make\+\_\+volume\+\_\+inputs}} (const \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_volume_discretization}{Volume\+Discretization}}$<$ typename Equation\+T\+::\+Test, SchemaT $>$ \&discretization, const CoefficientsT \&term\+\_\+coefficients, const \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_a317d4e0bea2ef8780ac3747cfe62bf72}{\+::mfem\+::\+Vector}} \&displacement\+\_\+coefficients, \mbox{\hyperlink{structserif_1_1utils_1_1types_1_1_type_list}{utils\+::types\+::\+Type\+List}}$<$ Columns... $>$ columns)
|
|
\begin{DoxyCompactList}\small\item\em Append a checked external displacement while preserving each original resource\textquotesingle{}s tracking policy. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Volume\+Equation EquationT, typename Scope = void, typename SchemaT, typename CoefficientsT$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_a784272fed6ef89b71d3524261fe82220}{serif\+::operators\+::backend\+::mfem\+::make\+\_\+volume\+\_\+inputs}} (const \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_volume_discretization}{Volume\+Discretization}}$<$ typename Equation\+T\+::\+Test, SchemaT $>$ \&discretization, const CoefficientsT \&term\+\_\+coefficients, const \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_a317d4e0bea2ef8780ac3747cfe62bf72}{\+::mfem\+::\+Vector}} \&displacement\+\_\+coefficients)
|
|
\begin{DoxyCompactList}\small\item\em Build a checked source context without retaining the coefficient vectors. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Volume\+Equation EquationT, typename Scope = void, typename SchemaT, typename CoefficientsT$>$ }\\void \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_a6860d00f1cd66747b2bfeb6c1c9677e8}{serif\+::operators\+::backend\+::mfem\+::make\+\_\+volume\+\_\+inputs}} (const \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_volume_discretization}{Volume\+Discretization}}$<$ typename Equation\+T\+::\+Test, SchemaT $>$ \&, const CoefficientsT \&, \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_a317d4e0bea2ef8780ac3747cfe62bf72}{\+::mfem\+::\+Vector}} \&\&)=delete
|
|
\item
|
|
{\footnotesize template$<$Volume\+Equation EquationT, typename Scope = void, typename SchemaT, typename CoefficientsT$>$ }\\void \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_a4c18e9a009be674c99de62486097a287}{serif\+::operators\+::backend\+::mfem\+::make\+\_\+volume\+\_\+inputs}} (const \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_volume_discretization}{Volume\+Discretization}}$<$ typename Equation\+T\+::\+Test, SchemaT $>$ \&, const CoefficientsT \&, const \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_a317d4e0bea2ef8780ac3747cfe62bf72}{\+::mfem\+::\+Vector}} \&\&)=delete
|
|
\end{DoxyCompactItemize}
|