Files
MeanField_SERiF/docs/latex/context_8hpp.tex

61 lines
3.5 KiB
TeX
Raw Normal View History

\doxysection{src/include/serif/backend/mfem/mapping/context.hpp File Reference}
\hypertarget{context_8hpp}{}\label{context_8hpp}\index{src/include/serif/backend/mfem/mapping/context.hpp@{src/include/serif/backend/mfem/mapping/context.hpp}}
File containing the mapping context structures for volume and face mappings.
{\ttfamily \#include "{}mfem/linalg/densemat.\+hpp"{}}\newline
{\ttfamily \#include "{}mfem/linalg/vector.\+hpp"{}}\newline
Include dependency graph for context.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=344pt]{context_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]{context_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1mapping_1_1_volume_quadrature_context}{serif\+::mapping\+::\+Volume\+Quadrature\+Context}}
\begin{DoxyCompactList}\small\item\em A structure representing the context of a volume quadrature point, including the inverse Jacobian of the mapping and the determinant of the mapping. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1mapping_1_1_face_quadrature_context}{serif\+::mapping\+::\+Face\+Quadrature\+Context}}
\begin{DoxyCompactList}\small\item\em A structure representing the context of a face quadrature point, including the normal vector, surface weight, and scale factor for the dot product of the velocity and normal vector. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1mapping_1_1_mapping_point_context}{serif\+::mapping\+::\+Mapping\+Point\+Context}}
\begin{DoxyCompactList}\small\item\em A structure representing the context of a mapping point, including the reference position, displaced position, physical position, displacement Jacobian, mapping Jacobian, inverse mapping Jacobian, mapping determinant, and compactification status. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1mapping_1_1_volume_mapping_context}{serif\+::mapping\+::\+Volume\+Mapping\+Context}}
\begin{DoxyCompactList}\small\item\em A structure representing the context of a volume mapping, including the mapping point context and volume quadrature context. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1mapping_1_1_face_mapping_context}{serif\+::mapping\+::\+Face\+Mapping\+Context}}
\begin{DoxyCompactList}\small\item\em A structure representing the context of a face mapping, including the mapping point context and face quadrature context. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1mapping}{serif\+::mapping}}
\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
File containing the mapping context structures for volume and face mappings.
\begin{DoxyAuthor}{Author}
Emily M. Boudreaux
\end{DoxyAuthor}
\begin{DoxyRefDesc}{Todo}
\item[\mbox{\hyperlink{todo__todo000007}{Todo}}]Like a lot of the parts of the mapping module written before I started factoring mfem stuff into backend modules, a good amount of this might be movable to some mfem backend\end{DoxyRefDesc}
All of these different "{}context"{} structures are built to contain sufficient information that the caller which gets one of these back can evaluate the mapping and its derivatives properly at some point.