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)
55 lines
1.4 KiB
Groff
55 lines
1.4 KiB
Groff
.TH "src/include/serif/backend/mfem/mapping/compactification/input_result.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/backend/mfem/mapping/compactification/input_result.hpp \- File containing the input and result structures for the compactification mapping\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'mfem/linalg/vector\&.hpp'\fP
|
|
.br
|
|
\fR#include 'mfem/linalg/densemat\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::mapping::compactification::ExteriorMapInput\fP"
|
|
.br
|
|
.RI "Structure representing the input to the exterior domain mapping\&. This includes the reference position, displaced position, displacement Jacobian, compactification coordinate gradient, and compactification coordinate\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::mapping::compactification::ExteriorMapResult\fP"
|
|
.br
|
|
.RI "Structure representing the result of the exterior domain mapping\&. This includes the physical position and the Jacobian of the mapping\&. "
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::mapping\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::mapping::compactification\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
File containing the input and result structures for the compactification mapping\&.
|
|
|
|
|
|
.PP
|
|
\fBAuthor\fP
|
|
.RS 4
|
|
Emily M\&. Boudreaux
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|