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)
35 lines
1.6 KiB
Groff
35 lines
1.6 KiB
Groff
.TH "serif::model::DimensionalScalarSpecification" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::model::DimensionalScalarSpecification \- Require exact dimensional agreement only when scalar numerical metadata is needed\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <specification\&.hpp>\fP
|
|
.SH "Concept definition"
|
|
.PP
|
|
|
|
.nf
|
|
template<typename Candidate>
|
|
concept serif::model::DimensionalScalarSpecification = ModelSpecification<Candidate> && requires(const std::remove_cvref_t<Candidate>& specification)
|
|
{
|
|
requires (std::remove_cvref_t<Candidate>::ModelDefinition::generated_state_kind != GeneratedStateKind::none);
|
|
typename std::remove_cvref_t<Candidate>::ModelDefinition::ScalarDescription::TargetQuantity;
|
|
typename std::remove_cvref_t<Candidate>::ModelDefinition::ScalarDescription::CoordinateQuantity;
|
|
typename std::remove_cvref_t<Candidate>::ModelDefinition::ScalarDescription::ResidualQuantity;
|
|
requires dimensions::PhysicalQuantityType<typename std::remove_cvref_t<Candidate>::ModelDefinition::ScalarDescription::CoordinateQuantity>;
|
|
requires dimensions::PhysicalQuantityType<typename std::remove_cvref_t<Candidate>::ModelDefinition::ScalarDescription::ResidualQuantity>;
|
|
{ specification\&.target() } \-> std::same_as<dimensions::QuantityValue<typename std::remove_cvref_t<Candidate>::ModelDefinition::ScalarDescription::TargetQuantity>>;
|
|
}
|
|
.PP
|
|
.fi
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Require exact dimensional agreement only when scalar numerical metadata is needed\&.
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|