1 |
% MITgcm_contrib Matlab routines of Guillaume MAZE |
% ----------------------------------------------------------------- |
2 |
|
% MITgcm_contrib > G. MAZE contribution > Matlab routines |
3 |
|
% |
4 |
|
% This package tries to provide some useful and simple routines to |
5 |
|
% compute, visualize and analyze Potential Vorticity from the |
6 |
|
% global high resolution (1/8deg) simulation of the MITgcm. |
7 |
|
% Routines are as general as possible for extended applications, but |
8 |
|
% note that they were developped to focus on the Western Atlantic |
9 |
|
% region for the CLIMODE project. |
10 |
|
% Enjoy ! |
11 |
% |
% |
12 |
% gmaze@mit.edu |
% gmaze@mit.edu |
13 |
% |
% |
14 |
|
% ----------------------------------------------------------------- |
15 |
|
% PROGRAMS LIST (NOT FUNCTIONS): |
16 |
|
% |
17 |
|
% MAIN_GETPV |
18 |
|
% This program defines the global setup and launch the PV computing. |
19 |
% |
% |
20 |
|
% ----------------------------------------------------------------- |
21 |
% FUNCTIONS LIST: |
% FUNCTIONS LIST: |
22 |
% |
% |
23 |
|
% A_COMPUTE_POTENTIAL_DENSITY(SNAPSHOT) |
24 |
|
% From netcdf files contained into the SNAPSHOT directory of the |
25 |
|
% ./netcdf-files/ home folder, this function computes potential |
26 |
|
% density from potential temperature THETA and anomalous salinity |
27 |
|
% SALTanom |
28 |
|
% |
29 |
|
% B_COMPUTE_RELATIVE_VORTICITY(SNAPSHOT) |
30 |
|
% From netcdf files contained into the SNAPSHOT directory of the |
31 |
|
% ./netcdf-files/ home folder, this function computes the three |
32 |
|
% components of the relative vorticity from horizontal flow UVEL |
33 |
|
% and VVEL. |
34 |
|
% |
35 |
|
% C_COMPUTE_POTENTIAL_VORTICITY(SNAPSHOT,[WANT_SPL_PV]) |
36 |
|
% From netcdf files contained into the SNAPSHOT directory of the |
37 |
|
% ./netcdf-files/ home folder, this function computes the |
38 |
|
% potential vorticity field from the relative vorticity components |
39 |
|
% and the potential density field. Option WANT_SPL_PV turned 1 |
40 |
|
% makes the function only computing the PV based on the planetary |
41 |
|
% vorticity. |
42 |
|
% |
43 |
% VOLBET2ISO(TRACER,LIMITS,DEPTH,LAT,LONG) |
% VOLBET2ISO(TRACER,LIMITS,DEPTH,LAT,LONG) |
44 |
% This function computes the volume limited northward by |
% This function computes the volume embedded between two |
45 |
% two tracer values and eastward, westward and southward |
% iso-TRACER values and limited eastward, westward and southward |
46 |
% by fixed limits. |
% by fixed limits. |
47 |
% Very simple test available with: TEST_VOLBET2ISO |
% Very simple test available with: TEST_VOLBET2ISO |
48 |
% |
% |
56 |
% of the field TRACER on the area limited by two outcrops. |
% of the field TRACER on the area limited by two outcrops. |
57 |
% Very simple test available with: TEST_INTBET2OUTCROPS |
% Very simple test available with: TEST_INTBET2OUTCROPS |
58 |
% |
% |
59 |
|
% ----------------------------------------------------------------- |
60 |
|
% LOWER LEVEL FUNCTIONS LIST: |
61 |
% |
% |
62 |
|
% PV_CHECKPATH |
63 |
|
% This function, systematicaly called by the others, ensures that |
64 |
|
% all needed sub-directories of the package are in the path. |
65 |
|
% |
66 |
|
% ----------------------------------------------------------------- |
67 |
% PS: |
% PS: |
68 |
% Several functions use the m_map package. |
% |
69 |
% Be sure to get it in the Matlab path. |
% > Several functions use the m_map package. |
70 |
% (M_MAP is available at: http://www.eos.ubc.ca/~rich/map.html) |
% Ensure to get it in the Matlab path. |
71 |
|
% (M_MAP is available at: http://www.eos.ubc.ca/~rich/map.html) |
72 |
|
% |
73 |
|
% ----------------------------------------------------------------- |
74 |
% |
% |