Files
MeanField_SERiF/docs/man/man3/serif_discretization_domain_DomainOrSet.3

95 lines
2.7 KiB
Groff
Raw Permalink Normal View History

.TH "serif::discretization::domain::DomainOrSet" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::discretization::domain::DomainOrSet \- A \fBDomainOrSet\fP is a type that can represent either a single domain or a set of domains\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <concepts\&.hpp>\fP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "template<IsDomain DomainT> constexpr \fBDomainOrSet\fP (DomainT) noexcept"
.br
.RI "Construct a \fBDomainOrSet\fP from a single domain type\&. "
.ti -1c
.RI "template<IsDomain\&.\&.\&. DomainTs> constexpr \fBDomainOrSet\fP (\fBDomainSet\fP< DomainTs\&.\&.\&. >) noexcept"
.br
.RI "Construct a \fBDomainOrSet\fP from a \fBDomainSet\fP type\&. "
.ti -1c
.RI "constexpr std::span< const std::string_view > \fBdomains\fP () const noexcept"
.br
.RI "Get the names of the domains in this \fBDomainOrSet\fP\&. "
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "std::span< const std::string_view > \fBm_domains\fP"
.br
.RI "The names of the domains in this \fBDomainOrSet\fP\&. "
.in -1c
.SH "Detailed Description"
.PP
A \fBDomainOrSet\fP is a type that can represent either a single domain or a set of domains\&.
.PP
\fBNote\fP
.RS 4
Do not make the constructors of this class explicit\&. We want to be able to pass a single domain or a domain set to functions that take a \fBDomainOrSet\fP\&.
.RE
.PP
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<IsDomain DomainT> serif::discretization::domain::DomainOrSet::DomainOrSet (DomainT )\fR [inline]\fP, \fR [constexpr]\fP, \fR [noexcept]\fP"
.PP
Construct a \fBDomainOrSet\fP from a single domain type\&.
.PP
\fBTemplate Parameters\fP
.RS 4
\fIDomainT\fP The domain type to construct from\&.
.RE
.PP
.SS "template<IsDomain\&.\&.\&. DomainTs> serif::discretization::domain::DomainOrSet::DomainOrSet (\fBDomainSet\fP< DomainTs\&.\&.\&. > )\fR [inline]\fP, \fR [constexpr]\fP, \fR [noexcept]\fP"
.PP
Construct a \fBDomainOrSet\fP from a \fBDomainSet\fP type\&.
.PP
\fBTemplate Parameters\fP
.RS 4
\fIDomainTs\fP The domain types that make up the set\&.
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "std::span< const std::string_view > serif::discretization::domain::DomainOrSet::domains () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [constexpr]\fP, \fR [noexcept]\fP"
.PP
Get the names of the domains in this \fBDomainOrSet\fP\&.
.PP
\fBReturns\fP
.RS 4
A span of string_views containing the names of the domains\&.
.RE
.PP
.SH "Member Data Documentation"
.PP
.SS "std::span<const std::string_view> serif::discretization::domain::DomainOrSet::m_domains\fR [private]\fP"
.PP
The names of the domains in this \fBDomainOrSet\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.