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)
197 lines
7.3 KiB
Groff
197 lines
7.3 KiB
Groff
.TH "serif::model::checks" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::model::checks
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBBinding\fP"
|
|
.br
|
|
.RI "Only the binding's physical identity is needed to check public overload constraints\&. "
|
|
.ti -1c
|
|
.RI "struct \fBBound\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBFixedPlan\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBMovingPlan\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Concepts"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "concept \fBReadsField\fP"
|
|
.br
|
|
.RI "Check field availability and owner lifetime without instantiating a getter body\&. "
|
|
.ti -1c
|
|
.RI "concept \fBReadsValues\fP"
|
|
.br
|
|
.RI "Packed views must remain tied to an lvalue owning state\&. "
|
|
.ti -1c
|
|
.RI "concept \fBReadsLayout\fP"
|
|
.br
|
|
.RI "Layout references cannot survive destruction of a temporary owning state\&. "
|
|
.ti -1c
|
|
.RI "concept \fBCanEvaluate\fP"
|
|
.br
|
|
.RI "Unsupported state and prescribed-field combinations must fail during overload selection\&. "
|
|
.ti -1c
|
|
.RI "concept \fBCanPrepareLinearSystem\fP"
|
|
.br
|
|
.RI "Linear preparation needs both a selected recipe and a valid candidate binding\&. "
|
|
.in -1c
|
|
.SS "Typedefs"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBDensity\fP = blocks::density::mass"
|
|
.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 \fBValues\fP = dependencies::KeyList<\fBDensity\fP, \fBShape\fP>"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBRows\fP = dependencies::KeyList<\fBShapeRow\fP, \fBDensity\fP>"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBLayout\fP = blocks::SystemLayout<\fBValues\fP, \fBRows\fP>"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBState\fP = \fBStellarState\fP<\fBLayout\fP>"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBEmptyInputs\fP = dependencies::DependencyContext<>"
|
|
.br
|
|
.ti -1c
|
|
.RI "template<typename Key, typename Term = Key> using \fBCoefficientSource\fP = decltype(dependencies::own<Key>(std::declval<\fBoperators::backend::mfem::CoefficientView\fP<\fBBinding\fP<Term>>>()))"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBRotationInputs\fP = dependencies::DependencyContext<\fBCoefficientSource\fP<\fBRotation\fP>>"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBWrongIdentity\fP = dependencies::DependencyContext<\fBCoefficientSource\fP<\fBRotation\fP, \fBDensity\fP>>"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBWrongValue\fP = decltype(dependencies::make_dependency_context(dependencies::own<\fBRotation\fP>(1\&.0)))"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBOverlap\fP = dependencies::DependencyContext<\fBCoefficientSource\fP<\fBDensity\fP>, \fBCoefficientSource\fP<\fBRotation\fP>>"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBShapeOverlap\fP = dependencies::DependencyContext<\fBCoefficientSource\fP<\fBShape\fP>, \fBCoefficientSource\fP<\fBRotation\fP>>"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBCompleteFields\fP = dependencies::DependencyContext<\fBCoefficientSource\fP<\fBDensity\fP>, \fBCoefficientSource\fP<\fBRotation\fP>>"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBGraph\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBMovingEvaluator\fP = execution::EquilibriumEvaluator<\fBBound\fP<\fBMovingPlan\fP>, \fBGraph\fP, \fBEmptyInputs\fP>"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBFixedEvaluator\fP = execution::EquilibriumEvaluator<\fBBound\fP<\fBFixedPlan\fP>, \fBGraph\fP, \fBEmptyInputs\fP>"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBPreparedGraph\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBMovingPreparedEvaluator\fP = execution::EquilibriumEvaluator<\fBBound\fP<\fBMovingPlan\fP>, \fBPreparedGraph\fP, \fBEmptyInputs\fP>"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBFixedPreparedEvaluator\fP = execution::EquilibriumEvaluator<\fBBound\fP<\fBFixedPlan\fP>, \fBPreparedGraph\fP, \fBEmptyInputs\fP>"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBFixedState\fP = \fBStellarState\fP<\fBFixedPlan::Layout\fP>"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBOtherState\fP = \fBStellarState\fP<blocks::SystemLayout<dependencies::KeyList<\fBShape\fP, \fBDensity\fP>, \fBRows\fP>>"
|
|
.br
|
|
.in -1c
|
|
.SH "Typedef Documentation"
|
|
.PP
|
|
.SS "template<typename Key, typename Term = Key> using \fBserif::model::checks::CoefficientSource\fP = decltype(dependencies::own<Key>(std::declval<\fBoperators::backend::mfem::CoefficientView\fP<\fBBinding\fP<Term>>>()))"
|
|
|
|
.SS "using \fBserif::model::checks::CompleteFields\fP = dependencies::DependencyContext<\fBCoefficientSource\fP<\fBDensity\fP>, \fBCoefficientSource\fP<\fBRotation\fP>>"
|
|
|
|
.SS "using \fBserif::model::checks::Density\fP = blocks::density::mass"
|
|
|
|
.SS "using \fBserif::model::checks::EmptyInputs\fP = dependencies::DependencyContext<>"
|
|
|
|
.SS "using \fBserif::model::checks::FixedEvaluator\fP = execution::EquilibriumEvaluator<\fBBound\fP<\fBFixedPlan\fP>, \fBGraph\fP, \fBEmptyInputs\fP>"
|
|
|
|
.SS "using \fBserif::model::checks::FixedPreparedEvaluator\fP = execution::EquilibriumEvaluator<\fBBound\fP<\fBFixedPlan\fP>, \fBPreparedGraph\fP, \fBEmptyInputs\fP>"
|
|
|
|
.SS "using \fBserif::model::checks::FixedState\fP = \fBStellarState\fP<\fBFixedPlan::Layout\fP>"
|
|
|
|
.SS "using \fBserif::model::checks::Graph\fP"
|
|
\fBInitial value:\fP
|
|
.nf
|
|
decltype(dependencies::make_computation_graph(
|
|
dependencies::make_computation<keys::PhysicalSystem, dependencies::InputList<>>([]() {
|
|
return 0;
|
|
})))
|
|
.PP
|
|
.fi
|
|
|
|
.SS "using \fBserif::model::checks::Layout\fP = blocks::SystemLayout<\fBValues\fP, \fBRows\fP>"
|
|
|
|
.SS "using \fBserif::model::checks::MovingEvaluator\fP = execution::EquilibriumEvaluator<\fBBound\fP<\fBMovingPlan\fP>, \fBGraph\fP, \fBEmptyInputs\fP>"
|
|
|
|
.SS "using \fBserif::model::checks::MovingPreparedEvaluator\fP = execution::EquilibriumEvaluator<\fBBound\fP<\fBMovingPlan\fP>, \fBPreparedGraph\fP, \fBEmptyInputs\fP>"
|
|
|
|
.SS "using \fBserif::model::checks::OtherState\fP = \fBStellarState\fP<blocks::SystemLayout<dependencies::KeyList<\fBShape\fP, \fBDensity\fP>, \fBRows\fP>>"
|
|
|
|
.SS "using \fBserif::model::checks::Overlap\fP = dependencies::DependencyContext<\fBCoefficientSource\fP<\fBDensity\fP>, \fBCoefficientSource\fP<\fBRotation\fP>>"
|
|
|
|
.SS "using \fBserif::model::checks::PreparedGraph\fP"
|
|
\fBInitial value:\fP
|
|
.nf
|
|
decltype(dependencies::make_computation_graph(
|
|
dependencies::make_computation<keys::PhysicalSystem, dependencies::InputList<>>([]() {
|
|
return 0;
|
|
}), dependencies::make_computation<preconditioning::PreparedSystem, dependencies::InputList<keys::PhysicalSystem>>([](int value) {
|
|
return value;
|
|
})))
|
|
.PP
|
|
.fi
|
|
|
|
.SS "using \fBserif::model::checks::Rotation\fP = blocks::rotation::angular_velocity"
|
|
|
|
.SS "using \fBserif::model::checks::RotationInputs\fP = dependencies::DependencyContext<\fBCoefficientSource\fP<\fBRotation\fP>>"
|
|
|
|
.SS "using \fBserif::model::checks::Rows\fP = dependencies::KeyList<\fBShapeRow\fP, \fBDensity\fP>"
|
|
|
|
.SS "using \fBserif::model::checks::Shape\fP = blocks::surface_deformation::coefficients"
|
|
|
|
.SS "using \fBserif::model::checks::ShapeOverlap\fP = dependencies::DependencyContext<\fBCoefficientSource\fP<\fBShape\fP>, \fBCoefficientSource\fP<\fBRotation\fP>>"
|
|
|
|
.SS "using \fBserif::model::checks::ShapeRow\fP = blocks::surface_deformation::shape_equilibrium"
|
|
|
|
.SS "using \fBserif::model::checks::State\fP = \fBStellarState\fP<\fBLayout\fP>"
|
|
|
|
.SS "using \fBserif::model::checks::Values\fP = dependencies::KeyList<\fBDensity\fP, \fBShape\fP>"
|
|
|
|
.SS "using \fBserif::model::checks::WrongIdentity\fP = dependencies::DependencyContext<\fBCoefficientSource\fP<\fBRotation\fP, \fBDensity\fP>>"
|
|
|
|
.SS "using \fBserif::model::checks::WrongValue\fP = decltype(dependencies::make_dependency_context(dependencies::own<\fBRotation\fP>(1\&.0)))"
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|