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)
87 lines
2.5 KiB
Groff
87 lines
2.5 KiB
Groff
.TH "src/include/serif/backend/mfem/solver/normalization/operators.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/backend/mfem/solver/normalization/operators.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <cstddef>\fP
|
|
.br
|
|
\fR#include <cstdint>\fP
|
|
.br
|
|
\fR#include <span>\fP
|
|
.br
|
|
\fR#include 'mfem/linalg/operator\&.hpp'\fP
|
|
.br
|
|
\fR#include 'mfem/linalg/vector\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/solver/normalization/diagonal\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "class \fBserif::solver::normalization::backend::mfem::detail::ScaledOperator< Inverse >\fP"
|
|
.br
|
|
.RI "Common algebra for a Jacobian L J S^-1 and an inverse S M^-1 L^-1\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::normalization::backend::mfem::ScaledPreconditionerStatistics\fP"
|
|
.br
|
|
.RI "Counts physical bindings and normalized applications without instrumenting the inverse itself\&. "
|
|
.ti -1c
|
|
.RI "class \fBserif::solver::normalization::backend::mfem::ScaledPreconditioner\fP"
|
|
.br
|
|
.RI "MFEM solver adapter which always binds the physical inverse to its dimensional Jacobian\&. "
|
|
.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::normalization\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver::normalization::backend\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver::normalization::backend::mfem\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver::normalization::backend::mfem::detail\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Typedefs"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBserif::solver::normalization::backend::mfem::ScaledJacobianOperator\fP = \fBdetail::ScaledOperator\fP<false>"
|
|
.br
|
|
.RI "Normalized Jacobian L J S^-1\&. "
|
|
.ti -1c
|
|
.RI "using \fBserif::solver::normalization::backend::mfem::ScaledInverseOperator\fP = \fBdetail::ScaledOperator\fP<true>"
|
|
.br
|
|
.RI "Normalized physical inverse S M^-1 L^-1\&. "
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "int \fBserif::solver::normalization::backend::mfem::detail::mfem_size\fP (std::size_t size)"
|
|
.br
|
|
.RI "Translate a prepared coordinate size without narrowing beyond MFEM's index range\&. "
|
|
.ti -1c
|
|
.RI "void \fBserif::solver::normalization::backend::mfem::detail::scale_vector\fP (std::span< const double > factors, const ::mfem::Vector &input, ::mfem::Vector &output, bool inverse)"
|
|
.br
|
|
.RI "Apply a diagonal to MFEM host storage, resizing only after the input has been checked\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|