Parent Directory
| 
Revision Log
| 
Revision Graph
| 
Patch
--- MITgcm_contrib/gmaze_pv/Contents.m 2006/06/16 21:09:16 1.3 +++ MITgcm_contrib/gmaze_pv/Contents.m 2006/07/10 15:09:01 1.4 @@ -1,74 +1,90 @@ -% ----------------------------------------------------------------- -% MITgcm_contrib > G. MAZE contribution > Matlab routines +% CLIMODE: potential vorticity toolbox % -% 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. +% 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 +% Last update: 07/06/06 % -% ----------------------------------------------------------------- -% PROGRAMS LIST (NOT FUNCTIONS): +% --------------------------------------------------------------------------------------------- +% PROGRAMS LIST (NOT A FUNCTIONS): % -% MAIN_GETPV -% This program defines the global setup and launch the PV computing. +% main_getPV_eg +% This program is an exemple of how to define global setup and +% to launch the PV computing. +% +% --------------------------------------------------------------------------------------------- +% FUNCTIONS LIST 1: NETCDF FILES DIAGNOSTICS +% From netcdf files contained into SNAPSHOT sub-directory of the +% ./netcdf-files/ home folder, these functions ... +% +% A_compute_potential_density(SNAPSHOT) +% Computes potential density SIGMATHETA from potential +% temperature THETA and anomalous salinity SALTanom. +% B_compute_relative_vorticity(SNAPSHOT) +% Computes the 3 components of the relative vorticity from the +% horizontal flow. +% C_compute_potential_vorticity(SNAPSHOT,[WANT_SPL_PV]) +% Computes the potential vorticity field from the relative +% vorticity components and the potential density. Option +% WANT_SPL_PV turned 1 (0 by default) makes the function only +% computing the PV based on the planetary vorticity. +% D_compute_potential_vorticity(SNAPSHOT,[WANT_SPL_PV]) +% Multiplies the potential vorticity computed with +% C_COMPUTE_POTENTIAL_VORTICITY by the coefficient: -1/RHO +% Optional flag WANTSPLPV is turned to 0 by default. Turn it to 1 +% if the PV computed was the simple one (f.dSIGMATHETA/dz). It's +% needed for the output netcdf file informations. +% compute_JBz(SNAPSHOT) +% Computes the surface PV flux due to diabatic processes. +% compute_JFz(SNAPSHOT) +% Computes the surface PV flux due to frictionnal forces. +% compute_density(SNAPSHOT) +% Computes density RHO from potential temperature THETA +% and anomalous salinity SALTanom. +% compute_alpha(SNAPSHOT) +% Computes the thermal expansion coefficient ALPHA from potential +% temperature THETA and salinity anomaly SALTanom. +% compute_QEk(SNAPSHOT) +% Computes QEk, the lateral heat flux induced by Ekman currents +% from JFz, the PV flux induced by frictional forces. +% +% --------------------------------------------------------------------------------------------- +% FUNCTIONS LIST 2: ANALYSIS FUNCTIONS +% +% 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. +% surfbet2outcrops(TRACER,LIMITS,LAT,LONG) +% This function computes the horizontal surface limited +% by two outcrops of a tracer. +% intbet2outcrops(TRACER,LIMITS,LAT,LONG) +% This function computes the horizontal surface integral +% of the field TRACER on the area limited by two outcrops. +% subfct_getisoS(TRACER,ISO) +% This function determines the iso-surface ISO of the +% 3D field TRACER(Z,Y,X). +% +% --------------------------------------------------------------------------------------------- +% LOWER LEVEL AND SUB-FUNCTIONS LIST: +% +% pv_checkpath +% This function, systematicaly called by the others, ensures that +% all needed sub-directories of the package are in the path. % -% ----------------------------------------------------------------- -% 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) +% > Functions name are case sensitive. +% > See sub-directory "subfct" for further functions. +% > Following packages are required: +% M_MAP: http://www.eos.ubc.ca/~rich/map.html +% SEAWATER: http://www.marine.csiro.au/datacentre/processing.htm % -% ----------------------------------------------------------------- +% --------------------------------------------------------------------------------------------- %
| ViewVC Help | |
| Powered by ViewVC 1.1.22 |