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)
64 lines
2.5 KiB
Groff
64 lines
2.5 KiB
Groff
.TH "serif::solver::continuation::IdentifiedEquations< Definition, Values >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::solver::continuation::IdentifiedEquations< Definition, Values > \- Give a deferred equation definition an explicit physical identity without runtime polymorphism\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <identified_equations\&.hpp>\fP
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "auto \fBcontinuation_identity\fP () const"
|
|
.br
|
|
.RI "Read fixed captured quantities in their declared physical units for family membership\&. "
|
|
.ti -1c
|
|
.RI "template<typename Model>
|
|
.br
|
|
requires std::invocable<const Definition&, const Model&>decltype(auto) \fBoperator()\fP (const Model &model) const"
|
|
.br
|
|
.RI "Rebuild equations from the stage's own model while retaining the supplied callable\&. "
|
|
.in -1c
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "Definition \fBdefinition\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::tuple< Values\&.\&.\&. > \fBidentity\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<typename Definition, CoordinateValue\&.\&.\&. Values>
|
|
.br
|
|
struct serif::solver::continuation::IdentifiedEquations< Definition, Values >"Give a deferred equation definition an explicit physical identity without runtime polymorphism\&.
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "template<typename Definition, CoordinateValue\&.\&.\&. Values> auto \fBserif::solver::continuation::IdentifiedEquations\fP< Definition, Values >::continuation_identity () const\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Read fixed captured quantities in their declared physical units for family membership\&.
|
|
.SS "template<typename Definition, CoordinateValue\&.\&.\&. Values> template<typename Model>
|
|
.br
|
|
requires std::invocable<const Definition&, const Model&>decltype(auto) \fBserif::solver::continuation::IdentifiedEquations\fP< Definition, Values >::operator() (const Model & model) const\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Rebuild equations from the stage's own model while retaining the supplied callable\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "template<typename Definition, CoordinateValue\&.\&.\&. Values> Definition \fBserif::solver::continuation::IdentifiedEquations\fP< Definition, Values >::definition"
|
|
|
|
.SS "template<typename Definition, CoordinateValue\&.\&.\&. Values> std::tuple<Values\&.\&.\&.> \fBserif::solver::continuation::IdentifiedEquations\fP< Definition, Values >::identity"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|