WVTransformBarotropicQG

Represent two-dimensional equivalent-barotropic quasigeostrophic flow.

Declaration 

classdef WVTransformBarotropicQG < WVTransform

Overview

This is a two-dimensional, single-layer transform. The h parameter is the equivalent depth; 0.80 m is a representative first-baroclinic value. The transform stores its state in A0 and has no wave Ap or Am content.

Lxy = 50e3;
Nxy = 256;
latitude = 25;
wvt = WVTransformBarotropicQG([Lxy,Lxy],[Nxy,Nxy],h=0.8,latitude=latitude);

The quasigeostrophic state is stored in A0, with current-time view A0t. This transform has no active Ap, Am, Apt, or Amt content.

Topics

  • Create and restore a transform
  • Inspect the domain
    • Physical environment
      • Planetary rotation
        • beta Meridional gradient of the Coriolis parameter.
        • f Coriolis parameter in radians per second.
        • inertialPeriod Inertial period in seconds.
        • latitude Central latitude of the rotating domain in degrees north.
        • planetaryRadius Radius of the rotating planetary body in meters.
        • rotationRate Planetary rotation rate in radians per second.
      • Gravity
        • g Gravitational acceleration in meters per second squared.
    • Spatial grid
      • Coordinate axes
        • x Periodic x-coordinate axis in meters.
        • y Periodic y-coordinate axis in meters.
      • Coordinate arrays
        • X Gridded x-coordinate array in meters with shape [Nx Ny].
        • Y Gridded y-coordinate array in meters with shape [Nx Ny].
        • xyGrid Return the two-dimensional spatial coordinate arrays.
      • Domain dimensions
        • Lx Periodic domain length in the x direction.
        • Ly Periodic domain length in the y direction.
      • Resolution and shape
        • Nx Number of spatial grid points in the x direction.
        • Ny Number of spatial grid points in the y direction.
        • spatialMatrixSize Shape of a gridded physical-space field.
    • Spectral grid
      • Compact grid vectors
        • k Compact Nkl-by-1 x-wavenumber vector in \(\mathrm{rad\,m^{-1}}\).
        • l Compact Nkl-by-1 y-wavenumber vector in \(\mathrm{rad\,m^{-1}}\).
      • Compact grid arrays
        • K X-direction angular-wavenumber array in \(\mathrm{rad\,m^{-1}}\) with shape [1 Nkl].
        • L Y-direction angular-wavenumber array in \(\mathrm{rad\,m^{-1}}\) with shape [1 Nkl].
        • klGrid Return the barotropic spectral-coordinate arrays.
      • Wavenumber spacing
        • dk Spacing of the x-direction angular-wavenumber axis.
        • dl Spacing of the y-direction angular-wavenumber axis.
      • Horizontal wavenumber geometry
        • Kh Horizontal angular-wavenumber magnitude on the coefficient grid.
        • K2 Squared horizontal angular wavenumber on the coefficient grid.
      • Resolution and shape
      • Equivalent depth and deformation scale
        • h Equivalent depth associated with a vertical mode.
        • h_0 Geostrophic equivalent-depth scale for each vertical mode.
        • Lr2 Squared Rossby deformation radius in square meters.
    • Transform configuration
      • isHydrostatic Whether the transform uses the hydrostatic approximation.
      • shouldAntialias Whether the spectral grid excludes modes that alias quadratic products.
  • Initialize the flow
  • Evaluate physical fields
    • Registered variables
    • On the model grid
      • Velocity
        • u x-component of the fluid velocity
        • v y-component of the fluid velocity
      • Pressure and surface fields
        • eta approximate isopycnal deviation
        • pi height anomaly
        • ssh sea-surface height
      • Vorticity and geostrophic fields
        • psi geostrophic streamfunction
        • qgpv quasigeostrophic potential vorticity
        • zeta_z vertical component of relative vorticity
    • At arbitrary positions
  • Manage forcing and closures
    • Configure forcing
    • Inspect forcing and closures
    • Summarize forcing
  • Analyze the flow
    • Flow diagnostics
    • Potential vorticity and enstrophy
    • Spectra
      • Spectral fields
        • kAxis Centered Nx-by-1 x-wavenumber axis in \(\mathrm{rad\,m^{-1}}\).
        • lAxis Centered Ny-by-1 y-wavenumber axis in \(\mathrm{rad\,m^{-1}}\).
        • transformToKLAxes transforms in the spectral domain from (j,kl) to (kAxis,lAxis,j)
      • Radial wavenumber
  • Analyze energy
  • Save transform state
  • Convert representations
    • Physical fields and coefficients
  • Differentiate and integrate fields
    • diffX Differentiate a gridded field in the periodic x direction.
    • diffY Differentiate a gridded field in the periodic y direction.
  • Inspect flow components
  • Inspect wave-vortex coefficients
    • Stored coefficients
      • A0 Zero-frequency geostrophic coefficients.
    • Coefficients at the current time
      • A0t A0t is the zero-frequency coefficient array evaluated at the current transform time. On the supported \(f\)-plane transforms, A0 has no linear phase winding and therefore
    • Coefficient evolution
      • t0 Reference time for the stored wave phases, in seconds.
      • t Current transform time in seconds.
  • Create a related transform
  • Extend a transform
  • Get package information
    • version Installed WaveVortexModel version.

Developer Topics

These items document internal implementation details and are not part of the primary public API.

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