Files
MeanField_SERiF/docs/latex/inscribed_8hpp.tex

64 lines
4.4 KiB
TeX
Raw Normal View History

\doxysection{src/include/serif/discretization/domain/schema/validation/inscribed.hpp File Reference}
\hypertarget{inscribed_8hpp}{}\label{inscribed_8hpp}\index{src/include/serif/discretization/domain/schema/validation/inscribed.hpp@{src/include/serif/discretization/domain/schema/validation/inscribed.hpp}}
File containing the specialization of Relation\+Validator for \doxylink{structserif_1_1discretization_1_1domain_1_1schema_1_1validation_1_1_inscribed}{Inscribed} relations. This relation enforces that an inner domain is inscribed within an outer domain, meaning that every face where the inner domain stops must have the outer domain on the far side.
{\ttfamily \#include $<$optional$>$}\newline
{\ttfamily \#include "{}serif/discretization/domain/concepts.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/mesh/topology.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/relation/relations.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/relation/validation/runtime.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/schema/concepts.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/schema/validation/validator.\+hpp"{}}\newline
Include dependency graph for inscribed.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{inscribed_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]{inscribed_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1schema_1_1validation_1_1_relation_validator_3_01_insc87246cae09a24ecef7193954743e1de0}{serif\+::discretization\+::domain\+::schema\+::validation\+::\+Relation\+Validator$<$ Inscribed$<$ Inner\+T, Outer\+T $>$ $>$}}
\begin{DoxyCompactList}\small\item\em Specialization of \doxylink{structserif_1_1discretization_1_1domain_1_1schema_1_1validation_1_1_relation_validator}{Relation\+Validator} for \doxylink{structserif_1_1discretization_1_1domain_1_1schema_1_1validation_1_1_inscribed}{Inscribed} relations. This relation enforces that an inner domain is inscribed within an outer domain, meaning that every face where the inner domain stops must have the outer domain on the far side. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1schema_1_1validation_1_1_inscribed}{serif\+::discretization\+::domain\+::schema\+::validation\+::\+Inscribed$<$ A, B $>$}}
\begin{DoxyCompactList}\small\item\em Compile time type representing the inscribed relation between two domains or sets. This relation states that every face of the inner domain (A) that is not interior to A borders the outer domain (B). \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}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1schema_1_1validation}{serif\+::discretization\+::domain\+::schema\+::validation}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Enumerations}
\begin{DoxyCompactItemize}
\item
enum class \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1schema_1_1validation_afb547c803b70b3013bc47f86612b950f}{serif\+::discretization\+::domain\+::schema\+::validation\+::\+Relation\+Validation\+Failure}}
\begin{DoxyCompactList}\small\item\em Enum representing the types of validation failures that can occur when validating relations in the domain module. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
File containing the specialization of Relation\+Validator for \doxylink{structserif_1_1discretization_1_1domain_1_1schema_1_1validation_1_1_inscribed}{Inscribed} relations. This relation enforces that an inner domain is inscribed within an outer domain, meaning that every face where the inner domain stops must have the outer domain on the far side.
\begin{DoxyAuthor}{Author}
Emily M. Boudreaux
\end{DoxyAuthor}