88 lines
4.1 KiB
Groff
88 lines
4.1 KiB
Groff
|
|
.TH "serif::discretization::domain::relation::DomainBoundary< BoundaryT, DomainTs >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
serif::discretization::domain::relation::DomainBoundary< BoundaryT, DomainTs > \- Compile time type representing the domain boundary relation between a boundary and one or two domains\&. This relation states that the boundary is exactly the surface between the specified domains\&. We enforce here that the size of the DomainTs pack is either one or two, as a boundary can only be associated with one or two domains\&. If it is one domain then the boundary is the surface of that domain, if it is two domains then the boundary is the interface between those two domains\&.
|
||
|
|
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
.PP
|
||
|
|
\fR#include <relations\&.hpp>\fP
|
||
|
|
.PP
|
||
|
|
Inherits \fBserif::discretization::domain::relation::DomainRelation\fP\&.
|
||
|
|
.SS "Public Types"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBboundary_type\fP = BoundaryT"
|
||
|
|
.br
|
||
|
|
.RI "\fBBoundary\fP type defining the boundary in the domain boundary relation\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBdomain_types\fP = \fBDomainOrSetList\fP<DomainTs\&.\&.\&.>"
|
||
|
|
.br
|
||
|
|
.RI "\fBDomain\fP or \fBDomain\fP Set types defining the domains in the domain boundary relation\&. "
|
||
|
|
.in -1c
|
||
|
|
.SS "Static Public Attributes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "static constexpr std::size_t \fBdomain_count\fP = \fBCountVariadicArguments\fP<DomainTs\&.\&.\&.>()"
|
||
|
|
.br
|
||
|
|
.RI "Compile time count of the number of domains associated with the boundary (either one or two)\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "static constexpr std::string_view \fBname\fP = 'domain_boundary'"
|
||
|
|
.br
|
||
|
|
.RI "Compile time name of the relation\&. "
|
||
|
|
.in -1c
|
||
|
|
.SH "Detailed Description"
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SS "template<IsBoundary BoundaryT, IsDomainOrSet\&.\&.\&. DomainTs>
|
||
|
|
.br
|
||
|
|
requires SetOfOneOrTwo<DomainTs\&.\&.\&.>
|
||
|
|
.br
|
||
|
|
struct serif::discretization::domain::relation::DomainBoundary< BoundaryT, DomainTs >"Compile time type representing the domain boundary relation between a boundary and one or two domains\&. This relation states that the boundary is exactly the surface between the specified domains\&. We enforce here that the size of the DomainTs pack is either one or two, as a boundary can only be associated with one or two domains\&. If it is one domain then the boundary is the surface of that domain, if it is two domains then the boundary is the interface between those two domains\&.
|
||
|
|
|
||
|
|
|
||
|
|
.PP
|
||
|
|
\fBTemplate Parameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fIBoundaryT\fP The boundary type\&.
|
||
|
|
.br
|
||
|
|
\fIDomainTs\fP The domain or set types (one or two) that define the domains associated with the boundary\&.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
This relation is used to define constraints on the mesh, ensuring that the boundary is properly aligned with the specified domains and that it represents the interface between them\&.
|
||
|
|
.SH "Member Typedef Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "template<IsBoundary BoundaryT, IsDomainOrSet\&.\&.\&. DomainTs> using \fBserif::discretization::domain::relation::DomainBoundary\fP< BoundaryT, DomainTs >::boundary_type = BoundaryT"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
\fBBoundary\fP type defining the boundary in the domain boundary relation\&.
|
||
|
|
.SS "template<IsBoundary BoundaryT, IsDomainOrSet\&.\&.\&. DomainTs> using \fBserif::discretization::domain::relation::DomainBoundary\fP< BoundaryT, DomainTs >::domain_types = \fBDomainOrSetList\fP<DomainTs\&.\&.\&.>"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
\fBDomain\fP or \fBDomain\fP Set types defining the domains in the domain boundary relation\&.
|
||
|
|
.SH "Member Data Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "template<IsBoundary BoundaryT, IsDomainOrSet\&.\&.\&. DomainTs> std::size_t \fBserif::discretization::domain::relation::DomainBoundary\fP< BoundaryT, DomainTs >::domain_count = \fBCountVariadicArguments\fP<DomainTs\&.\&.\&.>()\fR [static]\fP, \fR [constexpr]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Compile time count of the number of domains associated with the boundary (either one or two)\&.
|
||
|
|
.SS "template<IsBoundary BoundaryT, IsDomainOrSet\&.\&.\&. DomainTs> std::string_view \fBserif::discretization::domain::relation::DomainBoundary\fP< BoundaryT, DomainTs >::name = 'domain_boundary'\fR [static]\fP, \fR [constexpr]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Compile time name of the relation\&.
|
||
|
|
.PP
|
||
|
|
\fBTodo\fP
|
||
|
|
.RS 4
|
||
|
|
we should replace this with our meta library\&.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|