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)
62 lines
3.3 KiB
TeX
62 lines
3.3 KiB
TeX
\doxysection{src/include/serif/discretization/domain/ids/boundary.hpp File Reference}
|
|
\hypertarget{ids_2boundary_8hpp}{}\label{ids_2boundary_8hpp}\index{src/include/serif/discretization/domain/ids/boundary.hpp@{src/include/serif/discretization/domain/ids/boundary.hpp}}
|
|
|
|
|
|
This file defines the Boundary\+ID type, which is used to bind a semantic surface (a Boundary) to the integer boundary attribute MFEM stores in the mesh file.
|
|
|
|
|
|
{\ttfamily \#include $<$string\+\_\+view$>$}\newline
|
|
{\ttfamily \#include "{}serif/discretization/domain/concepts.\+hpp"{}}\newline
|
|
Include dependency graph for boundary.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{ids_2boundary_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]{ids_2boundary_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1ids_1_1_boundary_i_d}{serif\+::discretization\+::domain\+::ids\+::\+Boundary\+ID$<$ Boundary\+T, Identifier\+Value $>$}}
|
|
\begin{DoxyCompactList}\small\item\em The \doxylink{structserif_1_1discretization_1_1domain_1_1ids_1_1_boundary_i_d}{Boundary\+ID} struct is a compile-\/time type that associates a semantic boundary (a \doxylink{structserif_1_1discretization_1_1domain_1_1_boundary}{Boundary}) with an integer attribute in the mesh file. This allows the discretization framework to identify which boundary elements in the mesh correspond to which semantic boundaries in the simulation. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1ids_1_1_boundary_descriptor}{serif\+::discretization\+::domain\+::ids\+::\+Boundary\+Descriptor}}
|
|
\begin{DoxyCompactList}\small\item\em The \doxylink{structserif_1_1discretization_1_1domain_1_1ids_1_1_boundary_descriptor}{Boundary\+Descriptor} struct is a runtime representation of a boundary, containing its name and integer attribute ID. This is used to project compile-\/time \doxylink{structserif_1_1discretization_1_1domain_1_1ids_1_1_boundary_i_d}{Boundary\+ID} types into runtime values. \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_1domain}{serif\+::discretization\+::domain}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1ids}{serif\+::discretization\+::domain\+::ids}}
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
This file defines the Boundary\+ID type, which is used to bind a semantic surface (a Boundary) to the integer boundary attribute MFEM stores in the mesh file.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|
|
For example, the following code defines a Boundary\+ID that associates the Stellar\+Surface\+Boundary with the integer attribute 1 in the mesh file\+:
|
|
|
|
|
|
\begin{DoxyCode}{0}
|
|
\DoxyCodeLine{BoundaryID<StellarSurfaceBoundary,\ 1>\ stellarSurfaceBoundaryID;}
|
|
|
|
\end{DoxyCode}
|
|
|
|
|
|
Read this as "{}boundary elements with attribute 1 are the stellar surface"{}.
|