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)
40 lines
1.6 KiB
Groff
40 lines
1.6 KiB
Groff
.TH "serif::mapping::compactification" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::mapping::compactification
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "class \fBExteriorDomainMap\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\&. "
|
|
.ti -1c
|
|
.RI "struct \fBExteriorMapDirection\fP"
|
|
.br
|
|
.RI "Structure representing the direction of the variation in the exterior domain mapping\&. This includes the variation of the displaced position and the variation of the displacement Jacobian\&. "
|
|
.ti -1c
|
|
.RI "struct \fBExteriorMapInput\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 \fBExteriorMapResult\fP"
|
|
.br
|
|
.RI "Structure representing the result of the exterior domain mapping\&. This includes the physical position and the Jacobian of the mapping\&. "
|
|
.ti -1c
|
|
.RI "struct \fBExteriorMapVariation\fP"
|
|
.br
|
|
.RI "Structure representing the variation of the exterior domain mapping\&. This includes the variation of the physical position and the variation of the mapping Jacobian\&. "
|
|
.ti -1c
|
|
.RI "class \fBKelvinCompactification\fP"
|
|
.br
|
|
.RI "Concrete implementation of the \fBExteriorDomainMap\fP interface for the Kelvin compactification\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|