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)
67 lines
1.7 KiB
Groff
67 lines
1.7 KiB
Groff
.TH "src/include/serif/discretization/domain/schema/validation/all.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/discretization/domain/schema/validation/all.hpp \- File containing validate_schema, which selects the topology validators required by the schema type\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'serif/discretization/domain/mesh/topology\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/domain/schema/concepts\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/domain/schema/validation/results\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/domain/schema/validation/validator\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/domain/schema/validation/boundary\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/domain/schema/validation/connected\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/domain/schema/validation/inscribed\&.hpp'\fP
|
|
.br
|
|
|
|
.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
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<IsSchema SchemaT> \fBSchemaValidationResult\fP \fBserif::discretization::domain::schema::validation::validate_schema\fP (const \fBmesh::MeshTopology\fP &topology)"
|
|
.br
|
|
.RI "Validate a mesh against a schema\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
File containing validate_schema, which selects the topology validators required by the schema type\&.
|
|
|
|
|
|
.PP
|
|
\fBAuthor\fP
|
|
.RS 4
|
|
Emily M\&. Boudreaux
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|