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