Files
MeanField_SERiF/docs/latex/domain_8hpp.tex

62 lines
3.2 KiB
TeX
Raw Normal View History

\doxysection{src/include/serif/discretization/domain/ids/domain.hpp File Reference}
\hypertarget{domain_8hpp}{}\label{domain_8hpp}\index{src/include/serif/discretization/domain/ids/domain.hpp@{src/include/serif/discretization/domain/ids/domain.hpp}}
This file defines the Domain\+ID type, which is used to bind a semantic volume (a Domain) to the integer element attribute MFEM stores in the mesh file.
{\ttfamily \#include $<$string\+\_\+view$>$}\newline
{\ttfamily \#include "{}serif/discretization/domain/concepts.\+hpp"{}}\newline
Include dependency graph for domain.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{domain_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]{domain_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1ids_1_1_domain_i_d}{serif\+::discretization\+::domain\+::ids\+::\+Domain\+ID$<$ Domain\+T, Identifier\+Value $>$}}
\begin{DoxyCompactList}\small\item\em The \doxylink{structserif_1_1discretization_1_1domain_1_1ids_1_1_domain_i_d}{Domain\+ID} struct is a compile-\/time type that associates a semantic domain (a \doxylink{structserif_1_1discretization_1_1domain_1_1_domain}{Domain}) with an integer attribute in the mesh file. This allows the discretization framework to identify which elements in the mesh correspond to which semantic domains in the simulation. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1ids_1_1_domain_descriptor}{serif\+::discretization\+::domain\+::ids\+::\+Domain\+Descriptor}}
\begin{DoxyCompactList}\small\item\em The \doxylink{structserif_1_1discretization_1_1domain_1_1ids_1_1_domain_descriptor}{Domain\+Descriptor} struct is a runtime representation of a domain, containing its name and integer attribute ID. This is used to project compile-\/time \doxylink{structserif_1_1discretization_1_1domain_1_1ids_1_1_domain_i_d}{Domain\+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 Domain\+ID type, which is used to bind a semantic volume (a Domain) to the integer element attribute MFEM stores in the mesh file.
\begin{DoxyAuthor}{Author}
Emily M. Boudreaux
\end{DoxyAuthor}
For example, the following code defines a Domain\+ID that associates the Core\+Domain with the integer attribute 1 in the mesh file\+:
\begin{DoxyCode}{0}
\DoxyCodeLine{DomainID<CoreDomain,\ 1>\ coreDomainID;}
\end{DoxyCode}
Read this as "{}elements with attribute 1 are the core"{}.