199 lines
6.6 KiB
Groff
199 lines
6.6 KiB
Groff
|
|
.TH "serif::solver::preconditioner::checks" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
serif::solver::preconditioner::checks
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
.SS "Classes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBExtraField\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBExtraRow\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBExtraValue\fP"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SS "Concepts"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "concept \fBRestrictable\fP"
|
||
|
|
.br
|
||
|
|
.RI "A borrowed raw operator cannot satisfy factories which retain their numerical prerequisites\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "concept \fBReadsCoordinate\fP"
|
||
|
|
.br
|
||
|
|
.RI "Detection of an absent coordinate must fail in constraints instead of instantiating a function body\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "concept \fBReadsBlock\fP"
|
||
|
|
.br
|
||
|
|
.RI "Only declared equation/unknown pairs are exposed by a borrowed linearization\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "concept \fBHasOffset\fP"
|
||
|
|
.br
|
||
|
|
.RI "Malformed coordinate requests remain detection-safe on the owning metadata as well\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "concept \fBHasPrimalPreconditioner\fP"
|
||
|
|
.br
|
||
|
|
.RI "Keep unsupported coordinate sets out of the primal recipe before its body is instantiated\&. "
|
||
|
|
.in -1c
|
||
|
|
.SS "Typedefs"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBKind\fP = blocks::RepresentedValueKind"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBMass\fP = blocks::barotropic_constant::mass_normalization"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBReaction\fP = blocks::frame_acceleration::component<0>"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBDensity\fP = blocks::density::mass"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBKeys\fP = dependencies::KeyList<\fBMass\fP, \fBReaction\fP>"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBLayout\fP = blocks::SystemLayout<\fBKeys\fP, \fBKeys\fP>"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBState\fP = blocks::StateView<\fBLayout\fP>"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBConstantState\fP = blocks::StateView<\fBLayout\fP, const double>"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBPhysical\fP = \fBoperators::PhysicalBlock\fP<\fBMass\fP, \fBReaction\fP>"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBSources\fP = decltype(dependencies::make_dependency_context(dependencies::own<\fBPhysical\fP>(1)))"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBSystem\fP = \fBoperators::LinearizedSystemView\fP<\fBLayout\fP, \fBSources\fP>"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBReorderedLayout\fP = blocks::SystemLayout<\fBKeys\fP, dependencies::KeyList<\fBReaction\fP, \fBMass\fP>>"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBPotential\fP = blocks::gravity::potential"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBRotation\fP = blocks::rotation::angular_velocity"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBShape\fP = blocks::surface_deformation::coefficients"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBShapeRow\fP = blocks::surface_deformation::shape_equilibrium"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBPrimalFields\fP = dependencies::KeyList<\fBDensity\fP, \fBPotential\fP>"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBPrimalFixedLayout\fP = blocks::SystemLayout<\fBPrimalFields\fP, \fBPrimalFields\fP>"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBPrimalMovingLayout\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBPrimalRecipe\fP = decltype(\fBmake_primal_preconditioner\fP(std::declval<const \fBPrimalMovingLayout\fP&>()))"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBPrimalExtraLayout\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBPrimalExtraRecipe\fP = decltype(\fBmake_primal_preconditioner\fP(std::declval<const \fBPrimalExtraLayout\fP&>()))"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SS "Variables"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "constexpr \fBReorderedLayout\fP \fBresolved_layout\fP"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SH "Typedef Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "using \fBserif::solver::preconditioner::checks::ConstantState\fP = blocks::StateView<\fBLayout\fP, const double>"
|
||
|
|
|
||
|
|
.SS "using \fBserif::solver::preconditioner::checks::Density\fP = blocks::density::mass"
|
||
|
|
|
||
|
|
.SS "using \fBserif::solver::preconditioner::checks::Keys\fP = dependencies::KeyList<\fBMass\fP, \fBReaction\fP>"
|
||
|
|
|
||
|
|
.SS "using \fBserif::solver::preconditioner::checks::Kind\fP = blocks::RepresentedValueKind"
|
||
|
|
|
||
|
|
.SS "using \fBserif::solver::preconditioner::checks::Layout\fP = blocks::SystemLayout<\fBKeys\fP, \fBKeys\fP>"
|
||
|
|
|
||
|
|
.SS "using \fBserif::solver::preconditioner::checks::Mass\fP = blocks::barotropic_constant::mass_normalization"
|
||
|
|
|
||
|
|
.SS "using \fBserif::solver::preconditioner::checks::Physical\fP = \fBoperators::PhysicalBlock\fP<\fBMass\fP, \fBReaction\fP>"
|
||
|
|
|
||
|
|
.SS "using \fBserif::solver::preconditioner::checks::Potential\fP = blocks::gravity::potential"
|
||
|
|
|
||
|
|
.SS "using \fBserif::solver::preconditioner::checks::PrimalExtraLayout\fP"
|
||
|
|
\fBInitial value:\fP
|
||
|
|
.nf
|
||
|
|
blocks::SystemLayout<dependencies::CombinedKeyList<PrimalFields, dependencies::KeyList<ExtraValue>>,
|
||
|
|
dependencies::CombinedKeyList<PrimalFields, dependencies::KeyList<ExtraRow>>>
|
||
|
|
.PP
|
||
|
|
.fi
|
||
|
|
|
||
|
|
.SS "using \fBserif::solver::preconditioner::checks::PrimalExtraRecipe\fP = decltype(\fBmake_primal_preconditioner\fP(std::declval<const \fBPrimalExtraLayout\fP&>()))"
|
||
|
|
|
||
|
|
.SS "using \fBserif::solver::preconditioner::checks::PrimalFields\fP = dependencies::KeyList<\fBDensity\fP, \fBPotential\fP>"
|
||
|
|
|
||
|
|
.SS "using \fBserif::solver::preconditioner::checks::PrimalFixedLayout\fP = blocks::SystemLayout<\fBPrimalFields\fP, \fBPrimalFields\fP>"
|
||
|
|
|
||
|
|
.SS "using \fBserif::solver::preconditioner::checks::PrimalMovingLayout\fP"
|
||
|
|
\fBInitial value:\fP
|
||
|
|
.nf
|
||
|
|
blocks::SystemLayout<dependencies::KeyList<Potential, Shape, Mass, Density, Rotation>,
|
||
|
|
dependencies::KeyList<Rotation, Mass, ShapeRow, Potential, Density>>
|
||
|
|
.PP
|
||
|
|
.fi
|
||
|
|
|
||
|
|
.SS "using \fBserif::solver::preconditioner::checks::PrimalRecipe\fP = decltype(\fBmake_primal_preconditioner\fP(std::declval<const \fBPrimalMovingLayout\fP&>()))"
|
||
|
|
|
||
|
|
.SS "using \fBserif::solver::preconditioner::checks::Reaction\fP = blocks::frame_acceleration::component<0>"
|
||
|
|
|
||
|
|
.SS "using \fBserif::solver::preconditioner::checks::ReorderedLayout\fP = blocks::SystemLayout<\fBKeys\fP, dependencies::KeyList<\fBReaction\fP, \fBMass\fP>>"
|
||
|
|
|
||
|
|
.SS "using \fBserif::solver::preconditioner::checks::Rotation\fP = blocks::rotation::angular_velocity"
|
||
|
|
|
||
|
|
.SS "using \fBserif::solver::preconditioner::checks::Shape\fP = blocks::surface_deformation::coefficients"
|
||
|
|
|
||
|
|
.SS "using \fBserif::solver::preconditioner::checks::ShapeRow\fP = blocks::surface_deformation::shape_equilibrium"
|
||
|
|
|
||
|
|
.SS "using \fBserif::solver::preconditioner::checks::Sources\fP = decltype(dependencies::make_dependency_context(dependencies::own<\fBPhysical\fP>(1)))"
|
||
|
|
|
||
|
|
.SS "using \fBserif::solver::preconditioner::checks::State\fP = blocks::StateView<\fBLayout\fP>"
|
||
|
|
|
||
|
|
.SS "using \fBserif::solver::preconditioner::checks::System\fP = \fBoperators::LinearizedSystemView\fP<\fBLayout\fP, \fBSources\fP>"
|
||
|
|
|
||
|
|
.SH "Variable Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "\fBReorderedLayout\fP serif::solver::preconditioner::checks::resolved_layout\fR [constexpr]\fP"
|
||
|
|
\fBInitial value:\fP
|
||
|
|
.nf
|
||
|
|
= blocks::make_system_layout<ReorderedLayout>([]<typename Coordinate>() {
|
||
|
|
if constexpr (std::same_as<Coordinate, Mass>) {
|
||
|
|
return 3;
|
||
|
|
} else {
|
||
|
|
return 1;
|
||
|
|
}
|
||
|
|
})
|
||
|
|
.PP
|
||
|
|
.fi
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|