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)
61 lines
5.9 KiB
TeX
61 lines
5.9 KiB
TeX
\doxysection{src/include/serif/utils/projection/backend/mfem/radial.hpp File Reference}
|
|
\hypertarget{backend_2mfem_2radial_8hpp}{}\label{backend_2mfem_2radial_8hpp}\index{src/include/serif/utils/projection/backend/mfem/radial.hpp@{src/include/serif/utils/projection/backend/mfem/radial.hpp}}
|
|
{\ttfamily \#include $<$array$>$}\newline
|
|
{\ttfamily \#include $<$expected$>$}\newline
|
|
{\ttfamily \#include $<$functional$>$}\newline
|
|
{\ttfamily \#include $<$string$>$}\newline
|
|
{\ttfamily \#include "{}mfem/fem/gridfunc.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/projection/radial.\+hpp"{}}\newline
|
|
Include dependency graph for radial.\+hpp\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{backend_2mfem_2radial_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_2radial_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1utils_1_1projection_1_1backend_1_1mfem_1_1_radial_projection_options}{serif\+::utils\+::projection\+::backend\+::mfem\+::\+Radial\+Projection\+Options}}
|
|
\begin{DoxyCompactList}\small\item\em Sample physical radii about a center, optionally through SERiF\textquotesingle{}s existing geometry mapping. The mapping must use the projection space\textquotesingle{}s mesh and must be refreshed after its input fields change. \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_1utils}{serif\+::utils}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1utils_1_1projection}{serif\+::utils\+::projection}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1utils_1_1projection_1_1backend}{serif\+::utils\+::projection\+::backend}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem}{serif\+::utils\+::projection\+::backend\+::mfem}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_1_1detail}{serif\+::utils\+::projection\+::backend\+::mfem\+::detail}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Typedefs}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_a1c5d8756e8611ea09e6cab5dd2ef69f0}{serif\+::utils\+::projection\+::backend\+::mfem\+::\+Projection\+Result}} = std\+::expected$<$\+::mfem\+::\+Grid\+Function, std\+::string$>$
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_a1c5d8756e8611ea09e6cab5dd2ef69f0}{Projection\+Result}} \mbox{\hyperlink{namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_1_1detail_a4fdd9524c9c445deaeb098443c5dfd79}{serif\+::utils\+::projection\+::backend\+::mfem\+::detail\+::project\+\_\+scalar}} (\+::mfem\+::\+Finite\+Element\+Space \&space, const std\+::function$<$ \mbox{\hyperlink{namespaceserif_1_1utils_1_1projection_a99762ff1a5fff68c72feccd85e3976b5}{Radial\+Value}}(double)$>$ \&profile, const \mbox{\hyperlink{structserif_1_1utils_1_1projection_1_1backend_1_1mfem_1_1_radial_projection_options}{Radial\+Projection\+Options}} \&options)
|
|
\begin{DoxyCompactList}\small\item\em Implement scalar projection once for all checked radial profile types. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_a1c5d8756e8611ea09e6cab5dd2ef69f0}{Projection\+Result}} \mbox{\hyperlink{namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_1_1detail_a25ea05cf65248e096bc22ea1e6003ffb}{serif\+::utils\+::projection\+::backend\+::mfem\+::detail\+::project\+\_\+vector}} (\+::mfem\+::\+Finite\+Element\+Space \&space, const std\+::function$<$ \mbox{\hyperlink{namespaceserif_1_1utils_1_1projection_a99762ff1a5fff68c72feccd85e3976b5}{Radial\+Value}}(double)$>$ \&radial\+\_\+amplitude, const \mbox{\hyperlink{structserif_1_1utils_1_1projection_1_1backend_1_1mfem_1_1_radial_projection_options}{Radial\+Projection\+Options}} \&options)
|
|
\begin{DoxyCompactList}\small\item\em Implement vector projection once, including the physical-\/to-\/reference H(div) pullback. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Radial\+Function Function$>$ }\\\mbox{\hyperlink{namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_a1c5d8756e8611ea09e6cab5dd2ef69f0}{Projection\+Result}} \mbox{\hyperlink{namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_ae1cf810eb1d200398cab121763e6bb1f}{serif\+::utils\+::projection\+::backend\+::mfem\+::project\+\_\+scalar}} (\+::mfem\+::\+Finite\+Element\+Space \&space, const Function \&profile, const \mbox{\hyperlink{structserif_1_1utils_1_1projection_1_1backend_1_1mfem_1_1_radial_projection_options}{Radial\+Projection\+Options}} \&options=\{\})
|
|
\begin{DoxyCompactList}\small\item\em Project a radial scalar with the finite element\textquotesingle{}s native coefficient projection. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Radial\+Function Function$>$ }\\\mbox{\hyperlink{namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_a1c5d8756e8611ea09e6cab5dd2ef69f0}{Projection\+Result}} \mbox{\hyperlink{namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_ab646c4bfdd5381fd0bbc83b61537cb7e}{serif\+::utils\+::projection\+::backend\+::mfem\+::project\+\_\+vector}} (\+::mfem\+::\+Finite\+Element\+Space \&space, const Function \&radial\+\_\+amplitude, const \mbox{\hyperlink{structserif_1_1utils_1_1projection_1_1backend_1_1mfem_1_1_radial_projection_options}{Radial\+Projection\+Options}} \&options=\{\})
|
|
\begin{DoxyCompactList}\small\item\em Project amplitude(r) times the outward radial unit vector into a vector or H(div) space. \end{DoxyCompactList}\end{DoxyCompactItemize}
|