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

Last change on this file since 3592 was 3589, checked in by suehring, 5 years ago

Remove erroneous UTF encoding; last commit documented

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