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)
70 lines
2.6 KiB
Groff
70 lines
2.6 KiB
Groff
.TH "serif::discretization::backend::mfem::ElementReconstruction" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::backend::mfem::ElementReconstruction \- An element's radial reconstruction; the enclosing plan owns its profile\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <reconstruction\&.hpp>\fP
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "bool \fBoperator==\fP (const \fBElementReconstruction\fP &) const =default"
|
|
.br
|
|
.RI "Compare the mathematical reference operators for tensor-cache reuse\&. "
|
|
.ti -1c
|
|
.RI "void \fBradial\fP (const ::mfem::FiniteElement &element, double coordinate, ::mfem::Vector &values, ::mfem::Vector &derivatives) const"
|
|
.br
|
|
.RI "Evaluate radial factors in MFEM's canonical coordinate and ordering\&. "
|
|
.ti -1c
|
|
.RI "void \fBsample\fP (const ::mfem::FiniteElement &element, const ::mfem::IntegrationPoint &point, ::mfem::Vector &values, ::mfem::DenseMatrix &derivatives) const"
|
|
.br
|
|
.RI "Evaluate a dense reference oracle, retaining MFEM's native nodal ordering\&. "
|
|
.in -1c
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "const \fBreconstruction::RadialProfile\fP * \fBprofile\fP {nullptr}"
|
|
.br
|
|
.ti -1c
|
|
.RI "int \fBinward_axis\fP {0}"
|
|
.br
|
|
.ti -1c
|
|
.RI "bool \fBsurface_at_high_coordinate\fP {false}"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
An element's radial reconstruction; the enclosing plan owns its profile\&.
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "bool serif::discretization::backend::mfem::ElementReconstruction::operator== (const \fBElementReconstruction\fP & ) const\fR [default]\fP"
|
|
|
|
.PP
|
|
Compare the mathematical reference operators for tensor-cache reuse\&.
|
|
.SS "void serif::discretization::backend::mfem::ElementReconstruction::radial (const ::mfem::FiniteElement & element, double coordinate, ::mfem::Vector & values, ::mfem::Vector & derivatives) const"
|
|
|
|
.PP
|
|
Evaluate radial factors in MFEM's canonical coordinate and ordering\&.
|
|
.SS "void serif::discretization::backend::mfem::ElementReconstruction::sample (const ::mfem::FiniteElement & element, const ::mfem::IntegrationPoint & point, ::mfem::Vector & values, ::mfem::DenseMatrix & derivatives) const"
|
|
|
|
.PP
|
|
Evaluate a dense reference oracle, retaining MFEM's native nodal ordering\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "int serif::discretization::backend::mfem::ElementReconstruction::inward_axis {0}"
|
|
|
|
.SS "const \fBreconstruction::RadialProfile\fP* serif::discretization::backend::mfem::ElementReconstruction::profile {nullptr}"
|
|
|
|
.SS "bool serif::discretization::backend::mfem::ElementReconstruction::surface_at_high_coordinate {false}"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|