Supported features

This page defines the target support contract for WaveVortexModel 4.2.1 and the remainder of the 4.2.x release line. It does not imply that every behavior in the released 4.2.0 package already conforms to this contract. Known gaps are listed below and are assigned to the linked stabilization issues.

Support applies to documented behavior through the public WVTransform and WVModel interfaces. A MATLAB class or method being publicly visible does not by itself make that interface supported.

Status definitions

Status Meaning
Stable Compatibility is promised throughout 4.2.x. A regression is a v4.2.1 release blocker.
Experimental The feature is available, but its API or numerical behavior may change with notice.
Deprecated The feature is retained in 4.2.x for migration and may be removed in the next major release.
Internal The feature has no compatibility promise and must not be treated as a supported public API.

No feature is assigned to Deprecated in the v4.2.1 target contract.

Transforms and numerical services

Feature Status Contract
WVTransformConstantStratification Stable Hydrostatic and nonhydrostatic modes are supported.
WVTransformHydrostatic Stable The hydrostatic, variable-stratification transform is supported.
WVTransformBoussinesq Stable The nonhydrostatic, variable-stratification transform is supported.
WVTransformStratifiedQG Stable The stratified quasigeostrophic transform is supported.
WVTransformBarotropicQG Stable The equivalent-barotropic quasigeostrophic transform is supported.
Latitude Stable Supported transforms accept both hemispheres for 5 <= abs(latitude) <= 85, including the endpoints.
MATLAB builtin FFT implementation Stable This is the supported Fourier-transform backend.
Even and odd builtin horizontal grids Stable Positive integer grid counts are supported independently in each periodic direction. Nyquist modes exist and are excluded only along even-sized directions.
Transform indexing and resolution conversion Stable Scalar and column-vector mode/index mappings are bijective on supported modes. Resolution and explicit-antialias conversions preserve coefficients identified by common integer mode numbers and initialize new modes to zero.
Spectral and spatial quadratic invariants Stable Energy and, where defined, enstrophy agree within the documented transform discretization tolerance.
FFTW and RealToComplexTransform integration Internal These backend remnants are not selectable through a supported transform contract.
Periodic linear and spline interpolation Stable These are the only interpolation methods exposed by the supported public interpolation contract.
Vertical calculus for stable 3-D transforms Stable diffZF and diffZG support orders 1 through 4 on [Nx Ny Nz] grids. intZF and intZG support first antiderivatives on [Nx Ny Nz] grids and [Nz N] matrices. Unsupported orders and layouts are rejected through ordinary MATLAB argument validation.
hasMeanPressureDifference Stable The diagnostic reports whether the mean-density-anomaly component produces a resolved horizontally averaged pressure difference between the top and bottom boundaries. Transforms without an MDA component return false.
WVTotalFlowComponent.solutionForModeAtIndex Stable Total-flow indices select primary-component analytical solutions in lexical shortName order while retaining each component’s local mode ordering.
summarizeDegreesOfFreedom Stable The no-output console summary reports the spatial grid and mask-derived active spectral degrees of freedom for every primary component in lexical shortName order.
exact and finufft interpolation Internal These implementation paths and option values must not appear in public option lists or user documentation.
WVOffGridTransform, external-wave behavior, and off-grid pressure Internal These incomplete remnants have no 4.2.x compatibility promise.

Integration

Feature Status Contract
Adaptive integration through WVModel Stable The public model facade, tolerance handling, output, and restart behavior are supported.
Fixed-step integration through WVModel Stable The public model facade, time-step selection, output, and restart behavior are supported.
adaptive-cell integration Experimental The option is available for evaluation but is not yet covered by a stable numerical or compatibility promise.
Integrator mixins and ode45_cell Internal Low-level integrator implementations are not supported entry points.

Forcing

Custom forcing through the documented WVForcing extension surface is Stable. The supplied forcing classes have the following status.

Forcing class Status
WVNonlinearAdvection Stable
WVAdaptiveDamping Stable
WVAntialiasing Stable
WVHorizontalDamping Stable
WVVerticalDamping Stable
WVVerticalDiffusivity Stable
WVFixedAmplitudeForcing Stable
WVBottomFrictionLinear Stable
WVBottomFrictionQuadratic Stable
WVBetaPlanePVAdvection Stable
WVPseudoTopographicWaveGeneration Stable
WVThermalDamping Experimental
WVAdaptiveDiffusivity Internal
WVAdaptiveViscosity Internal
WVMeanFlowForcing Internal
WVSpectralVanishingViscosity Internal

The Internal forcing classes currently reside under Forcing/Experimental; their directory name does not override their status in this contract.

Observing systems, output, and persistence

Feature Status Contract
WVObservingSystem Stable The supplied base class and documented custom observing-system extension surface are supported.
WVEulerianFields Stable Eulerian field observation is supported.
WVCoefficients Stable Wave-vortex coefficient observation and integration are supported.
WVLagrangianParticles Stable Lagrangian particle observation and integration are supported.
WVMooring Stable Mooring observation is supported.
WVTracer Stable Tracer observation and integration are supported.
WVModelOutputFile Stable Model output through supported NetCDF files is supported.
WVModelOutputGroup Stable Custom output grouping through the documented base interface is supported.
WVModelOutputGroupEvenlySpaced Stable Evenly spaced output grouping is supported.
NetCDF round trips and model restart Stable Supported transforms, forcing, observing systems, output configuration, and model state must round-trip and release their file handles.

Extension points and optional tooling

Feature Status Contract
WVOperation and WVVariableAnnotation extension surfaces Stable Documented custom operations and annotations are supported.
WVFlowComponent extension surface Stable Documented custom flow components are supported.
WVNoMotionProfileOperation solver selection Stable lsqnonlin is used when Optimization Toolbox is available; otherwise the warning-producing fminsearch fallback is supported. Optimization Toolbox remains optional.
Low-level Adapative and mustBeDoulbyPeriodicFPlane spellings Internal These names may be corrected without compatibility wrappers; the stable WVModel facade must remain unchanged.

Known 4.2.0 gaps and follow-up work

New scientific capabilities, new transform families, and broad refactoring are outside the v4.2.1 stabilization release.

This site uses Just the Docs, a documentation theme for Jekyll.