% $Header: /u/gcmpack/MITgcm/utils/matlab/cs_grid/bk_line/README,v 1.2 2013/02/12 17:59:02 jmc Exp $
% $Name:  $

%- Feb 12 2013:
needs MDS (binary) grid files (XC,YC,XG,YG & RAC) in dir "./grid_files/"
 (read-in using matlab script: MITgcm/utils/matlab/load_grid.m)
allows to use MNC (NetCDF) grid files by changing "ncdf=0;" to "ncdf=1;"
in all the matlab scripts listed here after.

%------------------------------------------------------

%- define broken-line on the C.S. grid
%  as close as possible to given yLat latitude :
%- Sep 15  2002

gener_bk_line.m
(use: load_grid_bk_line find_bk_line clean_bk_line save_bk_line grph_bk_line)
=> write matlab file: isoLat_cube32_59.mat
( run 1rst time to try ; then set krd=0 and run 2nd time to calculate
  all the broken line and write to file)

%- generate array (= bkl_Zon) that give
%  the latidude zone (= between 2 broken-line) of each grid mesh (tracer pt),
%- Jul 24 2003

gen_bk_Zon.m
<= read grid_files/isoLat_cube32_59.mat
=> write matlab file: isoLat_cs32_59.mat
(contains all the arrays that were in isoLat_cube32_59.mat)

%--------------------------------------------------
%- define lines to compute the barotropic stream-Function
%   of the depth-integrated horizontal transport
%  starting from the N.Pole and going southward
%- Jul 21 2003

mk_psiLine_CS.m
=> write matlab file: psiLine_N2S_cs32.mat

%--------------------------------------------------
% define mask of 3 basins (Atlantic , Indian , Pacific)
%  and the list of border points (U,V point)
%- Jul 26 2003
 needs also hFacC,W,S from ocean-set-up (in dir: ./grid_files/ )

def_API_msk.m
(use line_sep)
=> write binary files: maskC_bas.bin maskS_bas.bin maskW_bas.bin
 + list of U,V points at the border: => open_basins_section.mat

%- combine "broken-line" + 3 basins
% used to compute the mask of Meridional StreamFunct. for Atl,Ind,Pac
%- Jul 26 2003

sep_API_basins.m
=> write matlab file: sepBas_cs32_60.mat

%------------------------------------------------------
% 2 example on how to use those files:
use_psiLine.m -> compute & plot Barotropic Transport Stream-function
use_bk_line.m -> compute & plot Meridional Transport Stream-function