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)
74 lines
1.9 KiB
Groff
74 lines
1.9 KiB
Groff
.TH "serif::mapping::FaceMappingContext" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::mapping::FaceMappingContext \- A structure representing the context of a face mapping, including the mapping point context and face 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 face mapping\&. "
|
|
.ti -1c
|
|
.RI "\fBFaceQuadratureContext\fP \fBquadrature\fP"
|
|
.br
|
|
.RI "The face quadrature context for the face mapping\&. "
|
|
.ti -1c
|
|
.RI "mfem::Vector \fBreference_normal\fP"
|
|
.br
|
|
.RI "The reference normal vector for the face mapping\&. "
|
|
.ti -1c
|
|
.RI "double \fBreference_surface_weight\fP {0\&.0}"
|
|
.br
|
|
.RI "The reference surface weight for the face mapping\&. "
|
|
.ti -1c
|
|
.RI "double \fBphysical_surface_weight\fP {0\&.0}"
|
|
.br
|
|
.RI "The physical surface weight for the face mapping\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
A structure representing the context of a face mapping, including the mapping point context and face quadrature context\&.
|
|
|
|
|
|
.PP
|
|
\fBTodo\fP
|
|
.RS 4
|
|
Add a worked example here
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "\fBMappingPointContext\fP serif::mapping::FaceMappingContext::mapping"
|
|
|
|
.PP
|
|
The mapping point context for the face mapping\&.
|
|
.SS "double serif::mapping::FaceMappingContext::physical_surface_weight {0\&.0}"
|
|
|
|
.PP
|
|
The physical surface weight for the face mapping\&.
|
|
.SS "\fBFaceQuadratureContext\fP serif::mapping::FaceMappingContext::quadrature"
|
|
|
|
.PP
|
|
The face quadrature context for the face mapping\&.
|
|
.SS "mfem::Vector serif::mapping::FaceMappingContext::reference_normal"
|
|
|
|
.PP
|
|
The reference normal vector for the face mapping\&.
|
|
.SS "double serif::mapping::FaceMappingContext::reference_surface_weight {0\&.0}"
|
|
|
|
.PP
|
|
The reference surface weight for the face mapping\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|