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)
91 lines
2.4 KiB
Groff
91 lines
2.4 KiB
Groff
.TH "serif::mapping::VolumeMappingCache" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::mapping::VolumeMappingCache
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <volume_cache\&.hpp>\fP
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "void \fBset_size\fP (int point_count, int dimension)"
|
|
.br
|
|
.ti -1c
|
|
.RI "void \fBstore\fP (int point, \fBVolumeMappingContext\fP &context)"
|
|
.br
|
|
.ti -1c
|
|
.RI "void \fBload\fP (int point, \fBVolumeMappingContext\fP &context) const"
|
|
.br
|
|
.ti -1c
|
|
.RI "void \fBload_inverse_jacobian\fP (int point, mfem::DenseMatrix &inverse) const"
|
|
.br
|
|
.ti -1c
|
|
.RI "int \fBget_point_count\fP () const noexcept"
|
|
.br
|
|
.ti -1c
|
|
.RI "int \fBget_dimension\fP () const noexcept"
|
|
.br
|
|
.in -1c
|
|
.SS "Private Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "void \fBvalidate_point\fP (int point) const"
|
|
.br
|
|
.ti -1c
|
|
.RI "const double * \fBget_point_data\fP (int point) const"
|
|
.br
|
|
.in -1c
|
|
.SS "Private Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "std::vector< double > \fBm_data\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "int \fBm_point_count\fP {0}"
|
|
.br
|
|
.ti -1c
|
|
.RI "int \fBm_dimension\fP {0}"
|
|
.br
|
|
.ti -1c
|
|
.RI "int \fBm_point_stride\fP {0}"
|
|
.br
|
|
.in -1c
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "int serif::mapping::VolumeMappingCache::get_dimension () const\fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.SS "int serif::mapping::VolumeMappingCache::get_point_count () const\fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.SS "const double * serif::mapping::VolumeMappingCache::get_point_data (int point) const\fR [nodiscard]\fP, \fR [private]\fP"
|
|
|
|
.SS "void serif::mapping::VolumeMappingCache::load (int point, \fBVolumeMappingContext\fP & context) const"
|
|
|
|
.SS "void serif::mapping::VolumeMappingCache::load_inverse_jacobian (int point, mfem::DenseMatrix & inverse) const"
|
|
|
|
.SS "void serif::mapping::VolumeMappingCache::set_size (int point_count, int dimension)"
|
|
|
|
.SS "void serif::mapping::VolumeMappingCache::store (int point, \fBVolumeMappingContext\fP & context)"
|
|
|
|
.SS "void serif::mapping::VolumeMappingCache::validate_point (int point) const\fR [private]\fP"
|
|
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "std::vector<double> serif::mapping::VolumeMappingCache::m_data\fR [private]\fP"
|
|
|
|
.SS "int serif::mapping::VolumeMappingCache::m_dimension {0}\fR [private]\fP"
|
|
|
|
.SS "int serif::mapping::VolumeMappingCache::m_point_count {0}\fR [private]\fP"
|
|
|
|
.SS "int serif::mapping::VolumeMappingCache::m_point_stride {0}\fR [private]\fP"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|