125 lines
10 KiB
Groff
125 lines
10 KiB
Groff
|
|
.TH "serif::model::EquilibriumPlan< EOS, Description, Prescribed, AdditionalFields >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
serif::model::EquilibriumPlan< EOS, Description, Prescribed, AdditionalFields > \- Collect the explicitly selected physical coefficients and supported constraint coordinates\&.
|
||
|
|
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
.PP
|
||
|
|
\fR#include <equilibrium_plan\&.hpp>\fP
|
||
|
|
.SS "Public Types"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBInterior\fP = \fBdetail::InteriorPlan\fP<typename Description::InteriorEquations>"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBShape\fP = \fBdetail::ShapePlan\fP<typename Description::ShapeForce>"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBResidualEquations\fP = typename Interior::EquationsList"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBAvailableFields\fP = \fButils::dependencies::CombinedKeyList\fP<typename Interior::Coefficients, typename Shape::Coefficients, AdditionalFields>"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBSolvedFields\fP = typename \fBdetail::RemoveKeys\fP<\fBAvailableFields\fP, Prescribed>::Type"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBResiduals\fP = \fButils::dependencies::CombinedKeyList\fP<typename Interior::Rows, typename Shape::Rows>"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBSurface\fP = \fBdetail::SurfacePlan\fP<typename Description::SurfaceCondition, EOS, \fBAvailableFields\fP, \fBResiduals\fP, \fBSolvedFields\fP, typename Interior::EquationsList>"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBCoefficients\fP = \fButils::dependencies::CombinedKeyList\fP<typename Interior::Coefficients, typename Shape::Coefficients, typename Surface::Coefficients>"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBValues\fP = \fButils::dependencies::CombinedKeyList\fP<typename \fBdetail::RemoveKeys\fP<\fBCoefficients\fP, Prescribed>::Type, typename Shape::Values>"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBPhysicalInputs\fP = \fButils::dependencies::CombinedKeyList\fP<\fBCoefficients\fP, \fBValues\fP, \fButils::dependencies::KeyList\fP<\fBdiscretization::blocks::surface_deformation::coefficients\fP>>"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBInactiveRows\fP = std::conditional_t<\fBhas_shape\fP, \fButils::dependencies::KeyList\fP<>, \fButils::dependencies::KeyList\fP<\fBdiscretization::blocks::surface_deformation::shape_equilibrium\fP>>"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBLayout\fP = \fBdiscretization::blocks::SystemLayout\fP<\fBValues\fP, \fBResiduals\fP>"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SS "Static Public Attributes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "static constexpr bool \fBhas_shape\fP = !std::same_as<typename Description::ShapeForce, \fBNoShapeForce\fP>"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "static constexpr bool \fBhas_surface\fP = !std::same_as<typename Description::SurfaceCondition, \fBNoSurfaceCondition\fP>"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "static constexpr bool \fBhas_primal_gravity\fP"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SH "Detailed Description"
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SS "template<typename EOS, EquilibriumEquationDescription Description, utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalFields = utils::dependencies::KeyList<>>
|
||
|
|
.br
|
||
|
|
struct serif::model::EquilibriumPlan< EOS, Description, Prescribed, AdditionalFields >"Collect the explicitly selected physical coefficients and supported constraint coordinates\&.
|
||
|
|
|
||
|
|
|
||
|
|
.PP
|
||
|
|
\fBNote\fP
|
||
|
|
.RS 4
|
||
|
|
This plan verifies representation, not mathematical closure\&. Equal units never merge distinct physical identities, and prescribed coefficients remain available as graph inputs without becoming unknowns\&.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SH "Member Typedef Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "template<typename EOS, EquilibriumEquationDescription Description, utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalFields = utils::dependencies::KeyList<>> using \fBserif::model::EquilibriumPlan\fP< EOS, Description, Prescribed, AdditionalFields >::AvailableFields = \fButils::dependencies::CombinedKeyList\fP<typename Interior::Coefficients, typename Shape::Coefficients, AdditionalFields>"
|
||
|
|
|
||
|
|
.SS "template<typename EOS, EquilibriumEquationDescription Description, utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalFields = utils::dependencies::KeyList<>> using \fBserif::model::EquilibriumPlan\fP< EOS, Description, Prescribed, AdditionalFields >::Coefficients = \fButils::dependencies::CombinedKeyList\fP<typename Interior::Coefficients, typename Shape::Coefficients, typename Surface::Coefficients>"
|
||
|
|
|
||
|
|
.SS "template<typename EOS, EquilibriumEquationDescription Description, utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalFields = utils::dependencies::KeyList<>> using \fBserif::model::EquilibriumPlan\fP< EOS, Description, Prescribed, AdditionalFields >::InactiveRows = std::conditional_t<\fBhas_shape\fP, \fButils::dependencies::KeyList\fP<>, \fButils::dependencies::KeyList\fP<\fBdiscretization::blocks::surface_deformation::shape_equilibrium\fP>>"
|
||
|
|
|
||
|
|
.SS "template<typename EOS, EquilibriumEquationDescription Description, utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalFields = utils::dependencies::KeyList<>> using \fBserif::model::EquilibriumPlan\fP< EOS, Description, Prescribed, AdditionalFields >::Interior = \fBdetail::InteriorPlan\fP<typename Description::InteriorEquations>"
|
||
|
|
|
||
|
|
.SS "template<typename EOS, EquilibriumEquationDescription Description, utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalFields = utils::dependencies::KeyList<>> using \fBserif::model::EquilibriumPlan\fP< EOS, Description, Prescribed, AdditionalFields >::Layout = \fBdiscretization::blocks::SystemLayout\fP<\fBValues\fP, \fBResiduals\fP>"
|
||
|
|
|
||
|
|
.SS "template<typename EOS, EquilibriumEquationDescription Description, utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalFields = utils::dependencies::KeyList<>> using \fBserif::model::EquilibriumPlan\fP< EOS, Description, Prescribed, AdditionalFields >::PhysicalInputs = \fButils::dependencies::CombinedKeyList\fP<\fBCoefficients\fP, \fBValues\fP, \fButils::dependencies::KeyList\fP<\fBdiscretization::blocks::surface_deformation::coefficients\fP>>"
|
||
|
|
|
||
|
|
.SS "template<typename EOS, EquilibriumEquationDescription Description, utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalFields = utils::dependencies::KeyList<>> using \fBserif::model::EquilibriumPlan\fP< EOS, Description, Prescribed, AdditionalFields >::ResidualEquations = typename Interior::EquationsList"
|
||
|
|
|
||
|
|
.SS "template<typename EOS, EquilibriumEquationDescription Description, utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalFields = utils::dependencies::KeyList<>> using \fBserif::model::EquilibriumPlan\fP< EOS, Description, Prescribed, AdditionalFields >::Residuals = \fButils::dependencies::CombinedKeyList\fP<typename Interior::Rows, typename Shape::Rows>"
|
||
|
|
|
||
|
|
.SS "template<typename EOS, EquilibriumEquationDescription Description, utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalFields = utils::dependencies::KeyList<>> using \fBserif::model::EquilibriumPlan\fP< EOS, Description, Prescribed, AdditionalFields >::Shape = \fBdetail::ShapePlan\fP<typename Description::ShapeForce>"
|
||
|
|
|
||
|
|
.SS "template<typename EOS, EquilibriumEquationDescription Description, utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalFields = utils::dependencies::KeyList<>> using \fBserif::model::EquilibriumPlan\fP< EOS, Description, Prescribed, AdditionalFields >::SolvedFields = typename \fBdetail::RemoveKeys\fP<\fBAvailableFields\fP, Prescribed>::Type"
|
||
|
|
|
||
|
|
.SS "template<typename EOS, EquilibriumEquationDescription Description, utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalFields = utils::dependencies::KeyList<>> using \fBserif::model::EquilibriumPlan\fP< EOS, Description, Prescribed, AdditionalFields >::Surface = \fBdetail::SurfacePlan\fP<typename Description::SurfaceCondition, EOS, \fBAvailableFields\fP, \fBResiduals\fP, \fBSolvedFields\fP, typename Interior::EquationsList>"
|
||
|
|
|
||
|
|
.SS "template<typename EOS, EquilibriumEquationDescription Description, utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalFields = utils::dependencies::KeyList<>> using \fBserif::model::EquilibriumPlan\fP< EOS, Description, Prescribed, AdditionalFields >::Values = \fButils::dependencies::CombinedKeyList\fP<typename \fBdetail::RemoveKeys\fP<\fBCoefficients\fP, Prescribed>::Type, typename Shape::Values>"
|
||
|
|
|
||
|
|
.SH "Member Data Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "template<typename EOS, EquilibriumEquationDescription Description, utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalFields = utils::dependencies::KeyList<>> bool \fBserif::model::EquilibriumPlan\fP< EOS, Description, Prescribed, AdditionalFields >::has_primal_gravity\fR [static]\fP, \fR [constexpr]\fP"
|
||
|
|
\fBInitial value:\fP
|
||
|
|
.nf
|
||
|
|
= []<typename\&.\&.\&. Equations>(utils::types::TypeList<Equations\&.\&.\&.>) {
|
||
|
|
return (std::same_as<Equations, equations::PrimalPoissonBalance> || \&.\&.\&.);
|
||
|
|
}(typename Description::InteriorEquations::Equations{})
|
||
|
|
.PP
|
||
|
|
.fi
|
||
|
|
|
||
|
|
.SS "template<typename EOS, EquilibriumEquationDescription Description, utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalFields = utils::dependencies::KeyList<>> bool \fBserif::model::EquilibriumPlan\fP< EOS, Description, Prescribed, AdditionalFields >::has_shape = !std::same_as<typename Description::ShapeForce, \fBNoShapeForce\fP>\fR [static]\fP, \fR [constexpr]\fP"
|
||
|
|
|
||
|
|
.SS "template<typename EOS, EquilibriumEquationDescription Description, utils::dependencies::IsKeyList Prescribed = utils::dependencies::KeyList<>, utils::dependencies::IsKeyList AdditionalFields = utils::dependencies::KeyList<>> bool \fBserif::model::EquilibriumPlan\fP< EOS, Description, Prescribed, AdditionalFields >::has_surface = !std::same_as<typename Description::SurfaceCondition, \fBNoSurfaceCondition\fP>\fR [static]\fP, \fR [constexpr]\fP"
|
||
|
|
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|