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)
140 lines
7.5 KiB
Groff
140 lines
7.5 KiB
Groff
.TH "serif::model::backend::mfem::StellarProblem< Graph, Inputs, Layout, Failure >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::model::backend::mfem::StellarProblem< Graph, Inputs, Layout, Failure > \- Execute an explicitly bound model while retaining the last complete accepted physical system\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <problem\&.hpp>\fP
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBCache\fP = \fButils::dependencies::ComputationCache\fP<Graph, Inputs, Failure>"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBInputContext\fP = Inputs"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBPreparationResult\fP = std::expected<typename \fBCache::Report\fP, typename \fBCache::Failure\fP>"
|
|
.br
|
|
.in -1c
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBStellarProblem\fP (Graph graph, Layout \fBlayout\fP)"
|
|
.br
|
|
.RI "Construct an unprepared graph; all numerical work starts with try_prepare\&. "
|
|
.ti -1c
|
|
.RI "template<utils::dependencies::IsKeyList Requested = utils::dependencies::KeyList<keys::PhysicalSystem>> \fBPreparationResult\fP \fBtry_prepare\fP (const Inputs &inputs, Requested requested={}, \fButils::dependencies::PreparationMode\fP mode=\fButils::dependencies::PreparationMode::reuse_unchanged\fP)"
|
|
.br
|
|
.RI "Publish the physical system only after all requested computations have succeeded\&. "
|
|
.ti -1c
|
|
.RI "template<typename InputFactory, utils::dependencies::IsKeyList Requested = utils::dependencies::KeyList<keys::PhysicalSystem>>
|
|
.br
|
|
requires std::invocable<InputFactory&> && std::same_as<std::invoke_result_t<InputFactory&>, std::expected<Inputs, Failure>>\fBPreparationResult\fP \fBtry_prepare_inputs\fP (InputFactory &&make_inputs, Requested requested={}, \fButils::dependencies::PreparationMode\fP mode=\fButils::dependencies::PreparationMode::reuse_unchanged\fP)"
|
|
.br
|
|
.RI "Validate and construct candidate inputs inside the preparation lifecycle\&. "
|
|
.ti -1c
|
|
.RI "const std::shared_ptr< const \fBAcceptedSystem\fP > & \fBaccepted\fP () const"
|
|
.br
|
|
.RI "Read the retained accepted system, including after a later candidate was rejected\&. "
|
|
.ti -1c
|
|
.RI "const Layout & \fBlayout\fP () const noexcept"
|
|
.br
|
|
.RI "Expose the independently ordered physical coordinate description\&. "
|
|
.ti -1c
|
|
.RI "const \fBCache\fP & \fBcache\fP () const noexcept"
|
|
.br
|
|
.RI "Read graph diagnostics and successfully requested numerical services\&. "
|
|
.in -1c
|
|
.SS "Private Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBCache\fP \fBm_cache\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "Layout \fBm_layout\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::shared_ptr< const \fBAcceptedSystem\fP > \fBm_accepted\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<typename Graph, typename Inputs, typename Layout, typename Failure>
|
|
.br
|
|
class serif::model::backend::mfem::StellarProblem< Graph, Inputs, Layout, Failure >"Execute an explicitly bound model while retaining the last complete accepted physical system\&.
|
|
|
|
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
This performs no Newton iteration or convergence test\&. Numerical failures are values; a rejected candidate never replaces the separately retained accepted result\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "template<typename Graph, typename Inputs, typename Layout, typename Failure> using \fBserif::model::backend::mfem::StellarProblem\fP< Graph, Inputs, Layout, Failure >::Cache = \fButils::dependencies::ComputationCache\fP<Graph, Inputs, Failure>"
|
|
|
|
.SS "template<typename Graph, typename Inputs, typename Layout, typename Failure> using \fBserif::model::backend::mfem::StellarProblem\fP< Graph, Inputs, Layout, Failure >::InputContext = Inputs"
|
|
|
|
.SS "template<typename Graph, typename Inputs, typename Layout, typename Failure> using \fBserif::model::backend::mfem::StellarProblem\fP< Graph, Inputs, Layout, Failure >::PreparationResult = std::expected<typename \fBCache::Report\fP, typename \fBCache::Failure\fP>"
|
|
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "template<typename Graph, typename Inputs, typename Layout, typename Failure> \fBserif::model::backend::mfem::StellarProblem\fP< Graph, Inputs, Layout, Failure >::StellarProblem (Graph graph, Layout layout)\fR [inline]\fP"
|
|
|
|
.PP
|
|
Construct an unprepared graph; all numerical work starts with try_prepare\&.
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "template<typename Graph, typename Inputs, typename Layout, typename Failure> const std::shared_ptr< const \fBAcceptedSystem\fP > & \fBserif::model::backend::mfem::StellarProblem\fP< Graph, Inputs, Layout, Failure >::accepted () const\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Read the retained accepted system, including after a later candidate was rejected\&.
|
|
.SS "template<typename Graph, typename Inputs, typename Layout, typename Failure> const \fBCache\fP & \fBserif::model::backend::mfem::StellarProblem\fP< Graph, Inputs, Layout, Failure >::cache () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Read graph diagnostics and successfully requested numerical services\&.
|
|
.SS "template<typename Graph, typename Inputs, typename Layout, typename Failure> const Layout & \fBserif::model::backend::mfem::StellarProblem\fP< Graph, Inputs, Layout, Failure >::layout () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Expose the independently ordered physical coordinate description\&.
|
|
.SS "template<typename Graph, typename Inputs, typename Layout, typename Failure> template<utils::dependencies::IsKeyList Requested = utils::dependencies::KeyList<keys::PhysicalSystem>> \fBPreparationResult\fP \fBserif::model::backend::mfem::StellarProblem\fP< Graph, Inputs, Layout, Failure >::try_prepare (const Inputs & inputs, Requested requested = \fR{}\fP, \fButils::dependencies::PreparationMode\fP mode = \fR\fButils::dependencies::PreparationMode::reuse_unchanged\fP\fP)\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Publish the physical system only after all requested computations have succeeded\&.
|
|
.SS "template<typename Graph, typename Inputs, typename Layout, typename Failure> template<typename InputFactory, utils::dependencies::IsKeyList Requested = utils::dependencies::KeyList<keys::PhysicalSystem>>
|
|
.br
|
|
requires std::invocable<InputFactory&> && std::same_as<std::invoke_result_t<InputFactory&>, std::expected<Inputs, Failure>>\fBPreparationResult\fP \fBserif::model::backend::mfem::StellarProblem\fP< Graph, Inputs, Layout, Failure >::try_prepare_inputs (InputFactory && make_inputs, Requested requested = \fR{}\fP, \fButils::dependencies::PreparationMode\fP mode = \fR\fButils::dependencies::PreparationMode::reuse_unchanged\fP\fP)\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Validate and construct candidate inputs inside the preparation lifecycle\&.
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
Input rejection or a caller error leaves the cache unavailable without discarding accepted snapshots\&. An input rejection uses computation_index == Graph::size, outside the graph's computation indices, because no computation has run yet\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "template<typename Graph, typename Inputs, typename Layout, typename Failure> std::shared_ptr<const \fBAcceptedSystem\fP> \fBserif::model::backend::mfem::StellarProblem\fP< Graph, Inputs, Layout, Failure >::m_accepted\fR [private]\fP"
|
|
|
|
.SS "template<typename Graph, typename Inputs, typename Layout, typename Failure> \fBCache\fP \fBserif::model::backend::mfem::StellarProblem\fP< Graph, Inputs, Layout, Failure >::m_cache\fR [private]\fP"
|
|
|
|
.SS "template<typename Graph, typename Inputs, typename Layout, typename Failure> Layout \fBserif::model::backend::mfem::StellarProblem\fP< Graph, Inputs, Layout, Failure >::m_layout\fR [private]\fP"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|