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)
62 lines
1.7 KiB
Groff
62 lines
1.7 KiB
Groff
.TH "src/include/serif/discretization/domain/mesh/topology.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/discretization/domain/mesh/topology.hpp \- This file defines the MeshTopology class, which provides a convenient interface for querying the topological relationships between elements, faces, and boundaries in a mesh\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <cstddef>\fP
|
|
.br
|
|
\fR#include <vector>\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::discretization::domain::mesh::FaceElements\fP"
|
|
.br
|
|
.RI "A simple struct to hold the IDs of the two elements that share a face\&. If the face is a boundary face, one of the element IDs will be -1\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::discretization::domain::mesh::MeshTopologyData\fP"
|
|
.br
|
|
.RI "Backend-independent material labels and face connectivity;\&. "
|
|
.ti -1c
|
|
.RI "class \fBserif::discretization::domain::mesh::MeshTopology\fP"
|
|
.br
|
|
.RI "Provides a convenient interface for querying the topological relationships between elements, faces, and boundaries in a mesh\&. "
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::discretization\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::discretization::domain\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::discretization::domain::mesh\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
This file defines the MeshTopology class, which provides a convenient interface for querying the topological relationships between elements, faces, and boundaries in a mesh\&.
|
|
|
|
|
|
.PP
|
|
\fBAuthor\fP
|
|
.RS 4
|
|
Emily M\&. Boudreaux
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|