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

120 lines
4.2 KiB
Groff
Raw Normal View History

.TH "serif::discretization::domain::ids" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::discretization::domain::ids
.SH SYNOPSIS
.br
.PP
.SS "Namespaces"
.in +1c
.ti -1c
.RI "namespace \fBlists\fP"
.br
.ti -1c
.RI "namespace \fBvalidation\fP"
.br
.in -1c
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBBoundaryDescriptor\fP"
.br
.RI "The \fBBoundaryDescriptor\fP struct is a runtime representation of a boundary, containing its name and integer attribute ID\&. This is used to project compile-time \fBBoundaryID\fP types into runtime values\&. "
.ti -1c
.RI "struct \fBBoundaryID\fP"
.br
.RI "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\&. "
.ti -1c
.RI "struct \fBDomainDescriptor\fP"
.br
.RI "The \fBDomainDescriptor\fP struct is a runtime representation of a domain, containing its name and integer attribute ID\&. This is used to project compile-time \fBDomainID\fP types into runtime values\&. "
.ti -1c
.RI "struct \fBDomainID\fP"
.br
.RI "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\&. "
.in -1c
.SS "Concepts"
.in +1c
.ti -1c
.RI "concept \fBIsDomainID\fP"
.br
.RI "Concept for types that are domain IDs in the discretization framework\&. To be a domain ID a type must satisfy the is_domain_id_v trait\&. "
.ti -1c
.RI "concept \fBIsBoundaryID\fP"
.br
.RI "Concept for types that are boundary IDs in the discretization framework\&. To be a boundary ID a type must satisfy the is_boundary_id_v trait\&. "
.in -1c
.SS "Variables"
.in +1c
.ti -1c
.RI "template<typename T> constexpr bool \fBis_domain_id_v\fP = false"
.br
.RI "Trait to determine if a type is a domain ID\&. Defaults to false for all types\&. "
.ti -1c
.RI "template<IsDomain DomainT, int IdentifierValue> constexpr bool \fBis_domain_id_v< DomainID< DomainT, IdentifierValue > >\fP = true"
.br
.RI "Trait to determine if a type is a domain ID\&. Specialization which is true for valid \fBDomainID\fP types\&. "
.ti -1c
.RI "template<typename T> constexpr bool \fBis_boundary_id_v\fP = false"
.br
.RI "Trait to determine if a type is a boundary ID\&. Defaults to false for all types\&. "
.ti -1c
.RI "template<IsBoundary BoundaryT, int IdentifierValue> constexpr bool \fBis_boundary_id_v< BoundaryID< BoundaryT, IdentifierValue > >\fP = true"
.br
.RI "Trait to determine if a type is a boundary ID\&. Specialization which is true for valid \fBBoundaryID\fP types\&. "
.in -1c
.SH "Variable Documentation"
.PP
.SS "template<typename T> bool serif::discretization::domain::ids::is_boundary_id_v = false\fR [constexpr]\fP"
.PP
Trait to determine if a type is a boundary ID\&. Defaults to false for all types\&.
.PP
\fBTemplate Parameters\fP
.RS 4
\fIT\fP The type to check\&.
.RE
.PP
.SS "template<IsBoundary BoundaryT, int IdentifierValue> bool \fBserif::discretization::domain::ids::is_boundary_id_v\fP< \fBBoundaryID\fP< BoundaryT, IdentifierValue > > = true\fR [constexpr]\fP"
.PP
Trait to determine if a type is a boundary ID\&. Specialization which is true for valid \fBBoundaryID\fP types\&.
.PP
\fBTemplate Parameters\fP
.RS 4
\fIT\fP The type to check\&.
.RE
.PP
.SS "template<typename T> bool serif::discretization::domain::ids::is_domain_id_v = false\fR [constexpr]\fP"
.PP
Trait to determine if a type is a domain ID\&. Defaults to false for all types\&.
.PP
\fBTemplate Parameters\fP
.RS 4
\fIT\fP The type to check\&.
.RE
.PP
.SS "template<IsDomain DomainT, int IdentifierValue> bool \fBserif::discretization::domain::ids::is_domain_id_v\fP< \fBDomainID\fP< DomainT, IdentifierValue > > = true\fR [constexpr]\fP"
.PP
Trait to determine if a type is a domain ID\&. Specialization which is true for valid \fBDomainID\fP types\&.
.PP
\fBTemplate Parameters\fP
.RS 4
\fIT\fP The type to check\&.
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.