.TH "serif::discretization::domain" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::discretization::domain
.SH SYNOPSIS
.br
.PP
.SS "Namespaces"

.in +1c
.ti -1c
.RI "namespace \fBids\fP"
.br
.ti -1c
.RI "namespace \fBmesh\fP"
.br
.ti -1c
.RI "namespace \fBrelation\fP"
.br
.ti -1c
.RI "namespace \fBschema\fP"
.br
.in -1c
.SS "Classes"

.in +1c
.ti -1c
.RI "struct \fBBoundary\fP"
.br
.RI "A \fBBoundary\fP is a surface in the mesh\&. It is a base class for all boundary types\&. "
.ti -1c
.RI "struct \fBBoundaryIDResolver\fP"
.br
.RI "A specialization of the \fBDomainIDResolver\fP struct for a \fBDomainOrSet\fP type\&. This struct is used to resolve the domain IDs for a given \fBDomainOrSet\fP type\&. "
.ti -1c
.RI "struct \fBBoundaryIDResolver< BoundarySet< BoundaryTs\&.\&.\&. >, ids::lists::BoundaryIDList< BoundaryIDTs\&.\&.\&. > >\fP"
.br
.RI "A specialization of the \fBBoundaryIDResolver\fP struct for a \fBBoundarySet\fP type\&. This struct is used to resolve the boundary IDs for a given \fBBoundarySet\fP type\&. "
.ti -1c
.RI "struct \fBBoundaryIDResolver< BoundaryT, ids::lists::BoundaryIDList< BoundaryIDTs\&.\&.\&. > >\fP"
.br
.RI "A specialization of the \fBBoundaryIDResolver\fP struct for a single \fBBoundary\fP type\&. This struct is used to resolve the boundary ID for a given \fBBoundary\fP type\&. "
.ti -1c
.RI "struct \fBBoundarySet\fP"
.br
.RI "A \fBBoundarySet\fP is a collection of boundaries\&. It is used to group multiple boundaries together for convenience\&. "
.ti -1c
.RI "struct \fBCoreDomain\fP"
.br
.RI "The \fBCoreDomain\fP is the central, cartesian, region of the star\&. It is a derived class of \fBDomain\fP\&. "
.ti -1c
.RI "struct \fBDomain\fP"
.br
.RI "A \fBDomain\fP is a volume in the mesh\&. It is a base class for all domain types\&. "
.ti -1c
.RI "struct \fBDomainIDResolver\fP"
.br
.ti -1c
.RI "struct \fBDomainIDResolver< DomainSet< DomainTs\&.\&.\&. >, ids::lists::DomainIDList< DomainIDTs\&.\&.\&. > >\fP"
.br
.RI "A specialization of the \fBDomainIDResolver\fP struct for a \fBDomainSet\fP type\&. This struct is used to resolve the domain IDs for a given \fBDomainSet\fP type\&. "
.ti -1c
.RI "struct \fBDomainIDResolver< DomainT, ids::lists::DomainIDList< DomainIDTs\&.\&.\&. > >\fP"
.br
.RI "A specialization of the \fBDomainIDResolver\fP struct for a single \fBDomain\fP type\&. This struct is used to resolve the domain ID for a given \fBDomain\fP type\&. "
.ti -1c
.RI "class \fBDomainOrSet\fP"
.br
.RI "A \fBDomainOrSet\fP is a type that can represent either a single domain or a set of domains\&. "
.ti -1c
.RI "struct \fBDomainOrSetList\fP"
.br
.RI "A list of \fBDomainOrSet\fP types\&. "
.ti -1c
.RI "struct \fBDomainSet\fP"
.br
.RI "A \fBDomainSet\fP is a collection of domains\&. It is used to group multiple domains together for convenience\&. "
.ti -1c
.RI "struct \fBEnvelopeDomain\fP"
.br
.RI "The \fBEnvelopeDomain\fP is the outer, spherical, region of the star\&. It is a derived class of \fBDomain\fP\&. "
.ti -1c
.RI "struct \fBInfinitySurfaceBoundary\fP"
.br
.RI "The \fBInfinitySurfaceBoundary\fP is the surface at infinity\&. It is a derived class of \fBBoundary\fP\&. More generally this is the outer boundary of the vacuum region; however, since we really need the boundary conditions to be applied at infinity, we call it the infinity surface\&. "
.ti -1c
.RI "struct \fBStellarSurfaceBoundary\fP"
.br
.RI "The \fBStellarSurfaceBoundary\fP is the surface of the star\&. It is a derived class of \fBBoundary\fP\&. "
.ti -1c
.RI "struct \fBVacuumDomain\fP"
.br
.RI "The \fBVacuumDomain\fP is the vacuum region surrounding the star\&. It is a derived class of \fBDomain\fP\&. "
.in -1c
.SS "Concepts"

.in +1c
.ti -1c
.RI "concept \fBIsDomain\fP"
.br
.RI "< "
.ti -1c
.RI "concept \fBIsBoundary\fP"
.br
.RI "A Boundary is a surface in the mesh\&. It is a base class for all boundary types\&. "
.ti -1c
.RI "concept \fBIsDomainSet\fP"
.br
.RI "A concept to determine if a type is a DomainSet\&. A type is a DomainSet if it satisfies the \fBis_domain_set_v\fP trait\&. "
.ti -1c
.RI "concept \fBIsDomainOrSet\fP"
.br
.RI "A concept to determine if a type is a DomainOrSet\&. A type is a DomainOrSet if it is either a Domain or a DomainSet\&. "
.ti -1c
.RI "concept \fBDomainIsIdentifiedBy\fP"
.br
.RI "A concept to determine if a Domain type is identified by a DomainID type\&. A Domain type is identified by a DomainID type if the DomainID's domain_type is the same as the Domain type\&. "
.ti -1c
.RI "concept \fBBoundaryIsIdentifiedBy\fP"
.br
.RI "A concept to determine if a Boundary type is identified by a BoundaryID type\&. A Boundary type is identified by a BoundaryID type if the BoundaryID's boundary_type is the same as the Boundary type\&. "
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "using \fBStellarDomains\fP = \fBDomainSet\fP<\fBCoreDomain\fP, \fBEnvelopeDomain\fP>"
.br
.RI "The set of domains that make up the stellar region of the mesh\&. "
.ti -1c
.RI "using \fBAllDomains\fP = \fBDomainSet\fP<\fBCoreDomain\fP, \fBEnvelopeDomain\fP, \fBVacuumDomain\fP>"
.br
.RI "The set of all domains in the mesh\&. "
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "template<typename\&.\&.\&. Ts> consteval std::size_t \fBCountVariadicArguments\fP () noexcept"
.br
.RI "< "
.in -1c
.SS "Variables"

.in +1c
.ti -1c
.RI "template<typename T> constexpr bool \fBis_domain_set_v\fP = false"
.br
.RI "A trait to determine if a type is a \fBDomainSet\fP\&. This is the default false specialization\&. "
.ti -1c
.RI "template<IsDomain\&.\&.\&. DomainTs> constexpr bool \fBis_domain_set_v< DomainSet< DomainTs\&.\&.\&. > >\fP = true"
.br
.RI "A trait to determine if a type is a \fBDomainSet\fP\&. This is the true specialization for \fBDomainSet\fP types\&. "
.ti -1c
.RI "template<class Child, class Parent> constexpr bool \fBAIsBaseClassOfB\fP"
.br
.in -1c
.SH "Typedef Documentation"
.PP 
.SS "using \fBserif::discretization::domain::AllDomains\fP = \fBDomainSet\fP<\fBCoreDomain\fP, \fBEnvelopeDomain\fP, \fBVacuumDomain\fP>"

.PP
The set of all domains in the mesh\&. 
.SS "using \fBserif::discretization::domain::StellarDomains\fP = \fBDomainSet\fP<\fBCoreDomain\fP, \fBEnvelopeDomain\fP>"

.PP
The set of domains that make up the stellar region of the mesh\&. 
.SH "Function Documentation"
.PP 
.SS "template<typename\&.\&.\&. Ts> std::size_t serif::utils::misc::std_helper::CountVariadicArguments ()\fR [nodiscard]\fP, \fR [consteval]\fP, \fR [noexcept]\fP"

.PP
< 
.PP
\fBTodo\fP
.RS 4
remove this and just use the raw std::is_base_of_v 
.RE
.PP

.SH "Variable Documentation"
.PP 
.SS "template<class Child, class Parent> bool serif::utils::misc::std_helper::AIsBaseClassOfB\fR [constexpr]\fP"

.SS "template<typename T> bool serif::discretization::domain::is_domain_set_v = false\fR [constexpr]\fP"

.PP
A trait to determine if a type is a \fBDomainSet\fP\&. This is the default false specialization\&. 
.PP
\fBTemplate Parameters\fP
.RS 4
\fIT\fP Candidate type to check\&. 
.RE
.PP

.SS "template<IsDomain\&.\&.\&. DomainTs> bool \fBserif::discretization::domain::is_domain_set_v\fP< \fBDomainSet\fP< DomainTs\&.\&.\&. > > = true\fR [constexpr]\fP"

.PP
A trait to determine if a type is a \fBDomainSet\fP\&. This is the true specialization for \fBDomainSet\fP types\&. 
.PP
\fBTemplate Parameters\fP
.RS 4
\fIDomainTs\fP The domain types that make up the set\&. 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for SERiF from the source code\&.