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

64 lines
4.3 KiB
Groff
Raw Normal View History

.TH "serif::model::ModelPlan< Registry, Prescribed, AdditionalValues, AdditionalRows >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::model::ModelPlan< Registry, Prescribed, AdditionalValues, AdditionalRows > \- Derive physical coordinates from explicit equations, independently of numerical solvability\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <plan\&.hpp>\fP
.PP
Inherits \fBserif::model::detail::InteriorPlan< std::remove_cvref_t< Registry > >\fP\&.
.SS "Public Types"
.in +1c
.ti -1c
.RI "using \fBInterior\fP = \fBdetail::InteriorPlan\fP<std::remove_cvref_t<Registry>>"
.br
.ti -1c
.RI "using \fBPrescribedCoefficients\fP = Prescribed"
.br
.ti -1c
.RI "using \fBValues\fP = \fButils::dependencies::CombinedKeyList\fP<typename \fBdetail::RemoveKeys\fP<typename Interior::Coefficients, Prescribed>::Type, AdditionalValues>"
.br
.ti -1c
.RI "using \fBResiduals\fP = \fButils::dependencies::CombinedKeyList\fP<typename Interior::Rows, AdditionalRows>"
.br
.ti -1c
.RI "using \fBLayout\fP = \fBdiscretization::blocks::SystemLayout\fP<\fBValues\fP, \fBResiduals\fP>"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<ExecutableInteriorEquations Registry, utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalValues = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalRows = utils::dependencies::KeyList<>>
.br
struct serif::model::ModelPlan< Registry, Prescribed, AdditionalValues, AdditionalRows >"Derive physical coordinates from explicit equations, independently of numerical solvability\&.
.PP
\fBNote\fP
.RS 4
Prescribed coefficients remain equation inputs but are excluded from solved coordinates\&. Additional coordinates and rows describe explicit shape or constraint contributions\&. Neither equation counting nor this plan claims absence of null spaces or existence of an equilibrium\&.
.RE
.PP
.SH "Member Typedef Documentation"
.PP
.SS "template<ExecutableInteriorEquations Registry, utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalValues = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalRows = utils::dependencies::KeyList<>> using \fBserif::model::ModelPlan\fP< Registry, Prescribed, AdditionalValues, AdditionalRows >::Interior = \fBdetail::InteriorPlan\fP<std::remove_cvref_t<Registry>>"
.SS "template<ExecutableInteriorEquations Registry, utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalValues = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalRows = utils::dependencies::KeyList<>> using \fBserif::model::ModelPlan\fP< Registry, Prescribed, AdditionalValues, AdditionalRows >::Layout = \fBdiscretization::blocks::SystemLayout\fP<\fBValues\fP, \fBResiduals\fP>"
.SS "template<ExecutableInteriorEquations Registry, utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalValues = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalRows = utils::dependencies::KeyList<>> using \fBserif::model::ModelPlan\fP< Registry, Prescribed, AdditionalValues, AdditionalRows >::PrescribedCoefficients = Prescribed"
.SS "template<ExecutableInteriorEquations Registry, utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalValues = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalRows = utils::dependencies::KeyList<>> using \fBserif::model::ModelPlan\fP< Registry, Prescribed, AdditionalValues, AdditionalRows >::Residuals = \fButils::dependencies::CombinedKeyList\fP<typename Interior::Rows, AdditionalRows>"
.SS "template<ExecutableInteriorEquations Registry, utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalValues = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalRows = utils::dependencies::KeyList<>> using \fBserif::model::ModelPlan\fP< Registry, Prescribed, AdditionalValues, AdditionalRows >::Values = \fButils::dependencies::CombinedKeyList\fP<typename \fBdetail::RemoveKeys\fP<typename Interior::Coefficients, Prescribed>::Type, AdditionalValues>"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.