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)
154 lines
6.3 KiB
Groff
154 lines
6.3 KiB
Groff
.TH "serif::model::StellarState< LayoutT >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::model::StellarState< LayoutT > \- Own one stellar candidate in physical coordinates, including any solved surface shape\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <state\&.hpp>\fP
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBLayout\fP = std::remove_cvref_t<LayoutT>"
|
|
.br
|
|
.in -1c
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBStellarState\fP (\fBLayout\fP \fBlayout\fP)"
|
|
.br
|
|
.RI "Allocate one zero-initialized coefficient vector in the declared physical ordering\&. "
|
|
.ti -1c
|
|
.RI "\fBStellarState\fP (\fBLayout\fP \fBlayout\fP, std::vector< double > \fBvalues\fP)"
|
|
.br
|
|
.RI "Adopt existing physical coefficients after checking their complete coordinate count\&. "
|
|
.ti -1c
|
|
.RI "const \fBLayout\fP & \fBlayout\fP () const &noexcept"
|
|
.br
|
|
.RI "Inspect the fixed field and equation ordering associated with this state\&. "
|
|
.ti -1c
|
|
.RI "const \fBLayout\fP & \fBlayout\fP () const &&=delete"
|
|
.br
|
|
.RI "\fBLayout\fP references must not outlive a temporary state\&. "
|
|
.ti -1c
|
|
.RI "template<typename Term>
|
|
.br
|
|
requires utils::dependencies::ContainsKey<Term, typename Layout::Values>std::span< double > \fBget\fP () &"
|
|
.br
|
|
.RI "Edit one physical field or scalar without maintaining a second coefficient copy\&. "
|
|
.ti -1c
|
|
.RI "template<typename Term>
|
|
.br
|
|
requires utils::dependencies::ContainsKey<Term, typename Layout::Values>std::span< const double > \fBget\fP () const &"
|
|
.br
|
|
.RI "Inspect one physical field while preserving the constness of its owning state\&. "
|
|
.ti -1c
|
|
.RI "template<typename Term> std::span< const double > \fBget\fP () const &&=delete"
|
|
.br
|
|
.RI "A field view cannot outlive a temporary owning state\&. "
|
|
.ti -1c
|
|
.RI "std::span< double > \fBvalues\fP () &noexcept"
|
|
.br
|
|
.RI "Access packed physical coordinates for an explicitly chosen numerical update\&. "
|
|
.ti -1c
|
|
.RI "std::span< const double > \fBvalues\fP () const &noexcept"
|
|
.br
|
|
.RI "Read packed physical coordinates without permitting a change in their count\&. "
|
|
.ti -1c
|
|
.RI "std::span< const double > \fBvalues\fP () const &&=delete"
|
|
.br
|
|
.RI "Do not return a span into a temporary owning state\&. "
|
|
.in -1c
|
|
.SS "Private Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBLayout\fP \fBm_layout\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::vector< double > \fBm_values\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<discretization::blocks::SystemLayoutType LayoutT>
|
|
.br
|
|
struct serif::model::StellarState< LayoutT >"Own one stellar candidate in physical coordinates, including any solved surface shape\&.
|
|
|
|
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
Copying a state makes an independent candidate\&. Its layout fixes the field identities and sizes; normalization changes solver coordinates, never these physical coefficients\&. Prescribed inputs are supplied separately to evaluation because they have no solved coordinate in this layout\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "template<discretization::blocks::SystemLayoutType LayoutT> using \fBserif::model::StellarState\fP< LayoutT >::Layout = std::remove_cvref_t<LayoutT>"
|
|
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "template<discretization::blocks::SystemLayoutType LayoutT> \fBserif::model::StellarState\fP< LayoutT >::StellarState (\fBLayout\fP layout)\fR [inline]\fP, \fR [explicit]\fP"
|
|
|
|
.PP
|
|
Allocate one zero-initialized coefficient vector in the declared physical ordering\&.
|
|
.SS "template<discretization::blocks::SystemLayoutType LayoutT> \fBserif::model::StellarState\fP< LayoutT >::StellarState (\fBLayout\fP layout, std::vector< double > values)\fR [inline]\fP"
|
|
|
|
.PP
|
|
Adopt existing physical coefficients after checking their complete coordinate count\&.
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "template<discretization::blocks::SystemLayoutType LayoutT> template<typename Term>
|
|
.br
|
|
requires utils::dependencies::ContainsKey<Term, typename Layout::Values>std::span< double > \fBserif::model::StellarState\fP< LayoutT >::get () &\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Edit one physical field or scalar without maintaining a second coefficient copy\&.
|
|
.SS "template<discretization::blocks::SystemLayoutType LayoutT> template<typename Term>
|
|
.br
|
|
requires utils::dependencies::ContainsKey<Term, typename Layout::Values>std::span< const double > \fBserif::model::StellarState\fP< LayoutT >::get () const &\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Inspect one physical field while preserving the constness of its owning state\&.
|
|
.SS "template<discretization::blocks::SystemLayoutType LayoutT> template<typename Term> std::span< const double > \fBserif::model::StellarState\fP< LayoutT >::get () const &&\fR [delete]\fP"
|
|
|
|
.PP
|
|
A field view cannot outlive a temporary owning state\&.
|
|
.SS "template<discretization::blocks::SystemLayoutType LayoutT> const \fBLayout\fP & \fBserif::model::StellarState\fP< LayoutT >::layout () const &&\fR [delete]\fP"
|
|
|
|
.PP
|
|
\fBLayout\fP references must not outlive a temporary state\&.
|
|
.SS "template<discretization::blocks::SystemLayoutType LayoutT> const \fBLayout\fP & \fBserif::model::StellarState\fP< LayoutT >::layout () const &\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Inspect the fixed field and equation ordering associated with this state\&.
|
|
.SS "template<discretization::blocks::SystemLayoutType LayoutT> std::span< double > \fBserif::model::StellarState\fP< LayoutT >::values () &\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Access packed physical coordinates for an explicitly chosen numerical update\&.
|
|
.SS "template<discretization::blocks::SystemLayoutType LayoutT> std::span< const double > \fBserif::model::StellarState\fP< LayoutT >::values () const &&\fR [delete]\fP"
|
|
|
|
.PP
|
|
Do not return a span into a temporary owning state\&.
|
|
.SS "template<discretization::blocks::SystemLayoutType LayoutT> std::span< const double > \fBserif::model::StellarState\fP< LayoutT >::values () const &\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Read packed physical coordinates without permitting a change in their count\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "template<discretization::blocks::SystemLayoutType LayoutT> \fBLayout\fP \fBserif::model::StellarState\fP< LayoutT >::m_layout\fR [private]\fP"
|
|
|
|
.SS "template<discretization::blocks::SystemLayoutType LayoutT> std::vector<double> \fBserif::model::StellarState\fP< LayoutT >::m_values\fR [private]\fP"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|