Files
MeanField_SERiF/docs/latex/schemas_8hpp.tex

69 lines
5.1 KiB
TeX
Raw Normal View History

\doxysection{src/include/serif/discretization/domain/schema/schemas.hpp File Reference}
\hypertarget{schemas_8hpp}{}\label{schemas_8hpp}\index{src/include/serif/discretization/domain/schema/schemas.hpp@{src/include/serif/discretization/domain/schema/schemas.hpp}}
File containing the primary domain schema for SERiF. This is a three-\/domain, two-\/boundary schema that is used to validate meshes that are loaded into SERiF.
{\ttfamily \#include "{}serif/discretization/domain/ids/boundary.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/ids/domain.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/ids/lists/lists.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/physical\+\_\+domains.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/relation/lists/relation\+\_\+list.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/relation/relations.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/schema/domain\+\_\+schema.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/types.\+hpp"{}}\newline
Include dependency graph for schemas.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{schemas_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]{schemas_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1schema_1_1_domain_i_d}{serif\+::discretization\+::domain\+::schema\+::\+Domain\+ID$<$ Domain\+T, Identifier\+Value $>$}}
\begin{DoxyCompactList}\small\item\em The \doxylink{structserif_1_1discretization_1_1domain_1_1schema_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_1schema_1_1_boundary_i_d}{serif\+::discretization\+::domain\+::schema\+::\+Boundary\+ID$<$ Boundary\+T, Identifier\+Value $>$}}
\begin{DoxyCompactList}\small\item\em The \doxylink{structserif_1_1discretization_1_1domain_1_1schema_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_1schema_1_1_domain_i_d_list}{serif\+::discretization\+::domain\+::schema\+::\+Domain\+IDList$<$ Domain\+IDTs $>$}}
\begin{DoxyCompactList}\small\item\em A list of domain IDs in the discretization framework. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1schema_1_1_boundary_i_d_list}{serif\+::discretization\+::domain\+::schema\+::\+Boundary\+IDList$<$ Boundary\+IDTs $>$}}
\begin{DoxyCompactList}\small\item\em A list of boundary IDs in the discretization framework. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1schema_1_1_relation_list}{serif\+::discretization\+::domain\+::schema\+::\+Relation\+List$<$ Relation\+Ts $>$}}
\begin{DoxyCompactList}\small\item\em Compile-\/time list of relations, used to group relations together for operations and forms. This struct is a variadic template that takes a list of relation types as template parameters. \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_1schema}{serif\+::discretization\+::domain\+::schema}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Typedefs}
\begin{DoxyCompactItemize}
\item
using \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1schema_abc22bc3b4f40b417480a061162a3dea2}{serif\+::discretization\+::domain\+::schema\+::\+Core\+Envelope\+Vacuum\+Domain\+Schema}}
\begin{DoxyCompactList}\small\item\em The primary domain schema for SERiF. This is a three-\/domain, two-\/boundary schema that is used to validate meshes that are loaded into SERiF. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
File containing the primary domain schema for SERiF. This is a three-\/domain, two-\/boundary schema that is used to validate meshes that are loaded into SERiF.
\begin{DoxyAuthor}{Author}
Emily M. Boudreaux
\end{DoxyAuthor}