98 lines
3.0 KiB
Groff
98 lines
3.0 KiB
Groff
|
.TH "serif::mapping::MappingPointContext" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
serif::mapping::MappingPointContext \- A structure representing the context of a mapping point, including the reference position, displaced position, physical position, displacement Jacobian, mapping Jacobian, inverse mapping Jacobian, mapping determinant, and compactification status\&.
|
||
|
|
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
.PP
|
||
|
|
\fR#include <context\&.hpp>\fP
|
||
|
|
.SS "Public Attributes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "mfem::Vector \fBreference_position\fP"
|
||
|
|
.br
|
||
|
|
.RI "The reference position of the mapping point\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "mfem::Vector \fBdisplaced_position\fP"
|
||
|
|
.br
|
||
|
|
.RI "The displaced position of the mapping point\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "mfem::Vector \fBphysical_position\fP"
|
||
|
|
.br
|
||
|
|
.RI "The physical position of the mapping point\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "mfem::DenseMatrix \fBdisplacement_jacobian\fP"
|
||
|
|
.br
|
||
|
|
.RI "The displacement Jacobian of the mapping point\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "mfem::DenseMatrix \fBmapping_jacobian\fP"
|
||
|
|
.br
|
||
|
|
.RI "The mapping Jacobian of the mapping point\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "mfem::DenseMatrix \fBinverse_mapping_jacobian\fP"
|
||
|
|
.br
|
||
|
|
.RI "The inverse mapping Jacobian of the mapping point\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "double \fBmapping_determinate\fP {0\&.0}"
|
||
|
|
.br
|
||
|
|
.RI "The determinant of the mapping Jacobian at the mapping point\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "bool \fBcompactified\fP {false}"
|
||
|
|
.br
|
||
|
|
.RI "A flag indicating whether the mapping point is compactified (true) or not (false)\&. "
|
||
|
|
.in -1c
|
||
|
|
.SH "Detailed Description"
|
||
|
|
.PP
|
||
|
|
A structure representing the context of a mapping point, including the reference position, displaced position, physical position, displacement Jacobian, mapping Jacobian, inverse mapping Jacobian, mapping determinant, and compactification status\&.
|
||
|
|
|
||
|
|
|
||
|
|
.PP
|
||
|
|
\fBTodo\fP
|
||
|
|
.RS 4
|
||
|
|
Add a worked example here
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SH "Member Data Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "bool serif::mapping::MappingPointContext::compactified {false}"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
A flag indicating whether the mapping point is compactified (true) or not (false)\&.
|
||
|
|
.SS "mfem::Vector serif::mapping::MappingPointContext::displaced_position"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
The displaced position of the mapping point\&.
|
||
|
|
.SS "mfem::DenseMatrix serif::mapping::MappingPointContext::displacement_jacobian"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
The displacement Jacobian of the mapping point\&.
|
||
|
|
.SS "mfem::DenseMatrix serif::mapping::MappingPointContext::inverse_mapping_jacobian"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
The inverse mapping Jacobian of the mapping point\&.
|
||
|
|
.SS "double serif::mapping::MappingPointContext::mapping_determinate {0\&.0}"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
The determinant of the mapping Jacobian at the mapping point\&.
|
||
|
|
.SS "mfem::DenseMatrix serif::mapping::MappingPointContext::mapping_jacobian"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
The mapping Jacobian of the mapping point\&.
|
||
|
|
.SS "mfem::Vector serif::mapping::MappingPointContext::physical_position"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
The physical position of the mapping point\&.
|
||
|
|
.SS "mfem::Vector serif::mapping::MappingPointContext::reference_position"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
The reference position of the mapping point\&.
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|