tboudreaux/MeanField_SERiF
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(docs): built docs

Browse Source 
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)
This commit is contained in:
Emily Boudreaux
2026-11-09 14:09:44 -05:00
parent d9c4919477
commit 6b57738330
32596 changed files with 4155414 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
docs/man/man3/serif_mapping_DMFixedMeshGeometry.3 Normal file
View File

@@ -0,0 +1,56 @@
.TH "serif::mapping::DMFixedMeshGeometry" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::mapping::DMFixedMeshGeometry \- A structure representing the fixed mesh geometry at a specific point, including position, Jacobian, inverse Jacobian, and weight\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <data\&.hpp>\fP
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "mfem::Vector \fBposition\fP"
.br
.RI "The physical position of the point in the mesh\&. "
.ti -1c
.RI "mfem::DenseMatrix \fBjacobian\fP"
.br
.RI "The Jacobian matrix of the mapping from the reference element to the physical element at the point\&. "
.ti -1c
.RI "mfem::DenseMatrix \fBinverse_jacobian\fP"
.br
.RI "The inverse of the Jacobian matrix of the mapping from the reference element to the physical element at the point\&. "
.ti -1c
.RI "double \fBweight\fP {0\&.0}"
.br
.RI "The mapping weight associated with the point, typically used for integration purposes\&. "
.in -1c
.SH "Detailed Description"
.PP
A structure representing the fixed mesh geometry at a specific point, including position, Jacobian, inverse Jacobian, and weight\&.
.SH "Member Data Documentation"
.PP
.SS "mfem::DenseMatrix serif::mapping::DMFixedMeshGeometry::inverse_jacobian"
.PP
The inverse of the Jacobian matrix of the mapping from the reference element to the physical element at the point\&.
.SS "mfem::DenseMatrix serif::mapping::DMFixedMeshGeometry::jacobian"
.PP
The Jacobian matrix of the mapping from the reference element to the physical element at the point\&.
.SS "mfem::Vector serif::mapping::DMFixedMeshGeometry::position"
.PP
The physical position of the point in the mesh\&.
.SS "double serif::mapping::DMFixedMeshGeometry::weight {0\&.0}"
.PP
The mapping weight associated with the point, typically used for integration purposes\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.