.TH "src/include/serif/discretization/domain/schema/domain_schema.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/discretization/domain/schema/domain_schema.hpp \- File containing the DomainSchema class\&. The idea here is to prevent a class of bugs wherein the user or developer things that their mesh is valid but there is some subtle difference between their mesh and what we expect\&. DomainSchema lets us define the particular traits a mesh must have to be valid (e\&.g\&. must have a particular set of domain and boundary IDs, those must correspond to a particular set of topological relations)\&. Then the first things that happens when a mesh is loaded is that it is validated against this schema\&.  

.SH SYNOPSIS
.br
.PP
\fR#include <cstddef>\fP
.br
\fR#include 'serif/discretization/domain/concepts\&.hpp'\fP
.br
\fR#include 'serif/discretization/domain/ids/lists/concepts\&.hpp'\fP
.br
\fR#include 'serif/discretization/domain/relation/lists/concepts\&.hpp'\fP
.br
\fR#include 'serif/discretization/domain/relation/validation/concepts\&.hpp'\fP
.br
\fR#include 'serif/discretization/domain/resolver\&.hpp'\fP
.br

.SS "Classes"

.in +1c
.ti -1c
.RI "struct \fBserif::discretization::domain::schema::DomainSchema< DomainIDs, BoundaryIDs, Relations >\fP"
.br
.RI "A \fBDomainSchema\fP is a collection of relations that describe the relationships between domains and boundaries in a mesh\&. It is used to validate that a mesh has the expected set of domains and boundaries, and that those domains and boundaries have the expected topological relations\&. This is important for ensuring that the mesh is suitable for the intended simulation or analysis\&. There is one primary schema we define for SERiF, that is three domains (core, envelope, and vacuum) and two boundaries (stellar surface and infinity surface)\&. See \fBschemas\&.hpp\fP for more information on this schema\&. "
.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
.in -1c
.SH "Detailed Description"
.PP 
File containing the DomainSchema class\&. The idea here is to prevent a class of bugs wherein the user or developer things that their mesh is valid but there is some subtle difference between their mesh and what we expect\&. DomainSchema lets us define the particular traits a mesh must have to be valid (e\&.g\&. must have a particular set of domain and boundary IDs, those must correspond to a particular set of topological relations)\&. Then the first things that happens when a mesh is loaded is that it is validated against this schema\&. 


.PP
\fBAuthor\fP
.RS 4
Emily M\&. Boudreaux
.RE
.PP

.PP
If you wish to extend the set of relations that can be validated or introduce a new more complex kind of mesh that SERiF can use you will likely want to start here or in adjacent files\&. 
.SH "Author"
.PP 
Generated automatically by Doxygen for SERiF from the source code\&.