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)
53 lines
2.8 KiB
TeX
53 lines
2.8 KiB
TeX
\doxysection{src/include/serif/backend/mfem/mapping/compactification/kelvin.hpp File Reference}
|
|
\hypertarget{backend_2mfem_2mapping_2compactification_2kelvin_8hpp}{}\label{backend_2mfem_2mapping_2compactification_2kelvin_8hpp}\index{src/include/serif/backend/mfem/mapping/compactification/kelvin.hpp@{src/include/serif/backend/mfem/mapping/compactification/kelvin.hpp}}
|
|
|
|
|
|
File containing the definition of the Kelvin\+Compactification class, which is a concrete implementation of the Exterior\+Domain\+Map interface for the Kelvin compactification.
|
|
|
|
|
|
{\ttfamily \#include $<$string\+\_\+view$>$}\newline
|
|
{\ttfamily \#include "{}mfem/linalg/vector.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/mapping/status.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/mapping/compactification/compactification.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/user\+\_\+options/mapping/compactification/kelvin.\+hpp"{}}\newline
|
|
Include dependency graph for kelvin.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{backend_2mfem_2mapping_2compactification_2kelvin_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]{backend_2mfem_2mapping_2compactification_2kelvin_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
class \mbox{\hyperlink{classserif_1_1mapping_1_1compactification_1_1_kelvin_compactification}{serif\+::mapping\+::compactification\+::\+Kelvin\+Compactification}}
|
|
\begin{DoxyCompactList}\small\item\em Concrete implementation of the \doxylink{classserif_1_1mapping_1_1compactification_1_1_exterior_domain_map}{Exterior\+Domain\+Map} interface for the Kelvin compactification. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1mapping_1_1compactification_1_1_kelvin_compactification_1_1_radial_factors}{serif\+::mapping\+::compactification\+::\+Kelvin\+Compactification\+::\+Radial\+Factors}}
|
|
\begin{DoxyCompactList}\small\item\em A struct to hold the radial factors for the Kelvin compactification mapping. \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 Kelvin\+Compactification class, which is a concrete implementation of the Exterior\+Domain\+Map interface for the Kelvin compactification.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|