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

76 lines
2.5 KiB
Groff
Raw Normal View History

.TH "src/include/serif/solver/normalization/computations.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/solver/normalization/computations.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <array>\fP
.br
\fR#include <cstddef>\fP
.br
\fR#include <expected>\fP
.br
\fR#include <span>\fP
.br
\fR#include <string>\fP
.br
\fR#include <tuple>\fP
.br
\fR#include <type_traits>\fP
.br
\fR#include 'serif/solver/normalization/detail/factor_computations\&.hpp'\fP
.br
\fR#include 'serif/solver/normalization/detail/packing\&.hpp'\fP
.br
.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::detail\fP"
.br
.in -1c
.SS "Concepts"
.in +1c
.ti -1c
.RI "concept \fBserif::solver::normalization::NormalizationPreparable\fP"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "template<typename RulesT, typename LayoutT, typename ScalesT, \fBdiscretization::blocks::RepresentedValueKind\fP Kind, typename\&.\&.\&. Coordinates> consteval bool \fBserif::solver::normalization::detail::can_prepare_coordinates\fP (\fButils::dependencies::KeyList\fP< Coordinates\&.\&.\&. >)"
.br
.RI "Test every coordinate factory without instantiating an unusable runtime graph\&. "
.ti -1c
.RI "template<typename RulesT, typename LayoutT, typename ScalesT, \fBdiscretization::blocks::RepresentedValueKind\fP Kind, typename\&.\&.\&. Coordinates> auto \fBserif::solver::normalization::detail::coordinate_computations\fP (\fButils::dependencies::KeyList\fP< Coordinates\&.\&.\&. >)"
.br
.RI "Expand the supplied layout, looking up methods without imposing plan declaration order\&. "
.ti -1c
.RI "template<typename\&.\&.\&. Values, typename\&.\&.\&. Residuals> auto \fBserif::solver::normalization::detail::packing_computation\fP (\fButils::dependencies::KeyList\fP< Values\&.\&.\&. >, \fButils::dependencies::KeyList\fP< Residuals\&.\&.\&. >)"
.br
.RI "Freeze the independently ordered state and residual coordinates into one owning result\&. "
.ti -1c
.RI "template<typename PlanT, typename ScalesT = StellarReferenceScales, typename LayoutT>
.br
requires NormalizationPreparable<PlanT, LayoutT, ScalesT>auto \fBserif::solver::normalization::make_normalization_computations\fP (const LayoutT &)"
.br
.RI "Declare normalization as ordinary dependency computations; no metrics or factors are prepared here\&. "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.