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.3 KiB
Groff
91 lines
2.3 KiB
Groff
.TH "src/include/serif/backend/mfem/operators/operand_evaluation.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/backend/mfem/operators/operand_evaluation.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <array>\fP
|
|
.br
|
|
\fR#include <concepts>\fP
|
|
.br
|
|
\fR#include <type_traits>\fP
|
|
.br
|
|
\fR#include <stdexcept>\fP
|
|
.br
|
|
\fR#include <utility>\fP
|
|
.br
|
|
\fR#include 'mfem/fem/fe/fe_base\&.hpp'\fP
|
|
.br
|
|
\fR#include 'mfem/fem/eltrans\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/operators/concepts\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/discretization/basis_evaluation\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/discretization/dof_map\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/mapping/transformations\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/utils/error/errors\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/utils/misc/compensated_sum\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::backend::mfem::OperandEvaluator< OperandT >\fP"
|
|
.br
|
|
.RI "Scalar and vector H1 gradients share the existing value/divergence coefficient contractions\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::operators::backend::mfem::BasisWorkspace\fP"
|
|
.br
|
|
.RI "Reusable scratch storage for basis contractions, reducing repeated allocations\&. "
|
|
.ti -1c
|
|
.RI "class \fBserif::operators::backend::mfem::TensorBasisCache\fP"
|
|
.br
|
|
.RI "Share immutable tensor plans within one operator; copied rules are keyed by their contents\&. "
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::operators\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::operators::backend\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::operators::backend::mfem\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Concepts"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "concept \fBserif::operators::backend::mfem::EvaluableOperand\fP"
|
|
.br
|
|
.RI "Check the complete interface used by preparation, Jacobian application, and its transpose\&. "
|
|
.in -1c
|
|
.SS "Enumerations"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "enum class \fBserif::operators::backend::mfem::ContractionMode\fP "
|
|
.br
|
|
.RI "Options enum to control how the tensor contractions are performed\&. "
|
|
.ti -1c
|
|
.RI "enum class \fBserif::operators::backend::mfem::ReferenceOperation\fP "
|
|
.br
|
|
.RI "Options enum to control what is actually evaluated at the reference points\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|