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)
65 lines
2.4 KiB
Groff
65 lines
2.4 KiB
Groff
.TH "src/include/serif/discretization/domain/resolver.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/discretization/domain/resolver.hpp \- File containing the DomainIDResolver and BoundaryIDResolver structs\&. These structs are used to resolve the domain and boundary IDs for a given domain or boundary type\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\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/ids/lists/lists\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::discretization::domain::DomainIDResolver< DomainT, ids::lists::DomainIDList< DomainIDTs\&.\&.\&. > >\fP"
|
|
.br
|
|
.RI "A specialization of the \fBDomainIDResolver\fP struct for a single \fBDomain\fP type\&. This struct is used to resolve the domain ID for a given \fBDomain\fP type\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::discretization::domain::DomainIDResolver< DomainSet< DomainTs\&.\&.\&. >, ids::lists::DomainIDList< DomainIDTs\&.\&.\&. > >\fP"
|
|
.br
|
|
.RI "A specialization of the \fBDomainIDResolver\fP struct for a \fBDomainSet\fP type\&. This struct is used to resolve the domain IDs for a given \fBDomainSet\fP type\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::discretization::domain::BoundaryIDResolver< BoundaryT, ids::lists::BoundaryIDList< BoundaryIDTs\&.\&.\&. > >\fP"
|
|
.br
|
|
.RI "A specialization of the \fBBoundaryIDResolver\fP struct for a single \fBBoundary\fP type\&. This struct is used to resolve the boundary ID for a given \fBBoundary\fP type\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::discretization::domain::BoundaryIDResolver< BoundarySet< BoundaryTs\&.\&.\&. >, ids::lists::BoundaryIDList< BoundaryIDTs\&.\&.\&. > >\fP"
|
|
.br
|
|
.RI "A specialization of the \fBBoundaryIDResolver\fP struct for a \fBBoundarySet\fP type\&. This struct is used to resolve the boundary IDs for a given \fBBoundarySet\fP type\&. "
|
|
.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
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
File containing the DomainIDResolver and BoundaryIDResolver structs\&. These structs are used to resolve the domain and boundary IDs for a given domain or boundary type\&.
|
|
|
|
|
|
.PP
|
|
\fBAuthor\fP
|
|
.RS 4
|
|
Emily M\&. Boudreaux
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|