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

Last change on this file since 3623 was 3597, checked in by maronga, 5 years ago

revised calculation of near surface air potential temperature

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