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)
108 lines
4.3 KiB
Groff
108 lines
4.3 KiB
Groff
.TH "src/include/serif/backend/mfem/mapping/data.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/backend/mfem/mapping/data.hpp \- File containing some misc data structures for the mapping module\&. This was the very first file I ported over from MeanField and I think because of that its organization is actually quite wonky\&. For one its int this poorly named "data" file, which could mean any number of things\&. Regardless, these are basically low leval containers for useful stuff and also some scratch workspaces for mapping operations\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'mfem/fem/fe/fe_base\&.hpp'\fP
|
|
.br
|
|
\fR#include 'mfem/fem/fespace\&.hpp'\fP
|
|
.br
|
|
\fR#include 'mfem/linalg/vector\&.hpp'\fP
|
|
.br
|
|
\fR#include 'mfem/linalg/densemat\&.hpp'\fP
|
|
.br
|
|
\fR#include 'mfem/mesh/mesh\&.hpp'\fP
|
|
.br
|
|
\fR#include <cstdint>\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/mapping/compactification/kelvin\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/mapping/context\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/mapping/data\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "class \fBserif::mapping::ElementDisplacementData\fP"
|
|
.br
|
|
.RI "A class representing the displacement data for a finite element, including the finite element, degree of freedom matrix, and dimension\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::mapping::CompactificationPointData\fP"
|
|
.br
|
|
.RI "A structure representing the compactification point data, including the compactification coordinate and coordinate gradient\&. "
|
|
.ti -1c
|
|
.RI "class \fBserif::mapping::ElementCompactificationData\fP"
|
|
.br
|
|
.RI "A class representing the compactification data for a finite element, including the finite element and degrees of freedom\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::mapping::ElementMappingData\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "class \fBserif::mapping::DMWorkspace\fP"
|
|
.br
|
|
.RI "A class representing a workspace for displacement mapping operations, including various vectors and matrices used in the mapping process\&. primarily this is just a separate class so we can more easily make this code thread-safe in the future\&. At construction of an instance of this class loads of Heap allocation is done (or really whatever mfem does internally for allocation for vector which dependents on the selected device) and then that allocation can be reused\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::mapping::DMFixedMeshGeometry\fP"
|
|
.br
|
|
.RI "A structure representing the fixed mesh geometry at a specific point, including position, Jacobian, inverse Jacobian, and weight\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::mapping::DMReferenceDisplacementSample\fP"
|
|
.br
|
|
.RI "A structure representing a sample of the reference displacement, including the value and gradient of the displacement at a specific point\&. "
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::mapping\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Enumerations"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "enum class \fBserif::mapping::FaceElementSide\fP : uint8_t { \fBserif::mapping::ELEMENT_1\fP, \fBserif::mapping::ELEMENT_2\fP }"
|
|
.br
|
|
.RI "An enumeration representing the side of a face element, either ELEMENT_1 or ELEMENT_2\&. There is no inherent ordering to these; however, broadly I have been thinking about ELEMENT_1 as the "inner" side and ELEMENT_2 as the "outer" side\&. "
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBElementDisplacementData\fP \fBserif::mapping::element_displacement_data_from_element_vdofs\fP (const mfem::FiniteElement &element, mfem::Vector &displacement_dofs)"
|
|
.br
|
|
.RI "Creates an \fBElementDisplacementData\fP object from a finite element and a vector of displacement degrees of freedom\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
File containing some misc data structures for the mapping module\&. This was the very first file I ported over from MeanField and I think because of that its organization is actually quite wonky\&. For one its int this poorly named "data" file, which could mean any number of things\&. Regardless, these are basically low leval containers for useful stuff and also some scratch workspaces for mapping operations\&.
|
|
|
|
|
|
.PP
|
|
\fBAuthor\fP
|
|
.RS 4
|
|
Emily M\&. Boudreaux
|
|
.RE
|
|
.PP
|
|
|
|
.PP
|
|
\fBTodo\fP
|
|
.RS 4
|
|
As said above there is some refactoring to make this cleaner which could happen\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|