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)
73 lines
2.3 KiB
Groff
73 lines
2.3 KiB
Groff
.TH "src/include/serif/backend/mfem/mapping/context.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/backend/mfem/mapping/context.hpp \- File containing the mapping context structures for volume and face mappings\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'mfem/linalg/densemat\&.hpp'\fP
|
|
.br
|
|
\fR#include 'mfem/linalg/vector\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::mapping::VolumeQuadratureContext\fP"
|
|
.br
|
|
.RI "A structure representing the context of a volume quadrature point, including the inverse Jacobian of the mapping and the determinant of the mapping\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::mapping::FaceQuadratureContext\fP"
|
|
.br
|
|
.RI "A structure representing the context of a face quadrature point, including the normal vector, surface weight, and scale factor for the dot product of the velocity and normal vector\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::mapping::MappingPointContext\fP"
|
|
.br
|
|
.RI "A structure representing the context of a mapping point, including the reference position, displaced position, physical position, displacement Jacobian, mapping Jacobian, inverse mapping Jacobian, mapping determinant, and compactification status\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::mapping::VolumeMappingContext\fP"
|
|
.br
|
|
.RI "A structure representing the context of a volume mapping, including the mapping point context and volume quadrature context\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::mapping::FaceMappingContext\fP"
|
|
.br
|
|
.RI "A structure representing the context of a face mapping, including the mapping point context and face quadrature context\&. "
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::mapping\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
File containing the mapping context structures for volume and face mappings\&.
|
|
|
|
|
|
.PP
|
|
\fBAuthor\fP
|
|
.RS 4
|
|
Emily M\&. Boudreaux
|
|
.RE
|
|
.PP
|
|
|
|
.PP
|
|
\fBTodo\fP
|
|
.RS 4
|
|
Like a lot of the parts of the mapping module written before I started factoring mfem stuff into backend modules, a good amount of this might be movable to some mfem backend
|
|
.RE
|
|
.PP
|
|
|
|
.PP
|
|
All of these different "context" structures are built to contain sufficient information that the caller which gets one of these back can evaluate the mapping and its derivatives properly at some point\&.
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|