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)
90 lines
3.2 KiB
Groff
90 lines
3.2 KiB
Groff
.TH "src/include/serif/discretization/domain/schema/schemas.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/discretization/domain/schema/schemas.hpp \- File containing the primary domain schema for SERiF\&. This is a three-domain, two-boundary schema that is used to validate meshes that are loaded into SERiF\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'serif/discretization/domain/ids/boundary\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/domain/ids/domain\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/domain/ids/lists/lists\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/domain/physical_domains\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/domain/relation/lists/relation_list\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/domain/relation/relations\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/domain/schema/domain_schema\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/domain/types\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::discretization::domain::schema::DomainID< DomainT, IdentifierValue >\fP"
|
|
.br
|
|
.RI "The \fBDomainID\fP struct is a compile-time type that associates a semantic domain (a \fBDomain\fP) with an integer attribute in the mesh file\&. This allows the discretization framework to identify which elements in the mesh correspond to which semantic domains in the simulation\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::discretization::domain::schema::BoundaryID< BoundaryT, IdentifierValue >\fP"
|
|
.br
|
|
.RI "The \fBBoundaryID\fP struct is a compile-time type that associates a semantic boundary (a \fBBoundary\fP) with an integer attribute in the mesh file\&. This allows the discretization framework to identify which boundary elements in the mesh correspond to which semantic boundaries in the simulation\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::discretization::domain::schema::DomainIDList< DomainIDTs >\fP"
|
|
.br
|
|
.RI "A list of domain IDs in the discretization framework\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::discretization::domain::schema::BoundaryIDList< BoundaryIDTs >\fP"
|
|
.br
|
|
.RI "A list of boundary IDs in the discretization framework\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::discretization::domain::schema::RelationList< RelationTs >\fP"
|
|
.br
|
|
.RI "Compile-time list of relations, used to group relations together for operations and forms\&. This struct is a variadic template that takes a list of relation types as template parameters\&. "
|
|
.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
|
|
.SS "Typedefs"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBserif::discretization::domain::schema::CoreEnvelopeVacuumDomainSchema\fP"
|
|
.br
|
|
.RI "The primary domain schema for SERiF\&. This is a three-domain, two-boundary schema that is used to validate meshes that are loaded into SERiF\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
File containing the primary domain schema for SERiF\&. This is a three-domain, two-boundary schema that is used to validate meshes that are loaded into SERiF\&.
|
|
|
|
|
|
.PP
|
|
\fBAuthor\fP
|
|
.RS 4
|
|
Emily M\&. Boudreaux
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|