61 lines
2.2 KiB
Groff
61 lines
2.2 KiB
Groff
|
|
.TH "serif::discretization::domain::schema::DomainID< DomainT, IdentifierValue >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
serif::discretization::domain::schema::DomainID< DomainT, IdentifierValue > \- 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\&.
|
||
|
|
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
.PP
|
||
|
|
\fR#include <domain\&.hpp>\fP
|
||
|
|
.SS "Public Types"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBdomain_type\fP = DomainT"
|
||
|
|
.br
|
||
|
|
.RI "The semantic domain type associated with this \fBDomainID\fP\&. "
|
||
|
|
.in -1c
|
||
|
|
.SS "Static Public Attributes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "static constexpr int \fBID\fP = IdentifierValue"
|
||
|
|
.br
|
||
|
|
.RI "The integer attribute value in the mesh file that corresponds to this domain\&. "
|
||
|
|
.in -1c
|
||
|
|
.SH "Detailed Description"
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SS "template<IsDomain DomainT, int IdentifierValue>
|
||
|
|
.br
|
||
|
|
struct serif::discretization::domain::schema::DomainID< DomainT, IdentifierValue >"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\&.
|
||
|
|
|
||
|
|
|
||
|
|
.PP
|
||
|
|
\fBTemplate Parameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fIDomainT\fP The semantic domain type (must satisfy the \fBIsDomain\fP concept)\&.
|
||
|
|
.br
|
||
|
|
\fIIdentifierValue\fP The integer attribute value in the mesh file that corresponds to this domain\&.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SH "Member Typedef Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "template<IsDomain DomainT, int IdentifierValue> using \fBserif::discretization::domain::ids::DomainID\fP< DomainT, IdentifierValue >::domain_type = DomainT"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
The semantic domain type associated with this \fBDomainID\fP\&.
|
||
|
|
.SH "Member Data Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "template<IsDomain DomainT, int IdentifierValue> int \fBserif::discretization::domain::ids::DomainID\fP< DomainT, IdentifierValue >::ID = IdentifierValue\fR [static]\fP, \fR [constexpr]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
The integer attribute value in the mesh file that corresponds to this domain\&.
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|