Diff of /MITgcm_contrib/dfer/matlab_stuff/calcBolusPsiCube.m

Parent Directory | Revision Log | Revision Graph | Patch

--- MITgcm_contrib/dfer/matlab_stuff/calcBolusPsiCube.m	2010/02/15 23:53:12	1.1
+++ MITgcm_contrib/dfer/matlab_stuff/calcBolusPsiCube.m	2018/03/07 22:01:18	1.2
@@ -2,15 +2,17 @@
 
 % [PsiB,ylat]=calcBolusPsiCube(d,g,GMform,blkFile);
 %
-% Compute bolus streamfunction from GM scheme
+% Compute eddy-induced streamfunction from Gent and McWilliams scheme
 %
 % Input arguments:  
 %   The incoming field data (d) and grid data (g) must be in a structured
 %   array format (which is the format that comes from rdmnc):
-%       d       [Field data]  Kwx,Kwy
+%       d       [Field data]  Kwx, Kwy (Skew flux form) or GM_PsiX, GM_PsiY (advective form)
 %       g       [Grid data ]  drF,rA,dxC,dyC,dxG,dyG,HFacW,HFacS
-%       GMform  [string]      GM form 'Skew' or 'Advc'
+%       GMform  [string]      GM form: 'Skew' or 'Advc'
 %       blkFile [file name]   Broken line file  
+%       mask    [structure]   Optional: Mask field for computation per basin, it assumes that
+%                             maskW and maskS are provided in a structure 
 % Output arguments:
 %       PsiB : bolus streamfunction at interface level (in Sv) 
 %       ylat : meridional coordinate of PsiB