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)
54 lines
1.5 KiB
Groff
54 lines
1.5 KiB
Groff
.TH "serif::discretization::domain::mesh::MeshTopologyData" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::domain::mesh::MeshTopologyData \- Backend-independent material labels and face connectivity;\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <topology\&.hpp>\fP
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "std::vector< int > \fBelementDomainIDs\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::vector< \fBFaceElements\fP > \fBfaceElements\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::vector< int > \fBboundaryElementBoundaryIDs\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::vector< int > \fBboundaryElementFaceIDs\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Backend-independent material labels and face connectivity;\&.
|
|
|
|
|
|
.PP
|
|
\fBTodo\fP
|
|
.RS 4
|
|
Implemented this with std::vector when I moved all the mfem code into backend/mfem; however, std::vector has all sorts of limitations and problems\&. We may want to consider using the types\&.hpp vector alias here instead? Or some other vector implementation\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "std::vector<int> serif::discretization::domain::mesh::MeshTopologyData::boundaryElementBoundaryIDs"
|
|
|
|
.SS "std::vector<int> serif::discretization::domain::mesh::MeshTopologyData::boundaryElementFaceIDs"
|
|
|
|
.SS "std::vector<int> serif::discretization::domain::mesh::MeshTopologyData::elementDomainIDs"
|
|
|
|
.SS "std::vector<\fBFaceElements\fP> serif::discretization::domain::mesh::MeshTopologyData::faceElements"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|