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)
123 lines
4.2 KiB
Groff
123 lines
4.2 KiB
Groff
.TH "src/include/serif/solver/continuation/family.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/solver/continuation/family.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <algorithm>\fP
|
|
.br
|
|
\fR#include <cmath>\fP
|
|
.br
|
|
\fR#include <functional>\fP
|
|
.br
|
|
\fR#include <limits>\fP
|
|
.br
|
|
\fR#include <optional>\fP
|
|
.br
|
|
\fR#include <tuple>\fP
|
|
.br
|
|
\fR#include <utility>\fP
|
|
.br
|
|
\fR#include <vector>\fP
|
|
.br
|
|
\fR#include 'serif/solver/continuation/parameters\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/model/stellar_model\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/utils/error/errors\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::continuation::ParameterLaw< Output, Dependencies, Function >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::continuation::detail::Contained< ParameterList< Parameters\&.\&.\&. >, Superset >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::continuation::detail::FamilyTraits< ParameterList< Selected\&.\&.\&. >, std::tuple< Laws\&.\&.\&. > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::continuation::detail::AllIdentified< utils::types::TypeList< Specifications\&.\&.\&. > >\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::continuation::detail::CopyEquations\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "class \fBserif::solver::continuation::BoundFamily< Model, ParameterList< Selected\&.\&.\&. >, std::tuple< Laws\&.\&.\&. >, EquationFactory >\fP"
|
|
.br
|
|
.RI "Own target physics and construct fresh family members without a mesh, evaluator, or mutable solve context\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::continuation::BoundFamily< Model, ParameterList< Selected\&.\&.\&. >, std::tuple< Laws\&.\&.\&. >, EquationFactory >::Values\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "class \fBserif::solver::continuation::Family< Selected, Laws >\fP"
|
|
.br
|
|
.RI "Own a reusable physical family definition before selecting a target model\&. "
|
|
.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::detail::LawDefinition\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "concept \fBserif::solver::continuation::detail::BindableFamily\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<PhysicalParameter\&.\&.\&. Parameters> constexpr auto \fBserif::solver::continuation::depends_on\fP (Parameters\&.\&.\&.) noexcept"
|
|
.br
|
|
.RI "Name only independent physical inputs to a dependent law\&. "
|
|
.ti -1c
|
|
.RI "template<typename Function> bool \fBserif::solver::continuation::detail::callable_valid\fP (const Function &value)"
|
|
.br
|
|
.RI "Reject null callable pointers even when a public aggregate bypasses its factory\&. "
|
|
.ti -1c
|
|
.RI "bool \fBserif::solver::continuation::detail::values_agree\fP (double first, double second) noexcept"
|
|
.br
|
|
.RI "Compare independently evaluated physical laws without an absolute unit-dependent tolerance\&. "
|
|
.ti -1c
|
|
.RI "template<typename Law, typename Model> auto \fBserif::solver::continuation::detail::bind_law\fP (Law &&value, const Model &target)"
|
|
.br
|
|
.RI "Bind target-dependent laws once, owning all resulting captures\&. "
|
|
.ti -1c
|
|
.RI "template<PhysicalParameter Output, PhysicalParameter\&.\&.\&. Inputs, typename Function>
|
|
.br
|
|
requires utils::dependencies::IsKeyList<\fBParameterList\fP<Inputs\&.\&.\&.>> && std::invocable<const std::remove_cvref_t<Function>&, typename Inputs::Value\&.\&.\&.> && std::same_as<std::remove_cvref_t<std::invoke_result_t<const std::remove_cvref_t<Function>&, typename Inputs::Value\&.\&.\&.>>, typename Output::Value>auto \fBserif::solver::continuation::law\fP (Output, \fBParameterList\fP< Inputs\&.\&.\&. >, Function &&function)"
|
|
.br
|
|
.RI "Own a typed law, including move-only captures; its inputs are selected coordinates rather than other laws\&. "
|
|
.ti -1c
|
|
.RI "template<PhysicalParameter\&.\&.\&. Parameters>
|
|
.br
|
|
requires (sizeof\&.\&.\&.(Parameters) > 0) && utils::dependencies::IsKeyList<\fBParameterList\fP<Parameters\&.\&.\&.>>auto \fBserif::solver::continuation::in\fP (Parameters\&.\&.\&.)"
|
|
.br
|
|
.RI "Select independent physical coordinates with duplicate detection at compile time\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|