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

130 lines
5.7 KiB
Groff
Raw Permalink Normal View History

.TH "serif::equations::PressureSurfaceConstraint< EOST >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::equations::PressureSurfaceConstraint< EOST > \- Compatibility equation for the existing enthalpy boundary rows, using the shared isobaric calculation\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <pressure_surface\&.hpp>\fP
.PP
Inherits \fBserif::equations::Contribution< discretization::forms::Operand< discretization::blocks::enthalpy::specific >, discretization::domain::StellarSurfaceBoundary >\fP\&.
.SS "Public Types"
.in +1c
.ti -1c
.RI "using \fBEnthalpy\fP = \fBdiscretization::blocks::enthalpy::specific\fP"
.br
.ti -1c
.RI "using \fBFormulation\fP = \fBgeometry::surface::PressureSurfaceFormulation\fP<EOST, \fButils::dependencies::Bindings\fP<\fButils::dependencies::Binding\fP<\fBdimensions::SpecificEnthalpy\fP, \fBEnthalpy\fP>>>"
.br
.ti -1c
.RI "using \fBOperands\fP = typename \fBFormulation::Operands\fP"
.br
.ti -1c
.RI "using \fBResidualQuantity\fP = typename \fBFormulation::ResidualQuantity\fP"
.br
.in -1c
Public Types inherited from \fBserif::equations::Contribution< discretization::forms::Operand< discretization::blocks::enthalpy::specific >, discretization::domain::StellarSurfaceBoundary >\fP
.in +1c
.ti -1c
.RI "using \fBTest\fP"
.br
.RI "The test type of the contribution\&. "
.ti -1c
.RI "using \fBTestOperand\fP"
.br
.RI "The operand type of the contribution (associating a test function and a term) "
.ti -1c
.RI "using \fBSupport\fP"
.br
.RI "The domain support of the contribution (which then boils down to the dofs which are supported by the term on that test function) "
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBPressureSurfaceConstraint\fP (const EOST &equation_of_state, \fBdimensions::PressureValue\fP \fBtarget_pressure\fP)"
.br
.RI "Freeze the EOS response at construction, preserving the existing boundary equation's value semantics\&. "
.ti -1c
.RI "\fBPointLinearization\fP< \fBOperands\fP > \fBevaluate\fP (const \fBEquationPoint\fP< \fBOperands\fP > &point) const"
.br
.RI "Reuse the surface residual and derivative without reevaluating the frozen EOS\&. "
.ti -1c
.RI "\fBdimensions::PressureValue\fP \fBtarget_pressure\fP () const noexcept"
.br
.RI "Retain the prescribed physical pressure independently of its enthalpy representation\&. "
.in -1c
.SS "Static Public Attributes"
.in +1c
.ti -1c
.RI "static constexpr std::string_view \fBname\fP = 'pressure surface constraint'"
.br
.ti -1c
.RI "static constexpr bool \fBposition_independent\fP = true"
.br
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "\fBgeometry::surface::Isobaric\fP \fBm_condition\fP"
.br
.ti -1c
.RI "\fBgeometry::surface::SurfaceEOSResponse\fP< \fBFormulation\fP > \fBm_response\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<eos::models::EOSModel EOST>
.br
requires eos::models::EOSSupportingRelation<EOST, \fBeos::relations::SpecificEnthalpyFromPressure\fP>
.br
class serif::equations::PressureSurfaceConstraint< EOST >"Compatibility equation for the existing enthalpy boundary rows, using the shared isobaric calculation\&.
.SH "Member Typedef Documentation"
.PP
.SS "template<eos::models::EOSModel EOST> using \fBserif::equations::PressureSurfaceConstraint\fP< EOST >::Enthalpy = \fBdiscretization::blocks::enthalpy::specific\fP"
.SS "template<eos::models::EOSModel EOST> using \fBserif::equations::PressureSurfaceConstraint\fP< EOST >::Formulation = \fBgeometry::surface::PressureSurfaceFormulation\fP<EOST, \fButils::dependencies::Bindings\fP<\fButils::dependencies::Binding\fP<\fBdimensions::SpecificEnthalpy\fP, \fBEnthalpy\fP>>>"
.SS "template<eos::models::EOSModel EOST> using \fBserif::equations::PressureSurfaceConstraint\fP< EOST >::Operands = typename \fBFormulation::Operands\fP"
.SS "template<eos::models::EOSModel EOST> using \fBserif::equations::PressureSurfaceConstraint\fP< EOST >::ResidualQuantity = typename \fBFormulation::ResidualQuantity\fP"
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<eos::models::EOSModel EOST> \fBserif::equations::PressureSurfaceConstraint\fP< EOST >::PressureSurfaceConstraint (const EOST & equation_of_state, \fBdimensions::PressureValue\fP target_pressure)\fR [inline]\fP"
.PP
Freeze the EOS response at construction, preserving the existing boundary equation's value semantics\&.
.SH "Member Function Documentation"
.PP
.SS "template<eos::models::EOSModel EOST> \fBPointLinearization\fP< \fBOperands\fP > \fBserif::equations::PressureSurfaceConstraint\fP< EOST >::evaluate (const \fBEquationPoint\fP< \fBOperands\fP > & point) const\fR [inline]\fP, \fR [nodiscard]\fP"
.PP
Reuse the surface residual and derivative without reevaluating the frozen EOS\&.
.SS "template<eos::models::EOSModel EOST> \fBdimensions::PressureValue\fP \fBserif::equations::PressureSurfaceConstraint\fP< EOST >::target_pressure () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
.PP
Retain the prescribed physical pressure independently of its enthalpy representation\&.
.SH "Member Data Documentation"
.PP
.SS "template<eos::models::EOSModel EOST> \fBgeometry::surface::Isobaric\fP \fBserif::equations::PressureSurfaceConstraint\fP< EOST >::m_condition\fR [private]\fP"
.SS "template<eos::models::EOSModel EOST> \fBgeometry::surface::SurfaceEOSResponse\fP<\fBFormulation\fP> \fBserif::equations::PressureSurfaceConstraint\fP< EOST >::m_response\fR [private]\fP"
.SS "template<eos::models::EOSModel EOST> std::string_view \fBserif::equations::PressureSurfaceConstraint\fP< EOST >::name = 'pressure surface constraint'\fR [static]\fP, \fR [constexpr]\fP"
.SS "template<eos::models::EOSModel EOST> bool \fBserif::equations::PressureSurfaceConstraint\fP< EOST >::position_independent = true\fR [static]\fP, \fR [constexpr]\fP"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.