2.8.1. vacumm.diag.dynamics – Dynamical processes

2.8.1.1. Overview

Attributes:
  • default_gravity
Functions:

2.8.1.2. Content

Diagnostic about dynamics

barotropic_geostrophic_velocity(ssh, dxy=None, gravity=9.822556428266076, cyclic=False, format_axes=True, getu=True, getv=True, filter=None)[source]

Get barotropic geostropic velocity from SSH on a C-grid

Note

ssh is supposed to be at T points, ubt is computed at V points, and vbt is computed at U points.

Todo

Rewrite it using vacumm.data.misc.arakawa and defining a limited number of algorithms for different staggering configurations.

Params:

  • ssh: Sea surface height.

  • dxy, optional: Horizontal resolutions (m). Resolution along X and Y are respectively at U and V points. Possible forms:

    • res: A scalar meaning a constant resolution along X and Y.
    • (dx,dy): A tuple of resolutions along X and Y.
    • None: Resolution is estimated using resol().
Return:

(ubt,vbt)
coriolis_parameter(lat, gravity=9.822556428266076, fromvar=False, format_axes=False)[source]

Get the coriolis parameters computed at each latitude

Params:
  • lat: Latitude or a variable with latitude coordinates.
  • gravity, optional: Gravity.
  • fromvar, optional: If True, lat is supposed to be a MV2 array with latitude coordinates.
eddy_kinetic_energy(sshuv, gravity=9.822556428266076, format_axes=None, dxy=None)

Compute kinetic energy in m2.s-2 either from SSH or velocity on C-grid

Todo

Rewrite it using vacumm.data.misc.arakawa and defining a limited number of algorithms for different staggering configurations.

Params:
Return:

KE at T points.
kinetic_energy(sshuv, gravity=9.822556428266076, format_axes=None, dxy=None)[source]

Compute kinetic energy in m2.s-2 either from SSH or velocity on C-grid

Todo

Rewrite it using vacumm.data.misc.arakawa and defining a limited number of algorithms for different staggering configurations.

Params:
Return:

KE at T points.