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)
58 lines
1.6 KiB
Groff
58 lines
1.6 KiB
Groff
.TH "serif::mapping::VolumeQuadratureContext" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::mapping::VolumeQuadratureContext \- A structure representing the context of a volume quadrature point, including the inverse Jacobian of the mapping and the determinant of the mapping\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <context\&.hpp>\fP
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "mfem::DenseMatrix \fBJ_element_to_physical_inverse\fP"
|
|
.br
|
|
.RI "The inverse Jacobian of the mapping from the element to the physical space\&. "
|
|
.ti -1c
|
|
.RI "double \fBmapping_determinate\fP"
|
|
.br
|
|
.RI "The determinant of the mapping from the element to the physical space,\&. "
|
|
.ti -1c
|
|
.RI "double \fBphysical_integration_weight\fP"
|
|
.br
|
|
.RI "The physical integration weight for the quadrature point\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
A structure representing the context of a volume quadrature point, including the inverse Jacobian of the mapping and the determinant of the mapping\&.
|
|
|
|
|
|
.PP
|
|
\fBTodo\fP
|
|
.RS 4
|
|
Add a worked example here
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "mfem::DenseMatrix serif::mapping::VolumeQuadratureContext::J_element_to_physical_inverse"
|
|
|
|
.PP
|
|
The inverse Jacobian of the mapping from the element to the physical space\&.
|
|
.SS "double serif::mapping::VolumeQuadratureContext::mapping_determinate"
|
|
|
|
.PP
|
|
The determinant of the mapping from the element to the physical space,\&.
|
|
.SS "double serif::mapping::VolumeQuadratureContext::physical_integration_weight"
|
|
|
|
.PP
|
|
The physical integration weight for the quadrature point\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|