68 lines
2.0 KiB
Groff
68 lines
2.0 KiB
Groff
|
|
.TH "src/include/serif/discretization/domain/ids/domain.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
src/include/serif/discretization/domain/ids/domain.hpp \- This file defines the DomainID type, which is used to bind a semantic volume (a Domain) to the integer element attribute MFEM stores in the mesh file\&.
|
||
|
|
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
\fR#include <string_view>\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/discretization/domain/concepts\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
|
||
|
|
.SS "Classes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::discretization::domain::ids::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::ids::DomainDescriptor\fP"
|
||
|
|
.br
|
||
|
|
.RI "The \fBDomainDescriptor\fP struct is a runtime representation of a domain, containing its name and integer attribute ID\&. This is used to project compile-time \fBDomainID\fP types into runtime values\&. "
|
||
|
|
.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::ids\fP"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SH "Detailed Description"
|
||
|
|
.PP
|
||
|
|
This file defines the DomainID type, which is used to bind a semantic volume (a Domain) to the integer element attribute MFEM stores in the mesh file\&.
|
||
|
|
|
||
|
|
|
||
|
|
.PP
|
||
|
|
\fBAuthor\fP
|
||
|
|
.RS 4
|
||
|
|
Emily M\&. Boudreaux
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
For example, the following code defines a DomainID that associates the CoreDomain with the integer attribute 1 in the mesh file:
|
||
|
|
|
||
|
|
.PP
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
DomainID<CoreDomain, 1> coreDomainID;
|
||
|
|
.fi
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Read this as "elements with attribute 1 are the core"\&.
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|