| 1 |
% ECCO2: potential vorticity toolbox |
| 2 |
% |
| 3 |
% This package tries to provide some useful and simple routines to compute, visualize and |
| 4 |
% analyze Potential Vorticity from the global high resolution (1/8deg) simulation of the |
| 5 |
% MITgcm. |
| 6 |
% Routines are as general as possible for extended applications, but note that they were |
| 7 |
% developped to focus on the Western Atlantic region for the CLIMODE project. |
| 8 |
% Enjoy ! |
| 9 |
% |
| 10 |
% gmaze@mit.edu |
| 11 |
% Last update: Feb1/2007 |
| 12 |
% |
| 13 |
% --------------------------------------------------------------------------------------------- |
| 14 |
% PROGRAMS LIST (NOT A FUNCTIONS): |
| 15 |
% |
| 16 |
% eg_main_getPV |
| 17 |
% This program is an example of how to define global setup and |
| 18 |
% to launch the PV computing. |
| 19 |
% eg_write_bin2cdf_latlongrid_subdomain |
| 20 |
% This program is an example of how to extract a subdomain from |
| 21 |
% a lat/lon grid (1/8) binary file and write it into netcdf. A |
| 22 |
% directory is created for each time step. |
| 23 |
% eg_write_bin2cdf_csgrid_subdomain |
| 24 |
% This program is an example of how to extract a subdomain from |
| 25 |
% a cube sphere grid (CS510) binary file and write it into netcdf |
| 26 |
% and lat/lon grid (1/4). A directory is created for each time step. |
| 27 |
% eg_write_UVbin2cdf_csgrid_subdomain |
| 28 |
% Idem, except adapted to U and V fields. |
| 29 |
% |
| 30 |
% --------------------------------------------------------------------------------------------- |
| 31 |
% FUNCTIONS LIST 1: NETCDF FILES DIAGNOSTICS |
| 32 |
% From netcdf files contained into SNAPSHOT sub-directory of the |
| 33 |
% ./netcdf-files/ home folder, these functions ... |
| 34 |
% |
| 35 |
% A_compute_potential_density(SNAPSHOT) |
| 36 |
% Computes potential density SIGMATHETA from potential |
| 37 |
% temperature THETA and anomalous salinity SALTanom. |
| 38 |
% B_compute_relative_vorticity(SNAPSHOT) |
| 39 |
% Computes the 3 components of the relative vorticity from the |
| 40 |
% horizontal flow. Take care to the (U,V) grid ! |
| 41 |
% C_compute_potential_vorticity(SNAPSHOT,[WANT_SPL_PV]) |
| 42 |
% Computes the potential vorticity field from the relative |
| 43 |
% vorticity components and the potential density. Option |
| 44 |
% WANT_SPL_PV turned 1 (0 by default) makes the function only |
| 45 |
% computing the PV based on the planetary vorticity. |
| 46 |
% D_compute_potential_vorticity(SNAPSHOT,[WANT_SPL_PV]) |
| 47 |
% Multiplies the potential vorticity computed with |
| 48 |
% C_COMPUTE_POTENTIAL_VORTICITY by the coefficient: -1/RHO |
| 49 |
% Optional flag WANTSPLPV is turned to 0 by default. Turn it to 1 |
| 50 |
% if the PV computed was the simple one (f.dSIGMATHETA/dz). It's |
| 51 |
% needed for the output netcdf file informations. |
| 52 |
% compute_JBz(SNAPSHOT) |
| 53 |
% Computes the surface PV flux due to diabatic processes. |
| 54 |
% compute_JFz(SNAPSHOT) |
| 55 |
% Computes the surface PV flux due to frictionnal forces. |
| 56 |
% compute_density(SNAPSHOT) |
| 57 |
% Computes density RHO from potential temperature THETA |
| 58 |
% and anomalous salinity SALTanom. |
| 59 |
% compute_alpha(SNAPSHOT) |
| 60 |
% Computes the thermal expansion coefficient ALPHA from potential |
| 61 |
% temperature THETA and salinity anomaly SALTanom. |
| 62 |
% compute_QEk(SNAPSHOT) |
| 63 |
% Computes QEk, the lateral heat flux induced by Ekman currents |
| 64 |
% from JFz, the PV flux induced by frictional forces. |
| 65 |
% compute_EKL(SNAPSHOT) |
| 66 |
% Compute the Ekman Layer Depth from the wind stress and the density |
| 67 |
% fields. |
| 68 |
% compute_MLD(SNAPSHOT) |
| 69 |
% Compute the Mixed Layer Depth from the SST, SSS and potential |
| 70 |
% density fields. |
| 71 |
% |
| 72 |
% --------------------------------------------------------------------------------------------- |
| 73 |
% FUNCTIONS LIST 2: ANALYSIS FUNCTIONS |
| 74 |
% |
| 75 |
% volbet2iso(TRACER,LIMITS,DEPTH,LAT,LONG) |
| 76 |
% This function computes the volume embedded between two |
| 77 |
% iso-TRACER values and limited eastward, westward and southward |
| 78 |
% by fixed limits. |
| 79 |
% surfbet2outcrops(TRACER,LIMITS,LAT,LONG) |
| 80 |
% This function computes the horizontal surface limited |
| 81 |
% by two outcrops of a tracer. |
| 82 |
% intbet2outcrops(TRACER,LIMITS,LAT,LONG) |
| 83 |
% This function computes the horizontal surface integral |
| 84 |
% of the field TRACER on the area limited by two outcrops. |
| 85 |
% subfct_getisoS(TRACER,ISO) |
| 86 |
% This function determines the iso-surface ISO of the |
| 87 |
% 3D field TRACER(Z,Y,X). |
| 88 |
% |
| 89 |
% --------------------------------------------------------------------------------------------- |
| 90 |
% LOWER LEVEL AND SUB-FUNCTIONS LIST: |
| 91 |
% |
| 92 |
% pv_checkpath |
| 93 |
% This function, systematicaly called by the others, ensures that |
| 94 |
% all needed sub-directories of the package are in the path. |
| 95 |
% |
| 96 |
% --------------------------------------------------------------------------------------------- |
| 97 |
% PS: |
| 98 |
% |
| 99 |
% > Functions name are case sensitive. |
| 100 |
% > See sub-directory "subfct" for further functions. |
| 101 |
% > Following packages are required: |
| 102 |
% M_MAP: http://www.eos.ubc.ca/~rich/map.html |
| 103 |
% SEAWATER: http://www.marine.csiro.au/datacentre/processing.htm |
| 104 |
% |
| 105 |
% --------------------------------------------------------------------------------------------- |
| 106 |
% |
Parent Directory
| 
Revision Log
| 
Revision Graph