MITgcm_contrib/gmaze_pv/Contents.m

% -----------------------------------------------------------------
% MITgcm_contrib > G. MAZE contribution > Matlab routines
%
% This package tries to provide some useful and simple routines to
% compute, visualize and analyze Potential Vorticity from the 
% global high resolution (1/8deg) simulation of the MITgcm.
% Routines are as general as possible for extended applications, but
% note that they were developped to focus on the Western Atlantic
% region for the CLIMODE project.
% Enjoy !
%
% gmaze@mit.edu
%
% -----------------------------------------------------------------
% PROGRAMS LIST (NOT FUNCTIONS):
%
% MAIN_GETPV
% This program defines the global setup and launch the PV computing.
%
% -----------------------------------------------------------------
% FUNCTIONS LIST:
%
% A_COMPUTE_POTENTIAL_DENSITY(SNAPSHOT)
% From netcdf files contained into the SNAPSHOT directory of the
% ./netcdf-files/ home folder, this function computes potential 
% density from potential temperature THETA and anomalous salinity 
% SALTanom
%
% B_COMPUTE_RELATIVE_VORTICITY(SNAPSHOT)
% From netcdf files contained into the SNAPSHOT directory of the
% ./netcdf-files/ home folder, this function computes the three
% components of the relative vorticity from horizontal flow UVEL
% and VVEL.
%
% C_COMPUTE_POTENTIAL_VORTICITY(SNAPSHOT,[WANT_SPL_PV])
% From netcdf files contained into the SNAPSHOT directory of the
% ./netcdf-files/ home folder, this function computes the 
% potential vorticity field from the relative vorticity components
% and the potential density field. Option WANT_SPL_PV turned 1 
% makes the function only computing the PV based on the planetary 
% vorticity.
%
% VOLBET2ISO(TRACER,LIMITS,DEPTH,LAT,LONG)
% This function computes the volume embedded between two
% iso-TRACER values and limited eastward, westward and southward
% by fixed limits.
% Very simple test available with: TEST_VOLBET2ISO
%
% SURFBET2OUTCROPS(TRACER,LIMITS,LAT,LONG)
% This function computes the horizontal surface limited
% by two outcrops of a tracer.
% Very simple test available with: TEST_SURFBET2OUTCROPS
%
% INTBET2OUTCROPS(TRACER,LIMITS,LAT,LONG)
% This function computes the horizontal surface integral
% of the field TRACER on the area limited by two outcrops.
% Very simple test available with: TEST_INTBET2OUTCROPS
%
% -----------------------------------------------------------------
% LOWER LEVEL FUNCTIONS LIST:
%
% PV_CHECKPATH
% This function, systematicaly called by the others, ensures that 
% all needed sub-directories of the package are in the path.
%
% -----------------------------------------------------------------
% PS:
%
% > Several functions use the m_map package.
%   Ensure to get it in the Matlab path.
%   (M_MAP is available at: http://www.eos.ubc.ca/~rich/map.html)
%
% -----------------------------------------------------------------
%
1	% -----------------------------------------------------------------
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
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:
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)
44	% This function computes the volume embedded between two
45	% iso-TRACER values and limited eastward, westward and southward
46	% by fixed limits.
47	% Very simple test available with: TEST_VOLBET2ISO
48	%
49	% SURFBET2OUTCROPS(TRACER,LIMITS,LAT,LONG)
50	% This function computes the horizontal surface limited
51	% by two outcrops of a tracer.
52	% Very simple test available with: TEST_SURFBET2OUTCROPS
53	%
54	% INTBET2OUTCROPS(TRACER,LIMITS,LAT,LONG)
55	% This function computes the horizontal surface integral
56	% of the field TRACER on the area limited by two outcrops.
57	% 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:
68	%
69	% > Several functions use the m_map package.
70	% 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	%