Emily Boudreaux
6b57738330
Note for now much of the docs is LLM written. This was done to save time and focus on code development. The docs have been LOOSLEY reviewed. However, the code itself has been either fully written by hand or fully reviewed. Therefore, the docs should at the moment be seen as a loose resource rather than authoratiative (and this is on top of the general ability for docs to drift)
72 lines
2.4 KiB
Groff
72 lines
2.4 KiB
Groff
.TH "serif::discretization::domain::relation" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::domain::relation
|
|
.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 \fBDomainBoundary\fP"
|
|
.br
|
|
.RI "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\&. "
|
|
.ti -1c
|
|
.RI "struct \fBDomainRelation\fP"
|
|
.br
|
|
.RI "Base class for all relations in the domain module\&. This class is used to define compile-time tags for relations that can be declared about a mesh\&. "
|
|
.ti -1c
|
|
.RI "struct \fBFullyConnected\fP"
|
|
.br
|
|
.RI "Compile time type representing the fully connected relation for a domain or set\&. This relation states that the domain is a single connected blob of elements, not two separate pieces\&. "
|
|
.ti -1c
|
|
.RI "struct \fBInscribed\fP"
|
|
.br
|
|
.RI "Compile time type representing the inscribed relation between two domains or sets\&. This relation states that every face of the inner domain (A) that is not interior to A borders the outer domain (B)\&. "
|
|
.in -1c
|
|
.SS "Concepts"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "concept \fBIsRelation\fP"
|
|
.br
|
|
.RI "Concept to validate that a type is a relation\&. This concept checks if the type is derived from the DomainRelation base class\&. "
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename\&.\&.\&. Ts> consteval std::size_t \fBCountVariadicArguments\fP () noexcept"
|
|
.br
|
|
.in -1c
|
|
.SS "Variables"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<class Child, class Parent> constexpr bool \fBAIsBaseClassOfB\fP"
|
|
.br
|
|
.in -1c
|
|
.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"
|
|
|
|
.SH "Variable Documentation"
|
|
.PP
|
|
.SS "template<class Child, class Parent> bool serif::utils::misc::std_helper::AIsBaseClassOfB\fR [constexpr]\fP"
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|