89 lines
3.2 KiB
Groff
89 lines
3.2 KiB
Groff
|
|
.TH "src/include/serif/discretization/domain/schema/validation/boundary.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
src/include/serif/discretization/domain/schema/validation/boundary.hpp \- File containing the specialization of RelationValidator for \fBDomainBoundary\fP relations\&. This relation enforces that a boundary element is adjacent to exactly one or two volume elements\&.
|
||
|
|
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
\fR#include <optional>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <tuple>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <vector>\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/discretization/domain/concepts\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/discretization/domain/mesh/topology\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/discretization/domain/relation/relations\&.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/validator\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/utils/error/errors\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
|
||
|
|
.SS "Classes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::discretization::domain::schema::validation::RelationValidator< DomainBoundary< BoundaryT, DomainTs\&.\&.\&. > >\fP"
|
||
|
|
.br
|
||
|
|
.RI "Specialization of \fBRelationValidator\fP for \fBDomainBoundary\fP relations\&. This relation enforces that a boundary element is adjacent to exactly one or two volume elements\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::discretization::domain::schema::validation::DomainBoundary< BoundaryT, DomainTs >\fP"
|
||
|
|
.br
|
||
|
|
.RI "Compile time type representing the domain boundary relation between a boundary and one or two domains\&. This relation states that the boundary is exactly the surface between the specified domains\&. We enforce here that the size of the DomainTs pack is either one or two, as a boundary can only be associated with one or two domains\&. If it is one domain then the boundary is the surface of that domain, if it is two domains then the boundary is the interface between those two domains\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::discretization::domain::schema::validation::RelationValidationResult\fP"
|
||
|
|
.br
|
||
|
|
.RI "Struct representing the result of validating a relation in the domain module\&. It contains information about the validation failure, if any, and optional diagnostics for specific relation types\&. "
|
||
|
|
.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
|
||
|
|
.SS "Enumerations"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "enum class \fBserif::discretization::domain::schema::validation::RelationValidationFailure\fP "
|
||
|
|
.br
|
||
|
|
.RI "Enum representing the types of validation failures that can occur when validating relations in the domain module\&. "
|
||
|
|
.in -1c
|
||
|
|
.SH "Detailed Description"
|
||
|
|
.PP
|
||
|
|
File containing the specialization of RelationValidator for \fBDomainBoundary\fP relations\&. This relation enforces that a boundary element is adjacent to exactly one or two volume elements\&.
|
||
|
|
|
||
|
|
|
||
|
|
.PP
|
||
|
|
\fBAuthor\fP
|
||
|
|
.RS 4
|
||
|
|
Emily M\&. Boudreaux
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|