Files
MeanField_SERiF/docs/man/man3/normalized_system.hpp.3

65 lines
1.6 KiB
Groff
Raw Normal View History

.TH "src/include/serif/backend/mfem/model/normalized_system.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/model/normalized_system.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <algorithm>\fP
.br
\fR#include <cmath>\fP
.br
\fR#include <expected>\fP
.br
\fR#include <memory>\fP
.br
\fR#include <string>\fP
.br
\fR#include <vector>\fP
.br
\fR#include 'serif/backend/mfem/model/system\&.hpp'\fP
.br
\fR#include 'serif/backend/mfem/solver/normalization/operators\&.hpp'\fP
.br
\fR#include 'serif/solver/normalization/scales\&.hpp'\fP
.br
\fR#include 'serif/utils/error/errors\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "class \fBserif::model::backend::mfem::NormalizedSystem\fP"
.br
.RI "A frozen physical preparation and its owning solver coordinates, safe after later graph preparation\&. "
.in -1c
.SS "Namespaces"
.in +1c
.ti -1c
.RI "namespace \fBserif\fP"
.br
.ti -1c
.RI "namespace \fBserif::model\fP"
.br
.ti -1c
.RI "namespace \fBserif::model::backend\fP"
.br
.ti -1c
.RI "namespace \fBserif::model::backend::mfem\fP"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "std::expected< std::shared_ptr< const \fBNormalizedSystem\fP >, std::string > \fBserif::model::backend::mfem::make_normalized_system\fP (std::shared_ptr< const \fBPhysicalSystem\fP > physical, \fBsolver::normalization::DiagonalNormalization\fP coordinates, \fBsolver::normalization::StellarReferenceScales\fP reference)"
.br
.RI "Reject a nonrepresentable normalized residual before publishing the matching physical preparation\&. "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.