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

Last change on this file since 3569 was 3569, checked in by kanani, 3 years ago

Fix for biomet output (ticket:757), merge of uv_exposure into biometeorology_mod

  • Property svn:keywords set to Id
File size: 19.7 KB
Line 
1!> @file average_3d_data.f90
2!------------------------------------------------------------------------------!
3! This file is part of the PALM model system.
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-2018 Leibniz Universitaet Hannover
18!------------------------------------------------------------------------------!
19!
20! Current revisions:
21! -----------------
22!
23!
24! Former revisions:
25! -----------------
26! $Id: average_3d_data.f90 3569 2018-11-27 17:03:40Z kanani $
27! dom_dwd_user:
28! Clean up biometeorology call
29!
30! 3525 2018-11-14 16:06:14Z kanani
31! Changes related to clean-up of biometeorology (dom_dwd_user)
32!
33! 3467 2018-10-30 19:05:21Z suehring
34! Implementation of a new aerosol module salsa.
35!
36! 3448 2018-10-29 18:14:31Z kanani
37! Adjustment of biometeorology calls
38!
39! 3421 2018-10-24 18:39:32Z gronemeier
40! Renamed output variables
41!
42! 3419 2018-10-24 17:27:31Z gronemeier
43! (from resler branch)
44! Add biometeorology output,
45! fix for chemistry output,
46! move of urban surface output
47!
48! 3294 2018-10-01 02:37:10Z raasch
49! changes concerning modularization of ocean option
50!
51! 3274 2018-09-24 15:42:55Z knoop
52! Modularization of all bulk cloud physics code components
53!
54! 3004 2018-04-27 12:33:25Z Giersch
55! Further allocation checks implemented, case z0q* added
56!
57! 2885 2018-03-14 11:02:46Z Giersch
58! Preliminary gust module interface implemented
59!
60! 2797 2018-02-08 13:24:35Z suehring
61! Enable output of ground-heat flux also at urban surfaces.
62!
63! 2766 2018-01-22 17:17:47Z kanani
64! Removed preprocessor directive __chem
65!
66! 2742 2018-01-12 14:59:47Z suehring
67! Enable output of surface temperature
68!
69! 2735 2018-01-11 12:01:27Z suehring
70! output of r_a moved from land-surface to consider also urban-type surfaces
71!
72! 2718 2018-01-02 08:49:38Z maronga
73! Corrected "Former revisions" section
74!
75! 2696 2017-12-14 17:12:51Z kanani
76! Change in file header (GPL part)
77! Implement call for turbulence_closure_mod (TG)
78! Implementation of chemistry module (FK)
79!
80! 2292 2017-06-20 09:51:42Z schwenkel
81! Implementation of new microphysic scheme: cloud_scheme = 'morrison'
82! includes two more prognostic equations for cloud drop concentration (nc) 
83! and cloud water content (qc). 
84!
85! 2233 2017-05-30 18:08:54Z suehring
86!
87! 2232 2017-05-30 17:47:52Z suehring
88! Adjustments to new surface concept - additional ghost point exchange
89! of surface variable required
90!
91! 2031 2016-10-21 15:11:58Z knoop
92! renamed variable rho to rho_ocean and rho_av to rho_ocean_av
93!
94! 2011 2016-09-19 17:29:57Z kanani
95! Flag urban_surface is now defined in module control_parameters,
96! changed prefix for urban surface model output to "usm_",
97! introduced control parameter varnamelength for LEN of trimvar.
98!
99! 2007 2016-08-24 15:47:17Z kanani
100! Added support for new urban surface model (temporary modifications of
101! SELECT CASE ( ) necessary, see variable trimvar),
102! added comments in variable declaration section
103!
104! 2000 2016-08-20 18:09:15Z knoop
105! Forced header and separation lines into 80 columns
106!
107! 1972 2016-07-26 07:52:02Z maronga
108! Output of land surface quantities is now done directly in the respective module
109!
110! 1960 2016-07-12 16:34:24Z suehring
111! Treat humidity and passive scalar separately
112!
113! 1691 2015-10-26 16:17:44Z maronga
114! Added output of Obukhov length and radiative heating rates for RRTMG.
115!
116! 1682 2015-10-07 23:56:08Z knoop
117! Code annotations made doxygen readable
118!
119! 1585 2015-04-30 07:05:52Z maronga
120! Adapted for RRTMG
121!
122! 1555 2015-03-04 17:44:27Z maronga
123! Added output of r_a and r_s
124!
125! 1551 2015-03-03 14:18:16Z maronga
126! Added support for land surface and radiation model parameters.
127!
128! 1322 2014-03-20 16:38:49Z raasch
129! REAL functions provided with KIND-attribute
130!
131! 1320 2014-03-20 08:40:49Z raasch
132! ONLY-attribute added to USE-statements,
133! kind-parameters added to all INTEGER and REAL declaration statements,
134! kinds are defined in new module kinds,
135! revision history before 2012 removed,
136! comment fields (!:) to be used for variable explanations added to
137! all variable declaration statements
138!
139! 1318 2014-03-17 13:35:16Z raasch
140! barrier argument removed from cpu_log,
141! module interfaces removed
142!
143! 1115 2013-03-26 18:16:16Z hoffmann
144! +qc
145!
146! 1053 2012-11-13 17:11:03Z hoffmann
147! averaging of nr, qr added
148!
149! 1036 2012-10-22 13:43:42Z raasch
150! code put under GPL (PALM 3.9)
151!
152! 978 2012-08-09 08:28:32Z fricke
153! +z0h_av
154!
155! Revision 1.1  2006/02/23 09:48:58  raasch
156! Initial revision
157!
158!
159! Description:
160! ------------
161!> Time-averaging of 3d-data-arrays.
162!------------------------------------------------------------------------------!
163 SUBROUTINE average_3d_data
164 
165
166    USE averaging
167
168    USE biometeorology_mod,                                                    &
169        ONLY:  bio_3d_data_averaging
170
171    USE bulk_cloud_model_mod,                                                  &
172        ONLY:  bulk_cloud_model, bcm_3d_data_averaging
173
174    USE chemistry_model_mod,                                                   &
175        ONLY:  chem_3d_data_averaging
176
177    USE control_parameters,                                                    &
178        ONLY:  air_chemistry, average_count_3d, biometeorology, doav, doav_n,  &
179               land_surface, ocean_mode, urban_surface, varnamelength
180
181    USE cpulog,                                                                &
182        ONLY:  cpu_log, log_point
183
184    USE gust_mod,                                                              &
185        ONLY:  gust_3d_data_averaging, gust_module_enabled
186
187    USE indices,                                                               &
188        ONLY:  nbgp, nxl, nxlg, nxr, nxrg, nyn, nyng, nys, nysg, nzb, nzt
189
190    USE kinds
191
192    USE land_surface_model_mod,                                                &
193        ONLY:  lsm_3d_data_averaging
194
195    USE ocean_mod,                                                             &
196        ONLY:  ocean_3d_data_averaging
197
198    USE radiation_model_mod,                                                   &
199        ONLY:  radiation, radiation_3d_data_averaging
200           
201    USE salsa_mod,                                                             &
202        ONLY:  salsa, salsa_3d_data_averaging
203
204    USE turbulence_closure_mod,                                                &
205        ONLY:  tcm_3d_data_averaging
206
207    USE urban_surface_mod,                                                     &
208        ONLY:  usm_average_3d_data
209
210
211
212
213    IMPLICIT NONE
214
215    INTEGER(iwp) ::  i   !< loop index
216    INTEGER(iwp) ::  ii  !< loop index
217    INTEGER(iwp) ::  j   !< loop index
218    INTEGER(iwp) ::  k   !< loop index
219
220    CHARACTER (LEN=varnamelength) ::  trimvar  !< TRIM of output-variable string
221
222
223    CALL cpu_log (log_point(35),'average_3d_data','start')
224
225!
226!-- Check, if averaging is necessary
227    IF ( average_count_3d <= 1 )  RETURN
228
229!
230!-- Loop of all variables to be averaged.
231    DO  ii = 1, doav_n
232
233       trimvar = TRIM( doav(ii) )
234
235!
236!--    Store the array chosen on the temporary array.
237       SELECT CASE ( trimvar )
238
239          CASE ( 'e' )
240             IF ( ALLOCATED( e_av ) ) THEN
241                DO  i = nxlg, nxrg
242                   DO  j = nysg, nyng
243                      DO  k = nzb, nzt+1
244                         e_av(k,j,i) = e_av(k,j,i) / REAL( average_count_3d, KIND=wp )
245                      ENDDO
246                   ENDDO
247                ENDDO
248             ENDIF
249
250          CASE ( 'ghf*' )
251             IF ( ALLOCATED( ghf_av ) ) THEN
252                DO  i = nxl, nxr
253                   DO  j = nys, nyn
254                      ghf_av(j,i) = ghf_av(j,i)                                   &
255                                    / REAL( average_count_3d, KIND=wp )
256                   ENDDO
257                ENDDO
258                CALL exchange_horiz_2d( ghf_av, nbgp )
259             ENDIF
260
261          CASE ( 'qsws*' )
262             IF ( ALLOCATED( qsws_av ) ) THEN
263                DO  i = nxlg, nxrg
264                   DO  j = nysg, nyng
265                      qsws_av(j,i) = qsws_av(j,i) / REAL( average_count_3d, KIND=wp )
266                   ENDDO
267                ENDDO
268                CALL exchange_horiz_2d( qsws_av, nbgp )
269             ENDIF
270
271          CASE ( 'thetal' )
272             IF ( ALLOCATED( lpt_av ) ) THEN
273                DO  i = nxlg, nxrg
274                   DO  j = nysg, nyng
275                      DO  k = nzb, nzt+1
276                         lpt_av(k,j,i) = lpt_av(k,j,i) / REAL( average_count_3d, KIND=wp )
277                      ENDDO
278                   ENDDO
279                ENDDO
280             ENDIF
281
282          CASE ( 'lwp*' )
283             IF ( ALLOCATED( lwp_av ) ) THEN
284                DO  i = nxlg, nxrg
285                   DO  j = nysg, nyng
286                      lwp_av(j,i) = lwp_av(j,i) / REAL( average_count_3d, KIND=wp )
287                   ENDDO
288                ENDDO
289             ENDIF
290
291         CASE ( 'ol*' )
292             IF ( ALLOCATED( ol_av ) ) THEN
293                DO  i = nxlg, nxrg
294                   DO  j = nysg, nyng
295                      ol_av(j,i) = ol_av(j,i) / REAL( average_count_3d, KIND=wp )
296                   ENDDO
297                ENDDO
298                CALL exchange_horiz_2d( ol_av, nbgp )
299             ENDIF
300
301          CASE ( 'p' )
302             IF ( ALLOCATED( p_av ) ) THEN
303                DO  i = nxlg, nxrg
304                   DO  j = nysg, nyng
305                      DO  k = nzb, nzt+1
306                         p_av(k,j,i) = p_av(k,j,i) / REAL( average_count_3d, KIND=wp )
307                      ENDDO
308                   ENDDO
309                ENDDO
310             ENDIF
311
312          CASE ( 'pc' )
313             IF ( ALLOCATED( pc_av ) ) THEN
314                DO  i = nxl, nxr
315                   DO  j = nys, nyn
316                      DO  k = nzb, nzt+1
317                         pc_av(k,j,i) = pc_av(k,j,i) / REAL( average_count_3d, KIND=wp )
318                      ENDDO
319                   ENDDO
320                ENDDO
321             ENDIF
322
323          CASE ( 'pr' )
324             IF ( ALLOCATED( pr_av ) ) THEN
325                DO  i = nxl, nxr
326                   DO  j = nys, nyn
327                      DO  k = nzb, nzt+1
328                         pr_av(k,j,i) = pr_av(k,j,i) / REAL( average_count_3d, KIND=wp )
329                      ENDDO
330                   ENDDO
331                ENDDO
332             ENDIF
333
334          CASE ( 'theta' )
335             IF ( ALLOCATED( pt_av ) ) THEN
336                DO  i = nxlg, nxrg
337                   DO  j = nysg, nyng
338                      DO  k = nzb, nzt+1
339                         pt_av(k,j,i) = pt_av(k,j,i) / REAL( average_count_3d, KIND=wp )
340                      ENDDO
341                   ENDDO
342                ENDDO
343             ENDIF
344
345          CASE ( 'q' )
346             IF ( ALLOCATED( q_av ) ) THEN
347                DO  i = nxlg, nxrg
348                   DO  j = nysg, nyng
349                      DO  k = nzb, nzt+1
350                         q_av(k,j,i) = q_av(k,j,i) / REAL( average_count_3d, KIND=wp )
351                      ENDDO
352                   ENDDO
353                ENDDO
354             ENDIF
355
356          CASE ( 'ql' )
357             IF ( ALLOCATED( ql_av ) ) THEN
358                DO  i = nxlg, nxrg
359                   DO  j = nysg, nyng
360                      DO  k = nzb, nzt+1
361                         ql_av(k,j,i) = ql_av(k,j,i) / REAL( average_count_3d, KIND=wp )
362                      ENDDO
363                   ENDDO
364                ENDDO
365             ENDIF
366
367          CASE ( 'ql_c' )
368             IF ( ALLOCATED( ql_c_av ) ) THEN
369                DO  i = nxlg, nxrg
370                   DO  j = nysg, nyng
371                      DO  k = nzb, nzt+1
372                         ql_c_av(k,j,i) = ql_c_av(k,j,i) / REAL( average_count_3d, KIND=wp )
373                      ENDDO
374                   ENDDO
375                ENDDO
376             ENDIF
377
378          CASE ( 'ql_v' )
379             IF ( ALLOCATED( ql_v_av ) ) THEN
380                DO  i = nxlg, nxrg
381                   DO  j = nysg, nyng
382                      DO  k = nzb, nzt+1
383                         ql_v_av(k,j,i) = ql_v_av(k,j,i) / REAL( average_count_3d, KIND=wp )
384                      ENDDO
385                   ENDDO
386                ENDDO
387             ENDIF
388
389          CASE ( 'ql_vp' )
390             IF ( ALLOCATED( ql_vp_av ) ) THEN
391                DO  i = nxlg, nxrg
392                   DO  j = nysg, nyng
393                      DO  k = nzb, nzt+1
394                         ql_vp_av(k,j,i) = ql_vp_av(k,j,i) /                      &
395                                           REAL( average_count_3d, KIND=wp )
396                      ENDDO
397                   ENDDO
398                ENDDO
399             ENDIF
400
401          CASE ( 'qv' )
402             IF ( ALLOCATED( qv_av ) ) THEN
403                DO  i = nxlg, nxrg
404                   DO  j = nysg, nyng
405                      DO  k = nzb, nzt+1
406                         qv_av(k,j,i) = qv_av(k,j,i) / REAL( average_count_3d, KIND=wp )
407                      ENDDO
408                   ENDDO
409                ENDDO
410             ENDIF
411
412         CASE ( 'r_a*' )
413             IF ( ALLOCATED( r_a_av ) ) THEN
414                DO  i = nxlg, nxrg
415                   DO  j = nysg, nyng
416                      r_a_av(j,i) = r_a_av(j,i) / REAL( average_count_3d, KIND=wp )
417                   ENDDO
418                ENDDO
419                CALL exchange_horiz_2d( r_a_av, nbgp )
420             ENDIF
421
422          CASE ( 's' )
423             IF ( ALLOCATED( s_av ) ) THEN
424                DO  i = nxlg, nxrg
425                   DO  j = nysg, nyng
426                      DO  k = nzb, nzt+1
427                         s_av(k,j,i) = s_av(k,j,i) / REAL( average_count_3d, KIND=wp )
428                      ENDDO
429                   ENDDO
430                ENDDO
431             ENDIF
432
433         CASE ( 'shf*' )
434             IF ( ALLOCATED( shf_av ) ) THEN
435                DO  i = nxlg, nxrg
436                   DO  j = nysg, nyng
437                      shf_av(j,i) = shf_av(j,i) / REAL( average_count_3d, KIND=wp )
438                   ENDDO
439                ENDDO
440                CALL exchange_horiz_2d( shf_av, nbgp )
441             ENDIF
442
443          CASE ( 'ssws*' )
444             IF ( ALLOCATED( ssws_av ) ) THEN
445                DO  i = nxlg, nxrg
446                   DO  j = nysg, nyng
447                      ssws_av(j,i) = ssws_av(j,i) / REAL( average_count_3d, KIND=wp )
448                   ENDDO
449                ENDDO
450                CALL exchange_horiz_2d( ssws_av, nbgp )
451             ENDIF
452
453          CASE ( 't*' )
454             IF ( ALLOCATED( ts_av ) ) THEN
455                DO  i = nxlg, nxrg
456                   DO  j = nysg, nyng
457                      ts_av(j,i) = ts_av(j,i) / REAL( average_count_3d, KIND=wp )
458                   ENDDO
459                ENDDO
460                CALL exchange_horiz_2d( ts_av, nbgp )
461             ENDIF
462
463         CASE ( 'tsurf*' )
464             IF ( ALLOCATED( tsurf_av ) ) THEN
465                DO  i = nxlg, nxrg
466                   DO  j = nysg, nyng
467                      tsurf_av(j,i) = tsurf_av(j,i) / REAL( average_count_3d, KIND=wp )
468                   ENDDO
469                ENDDO
470                CALL exchange_horiz_2d( tsurf_av, nbgp )
471             ENDIF
472
473          CASE ( 'u' )
474             IF ( ALLOCATED( u_av ) ) THEN
475                DO  i = nxlg, nxrg
476                   DO  j = nysg, nyng
477                      DO  k = nzb, nzt+1
478                         u_av(k,j,i) = u_av(k,j,i) / REAL( average_count_3d, KIND=wp )
479                      ENDDO
480                   ENDDO
481                ENDDO
482             ENDIF
483
484          CASE ( 'us*' )
485             IF ( ALLOCATED( us_av ) ) THEN
486                DO  i = nxlg, nxrg
487                   DO  j = nysg, nyng
488                      us_av(j,i) = us_av(j,i) / REAL( average_count_3d, KIND=wp )
489                   ENDDO
490                ENDDO
491                CALL exchange_horiz_2d( us_av, nbgp )
492             ENDIF
493
494          CASE ( 'v' )
495             IF ( ALLOCATED( v_av ) ) THEN
496                DO  i = nxlg, nxrg
497                   DO  j = nysg, nyng
498                      DO  k = nzb, nzt+1
499                         v_av(k,j,i) = v_av(k,j,i) / REAL( average_count_3d, KIND=wp )
500                      ENDDO
501                   ENDDO
502                ENDDO
503             ENDIF
504
505          CASE ( 'thetav' )
506             IF ( ALLOCATED( vpt_av ) ) THEN
507                DO  i = nxlg, nxrg
508                   DO  j = nysg, nyng
509                      DO  k = nzb, nzt+1
510                         vpt_av(k,j,i) = vpt_av(k,j,i) / REAL( average_count_3d, KIND=wp )
511                      ENDDO
512                   ENDDO
513                ENDDO
514             ENDIF
515
516          CASE ( 'w' )
517             IF ( ALLOCATED( w_av ) ) THEN
518                DO  i = nxlg, nxrg
519                   DO  j = nysg, nyng
520                      DO  k = nzb, nzt+1
521                         w_av(k,j,i) = w_av(k,j,i) / REAL( average_count_3d, KIND=wp )
522                      ENDDO
523                   ENDDO
524                ENDDO
525             ENDIF
526
527          CASE ( 'z0*' )
528             IF ( ALLOCATED( z0_av ) ) THEN
529                DO  i = nxlg, nxrg
530                   DO  j = nysg, nyng
531                      z0_av(j,i) = z0_av(j,i) / REAL( average_count_3d, KIND=wp )
532                   ENDDO
533                ENDDO
534                CALL exchange_horiz_2d( z0_av, nbgp )
535             ENDIF
536
537          CASE ( 'z0h*' )
538             IF ( ALLOCATED( z0h_av ) ) THEN
539                DO  i = nxlg, nxrg
540                   DO  j = nysg, nyng
541                      z0h_av(j,i) = z0h_av(j,i) / REAL( average_count_3d, KIND=wp )
542                   ENDDO
543                ENDDO
544                CALL exchange_horiz_2d( z0h_av, nbgp )
545             ENDIF
546
547          CASE ( 'z0q*' )
548             IF ( ALLOCATED( z0q_av ) ) THEN
549                DO  i = nxlg, nxrg
550                   DO  j = nysg, nyng
551                      z0q_av(j,i) = z0q_av(j,i) / REAL( average_count_3d, KIND=wp )
552                   ENDDO
553                ENDDO
554                CALL exchange_horiz_2d( z0q_av, nbgp )
555             ENDIF
556
557          CASE DEFAULT
558!
559!--          Averaging of data from other modules
560             IF ( air_chemistry .AND. &
561                  (trimvar(1:3) == 'kc_' .OR. trimvar(1:3) == 'em_')  )  THEN
562                CALL chem_3d_data_averaging( 'average', doav(ii) )
563             ENDIF
564
565             IF ( bulk_cloud_model )  THEN
566                CALL bcm_3d_data_averaging( 'average', doav(ii) )
567             ENDIF
568
569             IF ( gust_module_enabled )  THEN
570                CALL gust_3d_data_averaging( 'average', doav(ii) )
571             ENDIF
572
573             IF ( land_surface )  THEN
574                CALL lsm_3d_data_averaging( 'average', doav(ii) )
575             ENDIF
576
577             IF ( ocean_mode )  THEN
578                CALL ocean_3d_data_averaging( 'average', doav(ii) )
579             ENDIF
580
581             IF ( radiation )  THEN
582                CALL radiation_3d_data_averaging( 'average', doav(ii) )
583             ENDIF
584             
585             IF ( salsa )  THEN
586                CALL salsa_3d_data_averaging( 'average', doav(ii) )
587             ENDIF             
588
589             IF ( biometeorology )  THEN
590                CALL bio_3d_data_averaging( 'average', doav(ii) )
591             ENDIF
592
593             CALL tcm_3d_data_averaging( 'average', doav(ii) )
594
595             IF ( urban_surface  .AND.  trimvar(1:4) == 'usm_' )  THEN
596                CALL usm_average_3d_data( 'average', doav(ii) )
597             ENDIF
598
599!
600!--          User-defined quantities
601             CALL user_3d_data_averaging( 'average', doav(ii) )
602
603       END SELECT
604
605    ENDDO
606
607!
608!-- Reset the counter
609    average_count_3d = 0.0
610
611    CALL cpu_log( log_point(35), 'average_3d_data', 'stop' )
612
613
614 END SUBROUTINE average_3d_data
Note: See TracBrowser for help on using the repository browser.