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)
74 lines
2.4 KiB
Groff
74 lines
2.4 KiB
Groff
.TH "src/include/serif/discretization/domain/schema/validation/validator.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/discretization/domain/schema/validation/validator.hpp \- File containing the primary RelationValidator template, plus the fold that runs one validator per declared relation\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <cstddef>\fP
|
|
.br
|
|
\fR#include 'serif/discretization/domain/mesh/topology\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/domain/relation/concepts\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/domain/relation/lists/relation_list\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/domain/relation/validation/runtime\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/domain/schema/concepts\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/domain/schema/validation/results\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::discretization::domain::schema::validation::SchemaRelationValidator< SchemaT, relation::lists::RelationList< RelationTs\&.\&.\&. > >\fP"
|
|
.br
|
|
.RI "Fold that runs one validator per declared relation in a schema\&. This specialization is for a \fBRelationList\fP of arbitrary length\&. "
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::discretization\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::discretization::domain\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::discretization::domain::schema\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::discretization::domain::schema::validation\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
File containing the primary RelationValidator template, plus the fold that runs one validator per declared relation\&.
|
|
|
|
|
|
.PP
|
|
\fBAuthor\fP
|
|
.RS 4
|
|
Emily M\&. Boudreaux
|
|
.RE
|
|
.PP
|
|
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
Every relation kind is validated by an explicit specialization of RelationValidator, and those specializations live in sibling headers (\fBinscribed\&.hpp\fP, \fBconnected\&.hpp\fP, boundary\&.hpp)\&. Under headers, instantiating SchemaRelationValidator 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 \fBall\&.hpp\fP, which includes this header and every specialization\&. Include \fBall\&.hpp\fP, not this header, to validate a mesh\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|