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

Last change on this file since 3582 was 3582, checked in by suehring, 3 years ago

Merge branch salsa with trunk

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