-
Notifications
You must be signed in to change notification settings - Fork 8
/
cosp_utils.F90
344 lines (314 loc) · 13 KB
/
cosp_utils.F90
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
! (c) British Crown Copyright 2008, the Met Office.
! All rights reserved.
! $Revision: 23 $, $Date: 2011-03-31 07:41:37 -0600 (Thu, 31 Mar 2011) $
! $URL: http://cfmip-obs-sim.googlecode.com/svn/stable/v1.4.0/cosp_utils.F90 $
!
! Redistribution and use in source and binary forms, with or without modification, are permitted
! provided that the following conditions are met:
!
! * Redistributions of source code must retain the above copyright notice, this list
! of conditions and the following disclaimer.
! * Redistributions in binary form must reproduce the above copyright notice, this list
! of conditions and the following disclaimer in the documentation and/or other materials
! provided with the distribution.
! * Neither the name of the Met Office nor the names of its contributors may be used
! to endorse or promote products derived from this software without specific prior written
! permission.
!
! THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
! IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
! FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
! CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
! DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
! DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
! IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
! OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
!
! History:
! Jul 2007 - A. Bodas-Salcedo - Initial version
!
MODULE MOD_COSP_UTILS
USE MOD_COSP_CONSTANTS
IMPLICIT NONE
INTERFACE Z_TO_DBZ
MODULE PROCEDURE Z_TO_DBZ_2D,Z_TO_DBZ_3D,Z_TO_DBZ_4D
END INTERFACE
INTERFACE COSP_CHECK_INPUT
MODULE PROCEDURE COSP_CHECK_INPUT_1D,COSP_CHECK_INPUT_2D,COSP_CHECK_INPUT_3D
END INTERFACE
CONTAINS
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
!------------------- SUBROUTINE COSP_PRECIP_MXRATIO --------------
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
SUBROUTINE COSP_PRECIP_MXRATIO(Npoints,Nlevels,Ncolumns,p,T,prec_frac,prec_type, &
n_ax,n_bx,alpha_x,c_x,d_x,g_x,a_x,b_x,gamma1,gamma2,gamma3,gamma4, &
flux,mxratio,reff)
! Input arguments, (IN)
integer,intent(in) :: Npoints,Nlevels,Ncolumns
real,intent(in),dimension(Npoints,Nlevels) :: p,T,flux
real,intent(in),dimension(Npoints,Ncolumns,Nlevels) :: prec_frac
real,intent(in) :: n_ax,n_bx,alpha_x,c_x,d_x,g_x,a_x,b_x,gamma1,gamma2,gamma3,gamma4,prec_type
! Input arguments, (OUT)
real,intent(out),dimension(Npoints,Ncolumns,Nlevels) :: mxratio
real,intent(inout),dimension(Npoints,Ncolumns,Nlevels) :: reff
! Local variables
integer :: i,j,k
real :: sigma,one_over_xip1,xi,rho0,rho,lambda_x,gamma_4_3_2,delta
mxratio = 0.0
if (n_ax >= 0.0) then ! N_ax is used to control which hydrometeors need to be computed
xi = d_x/(alpha_x + b_x - n_bx + 1.0)
rho0 = 1.29
sigma = (gamma2/(gamma1*c_x))*(n_ax*a_x*gamma2)**xi
one_over_xip1 = 1.0/(xi + 1.0)
gamma_4_3_2 = 0.5*gamma4/gamma3
delta = (alpha_x + b_x + d_x - n_bx + 1.0)
do k=1,Nlevels
do j=1,Ncolumns
do i=1,Npoints
if ((prec_frac(i,j,k)==prec_type).or.(prec_frac(i,j,k)==3.)) then
rho = p(i,k)/(287.05*T(i,k))
mxratio(i,j,k)=(flux(i,k)*((rho/rho0)**g_x)*sigma)**one_over_xip1
mxratio(i,j,k)=mxratio(i,j,k)/rho
! Compute effective radius
if ((reff(i,j,k) <= 0.0).and.(flux(i,k) /= 0.0)) then
lambda_x = (a_x*c_x*((rho0/rho)**g_x)*n_ax*gamma1/flux(i,k))**(1./delta)
reff(i,j,k) = gamma_4_3_2/lambda_x
endif
endif
enddo
enddo
enddo
endif
END SUBROUTINE COSP_PRECIP_MXRATIO
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
!------------------- SUBROUTINE ZERO_INT -------------------------
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
ELEMENTAL SUBROUTINE ZERO_INT(x,y01,y02,y03,y04,y05,y06,y07,y08,y09,y10, &
y11,y12,y13,y14,y15,y16,y17,y18,y19,y20, &
y21,y22,y23,y24,y25,y26,y27,y28,y29,y30)
integer,intent(inout) :: x
integer,intent(inout),optional :: y01,y02,y03,y04,y05,y06,y07,y08,y09,y10, &
y11,y12,y13,y14,y15,y16,y17,y18,y19,y20, &
y21,y22,y23,y24,y25,y26,y27,y28,y29,y30
x = 0
if (present(y01)) y01 = 0
if (present(y02)) y02 = 0
if (present(y03)) y03 = 0
if (present(y04)) y04 = 0
if (present(y05)) y05 = 0
if (present(y06)) y06 = 0
if (present(y07)) y07 = 0
if (present(y08)) y08 = 0
if (present(y09)) y09 = 0
if (present(y10)) y10 = 0
if (present(y11)) y11 = 0
if (present(y12)) y12 = 0
if (present(y13)) y13 = 0
if (present(y14)) y14 = 0
if (present(y15)) y15 = 0
if (present(y16)) y16 = 0
if (present(y17)) y17 = 0
if (present(y18)) y18 = 0
if (present(y19)) y19 = 0
if (present(y20)) y20 = 0
if (present(y21)) y21 = 0
if (present(y22)) y22 = 0
if (present(y23)) y23 = 0
if (present(y24)) y24 = 0
if (present(y25)) y25 = 0
if (present(y26)) y26 = 0
if (present(y27)) y27 = 0
if (present(y28)) y28 = 0
if (present(y29)) y29 = 0
if (present(y30)) y30 = 0
END SUBROUTINE ZERO_INT
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
!------------------- SUBROUTINE ZERO_REAL ------------------------
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
ELEMENTAL SUBROUTINE ZERO_REAL(x,y01,y02,y03,y04,y05,y06,y07,y08,y09,y10, &
y11,y12,y13,y14,y15,y16,y17,y18,y19,y20, &
y21,y22,y23,y24,y25,y26,y27,y28,y29,y30)
real,intent(inout) :: x
real,intent(inout),optional :: y01,y02,y03,y04,y05,y06,y07,y08,y09,y10, &
y11,y12,y13,y14,y15,y16,y17,y18,y19,y20, &
y21,y22,y23,y24,y25,y26,y27,y28,y29,y30
x = 0.0
if (present(y01)) y01 = 0.0
if (present(y02)) y02 = 0.0
if (present(y03)) y03 = 0.0
if (present(y04)) y04 = 0.0
if (present(y05)) y05 = 0.0
if (present(y06)) y06 = 0.0
if (present(y07)) y07 = 0.0
if (present(y08)) y08 = 0.0
if (present(y09)) y09 = 0.0
if (present(y10)) y10 = 0.0
if (present(y11)) y11 = 0.0
if (present(y12)) y12 = 0.0
if (present(y13)) y13 = 0.0
if (present(y14)) y14 = 0.0
if (present(y15)) y15 = 0.0
if (present(y16)) y16 = 0.0
if (present(y17)) y17 = 0.0
if (present(y18)) y18 = 0.0
if (present(y19)) y19 = 0.0
if (present(y20)) y20 = 0.0
if (present(y21)) y21 = 0.0
if (present(y22)) y22 = 0.0
if (present(y23)) y23 = 0.0
if (present(y24)) y24 = 0.0
if (present(y25)) y25 = 0.0
if (present(y26)) y26 = 0.0
if (present(y27)) y27 = 0.0
if (present(y28)) y28 = 0.0
if (present(y29)) y29 = 0.0
if (present(y30)) y30 = 0.0
END SUBROUTINE ZERO_REAL
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
!--------------------- SUBROUTINE Z_TO_DBZ_2D --------------------
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
SUBROUTINE Z_TO_DBZ_2D(mdi,z)
real,intent(in) :: mdi
real,dimension(:,:),intent(inout) :: z
! Reflectivity Z:
! Input in [m3]
! Output in dBZ, with Z in [mm6 m-3]
! 1.e18 to convert from [m3] to [mm6 m-3]
z = 1.e18*z
where (z > 1.0e-6) ! Limit to -60 dBZ
z = 10.0*log10(z)
elsewhere
z = mdi
end where
END SUBROUTINE Z_TO_DBZ_2D
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
!--------------------- SUBROUTINE Z_TO_DBZ_3D --------------------
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
SUBROUTINE Z_TO_DBZ_3D(mdi,z)
real,intent(in) :: mdi
real,dimension(:,:,:),intent(inout) :: z
! Reflectivity Z:
! Input in [m3]
! Output in dBZ, with Z in [mm6 m-3]
! 1.e18 to convert from [m3] to [mm6 m-3]
z = 1.e18*z
where (z > 1.0e-6) ! Limit to -60 dBZ
z = 10.0*log10(z)
elsewhere
z = mdi
end where
END SUBROUTINE Z_TO_DBZ_3D
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
!--------------------- SUBROUTINE Z_TO_DBZ_4D --------------------
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
SUBROUTINE Z_TO_DBZ_4D(mdi,z)
real,intent(in) :: mdi
real,dimension(:,:,:,:),intent(inout) :: z
! Reflectivity Z:
! Input in [m3]
! Output in dBZ, with Z in [mm6 m-3]
! 1.e18 to convert from [m3] to [mm6 m-3]
z = 1.e18*z
where (z > 1.0e-6) ! Limit to -60 dBZ
z = 10.0*log10(z)
elsewhere
z = mdi
end where
END SUBROUTINE Z_TO_DBZ_4D
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
!----------------- SUBROUTINES COSP_CHECK_INPUT_1D ---------------
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
SUBROUTINE COSP_CHECK_INPUT_1D(vname,x,min_val,max_val)
character(len=*) :: vname
real,intent(inout) :: x(:)
real,intent(in),optional :: min_val,max_val
logical :: l_min,l_max
character(len=128) :: pro_name='COSP_CHECK_INPUT_1D'
l_min=.false.
l_max=.false.
if (present(min_val)) then
! if (x < min_val) x = min_val
if (any(x < min_val)) then
l_min = .true.
where (x < min_val)
x = min_val
end where
endif
endif
if (present(max_val)) then
! if (x > max_val) x = max_val
if (any(x > max_val)) then
l_max = .true.
where (x > max_val)
x = max_val
end where
endif
endif
if (l_min) print *,'----- WARNING: '//trim(pro_name)//': minimum value of '//trim(vname)//' set to: ',min_val
if (l_max) print *,'----- WARNING: '//trim(pro_name)//': maximum value of '//trim(vname)//' set to: ',max_val
END SUBROUTINE COSP_CHECK_INPUT_1D
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
!----------------- SUBROUTINES COSP_CHECK_INPUT_2D ---------------
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
SUBROUTINE COSP_CHECK_INPUT_2D(vname,x,min_val,max_val)
character(len=*) :: vname
real,intent(inout) :: x(:,:)
real,intent(in),optional :: min_val,max_val
logical :: l_min,l_max
character(len=128) :: pro_name='COSP_CHECK_INPUT_2D'
l_min=.false.
l_max=.false.
if (present(min_val)) then
! if (x < min_val) x = min_val
if (any(x < min_val)) then
l_min = .true.
where (x < min_val)
x = min_val
end where
endif
endif
if (present(max_val)) then
! if (x > max_val) x = max_val
if (any(x > max_val)) then
l_max = .true.
where (x > max_val)
x = max_val
end where
endif
endif
if (l_min) print *,'----- WARNING: '//trim(pro_name)//': minimum value of '//trim(vname)//' set to: ',min_val
if (l_max) print *,'----- WARNING: '//trim(pro_name)//': maximum value of '//trim(vname)//' set to: ',max_val
END SUBROUTINE COSP_CHECK_INPUT_2D
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
!----------------- SUBROUTINES COSP_CHECK_INPUT_3D ---------------
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
SUBROUTINE COSP_CHECK_INPUT_3D(vname,x,min_val,max_val)
character(len=*) :: vname
real,intent(inout) :: x(:,:,:)
real,intent(in),optional :: min_val,max_val
logical :: l_min,l_max
character(len=128) :: pro_name='COSP_CHECK_INPUT_3D'
l_min=.false.
l_max=.false.
if (present(min_val)) then
! if (x < min_val) x = min_val
if (any(x < min_val)) then
l_min = .true.
where (x < min_val)
x = min_val
end where
endif
endif
if (present(max_val)) then
! if (x > max_val) x = max_val
if (any(x > max_val)) then
l_max = .true.
where (x > max_val)
x = max_val
end where
endif
endif
if (l_min) print *,'----- WARNING: '//trim(pro_name)//': minimum value of '//trim(vname)//' set to: ',min_val
if (l_max) print *,'----- WARNING: '//trim(pro_name)//': maximum value of '//trim(vname)//' set to: ',max_val
END SUBROUTINE COSP_CHECK_INPUT_3D
END MODULE MOD_COSP_UTILS