.TH "serif::equations::SurfacePotentialBalance" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::equations::SurfacePotentialBalance \- Set the effective potential to one unknown level on the selected isobar\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <surface_potential\&.hpp>\fP
.SS "Public Types"

.in +1c
.ti -1c
.RI "using \fBPotential\fP = \fBdiscretization::blocks::gravity::potential\fP"
.br
.ti -1c
.RI "using \fBSurfaceLevel\fP = \fBdiscretization::blocks::barotropic_constant::mass_normalization\fP"
.br
.ti -1c
.RI "using \fBAngularVelocity\fP = \fBdiscretization::blocks::rotation::angular_velocity\fP"
.br
.ti -1c
.RI "using \fBOperands\fP"
.br
.ti -1c
.RI "using \fBResidualQuantity\fP = \fBdimensions::GravitationalPotential\fP"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSurfacePotentialBalance\fP (const \fBRigidRotation::Vector\fP &axis={0\&.0, 0\&.0, 1\&.0}, const \fBRigidRotation::Vector\fP &center={}, std::optional< \fBPointMassCompanion\fP > \fBcompanion\fP=std::nullopt)"
.br
.RI "Use the same physical rotation axis, origin and companion as the interior equation\&. "
.ti -1c
.RI "\fBPointLinearization\fP< \fBOperands\fP > \fBevaluate\fP (const \fBEquationPoint\fP< \fBOperands\fP > &point) const"
.br
.RI "Differentiate at fixed pulled-back potential; geometry moves only the centrifugal term\&. "
.ti -1c
.RI "const \fBRigidRotation\fP & \fBrotation\fP () const noexcept"
.br
.RI "Inspect the physical rotation convention\&. "
.ti -1c
.RI "const std::optional< \fBPointMassCompanion\fP > & \fBcompanion\fP () const noexcept"
.br
.RI "Inspect the companion, if any\&. "
.in -1c
.SS "Static Public Attributes"

.in +1c
.ti -1c
.RI "static constexpr std::string_view \fBname\fP = 'surface effective potential balance'"
.br
.in -1c
.SS "Private Attributes"

.in +1c
.ti -1c
.RI "\fBRigidRotation\fP \fBm_rotation\fP"
.br
.ti -1c
.RI "std::optional< \fBPointMassCompanion\fP > \fBm_companion\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Set the effective potential to one unknown level on the selected isobar\&. 

Integrate this point relation against the existing surface shape basis with a fixed dimensionless reference measure\&. The constant mode is retained\&. This is a boundary equation, not a volume displacement force\&. 
.SH "Member Typedef Documentation"
.PP 
.SS "using \fBserif::equations::SurfacePotentialBalance::AngularVelocity\fP = \fBdiscretization::blocks::rotation::angular_velocity\fP"

.SS "using \fBserif::equations::SurfacePotentialBalance::Operands\fP"
\fBInitial value:\fP
.nf
 utils::types::TypeList<discretization::forms::Operand<Potential>,
            discretization::forms::Operand<SurfaceLevel>, discretization::forms::Operand<AngularVelocity>>
.PP
.fi

.SS "using \fBserif::equations::SurfacePotentialBalance::Potential\fP = \fBdiscretization::blocks::gravity::potential\fP"

.SS "using \fBserif::equations::SurfacePotentialBalance::ResidualQuantity\fP = \fBdimensions::GravitationalPotential\fP"

.SS "using \fBserif::equations::SurfacePotentialBalance::SurfaceLevel\fP = \fBdiscretization::blocks::barotropic_constant::mass_normalization\fP"

.SH "Constructor & Destructor Documentation"
.PP 
.SS "serif::equations::SurfacePotentialBalance::SurfacePotentialBalance (const \fBRigidRotation::Vector\fP & axis = \fR{0\&.0, 0\&.0, 1\&.0}\fP, const \fBRigidRotation::Vector\fP & center = \fR{}\fP, std::optional< \fBPointMassCompanion\fP > companion = \fRstd::nullopt\fP)\fR [inline]\fP, \fR [explicit]\fP"

.PP
Use the same physical rotation axis, origin and companion as the interior equation\&. 
.SH "Member Function Documentation"
.PP 
.SS "const std::optional< \fBPointMassCompanion\fP > & serif::equations::SurfacePotentialBalance::companion () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"

.PP
Inspect the companion, if any\&. 
.SS "\fBPointLinearization\fP< \fBOperands\fP > serif::equations::SurfacePotentialBalance::evaluate (const \fBEquationPoint\fP< \fBOperands\fP > & point) const\fR [inline]\fP, \fR [nodiscard]\fP"

.PP
Differentiate at fixed pulled-back potential; geometry moves only the centrifugal term\&. 
.SS "const \fBRigidRotation\fP & serif::equations::SurfacePotentialBalance::rotation () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"

.PP
Inspect the physical rotation convention\&. 
.SH "Member Data Documentation"
.PP 
.SS "std::optional<\fBPointMassCompanion\fP> serif::equations::SurfacePotentialBalance::m_companion\fR [private]\fP"

.SS "\fBRigidRotation\fP serif::equations::SurfacePotentialBalance::m_rotation\fR [private]\fP"

.SS "std::string_view serif::equations::SurfacePotentialBalance::name = 'surface effective potential balance'\fR [static]\fP, \fR [constexpr]\fP"


.SH "Author"
.PP 
Generated automatically by Doxygen for SERiF from the source code\&.