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)
138 lines
4.4 KiB
Groff
138 lines
4.4 KiB
Groff
.TH "serif::model::normalization::detail" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::model::normalization::detail
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBAutomaticRules\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBAutomaticRules< Coordinates, Plan, dependencies::KeyList< Values\&.\&.\&. >, utils::types::TypeList< Equations\&.\&.\&. > >\fP"
|
|
.br
|
|
.RI "Equation residual quantities remain independent from the unknowns occupying their rows\&. "
|
|
.ti -1c
|
|
.RI "struct \fBConfigurationTracking\fP"
|
|
.br
|
|
.RI "Rebuilding the input context does not change the identity of an immutable configuration\&. "
|
|
.ti -1c
|
|
.RI "struct \fBInfinityRule\fP"
|
|
.br
|
|
.RI "Pointwise infinity values have potential units rather than integrated Poisson units\&. "
|
|
.ti -1c
|
|
.RI "struct \fBMethodMetrics\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBMethodMetrics< numerical::DimensionlessRieszCoordinate< Quantity, Metric, Geometry > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBMethodMetrics< numerical::PhysicalRieszCoordinate< Quantity, Metric > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBMethodMetrics< numerical::WithPointRows< Method, Quantity, Selection > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBMetric\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBMetric< Term, true >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBResidualRules\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBResidualRules< dependencies::Bindings< Interior\&.\&.\&. >, dependencies::Bindings< Shape\&.\&.\&. > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBRuleMetrics\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBRuleMetrics< dependencies::Bindings< Rules\&.\&.\&. > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBSelectPlan\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBSelectPlan< numerical::AutomaticPlan, Coordinates, Bound >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBSurfaceRule\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBSurfaceRule< Method, Row, Plan, true >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBValueRule\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBValueRule< Coordinates, blocks::surface_deformation::coefficients >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBVolumeMetric\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBVolumeMetric< solver::normalization::ReferenceVolumeMetric< TermT > >\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Concepts"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "concept \fBReferenceAvailable\fP"
|
|
.br
|
|
.RI "Explicit reference values take precedence over model defaults without changing physical prescriptions\&. "
|
|
.in -1c
|
|
.SS "Typedefs"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename Coordinates, typename Quantity, typename \fBMetric\fP> using \fBCoordinate\fP = numerical::DimensionlessRieszCoordinate<Quantity, \fBMetric\fP>"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename \fBMetric\fP, typename Discretization> auto \fBmetric_inputs\fP (const Discretization &discretization)"
|
|
.br
|
|
.RI "Reference volume metrics borrow the same term binding and track its mesh and space revisions\&. "
|
|
.ti -1c
|
|
.RI "template<typename \fBMetric\fP, typename Discretization> auto \fBmetric_computations\fP (const Discretization &)"
|
|
.br
|
|
.RI "Supply built-in metrics once; custom metric keys are provided by the user's ordinary graph sources\&. "
|
|
.ti -1c
|
|
.RI "template<typename Specification, typename Source, typename Model>
|
|
.br
|
|
requires ReferenceAvailable<Source, Model, Specification>auto \fBreference_value\fP (const Source &source, const Model &model)"
|
|
.br
|
|
.RI "Resolve a typed reference source only when its model default is available\&. "
|
|
.in -1c
|
|
.SH "Typedef Documentation"
|
|
.PP
|
|
.SS "template<typename Coordinates, typename Quantity, typename \fBMetric\fP> using \fBserif::model::normalization::detail::Coordinate\fP = numerical::DimensionlessRieszCoordinate<Quantity, \fBMetric\fP>"
|
|
|
|
.SH "Function Documentation"
|
|
.PP
|
|
.SS "template<typename \fBMetric\fP, typename Discretization> auto serif::model::normalization::detail::metric_computations (const Discretization & )\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Supply built-in metrics once; custom metric keys are provided by the user's ordinary graph sources\&.
|
|
.SS "template<typename \fBMetric\fP, typename Discretization> auto serif::model::normalization::detail::metric_inputs (const Discretization & discretization)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Reference volume metrics borrow the same term binding and track its mesh and space revisions\&.
|
|
.SS "template<typename Specification, typename Source, typename Model>
|
|
.br
|
|
requires ReferenceAvailable<Source, Model, Specification>auto serif::model::normalization::detail::reference_value (const Source & source, const Model & model)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Resolve a typed reference source only when its model default is available\&.
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|