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)
23 lines
1.1 KiB
Groff
23 lines
1.1 KiB
Groff
.TH "serif::discretization::domain::relation::DomainRelation" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::domain::relation::DomainRelation \- 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\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <relations\&.hpp>\fP
|
|
.PP
|
|
Inherited by \fBserif::discretization::domain::relation::DomainBoundary< BoundaryT, DomainTs >\fP, \fBserif::discretization::domain::relation::FullyConnected< A >\fP, and \fBserif::discretization::domain::relation::Inscribed< A, B >\fP\&.
|
|
.SH "Detailed Description"
|
|
.PP
|
|
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\&.
|
|
|
|
Each relation must hold for a mesh to be considered valid for a given schema\&. This base class serves as a common interface for all relation types, allowing for compile-time checks and validation of relations in the domain module\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|