Files
MeanField_SERiF/docs/man/man3/actions.cpp.3

69 lines
2.4 KiB
Groff
Raw Normal View History

.TH "src/lib/serif/backend/mfem/operators/actions.cpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/lib/serif/backend/mfem/operators/actions.cpp
.SH SYNOPSIS
.br
.PP
\fR#include 'serif/utils/error/nonfinite\&.hpp'\fP
.br
\fR#include 'serif/backend/mfem/operators/actions\&.hpp'\fP
.br
\fR#include <algorithm>\fP
.br
\fR#include <utility>\fP
.br
\fR#include 'serif/backend/mfem/shared/finite\&.hpp'\fP
.br
\fR#include 'serif/utils/error/errors\&.hpp'\fP
.br
.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 "Functions"
.in +1c
.ti -1c
.RI "\fBLinearizedBlock\fP \fBserif::operators::backend::mfem::linearized_action\fP (int rows, int columns, \fBMatrixAction\fP action, \fBMatrixAction\fP transpose)"
.br
.RI "Wrap owned callbacks with checked dimensions, finite results, and overlap-safe application\&. "
.ti -1c
.RI "\fBLinearizedBlock\fP \fBserif::operators::backend::mfem::linearized_action\fP (int rows, int columns, \fBMatrixAction\fP action, \fBMatrixAction\fP transpose, \fBMatrixArrayAction\fP batch)"
.br
.RI "As above, with a batched forward action used by the operator's ArrayMult\&. "
.ti -1c
.RI "void \fBserif::operators::backend::mfem::apply_many\fP (const ::mfem::Operator &action, std::span< const \fB::mfem::Vector\fP *const > inputs, std::span<\fB::mfem::Vector\fP *const > outputs)"
.br
.RI "Apply an operator to several directions; ArrayMult for SERiF actions, otherwise one Mult per direction\&. "
.ti -1c
.RI "\fBLinearizedBlock\fP \fBserif::operators::backend::mfem::transpose_block\fP (\fBLinearizedBlock\fP block)"
.br
.RI "Transpose a linearized block without discarding efficient assembly and diagonal operations\&. "
.ti -1c
.RI "\fBLinearizedBlock\fP \fBserif::operators::backend::mfem::compose_blocks\fP (\fBLinearizedBlock\fP left, \fBLinearizedBlock\fP right)"
.br
.RI "Compose linearized blocks in their written mathematical order\&. "
.ti -1c
.RI "\fBLinearizedBlock\fP \fBserif::operators::backend::mfem::sum_blocks\fP (int rows, int columns, std::vector< \fBLinearizedBlock\fP > blocks)"
.br
.RI "Sum compatible linearized blocks while retaining their native diagonal and sparse assembly operations\&. "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.