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)
109 lines
2.9 KiB
Groff
109 lines
2.9 KiB
Groff
.TH "src/include/serif/solver/continuation/parameters.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/solver/continuation/parameters.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <array>\fP
|
|
.br
|
|
\fR#include <concepts>\fP
|
|
.br
|
|
\fR#include <expected>\fP
|
|
.br
|
|
\fR#include <ranges>\fP
|
|
.br
|
|
\fR#include <string>\fP
|
|
.br
|
|
\fR#include <string_view>\fP
|
|
.br
|
|
\fR#include <type_traits>\fP
|
|
.br
|
|
\fR#include 'serif/dimensions/quantities\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/utils/dependencies/key_list_operations\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::continuation::Failure\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::continuation::ParameterDescriptor\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::continuation::SpecificationTraits< Specification >\fP"
|
|
.br
|
|
.RI "Add continuation access without imposing numerical dependencies on a physical prescription\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::continuation::detail::ParameterCatalog< Owner, typename >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::continuation::detail::ParameterCatalog< Owner, std::void_t< typename Owner::ContinuationParameters > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::continuation::detail::Catalog< Owner, typename >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::continuation::detail::Catalog< Owner, std::void_t< typename SpecificationTraits< Owner >::Parameters > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::continuation::detail::RequiredDependents< Parameter, typename >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::continuation::detail::RequiredDependents< Parameter, std::void_t< typename Parameter::RequiredDependentParameters > >\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver::continuation\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver::continuation::detail\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Concepts"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "concept \fBserif::solver::continuation::CoordinateValue\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "concept \fBserif::solver::continuation::PhysicalParameter\fP"
|
|
.br
|
|
.RI "A typed physical parameter owns its domain predicate, units, owner, and stable identity\&. "
|
|
.ti -1c
|
|
.RI "concept \fBserif::solver::continuation::IdentifiedSpecification\fP"
|
|
.br
|
|
.RI "Require explicit identity data, never an object address or incidental memory representation\&. "
|
|
.in -1c
|
|
.SS "Typedefs"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename\&.\&.\&. Parameters> using \fBserif::solver::continuation::ParameterList\fP = \fButils::dependencies::KeyList\fP<Parameters\&.\&.\&.>"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<CoordinateValue Value> constexpr double \fBserif::solver::continuation::coordinate_value\fP (Value value) noexcept"
|
|
.br
|
|
.RI "Convert physical units only at the coordinate-controller boundary\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|