Files
MeanField_SERiF/docs/man/man3/connected.hpp.3

83 lines
2.7 KiB
Groff
Raw Normal View History

.TH "src/include/serif/discretization/domain/schema/validation/connected.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/discretization/domain/schema/validation/connected.hpp \- File containing the specialization of RelationValidator for \fBFullyConnected\fP relations\&. This relation enforces that a domain is fully connected, meaning that all elements of the domain are reachable from any other element of the domain\&.
.SH SYNOPSIS
.br
.PP
\fR#include <cstddef>\fP
.br
\fR#include <optional>\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
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBserif::discretization::domain::schema::validation::RelationValidator< FullyConnected< DomainT > >\fP"
.br
.RI "Specialization of \fBRelationValidator\fP for \fBFullyConnected\fP relations\&. This relation enforces that a domain is fully connected, meaning that all elements of the domain are reachable from any other element of the domain\&. "
.ti -1c
.RI "struct \fBserif::discretization::domain::schema::validation::FullyConnected< A >\fP"
.br
.RI "Compile time type representing the fully connected relation for a domain or set\&. This relation states that the domain is a single connected blob of elements, not two separate pieces\&. "
.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 \fBFullyConnected\fP relations\&. This relation enforces that a domain is fully connected, meaning that all elements of the domain are reachable from any other element of the domain\&.
.PP
\fBAuthor\fP
.RS 4
Emily M\&. Boudreaux
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.