Files
MeanField_SERiF/docs/man/man3/serif_model_backend_mfem_StellarEquilibrium.3

140 lines
8.7 KiB
Groff
Raw Normal View History

.TH "serif::model::backend::mfem::StellarEquilibrium< Bound, Problem, AdditionalInputs, PreparedKey >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::model::backend::mfem::StellarEquilibrium< Bound, Problem, AdditionalInputs, PreparedKey > \- Execute one immutable physical definition against explicit candidate fields and geometry\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <equilibrium\&.hpp>\fP
.SS "Public Types"
.in +1c
.ti -1c
.RI "using \fBPlan\fP = typename Bound::Plan"
.br
.ti -1c
.RI "using \fBSurfaceFormulation\fP = typename Plan::Surface::Formulation"
.br
.ti -1c
.RI "using \fBPrepared\fP = std::remove_cvref_t<decltype(std::declval<const typename Problem::Cache&>()\&.template get<PreparedKey>())>"
.br
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBStellarEquilibrium\fP (std::shared_ptr< const Bound > bound, Problem problem, AdditionalInputs additional=AdditionalInputs{})"
.br
.RI "Keep physical and discretization owners alive before constructing their numerical cache\&. "
.ti -1c
.RI "template<typename Coefficients, typename Geometry> auto \fBtry_prepare\fP (const Coefficients &coefficients, const Geometry &geometry, \fButils::dependencies::PreparationMode\fP mode=\fButils::dependencies::PreparationMode::reuse_unchanged\fP)"
.br
.RI "Accept a complete residual and Jacobian, retaining the previous system on rejection\&. "
.ti -1c
.RI "const std::shared_ptr< const \fBAcceptedSystem\fP > & \fBaccepted\fP () const"
.br
.RI "Return an owning physical residual and Jacobian for the last successfully prepared candidate\&. "
.ti -1c
.RI "const \fBPrepared\fP & \fBprepared\fP () const"
.br
.RI "Retain the last complete physical or normalized preparation, including after a rejected candidate\&. "
.ti -1c
.RI "const auto & \fBlayout\fP () const noexcept"
.br
.RI "Inspect the independent physical unknown and residual orderings\&. "
.ti -1c
.RI "const auto & \fBcache\fP () const noexcept"
.br
.RI "Inspect cache availability and work from the latest preparation attempt\&. "
.ti -1c
.RI "const auto & \fBmodel\fP () const noexcept"
.br
.RI "Inspect the unchanged declarative stellar model\&. "
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "std::shared_ptr< const Bound > \fBm_bound\fP"
.br
.ti -1c
.RI "Problem \fBm_problem\fP"
.br
.ti -1c
.RI "AdditionalInputs \fBm_additional\fP"
.br
.ti -1c
.RI "\fBPrepared\fP \fBm_prepared\fP {}"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<typename Bound, typename Problem, typename AdditionalInputs = utils::dependencies::DependencyContext<>, typename PreparedKey = keys::PhysicalSystem>
.br
class serif::model::backend::mfem::StellarEquilibrium< Bound, Problem, AdditionalInputs, PreparedKey >"Execute one immutable physical definition against explicit candidate fields and geometry\&.
.SH "Member Typedef Documentation"
.PP
.SS "template<typename Bound, typename Problem, typename AdditionalInputs = utils::dependencies::DependencyContext<>, typename PreparedKey = keys::PhysicalSystem> using \fBserif::model::backend::mfem::StellarEquilibrium\fP< Bound, Problem, AdditionalInputs, PreparedKey >::Plan = typename Bound::Plan"
.SS "template<typename Bound, typename Problem, typename AdditionalInputs = utils::dependencies::DependencyContext<>, typename PreparedKey = keys::PhysicalSystem> using \fBserif::model::backend::mfem::StellarEquilibrium\fP< Bound, Problem, AdditionalInputs, PreparedKey >::Prepared = std::remove_cvref_t<decltype(std::declval<const typename Problem::Cache&>()\&.template get<PreparedKey>())>"
.SS "template<typename Bound, typename Problem, typename AdditionalInputs = utils::dependencies::DependencyContext<>, typename PreparedKey = keys::PhysicalSystem> using \fBserif::model::backend::mfem::StellarEquilibrium\fP< Bound, Problem, AdditionalInputs, PreparedKey >::SurfaceFormulation = typename Plan::Surface::Formulation"
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<typename Bound, typename Problem, typename AdditionalInputs = utils::dependencies::DependencyContext<>, typename PreparedKey = keys::PhysicalSystem> \fBserif::model::backend::mfem::StellarEquilibrium\fP< Bound, Problem, AdditionalInputs, PreparedKey >::StellarEquilibrium (std::shared_ptr< const Bound > bound, Problem problem, AdditionalInputs additional = \fRAdditionalInputs{}\fP)\fR [inline]\fP"
.PP
Keep physical and discretization owners alive before constructing their numerical cache\&.
.SH "Member Function Documentation"
.PP
.SS "template<typename Bound, typename Problem, typename AdditionalInputs = utils::dependencies::DependencyContext<>, typename PreparedKey = keys::PhysicalSystem> const std::shared_ptr< const \fBAcceptedSystem\fP > & \fBserif::model::backend::mfem::StellarEquilibrium\fP< Bound, Problem, AdditionalInputs, PreparedKey >::accepted () const\fR [inline]\fP, \fR [nodiscard]\fP"
.PP
Return an owning physical residual and Jacobian for the last successfully prepared candidate\&.
.SS "template<typename Bound, typename Problem, typename AdditionalInputs = utils::dependencies::DependencyContext<>, typename PreparedKey = keys::PhysicalSystem> const auto & \fBserif::model::backend::mfem::StellarEquilibrium\fP< Bound, Problem, AdditionalInputs, PreparedKey >::cache () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
.PP
Inspect cache availability and work from the latest preparation attempt\&.
.SS "template<typename Bound, typename Problem, typename AdditionalInputs = utils::dependencies::DependencyContext<>, typename PreparedKey = keys::PhysicalSystem> const auto & \fBserif::model::backend::mfem::StellarEquilibrium\fP< Bound, Problem, AdditionalInputs, PreparedKey >::layout () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
.PP
Inspect the independent physical unknown and residual orderings\&.
.SS "template<typename Bound, typename Problem, typename AdditionalInputs = utils::dependencies::DependencyContext<>, typename PreparedKey = keys::PhysicalSystem> const auto & \fBserif::model::backend::mfem::StellarEquilibrium\fP< Bound, Problem, AdditionalInputs, PreparedKey >::model () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
.PP
Inspect the unchanged declarative stellar model\&.
.SS "template<typename Bound, typename Problem, typename AdditionalInputs = utils::dependencies::DependencyContext<>, typename PreparedKey = keys::PhysicalSystem> const \fBPrepared\fP & \fBserif::model::backend::mfem::StellarEquilibrium\fP< Bound, Problem, AdditionalInputs, PreparedKey >::prepared () const\fR [inline]\fP, \fR [nodiscard]\fP"
.PP
Retain the last complete physical or normalized preparation, including after a rejected candidate\&.
.SS "template<typename Bound, typename Problem, typename AdditionalInputs = utils::dependencies::DependencyContext<>, typename PreparedKey = keys::PhysicalSystem> template<typename Coefficients, typename Geometry> auto \fBserif::model::backend::mfem::StellarEquilibrium\fP< Bound, Problem, AdditionalInputs, PreparedKey >::try_prepare (const Coefficients & coefficients, const Geometry & geometry, \fButils::dependencies::PreparationMode\fP mode = \fR\fButils::dependencies::PreparationMode::reuse_unchanged\fP\fP)\fR [inline]\fP, \fR [nodiscard]\fP"
.PP
Accept a complete residual and Jacobian, retaining the previous system on rejection\&.
.PP
\fBNote\fP
.RS 4
Nonfinite candidate coefficients are numerical rejections\&. Invalid bindings or sizes remain caller errors; either failure leaves the cache unavailable until preparation succeeds\&.
.RE
.PP
.SH "Member Data Documentation"
.PP
.SS "template<typename Bound, typename Problem, typename AdditionalInputs = utils::dependencies::DependencyContext<>, typename PreparedKey = keys::PhysicalSystem> AdditionalInputs \fBserif::model::backend::mfem::StellarEquilibrium\fP< Bound, Problem, AdditionalInputs, PreparedKey >::m_additional\fR [private]\fP"
.SS "template<typename Bound, typename Problem, typename AdditionalInputs = utils::dependencies::DependencyContext<>, typename PreparedKey = keys::PhysicalSystem> std::shared_ptr<const Bound> \fBserif::model::backend::mfem::StellarEquilibrium\fP< Bound, Problem, AdditionalInputs, PreparedKey >::m_bound\fR [private]\fP"
.SS "template<typename Bound, typename Problem, typename AdditionalInputs = utils::dependencies::DependencyContext<>, typename PreparedKey = keys::PhysicalSystem> \fBPrepared\fP \fBserif::model::backend::mfem::StellarEquilibrium\fP< Bound, Problem, AdditionalInputs, PreparedKey >::m_prepared {}\fR [private]\fP"
.SS "template<typename Bound, typename Problem, typename AdditionalInputs = utils::dependencies::DependencyContext<>, typename PreparedKey = keys::PhysicalSystem> Problem \fBserif::model::backend::mfem::StellarEquilibrium\fP< Bound, Problem, AdditionalInputs, PreparedKey >::m_problem\fR [private]\fP"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.