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)
52 lines
2.5 KiB
TeX
52 lines
2.5 KiB
TeX
\doxysection{src/include/serif/discretization/domain/mesh/topology.hpp File Reference}
|
|
\hypertarget{topology_8hpp}{}\label{topology_8hpp}\index{src/include/serif/discretization/domain/mesh/topology.hpp@{src/include/serif/discretization/domain/mesh/topology.hpp}}
|
|
|
|
|
|
This file defines the Mesh\+Topology class, which provides a convenient interface for querying the topological relationships between elements, faces, and boundaries in a mesh.
|
|
|
|
|
|
{\ttfamily \#include $<$cstddef$>$}\newline
|
|
{\ttfamily \#include $<$vector$>$}\newline
|
|
Include dependency graph for topology.\+hpp\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=226pt]{topology_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]{topology_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1mesh_1_1_face_elements}{serif\+::discretization\+::domain\+::mesh\+::\+Face\+Elements}}
|
|
\begin{DoxyCompactList}\small\item\em A simple struct to hold the IDs of the two elements that share a face. If the face is a boundary face, one of the element IDs will be -\/1. \end{DoxyCompactList}\item
|
|
class \mbox{\hyperlink{classserif_1_1discretization_1_1domain_1_1mesh_1_1_mesh_topology}{serif\+::discretization\+::domain\+::mesh\+::\+Mesh\+Topology}}
|
|
\begin{DoxyCompactList}\small\item\em Provides a convenient interface for querying the topological relationships between elements, faces, and boundaries in a mesh. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespacemfem}{mfem}}
|
|
\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_1mesh}{serif\+::discretization\+::domain\+::mesh}}
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
This file defines the Mesh\+Topology class, which provides a convenient interface for querying the topological relationships between elements, faces, and boundaries in a mesh.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|