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)
55 lines
3.1 KiB
TeX
55 lines
3.1 KiB
TeX
\doxysection{src/include/serif/backend/mfem/discretization/dof\+\_\+selection.hpp File Reference}
|
|
\hypertarget{dof__selection_8hpp}{}\label{dof__selection_8hpp}\index{src/include/serif/backend/mfem/discretization/dof\_selection.hpp@{src/include/serif/backend/mfem/discretization/dof\_selection.hpp}}
|
|
|
|
|
|
This file contains the Dof\+Selection which allows for the selection of a subset of DOFs from a term binding, with boundary attribute information.
|
|
|
|
|
|
{\ttfamily \#include "{}serif/backend/mfem/discretization/term\+\_\+binding.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/discretization/dof\+\_\+map.\+hpp"{}}\newline
|
|
Include dependency graph for dof\+\_\+selection.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{dof__selection_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]{dof__selection_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
class \mbox{\hyperlink{classserif_1_1discretization_1_1backend_1_1mfem_1_1_dof_selection}{serif\+::discretization\+::backend\+::mfem\+::\+Dof\+Selection}}
|
|
\begin{DoxyCompactList}\small\item\em A selection of supported DOFs from a term binding, with boundary attribute information. The purpose here is to allow for the selection of a subset of DOFs from a term binding, such as those associated with a particular boundary, while still retaining the ability to validate the selection against the underlying mesh and term binding. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1discretization}{serif\+::discretization}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1backend}{serif\+::discretization\+::backend}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1backend_1_1mfem}{serif\+::discretization\+::backend\+::mfem}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$domain\+::\+Is\+Boundary BoundaryT, blocks\+::\+Spatial\+Term TermT, domain\+::schema\+::\+Is\+Schema SchemaT$>$ }\\\mbox{\hyperlink{classserif_1_1discretization_1_1backend_1_1mfem_1_1_dof_selection}{Dof\+Selection}} \mbox{\hyperlink{namespaceserif_1_1discretization_1_1backend_1_1mfem_a769f048c919ab4a1150d41ff28f24920}{serif\+::discretization\+::backend\+::mfem\+::select\+\_\+boundary\+\_\+dofs}} (const \mbox{\hyperlink{classserif_1_1discretization_1_1backend_1_1mfem_1_1_term_binding}{Term\+Binding}}$<$ TermT, SchemaT $>$ \&binding)
|
|
\begin{DoxyCompactList}\small\item\em Select DOFs associated with a particular boundary from a term binding. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
This file contains the Dof\+Selection which allows for the selection of a subset of DOFs from a term binding, with boundary attribute information.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|