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

82 lines
2.2 KiB
Groff
Raw Permalink Normal View History

.TH "serif::geometry::surface::IsobaricSurface" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::geometry::surface::IsobaricSurface
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <isobaric\&.hpp>\fP
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBParameters\fP"
.br
.in -1c
.SS "Public Types"
.in +1c
.ti -1c
.RI "using \fBPhysicalQuantity\fP = \fBdimensions::Pressure\fP"
.br
.ti -1c
.RI "using \fBTargetValue\fP = \fBdimensions::PressureValue\fP"
.br
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBIsobaricSurface\fP (const \fBParameters\fP parameters)"
.br
.ti -1c
.RI "\fBIsobaricSurface\fP (const \fBTargetValue\fP targetPressure)"
.br
.ti -1c
.RI "\fBTargetValue\fP \fBtarget_pressure\fP () const noexcept"
.br
.ti -1c
.RI "std::array< double, 1 > \fBcontinuation_identity\fP () const noexcept"
.br
.ti -1c
.RI "\fBPressureSurfaceDescriptor\fP \fBdescriptor\fP () const noexcept"
.br
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "\fBTargetValue\fP \fBm_targetPressure\fP"
.br
.in -1c
.SH "Member Typedef Documentation"
.PP
.SS "using \fBserif::geometry::surface::IsobaricSurface::PhysicalQuantity\fP = \fBdimensions::Pressure\fP"
.SS "using \fBserif::geometry::surface::IsobaricSurface::TargetValue\fP = \fBdimensions::PressureValue\fP"
.SH "Constructor & Destructor Documentation"
.PP
.SS "serif::geometry::surface::IsobaricSurface::IsobaricSurface (const \fBParameters\fP parameters)\fR [explicit]\fP"
.SS "serif::geometry::surface::IsobaricSurface::IsobaricSurface (const \fBTargetValue\fP targetPressure)\fR [explicit]\fP"
.SH "Member Function Documentation"
.PP
.SS "std::array< double, 1 > serif::geometry::surface::IsobaricSurface::continuation_identity () const\fR [nodiscard]\fP, \fR [noexcept]\fP"
.SS "\fBPressureSurfaceDescriptor\fP serif::geometry::surface::IsobaricSurface::descriptor () const\fR [nodiscard]\fP, \fR [noexcept]\fP"
.SS "\fBIsobaricSurface::TargetValue\fP serif::geometry::surface::IsobaricSurface::target_pressure () const\fR [nodiscard]\fP, \fR [noexcept]\fP"
.SH "Member Data Documentation"
.PP
.SS "\fBTargetValue\fP serif::geometry::surface::IsobaricSurface::m_targetPressure\fR [private]\fP"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.