Skip to content

Commit

Permalink
Merge pull request #8 from iuryt/MeanEddy
Browse files Browse the repository at this point in the history 
added mean-eddy decomposition function to utils
  • Loading branch information
@dantecn
dantecn authored Jun 9, 2021
2 parents 1e20305 + 5cc9ede commit 2b170e7
Show file tree
Hide file tree
Showing 5 changed files with 259 additions and 85 deletions.
4 changes: 2 additions & 2 deletions OceanLab/__init.py__
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from .dyn import zeta, vmode_amp, psi2uv, eqmodes, vmodes
from .eof import my_eof_interp, eoft
from .oa import scaloa, vectoa
from utils import argdistnear
from .utils import argdistnear, meaneddy

__version__ = '0.0.7'
_version_ = '0.1.0'
175 changes: 101 additions & 74 deletions OceanLab/dyn.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,36 @@
import numpy as np
import seawater as sw

# ===========================================================
# DYNAMICAL MODES AMPLITUDE
# ===========================================================
def vmode_amp(A,vi):
'''
This function makes the projection of every vertical mode to
timeseries or section matrix to obtain its amplitude. It will be used to
data reconstruction.
timeseries or section matrix to obtain its amplitude.
It will be used to data reconstruction.
Operation: ((A'*A)^-1)*(A'*vi)
=============================================================
INPUT:
A =
vi =
OUTPUT:
AMP =
==============================================================
'''
return np.dot(np.linalg.inv(np.dot(A.T,A)),np.dot(A.T,vi))

return np.dot(np.linalg.inv(np.dot(A.T,A)),np.dot(A.T,vi))

# ===========================================================
# RELATIVE VORTICITY
# ===========================================================
def zeta(x,y,U,V):
'''
ZETA k-component of rotational by velocity field
ZETA k-component of rotational by velocity field
Returns the scalar field of vorticity from U and V
velocity components. X and Y are longitude and latitude
matrices, respectively, as U and V. All matrices have
Expand All @@ -39,25 +54,24 @@ def zeta(x,y,U,V):
(JM = 0) o ---------- o ---------- o ---------- o --- ...
(IM = 0) (IM = 1) (IM = 2) (IM = 3)
-----------------------------------------------------------------
================================================================
USAGE: ZETA = zeta(x,y,u,v)
USAGE: u,v = psi2uv(x,y,psi)
INPUT:
x = decimal degrees (+ve E, -ve W) [-180..+180]
y = decimal degrees (+ve N, -ve S) [- 90.. +90]
u = velocity zonal component [m s^-1]
v = velocity meridional component [m s^-1]
INPUT:
x = decimal degrees (+ve E, -ve W) [-180..+180]
y = decimal degrees (+ve N, -ve S) [- 90.. +90]
u = velocity zonal component [m s^-1]
v = velocity meridional component [m s^-1]
OUTPUT:
ZETA = Relative vorticity field [s^-1]
OUTPUT:
ZETA = Relative vorticity field [s^-1]
AUTHOR:
AUTHOR:
Iury T. Simoes-Sousa and Wandrey Watanabe - 29 Jun 2016
Laboratório de Dinâmica Oceânica - IOUSP
======================================================================
================================================================
'''

#função para cálculo de ângulos
angcalc = lambda dy,dx: np.math.atan2(dy,dx)

Expand Down Expand Up @@ -116,16 +130,21 @@ def zeta(x,y,U,V):

return ZETA

# ===========================================================
# U AND V FROM STREAMFUNCTION
# ===========================================================
def psi2uv(x,y,psi):
'''
PSI2UV Velocity components from streamfunction
Returns the velocity components U and V
from streamfunction PSI. X and Y are longitude and latitude matrices,
respectively, as PSI. All matrices have same dimension.
PSI2UV Velocity components from streamfunction
--> !!! IMPORTANT !!! <-----------------------------------------
The grid indexes IM and JM must have origin on the left-inferior
corner, increasing to right and to up, respectively.
Returns the velocity components U and V
from streamfunction PSI. X and Y are longitude and latitude
matrices, respectively, as PSI.
All matrices have same dimension.
--> !!! IMPORTANT !!! <-----------------------------------
The grid indexes IM and JM must have origin on the
lower-left corner, increasing to right and to up.
GRID
: : : :
Expand All @@ -139,23 +158,24 @@ def psi2uv(x,y,psi):
(JM = 0) o ---------- o ---------- o ---------- o --- ...
(IM = 0) (IM = 1) (IM = 2) (IM = 3)
-----------------------------------------------------------------
==============================================================
USAGE: u,v = psi2uv(x,y,psi)
USAGE: u,v = psi2uv(x,y,psi)
INPUT:
x = decimal degrees (+ve E, -ve W) [-180..+180]
y = decimal degrees (+ve N, -ve S) [- 90.. +90]
psi = streamfunction [m^2 s^-1]
INPUT:
x = decimal degrees (+ve E, -ve W) [-180..+180]
y = decimal degrees (+ve N, -ve S) [- 90.. +90]
psi = streamfunction [m^2 s^-1]
OUTPUT:
u = velocity zonal component [m s^-1]
v = velocity meridional component [m s^-1]
OUTPUT:
u = velocity zonal component [m s^-1]
v = velocity meridional component [m s^-1]
AUTHOR:
Iury T. Simoes-Sousa and Wandrey Watanabe - 12 May 2016
Laboratório de Dinâmica Oceânica - IOUSP
======================================================================
AUTHOR:
Iury T. Simoes-Sousa and Wandrey Watanabe
May 2016 - Laboratório de Dinâmica Oceânica - IOUSP
Universidade de São Paulo
==========================================================
'''

#função para cálculo de ângulos
Expand Down Expand Up @@ -210,45 +230,38 @@ def psi2uv(x,y,psi):

return U,V


# ===========================================================
# EQUATORIAL MODES
# ===========================================================
def eqmodes(N2,z,nm,lat,pmodes=False):
'''
This function computes the equatorial velocity modes
========================================================
Input:
N2 - Brunt-Vaisala frequency data array
z - Depth data array (equaly spaced)
lat - Latitude scalar
nm - Number of modes to be computed
pmodes - If the return of pressure modes is required.
Default is False
========================================================
Output:
Si - Equatorial modes matrix with MxN dimension being:
M = z array size
N = nm
Rdi - Deformation Radii array
Fi - Pressure modes matrix with MxN dimension being:
M = z array size
N = nm
Returned only if input pmodes=True
made by Iury T. Simoes-Sousa, Hélio Almeida and Wandrey Watanabe
Laboratório de Dinâmica Oceânica - Universidade de São Paulo
2016
============================================================
INPUT:
N2 = Brunt-Vaisala frequency data array
z = Depth data array (equaly spaced)
lat = Latitude scalar
nm = Number of modes to be computed
pmodes = If the return of pressure modes is required.
(Default is False)
OUTPUT:
Si = Equatorial modes matrix with MxN dimension being:
M = z array size
N = nm
Rdi = Deformation Radii array
Fi = Pressure modes matrix with MxN dimension being:
M = z array size
N = nm
(Returned only if input pmodes=True)
AUTHOR:
Iury T. Simoes-Sousa, Hélio Almeida and Wandrey Watanabe
2016 Laboratório de Dinâmica Oceânica
Universidade de São Paulo
============================================================
'''

#nm will be the number of baroclinic modes
Expand Down Expand Up @@ -352,8 +365,22 @@ def eqmodes(N2,z,nm,lat,pmodes=False):
return Si,radii



# ===========================================================
# DYNAMICAL MODES
# ===========================================================
def vmodes(N2,z,nm,lat,ubdy='N',lbdy='N'):

"""
========================================================
INPUT:
OUTPUT:
AUTHOR:
========================================================
"""

f0 = sw.f(lat)
dz = np.abs(z[1] - z[0])

Expand Down Expand Up @@ -417,4 +444,4 @@ def vmodes(N2,z,nm,lat,ubdy='N',lbdy='N'):
radii[0] = np.sqrt(9.81*H)/np.abs(f0)/1000
radii[1:] = 1/np.sqrt(ei[1:])/1000

return fi, radii
return fi, radii
Loading

0 comments on commit 2b170e7

Please sign in to comment.