WaveVortexModel represents rotating, stratified Boussinesq flow on an energetically orthogonal basis of internal waves, inertial oscillations, geostrophic motions, and mean-density anomalies. It can decompose a fluid state into wave–vortex coefficients, reconstruct physical fields, diagnose the resulting flow, and integrate nonlinear dynamics, with analytical linear evolution available when needed.
Complete documentation: wavevortexmodel.org
WaveVortexModel requires MATLAB R2025b or newer. The recommended installation uses OceanKit as an MPM repository:
mpmAddRepository("OceanKit","local/path/to/OceanKit")
mpminstall("WaveVortexModel")See the installation guide for complete runtime and authoring instructions.
Create a small constant-stratification transform, initialize one internal wave, inspect its velocity field, and advance the state with nonlinear model integration:
wvt = WVTransformConstantStratification([40e3 40e3 1000],[16 16 9],N0=5.2e-3,latitude=45);
[omega,k,l] = wvt.initWithWaveModes(kMode=1,lMode=0,j=1,phi=0,u=0.05,sign=1);
[u,v,w] = wvt.variableWithName('u','v','w');
wvt.addForcing(WVAdaptiveDamping(wvt));
model = WVModel(wvt);
model.integrateToTime(600);The transform stores the decomposed state in the wave–vortex coefficients Ap, Am, and A0. Physical variables such as u, v, w, density, pressure, energy, and potential vorticity are reconstructed from those coefficients when requested.
- User guide
- Capabilities and limitations
- Optional compiled execution paths
- Transform API
- WVModel API
- Mathematical introduction
If WaveVortexModel contributes to your work, cite the software and the scientific formulation relevant to your application:
- Early, J. J., Fabre-Lima, L., Remy, B. J., Wortham, C., & Sundermeyer, M. A. (2025). WaveVortexModel. Zenodo.
- Early, J. J., Lelong, M.-P., & Sundermeyer, M. A. (2021). A generalized wave-vortex decomposition for rotating Boussinesq flows with arbitrary stratification. Journal of Fluid Mechanics, 912, A32.
- Early, J. J., Hernández-Dueñas, G., Smith, L. M., & Lelong, M.-P. (2024). Available potential vorticity and the wave-vortex decomposition for arbitrary stratification. arXiv.
Additional acknowledgements and BibTeX downloads are available at wavevortexmodel.org/acknowledgements.