Files
MeanField_SERiF/docs/latex/validator_8hpp.tex

62 lines
3.6 KiB
TeX
Raw Normal View History

\doxysection{src/include/serif/discretization/domain/schema/validation/validator.hpp File Reference}
\hypertarget{validator_8hpp}{}\label{validator_8hpp}\index{src/include/serif/discretization/domain/schema/validation/validator.hpp@{src/include/serif/discretization/domain/schema/validation/validator.hpp}}
File containing the primary Relation\+Validator template, plus the fold that runs one validator per declared relation.
{\ttfamily \#include $<$cstddef$>$}\newline
{\ttfamily \#include "{}serif/discretization/domain/mesh/topology.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/relation/concepts.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/relation/lists/relation\+\_\+list.\+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/results.\+hpp"{}}\newline
Include dependency graph for validator.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{validator_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]{validator_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_schema_relation_validator_3_afe765ce6c914acbe31dc8ccf4607d13}{serif\+::discretization\+::domain\+::schema\+::validation\+::\+Schema\+Relation\+Validator$<$ Schema\+T, relation\+::lists\+::\+Relation\+List$<$ Relation\+Ts... $>$ $>$}}
\begin{DoxyCompactList}\small\item\em Fold that runs one validator per declared relation in a schema. This specialization is for a \doxylink{structserif_1_1discretization_1_1domain_1_1schema_1_1_relation_list}{Relation\+List} of arbitrary length. \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}
\doxysubsection{Detailed Description}
File containing the primary Relation\+Validator template, plus the fold that runs one validator per declared relation.
\begin{DoxyAuthor}{Author}
Emily M. Boudreaux
\end{DoxyAuthor}
\begin{DoxyNote}{Note}
Every relation kind is validated by an explicit specialization of Relation\+Validator, and those specializations live in sibling headers (\doxylink{inscribed_8hpp}{inscribed.\+hpp}, \doxylink{connected_8hpp}{connected.\+hpp}, boundary.\+hpp). Under headers, instantiating Schema\+Relation\+Validator in a translation unit that has not yet seen all of those specializations is ill-\/formed with no diagnostic required. That is why validate\+\_\+schema lives in \doxylink{all_8hpp}{all.\+hpp}, which includes this header and every specialization. Include \doxylink{all_8hpp}{all.\+hpp}, not this header, to validate a mesh.
\end{DoxyNote}