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)
88 lines
3.2 KiB
Groff
88 lines
3.2 KiB
Groff
.TH "src/include/serif/model/execution_validation.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/model/execution_validation.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'serif/model/equilibrium_plan\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/model/validation\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::model::detail::CartesianCouplings< utils::dependencies::KeyList< Rows\&.\&.\&. >, utils::dependencies::KeyList< Fields\&.\&.\&. > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::model::detail::ExecutionSurface< Plan, typename >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::model::detail::ExecutionSurface< Plan, std::void_t< typename Plan::Surface > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::model::detail::ExecutionInputs< Plan, typename >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::model::detail::ExecutionInputs< Plan, std::void_t< typename Plan::PhysicalInputs, typename Plan::InactiveRows > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::model::detail::EquilibriumCouplings< Description, Surface >\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::model\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::model::detail\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Concepts"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "concept \fBserif::model::ExecutableEquilibriumDescription\fP"
|
|
.br
|
|
.RI "Recognize current equation backends without instantiating an invalid complete plan\&. "
|
|
.in -1c
|
|
.SS "Typedefs"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<ExecutableEquilibriumDescription Description, typename Plan> using \fBserif::model::ActualEquilibriumCouplings\fP = typename \fBdetail::EquilibriumCouplings\fP<Description, \fBdetail::ExecutionSurface\fP<Plan>>::Type"
|
|
.br
|
|
.RI "Inspect the actual derivative producers admitted by the explicitly supplied physical formulation\&. "
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<DimensionalScalarSpecification Specification, typename Rows, typename InactiveRows, typename Actual, typename Bindings> consteval bool \fBserif::model::detail::generated_physics_is_present\fP ()"
|
|
.br
|
|
.RI "Demand an explicitly supplied generated equation and effect before inferring closed-row zeros\&. "
|
|
.ti -1c
|
|
.RI "template<typename Rows, typename InactiveRows, typename Actual, typename Bindings, typename\&.\&.\&. Specifications> consteval bool \fBserif::model::detail::generated_physics_are_present\fP (\fButils::types::TypeList\fP< Specifications\&.\&.\&. >)"
|
|
.br
|
|
.RI "Check only numerical-provider admission; physical endpoint ownership is checked separately\&. "
|
|
.ti -1c
|
|
.RI "template<typename Rows, typename\&.\&.\&. Required> consteval bool \fBserif::model::detail::equation_rows_exist\fP (\fButils::dependencies::KeyList\fP< Required\&.\&.\&. >)"
|
|
.br
|
|
.RI "Every surface carrier must have an equation row in the selected layout\&. "
|
|
.ti -1c
|
|
.RI "template<typename Model, typename Description, typename Plan, typename Bindings = DefaultSpecificationBindings, typename ExplicitZeroCouplings = utils::dependencies::KeyList<>> consteval bool \fBserif::model::executable_model_topology\fP ()"
|
|
.br
|
|
.RI "Validate a complete selected formulation without inferring solvability or selecting physics\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|