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

117 lines
4.6 KiB
Groff
Raw Permalink Normal View History

.TH "serif::equations::PressureForce< EOST >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::equations::PressureForce< EOST > \- Pressure's contribution to displacement balance: -integral_star P(h) div(w) dV\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <pressure_force\&.hpp>\fP
.PP
Inherits \fBserif::equations::Contribution< discretization::forms::Operand< discretization::blocks::displacement::vector, discretization::forms::Operation::Divergence >, discretization::domain::StellarDomains >\fP\&.
.SS "Public Types"
.in +1c
.ti -1c
.RI "using \fBEnthalpy\fP = \fBdiscretization::blocks::enthalpy::specific\fP"
.br
.ti -1c
.RI "using \fBEnthalpyValue\fP = \fBdiscretization::forms::Operand\fP<\fBEnthalpy\fP>"
.br
.ti -1c
.RI "using \fBOperands\fP = \fButils::types::TypeList\fP<\fBEnthalpyValue\fP>"
.br
.in -1c
Public Types inherited from \fBserif::equations::Contribution< discretization::forms::Operand< discretization::blocks::displacement::vector, discretization::forms::Operation::Divergence >, discretization::domain::StellarDomains >\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 "\fBPressureForce\fP (EOST equation_of_state, const double enthalpy_power)"
.br
.RI "The effective power describes P(h), not rho(h), for quadrature selection\&. "
.ti -1c
.RI "\fBPressureForce\fP (EOST equation_of_state)"
.br
.ti -1c
.RI "\fBPointLinearization\fP< \fBOperands\fP > \fBevaluate\fP (const \fBEquationPoint\fP< \fBOperands\fP > &point) const"
.br
.ti -1c
.RI "int \fBadditional_order\fP (\fBEnthalpyValue\fP, int) const"
.br
.in -1c
.SS "Static Public Attributes"
.in +1c
.ti -1c
.RI "static constexpr std::string_view \fBname\fP = 'pressure force'"
.br
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "EOST \fBm_eos\fP"
.br
.ti -1c
.RI "double \fBm_enthalpy_power\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<eos::models::PressureForceEOS EOST>
.br
class serif::equations::PressureForce< EOST >"Pressure's contribution to displacement balance: -integral_star P(h) div(w) dV\&.
.SH "Member Typedef Documentation"
.PP
.SS "template<eos::models::PressureForceEOS EOST> using \fBserif::equations::PressureForce\fP< EOST >::Enthalpy = \fBdiscretization::blocks::enthalpy::specific\fP"
.SS "template<eos::models::PressureForceEOS EOST> using \fBserif::equations::PressureForce\fP< EOST >::EnthalpyValue = \fBdiscretization::forms::Operand\fP<\fBEnthalpy\fP>"
.SS "template<eos::models::PressureForceEOS EOST> using \fBserif::equations::PressureForce\fP< EOST >::Operands = \fButils::types::TypeList\fP<\fBEnthalpyValue\fP>"
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<eos::models::PressureForceEOS EOST> \fBserif::equations::PressureForce\fP< EOST >::PressureForce (EOST equation_of_state, const double enthalpy_power)\fR [inline]\fP, \fR [explicit]\fP"
.PP
The effective power describes P(h), not rho(h), for quadrature selection\&.
.SS "template<eos::models::PressureForceEOS EOST> \fBserif::equations::PressureForce\fP< EOST >::PressureForce (EOST equation_of_state)\fR [inline]\fP, \fR [explicit]\fP"
.SH "Member Function Documentation"
.PP
.SS "template<eos::models::PressureForceEOS EOST> int \fBserif::equations::PressureForce\fP< EOST >::additional_order (\fBEnthalpyValue\fP , int ) const\fR [inline]\fP, \fR [nodiscard]\fP"
.SS "template<eos::models::PressureForceEOS EOST> \fBPointLinearization\fP< \fBOperands\fP > \fBserif::equations::PressureForce\fP< EOST >::evaluate (const \fBEquationPoint\fP< \fBOperands\fP > & point) const\fR [inline]\fP, \fR [nodiscard]\fP"
The test divergence is scalar, so the physics supplies -P and -dP/dh\&. \fBTest\fP mapping and volume variation belong to the shared operator backend\&.
.SH "Member Data Documentation"
.PP
.SS "template<eos::models::PressureForceEOS EOST> double \fBserif::equations::PressureForce\fP< EOST >::m_enthalpy_power\fR [private]\fP"
.SS "template<eos::models::PressureForceEOS EOST> EOST \fBserif::equations::PressureForce\fP< EOST >::m_eos\fR [private]\fP"
.SS "template<eos::models::PressureForceEOS EOST> std::string_view \fBserif::equations::PressureForce\fP< EOST >::name = 'pressure force'\fR [static]\fP, \fR [constexpr]\fP"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.