1 |
% |
2 |
% [Q] = D_compute_potential_vorticity(SNAPSHOT,[WANTSPLPV]) |
3 |
% |
4 |
% For a time snapshot, this program multiplies the potential |
5 |
% vorticity computed with C_COMPUTE_POTENTIAL_VORTICITY by the |
6 |
% coefficient: -1/RHO |
7 |
% Optional flag WANTSPLPV is turn to 0 by default. Turn it to 1 |
8 |
% if the PV computed is the simple one (f.dSIGMATHETA/dz). It's |
9 |
% needed for the output netcdf file informations. |
10 |
% |
11 |
% CAUTION: |
12 |
%% If all the PV computing procedure has been performed with routines |
13 |
%% from the package, the PV field has less points than the RHO one, exactly |
14 |
%% first and last in all directions have to be removed from RHO. |
15 |
% |
16 |
% Files names are: |
17 |
% INPUT: |
18 |
% ./netcdf-files/<SNAPSHOT>/<netcdf_RHO>.<netcdf_domain>.<netcdf_suff> |
19 |
% ./netcdf-files/<SNAPSHOT>/<netcdf_PV>.<netcdf_domain>.<netcdf_suff> |
20 |
% OUPUT: |
21 |
% ./netcdf-files/<SNAPSHOT>/PV.<netcdf_domain>.<netcdf_suff> |
22 |
% or |
23 |
% ./netcdf-files/<SNAPSHOT>/splPV.<netcdf_domain>.<netcdf_suff> |
24 |
% |
25 |
% 06/21/2006 |
26 |
% gmaze@mit.edu |
27 |
% |
28 |
|
29 |
|
30 |
function varargout = D_compute_potential_vorticity(snapshot,varargin) |
31 |
|
32 |
|
33 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
34 |
%% Setup |
35 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
36 |
global sla netcdf_RHO netcdf_PV netcdf_domain netcdf_suff |
37 |
pv_checkpath |
38 |
|
39 |
%% Flags to choose which term to compute (by default, all): |
40 |
FLpv3 = 1; |
41 |
if nargin==2 % case of optional flag presents: |
42 |
if varargin{1}(1) == 1 % Case of the simple PV: |
43 |
FLpv3 = 0; |
44 |
end |
45 |
end %if |
46 |
|
47 |
%% PV and RHO netcdf-files: |
48 |
filPV = strcat(netcdf_PV ,'.',netcdf_domain); |
49 |
filRHO = strcat(netcdf_RHO,'.',netcdf_domain); |
50 |
|
51 |
%% Path and extension to find them: |
52 |
pathname = strcat('netcdf-files',sla,snapshot); |
53 |
ext = strcat('.',netcdf_suff); |
54 |
|
55 |
%% Load netcdf files: |
56 |
ferfile = strcat(pathname,sla,filPV,ext); |
57 |
ncPV = netcdf(ferfile,'nowrite'); |
58 |
[PV_lon PV_lat PV_dpt] = coordfromnc(ncPV); |
59 |
|
60 |
ferfile = strcat(pathname,sla,filRHO,ext); |
61 |
ncRHO = netcdf(ferfile,'nowrite'); |
62 |
[RHO_lon RHO_lat RHO_dpt] = coordfromnc(ncRHO); |
63 |
|
64 |
%% Flags: |
65 |
global toshow % Turn to 1 to follow the computing process |
66 |
|
67 |
|
68 |
|
69 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
70 |
%% Apply the coefficient |
71 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
72 |
|
73 |
%% Pre-allocate: |
74 |
if toshow,disp('Pre-allocate');end |
75 |
nx = length(PV_lon); |
76 |
ny = length(PV_lat); |
77 |
nz = length(PV_dpt); |
78 |
PV = zeros(nz,ny,nx).*NaN; |
79 |
|
80 |
%% Apply: |
81 |
if toshow,disp('Multiplying PV field by -1/RHO'),end |
82 |
PV = - ncPV{4}(:,:,:) ./ ncRHO{4}(2:nz+1,2:ny+1,2:nx+1) ; |
83 |
|
84 |
|
85 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
86 |
% Record: |
87 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
88 |
if toshow,disp('Now reccording PV file ...'),end |
89 |
|
90 |
% General informations: |
91 |
%ncclose(ncPV); |
92 |
|
93 |
if FLpv3 == 1 |
94 |
netfil = strcat('PV','.',netcdf_domain,'.',netcdf_suff); |
95 |
units = '1/s/m'; |
96 |
ncid = 'PV'; |
97 |
longname = 'Potential vorticity'; |
98 |
uniquename = 'potential_vorticity'; |
99 |
else |
100 |
netfil = strcat('splPV','.',netcdf_domain,'.',netcdf_suff); |
101 |
units = '1/s/m'; |
102 |
ncid = 'splPV'; |
103 |
longname = 'Simple Potential vorticity'; |
104 |
uniquename = 'simple_potential_vorticity'; |
105 |
end %if |
106 |
|
107 |
% Open output file: |
108 |
nc = netcdf(strcat(pathname,sla,netfil),'clobber'); |
109 |
|
110 |
% Define axis: |
111 |
nc('X') = length(PV_lon); |
112 |
nc('Y') = length(PV_lat); |
113 |
nc('Z') = length(PV_dpt); |
114 |
|
115 |
nc{'X'} = 'X'; |
116 |
nc{'Y'} = 'Y'; |
117 |
nc{'Z'} = 'Z'; |
118 |
|
119 |
nc{'X'} = ncfloat('X'); |
120 |
nc{'X'}.uniquename = ncchar('X'); |
121 |
nc{'X'}.long_name = ncchar('longitude'); |
122 |
nc{'X'}.gridtype = nclong(0); |
123 |
nc{'X'}.units = ncchar('degrees_east'); |
124 |
nc{'X'}(:) = PV_lon; |
125 |
|
126 |
nc{'Y'} = ncfloat('Y'); |
127 |
nc{'Y'}.uniquename = ncchar('Y'); |
128 |
nc{'Y'}.long_name = ncchar('latitude'); |
129 |
nc{'Y'}.gridtype = nclong(0); |
130 |
nc{'Y'}.units = ncchar('degrees_north'); |
131 |
nc{'Y'}(:) = PV_lat; |
132 |
|
133 |
nc{'Z'} = ncfloat('Z'); |
134 |
nc{'Z'}.uniquename = ncchar('Z'); |
135 |
nc{'Z'}.long_name = ncchar('depth'); |
136 |
nc{'Z'}.gridtype = nclong(0); |
137 |
nc{'Z'}.units = ncchar('m'); |
138 |
nc{'Z'}(:) = PV_dpt; |
139 |
|
140 |
% And main field: |
141 |
nc{ncid} = ncfloat('Z', 'Y', 'X'); |
142 |
nc{ncid}.units = ncchar(units); |
143 |
nc{ncid}.missing_value = ncfloat(NaN); |
144 |
nc{ncid}.FillValue_ = ncfloat(NaN); |
145 |
nc{ncid}.longname = ncchar(longname); |
146 |
nc{ncid}.uniquename = ncchar(uniquename); |
147 |
nc{ncid}(:,:,:) = PV; |
148 |
|
149 |
nc=close(nc); |
150 |
close(ncPV); |
151 |
close(ncRHO); |
152 |
|
153 |
% Outputs: |
154 |
OUT = struct('PV',PV,'dpt',PV_dpt,'lat',PV_lat,'lon',PV_lon); |
155 |
switch nargout |
156 |
case 1 |
157 |
varargout(1) = {OUT}; |
158 |
end |