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)
33 lines
1.2 KiB
Groff
33 lines
1.2 KiB
Groff
.TH "serif::solver::continuation::PhysicalParameter" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::solver::continuation::PhysicalParameter \- A typed physical parameter owns its domain predicate, units, owner, and stable identity\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <parameters\&.hpp>\fP
|
|
.SH "Concept definition"
|
|
.PP
|
|
|
|
.nf
|
|
template<typename Parameter>
|
|
concept serif::solver::continuation::PhysicalParameter = requires(const typename Parameter::Specification& specification, typename Parameter::Value value) {
|
|
requires CoordinateValue<typename Parameter::Value>;
|
|
{ Parameter::name } \-> std::convertible_to<std::string_view>;
|
|
{ Parameter::stable_id } \-> std::convertible_to<std::string_view>;
|
|
{ Parameter::read(specification) } \-> std::same_as<typename Parameter::Value>;
|
|
{ Parameter::valid(value) } \-> std::same_as<bool>;
|
|
requires utils::dependencies::ContainsKey<Parameter, typename detail::Catalog<typename Parameter::Specification>::Type>;
|
|
}
|
|
.PP
|
|
.fi
|
|
.SH "Detailed Description"
|
|
.PP
|
|
A typed physical parameter owns its domain predicate, units, owner, and stable identity\&.
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|