Files
MeanField_SERiF/docs/man/man3/serif_geometry_surface_detail_PressureSurfaceDescription.3

114 lines
7.5 KiB
Groff
Raw Normal View History

.TH "serif::geometry::surface::detail::PressureSurfaceDescription< EOS, Bindings, RowQuantity, RelationT, ResolveCarrier >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::geometry::surface::detail::PressureSurfaceDescription< EOS, Bindings, RowQuantity, RelationT, ResolveCarrier > \- Common physical metadata; numerical values and preparation belong to the dependency context and cache\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <compilation\&.hpp>\fP
.SS "Public Types"
.in +1c
.ti -1c
.RI "using \fBEquationOfState\fP = std::remove_cvref_t<EOS>"
.br
.ti -1c
.RI "using \fBStateBindings\fP = std::remove_cvref_t<Bindings>"
.br
.ti -1c
.RI "using \fBRelation\fP = RelationT"
.br
.ti -1c
.RI "using \fBPhysicalQuantity\fP = \fBdimensions::Pressure\fP"
.br
.ti -1c
.RI "using \fBResidualQuantity\fP = std::conditional_t<ResolveCarrier, RowQuantity, \fBdimensions::Pressure\fP>"
.br
.ti -1c
.RI "using \fBCarrierQuantity\fP = RowQuantity"
.br
.ti -1c
.RI "using \fBCarrierTerm\fP = \fButils::dependencies::bound_type_t\fP<\fBStateBindings\fP, RowQuantity>"
.br
.ti -1c
.RI "using \fBTest\fP = \fBCarrierTerm\fP"
.br
.ti -1c
.RI "using \fBSupport\fP = \fBdiscretization::domain::StellarSurfaceBoundary\fP"
.br
.ti -1c
.RI "using \fBEOSStateQuantities\fP = std::conditional_t<ResolveCarrier, typename \fBRelationQuantities\fP<\fBRelation\fP>::NonPressureInputs, typename \fBRelationQuantities\fP<\fBRelation\fP>::AllInputs>"
.br
.ti -1c
.RI "using \fBStateQuantities\fP = \fButils::dependencies::CombinedKeyList\fP<\fButils::dependencies::KeyList\fP<RowQuantity>, \fBEOSStateQuantities\fP>"
.br
.ti -1c
.RI "using \fBStateTerms\fP = \fBBoundTerms\fP<\fBStateBindings\fP, \fBStateQuantities\fP>"
.br
.ti -1c
.RI "using \fBEOSStateTerms\fP = \fBBoundTerms\fP<\fBStateBindings\fP, \fBEOSStateQuantities\fP>"
.br
.ti -1c
.RI "using \fBOperands\fP = typename \fBSurfaceOperands\fP<\fBStateTerms\fP>::Type"
.br
.in -1c
.SS "Static Public Attributes"
.in +1c
.ti -1c
.RI "static constexpr bool \fBresolves_carrier\fP = ResolveCarrier"
.br
.ti -1c
.RI "static constexpr bool \fBuses_eos\fP = true"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<typename EOS, typename Bindings, typename RowQuantity, typename RelationT, bool ResolveCarrier>
.br
struct serif::geometry::surface::detail::PressureSurfaceDescription< EOS, Bindings, RowQuantity, RelationT, ResolveCarrier >"Common physical metadata; numerical values and preparation belong to the dependency context and cache\&.
.SH "Member Typedef Documentation"
.PP
.SS "template<typename EOS, typename Bindings, typename RowQuantity, typename RelationT, bool ResolveCarrier> using \fBserif::geometry::surface::detail::PressureSurfaceDescription\fP< EOS, Bindings, RowQuantity, RelationT, ResolveCarrier >::CarrierQuantity = RowQuantity"
.SS "template<typename EOS, typename Bindings, typename RowQuantity, typename RelationT, bool ResolveCarrier> using \fBserif::geometry::surface::detail::PressureSurfaceDescription\fP< EOS, Bindings, RowQuantity, RelationT, ResolveCarrier >::CarrierTerm = \fButils::dependencies::bound_type_t\fP<\fBStateBindings\fP, RowQuantity>"
.SS "template<typename EOS, typename Bindings, typename RowQuantity, typename RelationT, bool ResolveCarrier> using \fBserif::geometry::surface::detail::PressureSurfaceDescription\fP< EOS, Bindings, RowQuantity, RelationT, ResolveCarrier >::EOSStateQuantities = std::conditional_t<ResolveCarrier, typename \fBRelationQuantities\fP<\fBRelation\fP>::NonPressureInputs, typename \fBRelationQuantities\fP<\fBRelation\fP>::AllInputs>"
.SS "template<typename EOS, typename Bindings, typename RowQuantity, typename RelationT, bool ResolveCarrier> using \fBserif::geometry::surface::detail::PressureSurfaceDescription\fP< EOS, Bindings, RowQuantity, RelationT, ResolveCarrier >::EOSStateTerms = \fBBoundTerms\fP<\fBStateBindings\fP, \fBEOSStateQuantities\fP>"
.SS "template<typename EOS, typename Bindings, typename RowQuantity, typename RelationT, bool ResolveCarrier> using \fBserif::geometry::surface::detail::PressureSurfaceDescription\fP< EOS, Bindings, RowQuantity, RelationT, ResolveCarrier >::EquationOfState = std::remove_cvref_t<EOS>"
.SS "template<typename EOS, typename Bindings, typename RowQuantity, typename RelationT, bool ResolveCarrier> using \fBserif::geometry::surface::detail::PressureSurfaceDescription\fP< EOS, Bindings, RowQuantity, RelationT, ResolveCarrier >::Operands = typename \fBSurfaceOperands\fP<\fBStateTerms\fP>::Type"
.SS "template<typename EOS, typename Bindings, typename RowQuantity, typename RelationT, bool ResolveCarrier> using \fBserif::geometry::surface::detail::PressureSurfaceDescription\fP< EOS, Bindings, RowQuantity, RelationT, ResolveCarrier >::PhysicalQuantity = \fBdimensions::Pressure\fP"
.SS "template<typename EOS, typename Bindings, typename RowQuantity, typename RelationT, bool ResolveCarrier> using \fBserif::geometry::surface::detail::PressureSurfaceDescription\fP< EOS, Bindings, RowQuantity, RelationT, ResolveCarrier >::Relation = RelationT"
.SS "template<typename EOS, typename Bindings, typename RowQuantity, typename RelationT, bool ResolveCarrier> using \fBserif::geometry::surface::detail::PressureSurfaceDescription\fP< EOS, Bindings, RowQuantity, RelationT, ResolveCarrier >::ResidualQuantity = std::conditional_t<ResolveCarrier, RowQuantity, \fBdimensions::Pressure\fP>"
.SS "template<typename EOS, typename Bindings, typename RowQuantity, typename RelationT, bool ResolveCarrier> using \fBserif::geometry::surface::detail::PressureSurfaceDescription\fP< EOS, Bindings, RowQuantity, RelationT, ResolveCarrier >::StateBindings = std::remove_cvref_t<Bindings>"
.SS "template<typename EOS, typename Bindings, typename RowQuantity, typename RelationT, bool ResolveCarrier> using \fBserif::geometry::surface::detail::PressureSurfaceDescription\fP< EOS, Bindings, RowQuantity, RelationT, ResolveCarrier >::StateQuantities = \fButils::dependencies::CombinedKeyList\fP<\fButils::dependencies::KeyList\fP<RowQuantity>, \fBEOSStateQuantities\fP>"
.SS "template<typename EOS, typename Bindings, typename RowQuantity, typename RelationT, bool ResolveCarrier> using \fBserif::geometry::surface::detail::PressureSurfaceDescription\fP< EOS, Bindings, RowQuantity, RelationT, ResolveCarrier >::StateTerms = \fBBoundTerms\fP<\fBStateBindings\fP, \fBStateQuantities\fP>"
.SS "template<typename EOS, typename Bindings, typename RowQuantity, typename RelationT, bool ResolveCarrier> using \fBserif::geometry::surface::detail::PressureSurfaceDescription\fP< EOS, Bindings, RowQuantity, RelationT, ResolveCarrier >::Support = \fBdiscretization::domain::StellarSurfaceBoundary\fP"
.SS "template<typename EOS, typename Bindings, typename RowQuantity, typename RelationT, bool ResolveCarrier> using \fBserif::geometry::surface::detail::PressureSurfaceDescription\fP< EOS, Bindings, RowQuantity, RelationT, ResolveCarrier >::Test = \fBCarrierTerm\fP"
.SH "Member Data Documentation"
.PP
.SS "template<typename EOS, typename Bindings, typename RowQuantity, typename RelationT, bool ResolveCarrier> bool \fBserif::geometry::surface::detail::PressureSurfaceDescription\fP< EOS, Bindings, RowQuantity, RelationT, ResolveCarrier >::resolves_carrier = ResolveCarrier\fR [static]\fP, \fR [constexpr]\fP"
.SS "template<typename EOS, typename Bindings, typename RowQuantity, typename RelationT, bool ResolveCarrier> bool \fBserif::geometry::surface::detail::PressureSurfaceDescription\fP< EOS, Bindings, RowQuantity, RelationT, ResolveCarrier >::uses_eos = true\fR [static]\fP, \fR [constexpr]\fP"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.