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)
50 lines
1.2 KiB
Groff
50 lines
1.2 KiB
Groff
.TH "serif::mapping::VolumeMappingContext" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::mapping::VolumeMappingContext \- A structure representing the context of a volume mapping, including the mapping point context and volume quadrature context\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <context\&.hpp>\fP
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBMappingPointContext\fP \fBmapping\fP"
|
|
.br
|
|
.RI "The mapping point context for the volume mapping\&. "
|
|
.ti -1c
|
|
.RI "\fBVolumeQuadratureContext\fP \fBquadrature\fP"
|
|
.br
|
|
.RI "The volume quadrature context for the volume mapping\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
A structure representing the context of a volume mapping, including the mapping point context and volume quadrature context\&.
|
|
|
|
|
|
.PP
|
|
\fBTodo\fP
|
|
.RS 4
|
|
Add a worked example here
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "\fBMappingPointContext\fP serif::mapping::VolumeMappingContext::mapping"
|
|
|
|
.PP
|
|
The mapping point context for the volume mapping\&.
|
|
.SS "\fBVolumeQuadratureContext\fP serif::mapping::VolumeMappingContext::quadrature"
|
|
|
|
.PP
|
|
The volume quadrature context for the volume mapping\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|