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)
57 lines
1.5 KiB
Groff
57 lines
1.5 KiB
Groff
.TH "src/include/serif/backend/mfem/mapping/compactification/compactification.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/backend/mfem/mapping/compactification/compactification.hpp \- File containing the definition of the ExteriorDomainMap interface, which is used to define the mapping from reference coordinates to physical coordinates in the exterior domain\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <string_view>\fP
|
|
.br
|
|
\fR#include <memory>\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/mapping/status\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/mapping/compactification/input_result\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/mapping/compactification/variation\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "class \fBserif::mapping::compactification::ExteriorDomainMap\fP"
|
|
.br
|
|
.RI "Abstract interface for some mapping from reference coordinates to physical coordinates in the exterior domain\&. Currently the only concrete implementation of this is the kelvin compactification\&. "
|
|
.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 definition of the ExteriorDomainMap interface, which is used to define the mapping from reference coordinates to physical coordinates in the exterior domain\&.
|
|
|
|
|
|
.PP
|
|
\fBAuthor\fP
|
|
.RS 4
|
|
Emily M\&. Boudreaux
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|