MeanField_SERiF/docs/man/man3/serif_model_normalization.3

.TH "serif::model::normalization" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::model::normalization
.SH SYNOPSIS
.br
.PP
.SS "Namespaces"

.in +1c
.ti -1c
.RI "namespace \fBdetail\fP"
.br
.in -1c
.SS "Classes"

.in +1c
.ti -1c
.RI "struct \fBConfiguration\fP"
.br
.ti -1c
.RI "struct \fBInfinityRows\fP"
.br
.RI "Potential rows replaced by the zero trace at compactified infinity\&. "
.ti -1c
.RI "struct \fBPreparedSystem\fP"
.br
.ti -1c
.RI "struct \fBSurfaceRows\fP"
.br
.RI "Reduced equation rows whose volume residual is replaced by the selected surface condition\&. "
.in -1c
.SS "Concepts"

.in +1c
.ti -1c
.RI "concept \fBReferenceResolvable\fP"
.br
.RI "Check model-provided reference requirements before instantiating numerical preparation\&. "
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "template<typename Selection, typename Coordinates, typename Bound> using \fBPlanFor\fP = typename \fBdetail::SelectPlan\fP<Selection, Coordinates, Bound>::Type"
.br
.RI "Compile automatic physics-aware rules or retain the user's complete explicit plan\&. "
.ti -1c
.RI "template<typename Plan> using \fBMetricsFor\fP"
.br
.RI "Assemble each metric once even when several state and residual rules share it\&. "
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "template<typename Options, typename Discretization, typename\&.\&.\&. Metrics> auto \fBmake_inputs\fP (std::shared_ptr< const Options > options, const Discretization &discretization, \fButils::dependencies::KeyList\fP< Metrics\&.\&.\&. >)"
.br
.RI "Keep the immutable configuration alive and reference metrics separate from candidate coefficients\&. "
.ti -1c
.RI "template<typename NormalizationPlan, typename Bound, typename Options, typename Layout, typename\&.\&.\&. Metrics> auto \fBmake_computations\fP (const Bound &bound, const Options &options, const Layout &layout, \fButils::dependencies::KeyList\fP< Metrics\&.\&.\&. >)"
.br
.RI "Compose normalization into the physical graph, including the selected surface row replacement\&. "
.ti -1c
.RI "template<typename Mass, typename Density, StellarModelType Model> 
.br
requires detail::ReferenceAvailable<Mass, Model, \fBFixedTotalMass\fP> && std::same_as<Density, \fBdimensions::DensityValue\fP>auto \fBresolve_reference\fP (const \fBsolver::normalization::LaneEmdenApproximation\fP< Mass, Density > &scheme, const Model &model)"
.br
.RI "Resolve the Lane–Emden reference from explicit inputs or the model's mass target; no model prescribes central density\&. "
.ti -1c
.RI "template<solver::normalization::ReferenceScheme Scheme, StellarModelType Model> Scheme \fBresolve_reference\fP (const Scheme &scheme, const Model &)"
.br
.RI "Explicit or custom reference schemes need no model-specific defaults\&. "
.ti -1c
.RI "template<typename Options, StellarModelType Model> 
.br
requires ReferenceResolvable<Options, Model>auto \fBresolve_configuration\fP (Options options, const Model &model)"
.br
.RI "Freeze resolved reference choices while retaining the deduced coordinate and plan types\&. "
.in -1c
.SH "Typedef Documentation"
.PP 
.SS "template<typename Plan> using \fBserif::model::normalization::MetricsFor\fP"
\fBInitial value:\fP
.nf
 utils::dependencies::CombinedKeyList<typename detail::RuleMetrics<typename Plan::Values>::Type,
        typename detail::RuleMetrics<typename Plan::Residuals>::Type>
.PP
.fi

.PP
Assemble each metric once even when several state and residual rules share it\&. 
.SS "template<typename Selection, typename Coordinates, typename Bound> using \fBserif::model::normalization::PlanFor\fP = typename \fBdetail::SelectPlan\fP<Selection, Coordinates, Bound>::Type"

.PP
Compile automatic physics-aware rules or retain the user's complete explicit plan\&. 
.SH "Function Documentation"
.PP 
.SS "template<typename NormalizationPlan, typename Bound, typename Options, typename Layout, typename\&.\&.\&. Metrics> auto serif::model::normalization::make_computations (const Bound & bound, const Options & options, const Layout & layout, \fButils::dependencies::KeyList\fP< Metrics\&.\&.\&. > )\fR [nodiscard]\fP"

.PP
Compose normalization into the physical graph, including the selected surface row replacement\&. 
.SS "template<typename Options, typename Discretization, typename\&.\&.\&. Metrics> auto serif::model::normalization::make_inputs (std::shared_ptr< const Options > options, const Discretization & discretization, \fButils::dependencies::KeyList\fP< Metrics\&.\&.\&. > )\fR [nodiscard]\fP"

.PP
Keep the immutable configuration alive and reference metrics separate from candidate coefficients\&. 
.SS "template<typename Options, StellarModelType Model> 
.br
requires ReferenceResolvable<Options, Model>auto serif::model::normalization::resolve_configuration (Options options, const Model & model)\fR [nodiscard]\fP"

.PP
Freeze resolved reference choices while retaining the deduced coordinate and plan types\&. 
.SS "template<solver::normalization::ReferenceScheme Scheme, StellarModelType Model> Scheme serif::model::normalization::resolve_reference (const Scheme & scheme, const Model & )\fR [nodiscard]\fP"

.PP
Explicit or custom reference schemes need no model-specific defaults\&. 
.SS "template<typename Mass, typename Density, StellarModelType Model> 
.br
requires detail::ReferenceAvailable<Mass, Model, \fBFixedTotalMass\fP> && std::same_as<Density, \fBdimensions::DensityValue\fP>auto serif::model::normalization::resolve_reference (const \fBsolver::normalization::LaneEmdenApproximation\fP< Mass, Density > & scheme, const Model & model)\fR [nodiscard]\fP"

.PP
Resolve the Lane–Emden reference from explicit inputs or the model's mass target; no model prescribes central density\&. 
.SH "Author"
.PP 
Generated automatically by Doxygen for SERiF from the source code\&.