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)
41 lines
1.2 KiB
Groff
41 lines
1.2 KiB
Groff
.TH "serif::mapping::DMReferenceDisplacementSample" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::mapping::DMReferenceDisplacementSample \- A structure representing a sample of the reference displacement, including the value and gradient of the displacement at a specific point\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <data\&.hpp>\fP
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "const mfem::Vector & \fBvalue\fP"
|
|
.br
|
|
.RI "The value of the reference displacement at the point\&. "
|
|
.ti -1c
|
|
.RI "const mfem::DenseMatrix & \fBgradient\fP"
|
|
.br
|
|
.RI "The gradient of the reference displacement at the point\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
A structure representing a sample of the reference displacement, including the value and gradient of the displacement at a specific point\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "const mfem::DenseMatrix& serif::mapping::DMReferenceDisplacementSample::gradient"
|
|
|
|
.PP
|
|
The gradient of the reference displacement at the point\&.
|
|
.SS "const mfem::Vector& serif::mapping::DMReferenceDisplacementSample::value"
|
|
|
|
.PP
|
|
The value of the reference displacement at the point\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|