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)
99 lines
3.1 KiB
Groff
99 lines
3.1 KiB
Groff
.TH "src/include/serif/model/stellar_model.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/model/stellar_model.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <functional>\fP
|
|
.br
|
|
\fR#include <span>\fP
|
|
.br
|
|
\fR#include <tuple>\fP
|
|
.br
|
|
\fR#include <type_traits>\fP
|
|
.br
|
|
\fR#include <utility>\fP
|
|
.br
|
|
\fR#include 'serif/model/detail/specification_list\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/model/equilibrium_equations\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "class \fBserif::model::StellarModel< EquationOfStateT, EquationDefinitionT, utils::types::TypeList< Specifications\&.\&.\&. > >\fP"
|
|
.br
|
|
.RI "Own immutable physics and an explicit formulation, independently of meshes, caches and solvers\&. "
|
|
.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::ValidSpecificationPack\fP"
|
|
.br
|
|
.RI "Prescriptions accompany one separately owned EOS; no numerical capability is assumed\&. "
|
|
.ti -1c
|
|
.RI "concept \fBserif::model::StellarModelType\fP"
|
|
.br
|
|
.RI "Safely recognize descriptions, including when presented with an incomplete specialization\&. "
|
|
.ti -1c
|
|
.RI "concept \fBserif::model::HasUniqueSpecificationForRole\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Typedefs"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<\fBSpecificationRole\fP Role, StellarModelType Candidate> using \fBserif::model::SpecificationsForRole\fP = typename std::remove_cvref_t<Candidate>::template \fBSpecificationsForRole\fP<Role>"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename EOS, typename Definition, typename\&.\&.\&. Specifications>
|
|
.br
|
|
requires ValidSpecificationPack<std::remove_cvref_t<Specifications>\&.\&.\&.>\fBserif::model::StellarModel\fP (EOS &&, Definition &&, Specifications &&\&.\&.\&.) \-> StellarModel< std::remove_cvref_t< EOS >, std::remove_cvref_t< Definition >, typename \fBdetail::CanonicalSpecifications\fP< std::remove_cvref_t< Specifications >\&.\&.\&. >::Type >"
|
|
.br
|
|
.ti -1c
|
|
.RI "template<typename EOS, typename Definition, typename\&.\&.\&. Specifications>
|
|
.br
|
|
requires ValidSpecificationPack<std::remove_cvref_t<Specifications>\&.\&.\&.>auto \fBserif::model::make_stellar_model\fP (EOS &&eos, Definition &&definition, Specifications &&\&.\&.\&. specifications)"
|
|
.br
|
|
.RI "Construct a typed physical description with programmer-selected equations\&. "
|
|
.in -1c
|
|
.SS "Variables"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename Candidate, typename = void> constexpr bool \fBserif::model::detail::is_stellar_model\fP = false"
|
|
.br
|
|
.ti -1c
|
|
.RI "template<typename EOS, typename Definition, typename List> constexpr bool \fBserif::model::detail::is_stellar_model< StellarModel< EOS, Definition, List >, std::void_t< typename StellarModel< EOS, Definition, List >::SpecificationTypes > >\fP = true"
|
|
.br
|
|
.ti -1c
|
|
.RI "template<\fBSpecificationRole\fP Role, typename Candidate> constexpr std::size_t \fBserif::model::specification_role_count\fP"
|
|
.br
|
|
.RI "Inspect role counts without instantiating invalid model specializations\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|