UpperBoundary

Enumerate the supported upper boundary conditions.

Declaration 

classdef UpperBoundary

Overview

UpperBoundary collects the upper-surface boundary-condition labels used by the internal-modes solvers. The main user-facing values are rigidLid and freeSurface, matching the boundary conditions described in Section 2.3 of Early, Lelong, and Smith (2020).

The valid values are:

  • UpperBoundary.rigidLid for \(G(0) = 0\)
  • UpperBoundary.freeSurface for \(h \partial_z G(0) = G(0)\)
  • UpperBoundary.mda, UpperBoundary.buoyancyAnomaly, UpperBoundary.geostrophicFreeSurface, and UpperBoundary.custom for specialized internal workflows
  • UpperBoundary.none when no explicit upper condition should be imposed
im = InternalModes(rho, zIn, zOut, latitude);
im.upperBoundary = UpperBoundary.freeSurface;

Topics