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)
65 lines
2.7 KiB
Groff
65 lines
2.7 KiB
Groff
.TH "serif::mapping::compactification::ExteriorMapInput" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::mapping::compactification::ExteriorMapInput \- Structure representing the input to the exterior domain mapping\&. This includes the reference position, displaced position, displacement Jacobian, compactification coordinate gradient, and compactification coordinate\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <input_result\&.hpp>\fP
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "const mfem::Vector & \fBreference_position\fP"
|
|
.br
|
|
.RI "Position in reference space to evaluate the mapping at\&. "
|
|
.ti -1c
|
|
.RI "const mfem::Vector & \fBdisplaced_position\fP"
|
|
.br
|
|
.RI "Position in displaced space to evaluate the mapping at (note this is displaced but not yet compactified)\&. "
|
|
.ti -1c
|
|
.RI "const mfem::DenseMatrix & \fBdisplacement_jacobian\fP"
|
|
.br
|
|
.RI "Jacobian of the displacement mapping at the reference position\&. "
|
|
.ti -1c
|
|
.RI "const mfem::Vector & \fBcompactification_coordinate_gradient\fP"
|
|
.br
|
|
.RI "Gradient of the compactification coordinate at the reference position\&. "
|
|
.ti -1c
|
|
.RI "double \fBcompactification_coordinate\fP"
|
|
.br
|
|
.RI "The compactification coordinate at the reference position\&. This ranges from 0 to 1, where 0 is the inner surface and 1 is the outer surface of the reference domain\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Structure representing the input to the exterior domain mapping\&. This includes the reference position, displaced position, displacement Jacobian, compactification coordinate gradient, and compactification coordinate\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "double serif::mapping::compactification::ExteriorMapInput::compactification_coordinate"
|
|
|
|
.PP
|
|
The compactification coordinate at the reference position\&. This ranges from 0 to 1, where 0 is the inner surface and 1 is the outer surface of the reference domain\&.
|
|
.SS "const mfem::Vector& serif::mapping::compactification::ExteriorMapInput::compactification_coordinate_gradient"
|
|
|
|
.PP
|
|
Gradient of the compactification coordinate at the reference position\&.
|
|
.SS "const mfem::Vector& serif::mapping::compactification::ExteriorMapInput::displaced_position"
|
|
|
|
.PP
|
|
Position in displaced space to evaluate the mapping at (note this is displaced but not yet compactified)\&.
|
|
.SS "const mfem::DenseMatrix& serif::mapping::compactification::ExteriorMapInput::displacement_jacobian"
|
|
|
|
.PP
|
|
Jacobian of the displacement mapping at the reference position\&.
|
|
.SS "const mfem::Vector& serif::mapping::compactification::ExteriorMapInput::reference_position"
|
|
|
|
.PP
|
|
Position in reference space to evaluate the mapping at\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|