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

139 lines
5.2 KiB
Groff
Raw Normal View History

.TH "src/include/serif/solver/normalization/plan.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/solver/normalization/plan.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <concepts>\fP
.br
\fR#include <type_traits>\fP
.br
\fR#include 'serif/dimensions/quantities\&.hpp'\fP
.br
\fR#include 'serif/discretization/blocks/base\&.hpp'\fP
.br
\fR#include 'serif/solver/normalization/metrics\&.hpp'\fP
.br
\fR#include 'serif/solver/normalization/dimensionless\&.hpp'\fP
.br
\fR#include 'serif/utils/dependencies/binding\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBserif::solver::normalization::NormalizationPrescriptionTag\fP"
.br
.ti -1c
.RI "struct \fBserif::solver::normalization::IdentityCoordinate\fP"
.br
.RI "Leave the declared coordinates unchanged, including their physical units\&. "
.ti -1c
.RI "struct \fBserif::solver::normalization::PhysicalRieszCoordinate< QuantityT, MetricKeyT >\fP"
.br
.RI "Measure a physical quantity with the named reference Gram diagonal\&. "
.ti -1c
.RI "struct \fBserif::solver::normalization::DimensionlessRieszCoordinate< QuantityT, MetricKeyT, Geometry >\fP"
.br
.RI "Measure coordinates using dimensionless physical fields and reference geometry\&. "
.ti -1c
.RI "struct \fBserif::solver::normalization::WithPointRows< VolumeMethodT, PointQuantityT, SelectionKeyT >\fP"
.br
.RI "Replace selected volume residual rows by point residuals with their own physical quantity\&. "
.ti -1c
.RI "struct \fBserif::solver::normalization::RuntimePreparedCoordinate< PrescriptionT >\fP"
.br
.RI "Identify the exact prescription supplying positive factors; this never claims identity scaling\&. "
.ti -1c
.RI "struct \fBserif::solver::normalization::NormalizationPlan< ValueRulesT, ResidualRulesT >\fP"
.br
.RI "Independent term-to-method and row-to-method maps; their order does not define the packed layout\&. "
.ti -1c
.RI "struct \fBserif::solver::normalization::detail::RuleKeys< utils::dependencies::Bindings< Rules\&.\&.\&. > >\fP"
.br
.ti -1c
.RI "struct \fBserif::solver::normalization::detail::MethodSupports< MethodT, KeyT, Kind >\fP"
.br
.ti -1c
.RI "struct \fBserif::solver::normalization::detail::MethodSupports< IdentityCoordinate, KeyT, Kind >\fP"
.br
.ti -1c
.RI "struct \fBserif::solver::normalization::detail::MethodSupports< PhysicalRieszCoordinate< QuantityT, MetricT >, KeyT, Kind >\fP"
.br
.ti -1c
.RI "struct \fBserif::solver::normalization::detail::MethodSupports< WithPointRows< PhysicalRieszCoordinate< QuantityT, MetricT >, PointQuantityT, SelectionT >, KeyT, discretization::blocks::RepresentedValueKind::residual >\fP"
.br
.ti -1c
.RI "struct \fBserif::solver::normalization::detail::MethodSupports< DimensionlessRieszCoordinate< QuantityT, MetricT, Geometry >, KeyT, Kind >\fP"
.br
.ti -1c
.RI "struct \fBserif::solver::normalization::detail::MethodSupports< WithPointRows< DimensionlessRieszCoordinate< QuantityT, MetricT, Geometry >, PointQuantityT, SelectionT >, KeyT, discretization::blocks::RepresentedValueKind::residual >\fP"
.br
.ti -1c
.RI "struct \fBserif::solver::normalization::detail::MethodSupports< RuntimePreparedCoordinate< PrescriptionT >, KeyT, Kind >\fP"
.br
.ti -1c
.RI "struct \fBserif::solver::normalization::detail::ValidRules< RulesT, Kind >\fP"
.br
.ti -1c
.RI "struct \fBserif::solver::normalization::detail::ValidRules< utils::dependencies::Bindings< Rules\&.\&.\&. >, Kind >\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::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::NormalizationPrescription\fP"
.br
.ti -1c
.RI "concept \fBserif::solver::normalization::NormalizationPlanType\fP"
.br
.ti -1c
.RI "concept \fBserif::solver::normalization::CompleteNormalizationFor\fP"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "template<typename\&.\&.\&. Declared, typename\&.\&.\&. Required> consteval bool \fBserif::solver::normalization::detail::exact_coordinates\fP (\fButils::dependencies::KeyList\fP< Declared\&.\&.\&. >, \fButils::dependencies::KeyList\fP< Required\&.\&.\&. >)"
.br
.RI "Compare memberships in both directions without deduplicating ownership declarations\&. "
.ti -1c
.RI "template<typename KeyT, typename QuantityT, \fBdiscretization::blocks::RepresentedValueKind\fP Kind> consteval bool \fBserif::solver::normalization::detail::quantity_matches\fP ()"
.br
.RI "Check physics metadata when present; explicit low-level residual declarations remain their own authority\&. "
.in -1c
.SS "Variables"
.in +1c
.ti -1c
.RI "template<typename Candidate> constexpr bool \fBserif::solver::normalization::detail::valid_plan\fP = false"
.br
.ti -1c
.RI "template<typename ValuesT, typename ResidualsT> constexpr bool \fBserif::solver::normalization::detail::valid_plan< NormalizationPlan< ValuesT, ResidualsT > >\fP = \fBValidRules\fP<ValuesT, \fBdiscretization::blocks::RepresentedValueKind::value\fP>::value && \fBValidRules\fP<ResidualsT, \fBdiscretization::blocks::RepresentedValueKind::residual\fP>::value"
.br
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.