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)
51 lines
2.4 KiB
TeX
51 lines
2.4 KiB
TeX
\doxysection{src/include/serif/backend/mfem/mapping/compactification/compactification.hpp File Reference}
|
|
\hypertarget{compactification_8hpp}{}\label{compactification_8hpp}\index{src/include/serif/backend/mfem/mapping/compactification/compactification.hpp@{src/include/serif/backend/mfem/mapping/compactification/compactification.hpp}}
|
|
|
|
|
|
File containing the definition of the Exterior\+Domain\+Map interface, which is used to define the mapping from reference coordinates to physical coordinates in the exterior domain.
|
|
|
|
|
|
{\ttfamily \#include $<$string\+\_\+view$>$}\newline
|
|
{\ttfamily \#include $<$memory$>$}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/mapping/status.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/mapping/compactification/input\+\_\+result.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/mapping/compactification/variation.\+hpp"{}}\newline
|
|
Include dependency graph for compactification.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{compactification_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]{compactification_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
class \mbox{\hyperlink{classserif_1_1mapping_1_1compactification_1_1_exterior_domain_map}{serif\+::mapping\+::compactification\+::\+Exterior\+Domain\+Map}}
|
|
\begin{DoxyCompactList}\small\item\em Abstract interface for some mapping from reference coordinates to physical coordinates in the exterior domain. Currently the only concrete implementation of this is the kelvin compactification. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1mapping}{serif\+::mapping}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1mapping_1_1compactification}{serif\+::mapping\+::compactification}}
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
File containing the definition of the Exterior\+Domain\+Map interface, which is used to define the mapping from reference coordinates to physical coordinates in the exterior domain.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|