serif::equations::SurfacePotentialBalance Class Reference

Set the effective potential to one unknown level on the selected isobar. More...

#include <surface_potential.hpp>

Collaboration diagram for serif::equations::SurfacePotentialBalance:

Public Types
using	Potential = discretization::blocks::gravity::potential
using	SurfaceLevel = discretization::blocks::barotropic_constant::mass_normalization
using	AngularVelocity = discretization::blocks::rotation::angular_velocity
using	Operands
using	ResidualQuantity = dimensions::GravitationalPotential

Public Member Functions
	SurfacePotentialBalance (const RigidRotation::Vector &axis={0.0, 0.0, 1.0}, const RigidRotation::Vector &center={}, std::optional< PointMassCompanion > companion=std::nullopt)
	Use the same physical rotation axis, origin and companion as the interior equation.
PointLinearization< Operands >	evaluate (const EquationPoint< Operands > &point) const
	Differentiate at fixed pulled-back potential; geometry moves only the centrifugal term.
const RigidRotation &	rotation () const noexcept
	Inspect the physical rotation convention.
const std::optional< PointMassCompanion > &	companion () const noexcept
	Inspect the companion, if any.

Static Public Attributes
static constexpr std::string_view	name = "surface effective potential balance"

Private Attributes
RigidRotation	m_rotation
std::optional< PointMassCompanion >	m_companion

Detailed Description

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.

Member Typedef Documentation

AngularVelocity

using serif::equations::SurfacePotentialBalance::AngularVelocity = discretization::blocks::rotation::angular_velocity

Operands

using serif::equations::SurfacePotentialBalance::Operands

Initial value:

 utils::types::TypeList<discretization::forms::Operand<Potential>,
            discretization::forms::Operand<SurfaceLevel>, discretization::forms::Operand<AngularVelocity>>

Potential

using serif::equations::SurfacePotentialBalance::Potential = discretization::blocks::gravity::potential

ResidualQuantity

using serif::equations::SurfacePotentialBalance::ResidualQuantity = dimensions::GravitationalPotential

SurfaceLevel

using serif::equations::SurfacePotentialBalance::SurfaceLevel = discretization::blocks::barotropic_constant::mass_normalization

Constructor & Destructor Documentation

SurfacePotentialBalance()

serif::equations::SurfacePotentialBalance::SurfacePotentialBalance ( const RigidRotation::Vector & axis = {0.0, 0.0, 1.0}, const RigidRotation::Vector & center = {}, std::optional< PointMassCompanion > companion = std::nullopt )

inlineexplicit

Use the same physical rotation axis, origin and companion as the interior equation.

Member Function Documentation

companion()

const std::optional< PointMassCompanion > & serif::equations::SurfacePotentialBalance::companion ( ) const

inlinenodiscardnoexcept

Inspect the companion, if any.

evaluate()

PointLinearization< Operands > serif::equations::SurfacePotentialBalance::evaluate ( const EquationPoint< Operands > & point ) const

inlinenodiscard

Differentiate at fixed pulled-back potential; geometry moves only the centrifugal term.

rotation()

const RigidRotation & serif::equations::SurfacePotentialBalance::rotation ( ) const

inlinenodiscardnoexcept

Inspect the physical rotation convention.

Member Data Documentation

m_companion

std::optional<PointMassCompanion> serif::equations::SurfacePotentialBalance::m_companion

private

m_rotation

RigidRotation serif::equations::SurfacePotentialBalance::m_rotation

private

name

std::string_view serif::equations::SurfacePotentialBalance::name = "surface effective potential balance"

staticconstexpr

---

The documentation for this class was generated from the following file:

• src/include/serif/equations/surface_potential.hpp