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)
52 lines
1.6 KiB
Groff
52 lines
1.6 KiB
Groff
.TH "serif::model::preconditioning" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::model::preconditioning
|
|
.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 \fBNone\fP"
|
|
.br
|
|
.RI "Evaluate physical equations without preparing an inverse until a recipe is selected\&. "
|
|
.ti -1c
|
|
.RI "struct \fBPreparedSystem\fP"
|
|
.br
|
|
.RI "An owning evaluated system and its matching preconditioner\&. "
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename ResultKey, typename Recipe, typename Layout, typename\&.\&.\&. Existing> auto \fBmake_computations\fP (const Recipe &recipe, const Layout &layout, const std::tuple< Existing\&.\&.\&. > &existing)"
|
|
.br
|
|
.RI "Connect a recipe to the same physical root, layout and reference geometry as model evaluation\&. "
|
|
.in -1c
|
|
.SH "Function Documentation"
|
|
.PP
|
|
.SS "template<typename ResultKey, typename Recipe, typename Layout, typename\&.\&.\&. Existing> auto serif::model::preconditioning::make_computations (const Recipe & recipe, const Layout & layout, const std::tuple< Existing\&.\&.\&. > & existing)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Connect a recipe to the same physical root, layout and reference geometry as model evaluation\&.
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
Merely adding these computations does not prepare an inverse\&. Only requesting \fBPreparedSystem\fP reaches this branch, so line-search evaluations can reuse the physical graph without inverse setup\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|