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)
47 lines
1.1 KiB
Groff
47 lines
1.1 KiB
Groff
.TH "serif::solver::normalization::keys" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::solver::normalization::keys
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBFactors\fP"
|
|
.br
|
|
.RI "Distinguish state and residual factors even when they share the same physical term\&. "
|
|
.ti -1c
|
|
.RI "struct \fBNormalization\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBPrescription\fP"
|
|
.br
|
|
.RI "Bind the exact custom prescription named by a runtime-prepared coordinate\&. "
|
|
.ti -1c
|
|
.RI "struct \fBReferenceBinding\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBScales\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Typedefs"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBLayout\fP = \fBdiscretization::blocks::keys::Layout\fP"
|
|
.br
|
|
.RI "\fBNormalization\fP consumes the same coordinate layout as every other numerical service\&. "
|
|
.in -1c
|
|
.SH "Typedef Documentation"
|
|
.PP
|
|
.SS "using \fBserif::solver::normalization::keys::Layout\fP = \fBdiscretization::blocks::keys::Layout\fP"
|
|
|
|
.PP
|
|
\fBNormalization\fP consumes the same coordinate layout as every other numerical service\&.
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|