100 lines
3.2 KiB
Groff
100 lines
3.2 KiB
Groff
|
.TH "src/include/serif/backend/mfem/discretization/tensor_basis.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
src/include/serif/backend/mfem/discretization/tensor_basis.hpp \- Implementation of fast tensor evaluation functions\&. These do not contribute physics but are used to accelerate evaluations\&.
|
||
|
|
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
\fR#include <algorithm>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <array>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <cmath>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <limits>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <memory>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <vector>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <utility>\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'mfem/fem/fe/fe_h1\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'mfem/fem/fe/fe_l2\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/utils/error/errors\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/backend/mfem/discretization/reconstruction\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
|
||
|
|
.SS "Classes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::discretization::backend::mfem::TensorWorkspace\fP"
|
||
|
|
.br
|
||
|
|
.RI "A workspace for tensor contractions to avoid repeated allocations and pack memory (TODO: does this actual pack memory in a useful manner when using mfem vectors? Probably something to look into)\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "class \fBserif::discretization::backend::mfem::TensorBasis\fP"
|
||
|
|
.br
|
||
|
|
.RI "A class that represents a tensor basis for a finite element\&. This class is used to evaluate the basis functions and their derivatives at a set of reference points\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::discretization::backend::mfem::TensorBasis::Product\fP"
|
||
|
|
.br
|
||
|
|
.RI "A struct that represents a product of one-dimensional basis functions\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "class \fBserif::discretization::backend::mfem::TensorBasisCache\fP"
|
||
|
|
.br
|
||
|
|
.RI "Share immutable tensor plans within one operator; copied rules are keyed by their contents\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::discretization::backend::mfem::TensorBasisCache::Entry\fP"
|
||
|
|
.br
|
||
|
|
.RI "A struct that represents an entry in the \fBTensorBasisCache\fP\&. Each entry contains a non-owning pointer to a finite element, the reference operation, the number of copies, the points used to construct the \fBTensorBasis\fP, and a shared pointer to the \fBTensorBasis\fP itself\&. "
|
||
|
|
.in -1c
|
||
|
|
.SS "Namespaces"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBserif\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBserif::discretization\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBserif::discretization::backend\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBserif::discretization::backend::mfem\fP"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SS "Enumerations"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "enum class \fBserif::discretization::backend::mfem::ReferenceOperation\fP { \fBserif::discretization::backend::mfem::value\fP, \fBserif::discretization::backend::mfem::gradient\fP, \fBserif::discretization::backend::mfem::value_and_gradient\fP }"
|
||
|
|
.br
|
||
|
|
.RI "Options enum to control what is actually evaluated at the reference points\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "enum class \fBserif::discretization::backend::mfem::ContractionMode\fP { \fBserif::discretization::backend::mfem::automatic\fP, \fBserif::discretization::backend::mfem::dense\fP }"
|
||
|
|
.br
|
||
|
|
.RI "Options enum to control how the tensor contractions are performed\&. "
|
||
|
|
.in -1c
|
||
|
|
.SH "Detailed Description"
|
||
|
|
.PP
|
||
|
|
Implementation of fast tensor evaluation functions\&. These do not contribute physics but are used to accelerate evaluations\&.
|
||
|
|
|
||
|
|
|
||
|
|
.PP
|
||
|
|
\fBAuthor\fP
|
||
|
|
.RS 4
|
||
|
|
Emily M\&. Boudreaux
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|