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

Last change on this file since 2766 was 2766, checked in by kanani, 4 years ago

Removal of chem directive, plus minor changes

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