Files
MeanField_SERiF/docs/latex/dof__map_8hpp.tex

59 lines
3.7 KiB
TeX
Raw Normal View History

\doxysection{src/include/serif/backend/mfem/discretization/dof\+\_\+map.hpp File Reference}
\hypertarget{dof__map_8hpp}{}\label{dof__map_8hpp}\index{src/include/serif/backend/mfem/discretization/dof\_map.hpp@{src/include/serif/backend/mfem/discretization/dof\_map.hpp}}
This file contains the Dof\+Map which allows for the full dof vector to be projected into a reduced space of dofs on supported elements for some field Generally, while much of the code here may be exercised, you will rarely see a Dof\+Map be directly invoked. Rather, these are generally implicitly constructed through their child class term\+\_\+binding.
{\ttfamily \#include $<$cmath$>$}\newline
{\ttfamily \#include $<$optional$>$}\newline
{\ttfamily \#include $<$memory$>$}\newline
{\ttfamily \#include "{}serif/backend/mfem/discretization/reconstruction.\+hpp"{}}\newline
{\ttfamily \#include $<$stdexcept$>$}\newline
{\ttfamily \#include "{}mfem/fem/fespace.\+hpp"{}}\newline
{\ttfamily \#include "{}mfem/fem/pfespace.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/utils/error/errors.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/utils/error/nonfinite.\+hpp"{}}\newline
Include dependency graph for dof\+\_\+map.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{dof__map_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__map_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_map}{serif\+::discretization\+::backend\+::mfem\+::\+Dof\+Map}}
\begin{DoxyCompactList}\small\item\em A mapping from a full MFEM finite-\/element space to a reduced set of DOFs that are supporter by the given element support. That is to say that if one has some set of dofs D (perhaps it looks like \mbox{[}0, 1, 2, 3, 4\mbox{]} as a hypothetical) and dofs 0, 2, and 4 are associated to domain A while 1 and 3 are associated to domain B. Then if one were to construct a \doxylink{classserif_1_1discretization_1_1backend_1_1mfem_1_1_dof_map}{Dof\+Map} with element support \mbox{[}1, 0, 1, 0, 1\mbox{]} (where 1 indicates that the element is supported and 0 indicates that it is not) then the reduced dof map would be \mbox{[}0, 2, 4\mbox{]} and the full to reduced map would be \mbox{[}-\/1, -\/1, 0, -\/1, 1\mbox{]}. \end{DoxyCompactList}\item
class \mbox{\hyperlink{classserif_1_1discretization_1_1backend_1_1mfem_1_1_dof_map_1_1_elements}{serif\+::discretization\+::backend\+::mfem\+::\+Dof\+Map\+::\+Elements}}
\begin{DoxyCompactList}\small\item\em Borrow element access for one traversal after checking the complete 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}
\doxysubsection{Detailed Description}
This file contains the Dof\+Map which allows for the full dof vector to be projected into a reduced space of dofs on supported elements for some field Generally, while much of the code here may be exercised, you will rarely see a Dof\+Map be directly invoked. Rather, these are generally implicitly constructed through their child class term\+\_\+binding.
\begin{DoxyAuthor}{Author}
Emily M. Boudreaux
\end{DoxyAuthor}