source: palm/trunk/SOURCE/average_3d_data.f90 @ 2008

Last change on this file since 2008 was 2008, checked in by kanani, 5 years ago

last commit documented

  • Property svn:keywords set to Id
File size: 13.6 KB
Line 
1!> @file average_3d_data.f90
2!------------------------------------------------------------------------------!
3! This file is part of PALM.
4!
5! PALM is free software: you can redistribute it and/or modify it under the
6! terms of the GNU General Public License as published by the Free Software
7! Foundation, either version 3 of the License, or (at your option) any later
8! version.
9!
10! PALM is distributed in the hope that it will be useful, but WITHOUT ANY
11! WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
12! A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
13!
14! You should have received a copy of the GNU General Public License along with
15! PALM. If not, see <http://www.gnu.org/licenses/>.
16!
17! Copyright 1997-2016 Leibniz Universitaet Hannover
18!------------------------------------------------------------------------------!
19!
20! Current revisions:
21! -----------------
22!
23!
24! Former revisions:
25! -----------------
26! $Id: average_3d_data.f90 2008 2016-08-24 15:53:00Z kanani $
27!
28! 2007 2016-08-24 15:47:17Z kanani
29! Added support for new urban surface model (temporary modifications of
30! SELECT CASE ( ) necessary, see variable trimvar),
31! added comments in variable declaration section
32!
33! 2000 2016-08-20 18:09:15Z knoop
34! Forced header and separation lines into 80 columns
35!
36! 1972 2016-07-26 07:52:02Z maronga
37! Output of land surface quantities is now done directly in the respective module
38!
39! 1960 2016-07-12 16:34:24Z suehring
40! Treat humidity and passive scalar separately
41!
42! 1691 2015-10-26 16:17:44Z maronga
43! Added output of Obukhov length and radiative heating rates for RRTMG.
44!
45! 1682 2015-10-07 23:56:08Z knoop
46! Code annotations made doxygen readable
47!
48! 1585 2015-04-30 07:05:52Z maronga
49! Adapted for RRTMG
50!
51! 1555 2015-03-04 17:44:27Z maronga
52! Added output of r_a and r_s
53!
54! 1551 2015-03-03 14:18:16Z maronga
55! Added support for land surface and radiation model parameters.
56!
57! 1322 2014-03-20 16:38:49Z raasch
58! REAL functions provided with KIND-attribute
59!
60! 1320 2014-03-20 08:40:49Z raasch
61! ONLY-attribute added to USE-statements,
62! kind-parameters added to all INTEGER and REAL declaration statements,
63! kinds are defined in new module kinds,
64! revision history before 2012 removed,
65! comment fields (!:) to be used for variable explanations added to
66! all variable declaration statements
67!
68! 1318 2014-03-17 13:35:16Z raasch
69! barrier argument removed from cpu_log,
70! module interfaces removed
71!
72! 1115 2013-03-26 18:16:16Z hoffmann
73! +qc
74!
75! 1053 2012-11-13 17:11:03Z hoffmann
76! averaging of nr, qr added
77!
78! 1036 2012-10-22 13:43:42Z raasch
79! code put under GPL (PALM 3.9)
80!
81! 978 2012-08-09 08:28:32Z fricke
82! +z0h_av
83!
84! Revision 1.1  2006/02/23 09:48:58  raasch
85! Initial revision
86!
87!
88! Description:
89! ------------
90!> Time-averaging of 3d-data-arrays.
91!------------------------------------------------------------------------------!
92 SUBROUTINE average_3d_data
93 
94
95    USE averaging
96
97    USE control_parameters,                                                    &
98        ONLY:  average_count_3d, doav, doav_n
99
100    USE cpulog,                                                                &
101        ONLY:  cpu_log, log_point
102
103    USE indices,                                                               &
104        ONLY:  nxl, nxlg, nxr, nxrg, nyn, nyng, nys, nysg, nzb, nzt
105
106    USE kinds
107
108    USE land_surface_model_mod,                                                &
109        ONLY:  land_surface, lsm_3d_data_averaging
110
111    USE radiation_model_mod,                                                   &
112        ONLY:  radiation, radiation_3d_data_averaging
113
114    USE urban_surface_mod,                                                     &
115        ONLY:  urban_surface, usm_average_3d_data
116
117
118    IMPLICIT NONE
119
120    INTEGER(iwp) ::  i  !< running index
121    INTEGER(iwp) ::  ii !< running index
122    INTEGER(iwp) ::  j  !< running index
123    INTEGER(iwp) ::  k  !< running index
124
125    CHARACTER (LEN=20) ::  trimvar  !< TRIM of output-variable string
126
127
128    CALL cpu_log (log_point(35),'average_3d_data','start')
129
130!
131!-- Check, if averaging is necessary
132    IF ( average_count_3d <= 1 )  RETURN
133
134!
135!-- Loop of all variables to be averaged.
136    DO  ii = 1, doav_n
137
138!
139!--    Temporary solution to account for data output within the new urban
140!--    surface model (urban_surface_mod.f90), see also SELECT CASE ( trimvar )
141       trimvar = TRIM( doav(ii) )
142       IF ( urban_surface  .AND.  trimvar(1:3) == 'us_' )  THEN
143          trimvar = 'usm_output'
144       ENDIF
145
146!
147!--    Store the array chosen on the temporary array.
148       SELECT CASE ( trimvar )
149
150          CASE ( 'e' )
151             DO  i = nxlg, nxrg
152                DO  j = nysg, nyng
153                   DO  k = nzb, nzt+1
154                      e_av(k,j,i) = e_av(k,j,i) / REAL( average_count_3d, KIND=wp )
155                   ENDDO
156                ENDDO
157             ENDDO
158
159          CASE ( 'qsws*' )
160             DO  i = nxlg, nxrg
161                DO  j = nysg, nyng
162                   qsws_av(j,i) = qsws_av(j,i) / REAL( average_count_3d, KIND=wp )
163                ENDDO
164             ENDDO
165
166          CASE ( 'lpt' )
167             DO  i = nxlg, nxrg
168                DO  j = nysg, nyng
169                   DO  k = nzb, nzt+1
170                      lpt_av(k,j,i) = lpt_av(k,j,i) / REAL( average_count_3d, KIND=wp )
171                   ENDDO
172                ENDDO
173             ENDDO
174
175          CASE ( 'lwp*' )
176             DO  i = nxlg, nxrg
177                DO  j = nysg, nyng
178                   lwp_av(j,i) = lwp_av(j,i) / REAL( average_count_3d, KIND=wp )
179                ENDDO
180             ENDDO
181
182          CASE ( 'nr' )
183             DO  i = nxlg, nxrg
184                DO  j = nysg, nyng
185                   DO  k = nzb, nzt+1
186                      nr_av(k,j,i) = nr_av(k,j,i) / REAL( average_count_3d, KIND=wp )
187                   ENDDO
188                ENDDO
189             ENDDO
190
191         CASE ( 'ol*' )
192             DO  i = nxlg, nxrg
193                DO  j = nysg, nyng
194                   ol_av(j,i) = ol_av(j,i) / REAL( average_count_3d, KIND=wp )
195                ENDDO
196             ENDDO
197
198          CASE ( 'p' )
199             DO  i = nxlg, nxrg
200                DO  j = nysg, nyng
201                   DO  k = nzb, nzt+1
202                      p_av(k,j,i) = p_av(k,j,i) / REAL( average_count_3d, KIND=wp )
203                   ENDDO
204                ENDDO
205             ENDDO
206
207          CASE ( 'pc' )
208             DO  i = nxl, nxr
209                DO  j = nys, nyn
210                   DO  k = nzb, nzt+1
211                      pc_av(k,j,i) = pc_av(k,j,i) / REAL( average_count_3d, KIND=wp )
212                   ENDDO
213                ENDDO
214             ENDDO
215
216          CASE ( 'pr' )
217             DO  i = nxl, nxr
218                DO  j = nys, nyn
219                   DO  k = nzb, nzt+1
220                      pr_av(k,j,i) = pr_av(k,j,i) / REAL( average_count_3d, KIND=wp )
221                   ENDDO
222                ENDDO
223             ENDDO
224
225          CASE ( 'prr*' )
226             DO  i = nxlg, nxrg
227                DO  j = nysg, nyng
228                   precipitation_rate_av(j,i) = precipitation_rate_av(j,i) /   &
229                                                REAL( average_count_3d, KIND=wp )
230                ENDDO
231             ENDDO
232
233          CASE ( 'pt' )
234             DO  i = nxlg, nxrg
235                DO  j = nysg, nyng
236                   DO  k = nzb, nzt+1
237                      pt_av(k,j,i) = pt_av(k,j,i) / REAL( average_count_3d, KIND=wp )
238                   ENDDO
239                ENDDO
240             ENDDO
241
242          CASE ( 'q' )
243             DO  i = nxlg, nxrg
244                DO  j = nysg, nyng
245                   DO  k = nzb, nzt+1
246                      q_av(k,j,i) = q_av(k,j,i) / REAL( average_count_3d, KIND=wp )
247                   ENDDO
248                ENDDO
249             ENDDO
250
251          CASE ( 'qc' )
252             DO  i = nxlg, nxrg
253                DO  j = nysg, nyng
254                   DO  k = nzb, nzt+1
255                      qc_av(k,j,i) = qc_av(k,j,i) / REAL( average_count_3d, KIND=wp )
256                   ENDDO
257                ENDDO
258             ENDDO
259
260          CASE ( 'ql' )
261             DO  i = nxlg, nxrg
262                DO  j = nysg, nyng
263                   DO  k = nzb, nzt+1
264                      ql_av(k,j,i) = ql_av(k,j,i) / REAL( average_count_3d, KIND=wp )
265                   ENDDO
266                ENDDO
267             ENDDO
268
269          CASE ( 'ql_c' )
270             DO  i = nxlg, nxrg
271                DO  j = nysg, nyng
272                   DO  k = nzb, nzt+1
273                      ql_c_av(k,j,i) = ql_c_av(k,j,i) / REAL( average_count_3d, KIND=wp )
274                   ENDDO
275                ENDDO
276             ENDDO
277
278          CASE ( 'ql_v' )
279             DO  i = nxlg, nxrg
280                DO  j = nysg, nyng
281                   DO  k = nzb, nzt+1
282                      ql_v_av(k,j,i) = ql_v_av(k,j,i) / REAL( average_count_3d, KIND=wp )
283                   ENDDO
284                ENDDO
285             ENDDO
286
287          CASE ( 'ql_vp' )
288             DO  i = nxlg, nxrg
289                DO  j = nysg, nyng
290                   DO  k = nzb, nzt+1
291                      ql_vp_av(k,j,i) = ql_vp_av(k,j,i) /                      &
292                                        REAL( average_count_3d, KIND=wp )
293                   ENDDO
294                ENDDO
295             ENDDO
296
297          CASE ( 'qr' )
298             DO  i = nxlg, nxrg
299                DO  j = nysg, nyng
300                   DO  k = nzb, nzt+1
301                      qr_av(k,j,i) = qr_av(k,j,i) / REAL( average_count_3d, KIND=wp )
302                   ENDDO
303                ENDDO
304             ENDDO
305
306          CASE ( 'qv' )
307             DO  i = nxlg, nxrg
308                DO  j = nysg, nyng
309                   DO  k = nzb, nzt+1
310                      qv_av(k,j,i) = qv_av(k,j,i) / REAL( average_count_3d, KIND=wp )
311                   ENDDO
312                ENDDO
313             ENDDO
314
315          CASE ( 'rho' )
316             DO  i = nxlg, nxrg
317                DO  j = nysg, nyng
318                   DO  k = nzb, nzt+1
319                      rho_av(k,j,i) = rho_av(k,j,i) / REAL( average_count_3d, KIND=wp )
320                   ENDDO
321                ENDDO
322             ENDDO
323
324          CASE ( 's' )
325             DO  i = nxlg, nxrg
326                DO  j = nysg, nyng
327                   DO  k = nzb, nzt+1
328                      s_av(k,j,i) = s_av(k,j,i) / REAL( average_count_3d, KIND=wp )
329                   ENDDO
330                ENDDO
331             ENDDO
332
333          CASE ( 'sa' )
334             DO  i = nxlg, nxrg
335                DO  j = nysg, nyng
336                   DO  k = nzb, nzt+1
337                      sa_av(k,j,i) = sa_av(k,j,i) / REAL( average_count_3d, KIND=wp )
338                   ENDDO
339                ENDDO
340             ENDDO
341
342         CASE ( 'shf*' )
343             DO  i = nxlg, nxrg
344                DO  j = nysg, nyng
345                   shf_av(j,i) = shf_av(j,i) / REAL( average_count_3d, KIND=wp )
346                ENDDO
347             ENDDO
348
349          CASE ( 'ssws*' )
350             DO  i = nxlg, nxrg
351                DO  j = nysg, nyng
352                   ssws_av(j,i) = ssws_av(j,i) / REAL( average_count_3d, KIND=wp )
353                ENDDO
354             ENDDO
355
356          CASE ( 't*' )
357             DO  i = nxlg, nxrg
358                DO  j = nysg, nyng
359                   ts_av(j,i) = ts_av(j,i) / REAL( average_count_3d, KIND=wp )
360                ENDDO
361             ENDDO
362
363          CASE ( 'u' )
364             DO  i = nxlg, nxrg
365                DO  j = nysg, nyng
366                   DO  k = nzb, nzt+1
367                      u_av(k,j,i) = u_av(k,j,i) / REAL( average_count_3d, KIND=wp )
368                   ENDDO
369                ENDDO
370             ENDDO
371
372          CASE ( 'u*' )
373             DO  i = nxlg, nxrg
374                DO  j = nysg, nyng
375                   us_av(j,i) = us_av(j,i) / REAL( average_count_3d, KIND=wp )
376                ENDDO
377             ENDDO
378
379          CASE ( 'v' )
380             DO  i = nxlg, nxrg
381                DO  j = nysg, nyng
382                   DO  k = nzb, nzt+1
383                      v_av(k,j,i) = v_av(k,j,i) / REAL( average_count_3d, KIND=wp )
384                   ENDDO
385                ENDDO
386             ENDDO
387
388          CASE ( 'vpt' )
389             DO  i = nxlg, nxrg
390                DO  j = nysg, nyng
391                   DO  k = nzb, nzt+1
392                      vpt_av(k,j,i) = vpt_av(k,j,i) / REAL( average_count_3d, KIND=wp )
393                   ENDDO
394                ENDDO
395             ENDDO
396
397          CASE ( 'w' )
398             DO  i = nxlg, nxrg
399                DO  j = nysg, nyng
400                   DO  k = nzb, nzt+1
401                      w_av(k,j,i) = w_av(k,j,i) / REAL( average_count_3d, KIND=wp )
402                   ENDDO
403                ENDDO
404             ENDDO
405
406          CASE ( 'z0*' )
407             DO  i = nxlg, nxrg
408                DO  j = nysg, nyng
409                   z0_av(j,i) = z0_av(j,i) / REAL( average_count_3d, KIND=wp )
410                ENDDO
411             ENDDO
412
413          CASE ( 'z0h*' )
414             DO  i = nxlg, nxrg
415                DO  j = nysg, nyng
416                   z0h_av(j,i) = z0h_av(j,i) / REAL( average_count_3d, KIND=wp )
417                ENDDO
418             ENDDO
419!             
420!--       Block of urban surface model outputs   
421          CASE ( 'usm_output' )
422             CALL usm_average_3d_data( 'average', doav(ii) )
423
424          CASE DEFAULT
425!
426!--          Land surface quantity
427             IF ( land_surface )  THEN
428                CALL lsm_3d_data_averaging( 'average', doav(ii) )
429             ENDIF
430
431!
432!--          Radiation quantity
433             IF ( radiation )  THEN
434                CALL radiation_3d_data_averaging( 'average', doav(ii) )
435             ENDIF
436
437!
438!--          User-defined quantity
439             CALL user_3d_data_averaging( 'average', doav(ii) )
440
441       END SELECT
442
443    ENDDO
444
445!
446!-- Reset the counter
447    average_count_3d = 0.0
448
449    CALL cpu_log( log_point(35), 'average_3d_data', 'stop' )
450
451
452 END SUBROUTINE average_3d_data
Note: See TracBrowser for help on using the repository browser.