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)
69 lines
2.0 KiB
Groff
69 lines
2.0 KiB
Groff
.TH "src/lib/serif/backend/mfem/solver/preconditioner/inverse/sparse_direct.cpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/lib/serif/backend/mfem/solver/preconditioner/inverse/sparse_direct.cpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'serif/backend/mfem/solver/preconditioner/inverse/sparse_direct\&.hpp'\fP
|
|
.br
|
|
\fR#include <algorithm>\fP
|
|
.br
|
|
\fR#include <cmath>\fP
|
|
.br
|
|
\fR#include <mutex>\fP
|
|
.br
|
|
\fR#include <vector>\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/solver/preconditioner/inverse/validation\&.hpp'\fP
|
|
.br
|
|
\fR#include 'direct_lu\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::preconditioner::backend::mfem::SparseDirectCache::State\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver::preconditioner\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver::preconditioner::backend\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver::preconditioner::backend::mfem\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "std::string_view \fBserif::solver::preconditioner::backend::mfem::sparse_direct_backend\fP () noexcept"
|
|
.br
|
|
.RI "The sparse LU backend compiled into this library (Meson option sparse_direct): "accelerate", "umfpack" or "none"\&. "
|
|
.ti -1c
|
|
.RI "bool \fBserif::solver::preconditioner::backend::mfem::sparse_direct_available\fP () noexcept"
|
|
.br
|
|
.RI "True when SparseDirect can be prepared on this machine; with "none", or Accelerate before macOS 15\&.5, it cannot\&. "
|
|
.ti -1c
|
|
.RI "std::expected< \fBInverse\fP, \fBFailure\fP > \fBserif::solver::preconditioner::backend::mfem::try_sparse_direct_inverse\fP (std::shared_ptr< const ::mfem::SparseMatrix > matrix, const \fBstrategies::inverse::SparseDirect\fP &options={}, \fBSparseDirectCache\fP *cache=nullptr)"
|
|
.br
|
|
.RI "Factor a finalized square sparse matrix with a pivoted sparse LU; every application is one exact solve\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|