source: palm/trunk/SOURCE/module_interface.f90 @ 3875

Last change on this file since 3875 was 3875, checked in by knoop, 2 years ago

Implemented wtm_actions and moved respective module code into it

  • Property svn:keywords set to Id
File size: 65.7 KB
Line 
1!> @file module_interface.f90
2!------------------------------------------------------------------------------!
3! This file is part of PALM.
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-2019 Leibniz Universitaet Hannover
18!------------------------------------------------------------------------------!
19!
20! Current revisions:
21! -----------------
22!
23!
24! Former revisions:
25! -----------------
26! $Id: module_interface.f90 3875 2019-04-08 17:35:12Z knoop $
27! Add a call for salsa_prognostic_equations
28!
29! 3840 2019-03-29 10:35:52Z knoop
30! bugfix: intent of dummy arguments changed to inout
31!
32! 3770 2019-02-28 11:22:32Z moh.hefny
33! removed unused variables in module_interface_check_data_output_ts
34!
35! 3767 08:18:02Z raasch
36! unused variable file_index removed from subroutine parameter list
37!
38! 3766 2019-02-26 16:23:41Z raasch
39! first argument removed from module_interface_rrd_*, statement added to avoid
40! compiler warning about unused variable, file reformatted with respect to coding
41! standards
42!
43! 3762 2019-02-25 16:54:16Z suehring
44! only pass required arguments to surface_data_output_rrd_local
45!
46! 3747 2019-02-16 15:15:23Z gronemeier
47! Call user_init_arrays
48!
49! 3745 2019-02-15 18:57:56Z suehring
50! Add indoor model
51!
52! 3744 2019-02-15 18:38:58Z suehring
53! Removed bio_check_parameters as the method is empty.
54!
55! 3735 2019-02-12 09:52:40Z dom_dwd_user
56! Accepting variable j from check_parameters and passing it to
57! bio_check_data_output
58! Add required restart data for surface output module
59!
60! 3731 2019-02-11 13:06:27Z suehring
61! Add check_parameters routine for virtual measurements
62!
63! 3711 2019-01-31 13:44:26Z knoop
64! Introduced module_interface_init_checks for post-init checks
65!
66! 3705 2019-01-29 19:56:39Z suehring
67! Add last_actions for virtual measurements
68!
69! 3704 2019-01-29 19:51:41Z suehring
70! Some interface calls moved to module_interface + cleanup
71!
72! 3684 2019-01-20 20:20:58Z knoop
73! Bugfix: made unit intend INOUT
74!
75! 3650 2019-01-04 13:01:33Z kanani
76! Add restart routines for biometeorology
77!
78! 3649 2019-01-02 16:52:21Z suehring
79! Initialize strings, in order to avoid compiler warnings for non-initialized
80! characters with intent(out) attribute
81!
82! 3648 2019-01-02 16:35:46Z suehring
83! Rename subroutines for surface-data output
84!
85! 3641 2018-12-23 22:10:01Z knoop
86! Initial implementation of the PALM module interface
87!
88!
89! Description:
90! ------------
91!> This is the interface between the PALM model core and all its modules.
92!>
93!> @todo Re-format module to be consistent with coding standard
94!------------------------------------------------------------------------------!
95 MODULE module_interface
96
97    USE indices,                                                               &
98        ONLY:  nbgp, nxl, nxlg, nxr, nxrg, nys, nysg, nyn, nyng, nzb, nzt
99
100    USE kinds
101
102!
103!-- load module-specific control parameters.
104!-- ToDo: move all of them to respective module or a dedicated central module
105    USE control_parameters,                                                    &
106        ONLY:  biometeorology,                                                 &
107               air_chemistry,                                                  &
108               indoor_model,                                                   &
109               land_surface,                                                   &
110               large_scale_forcing,                                            &
111               nesting_offline,                                                &
112               nudging,                                                        &
113               ocean_mode,                                                     &
114               plant_canopy,                                                   &
115               salsa,                                                          &
116               surface_output,                                                 &
117               syn_turb_gen,                                                   &
118               urban_surface,                                                  &
119               virtual_flight,                                                 &
120               virtual_measurement,                                            &
121               wind_turbine
122
123!
124!-- load interface routines of all PALM modules
125    USE biometeorology_mod,                                                    &
126        ONLY:  bio_parin,                                                      &
127               bio_check_data_output,                                          &
128               bio_init,                                                       &
129               bio_init_checks,                                                &
130               bio_header,                                                     &
131               bio_3d_data_averaging,                                          &
132               bio_data_output_2d,                                             &
133               bio_data_output_3d,                                             &
134               bio_rrd_global,                                                 &
135               bio_rrd_local,                                                  &
136               bio_wrd_global,                                                 &
137               bio_wrd_local
138
139    USE bulk_cloud_model_mod,                                                  &
140        ONLY:  bulk_cloud_model,                                               &
141               bcm_parin,                                                      &
142               bcm_check_parameters,                                           &
143               bcm_check_data_output_pr,                                       &
144               bcm_check_data_output,                                          &
145               bcm_init_arrays,                                                &
146               bcm_init,                                                       &
147               bcm_header,                                                     &
148               bcm_actions,                                                    &
149               bcm_non_transport_physics,                                      &
150               bcm_prognostic_equations,                                       &
151               bcm_swap_timelevel,                                             &
152               bcm_3d_data_averaging,                                          &
153               bcm_data_output_2d,                                             &
154               bcm_data_output_3d,                                             &
155               bcm_rrd_global,                                                 &
156               bcm_wrd_global,                                                 &
157               bcm_rrd_local,                                                  &
158               bcm_wrd_local
159
160   USE chemistry_model_mod,                                                    &
161       ONLY:  chem_parin,                                                      &
162              chem_check_parameters,                                           &
163              chem_check_data_output_pr,                                       &
164              chem_check_data_output,                                          &
165              chem_init_arrays,                                                &
166              chem_init,                                                       &
167              chem_header,                                                     &
168              chem_swap_timelevel,                                             &
169              chem_3d_data_averaging,                                          &
170              chem_data_output_2d,                                             &
171              chem_data_output_3d,                                             &
172              chem_statistics,                                                 &
173              chem_rrd_local,                                                  &
174               chem_wrd_local
175
176    USE flight_mod,                                                            &
177        ONLY:  flight_parin,                                                   &
178               flight_header,                                                  &
179               flight_init,                                                    &
180               flight_rrd_global,                                              &
181               flight_wrd_global
182
183    USE gust_mod,                                                              &
184        ONLY:  gust_module_enabled,                                            &
185               gust_parin,                                                     &
186               gust_check_parameters,                                          &
187               gust_check_data_output_pr,                                      &
188               gust_check_data_output,                                         &
189               gust_init_arrays,                                               &
190               gust_init,                                                      &
191               gust_header,                                                    &
192               gust_actions,                                                   &
193               gust_prognostic_equations,                                      &
194               gust_swap_timelevel,                                            &
195               gust_3d_data_averaging,                                         &
196               gust_data_output_2d,                                            &
197               gust_data_output_3d,                                            &
198               gust_statistics,                                                &
199               gust_rrd_global,                                                &
200               gust_wrd_global,                                                &
201               gust_rrd_local,                                                 &
202               gust_wrd_local
203
204    USE indoor_model_mod,                                                      &
205        ONLY:  im_parin,                                                       &
206               im_check_data_output,                                           &
207               im_check_parameters,                                            &
208               im_data_output_3d,                                              &
209               im_init
210
211    USE land_surface_model_mod,                                                &
212        ONLY:  lsm_parin,                                                      &
213               lsm_check_parameters,                                           &
214               lsm_check_data_output_pr,                                       &
215               lsm_check_data_output,                                          &
216               lsm_init_arrays,                                                &
217               lsm_init,                                                       &
218               lsm_header,                                                     &
219               lsm_swap_timelevel,                                             &
220               lsm_3d_data_averaging,                                          &
221               lsm_data_output_2d,                                             &
222               lsm_rrd_local,                                                  &
223               lsm_wrd_local
224
225    USE lsf_nudging_mod,                                                       &
226        ONLY:  lsf_nudging_check_parameters,                                   &
227               lsf_nudging_check_data_output_pr,                               &
228               lsf_init,                                                       &
229               nudge_init,                                                     &
230               lsf_nudging_header
231
232    USE multi_agent_system_mod,                                                &
233        ONLY:  mas_parin
234
235    USE nesting_offl_mod,                                                      &
236        ONLY:  nesting_offl_parin,                                             &
237               nesting_offl_check_parameters,                                  &
238               nesting_offl_header
239
240    USE ocean_mod,                                                             &
241        ONLY:  ocean_parin,                                                    &
242               ocean_check_parameters,                                         &
243               ocean_check_data_output_pr,                                     &
244               ocean_check_data_output,                                        &
245               ocean_init_arrays,                                              &
246               ocean_init,                                                     &
247               ocean_header,                                                   &
248               ocean_actions,                                                  &
249               ocean_prognostic_equations,                                     &
250               ocean_swap_timelevel,                                           &
251               ocean_3d_data_averaging,                                        &
252               ocean_data_output_2d,                                           &
253               ocean_data_output_3d,                                           &
254               ocean_rrd_global,                                               &
255               ocean_wrd_global,                                               &
256               ocean_rrd_local,                                                &
257               ocean_wrd_local
258
259    USE plant_canopy_model_mod,                                                &
260         ONLY: pcm_parin,                                                      &
261               pcm_check_parameters,                                           &
262               pcm_check_data_output,                                          &
263               pcm_init,                                                       &
264               pcm_header,                                                     &
265               pcm_data_output_3d
266
267    USE radiation_model_mod,                                                   &
268        ONLY:  radiation,                                                      &
269               radiation_parin,                                                &
270               radiation_check_parameters,                                     &
271               radiation_check_data_output_ts,                                 &
272               radiation_check_data_output_pr,                                 &
273               radiation_check_data_output,                                    &
274               radiation_init,                                                 &
275               radiation_header,                                               &
276               radiation_3d_data_averaging,                                    &
277               radiation_data_output_2d,                                       &
278               radiation_data_output_3d,                                       &
279               radiation_rrd_local,                                            &
280               radiation_wrd_local
281
282    USE salsa_mod,                                                             &
283        ONLY:  salsa_parin,                                                    &
284               salsa_check_parameters,                                         &
285               salsa_check_data_output,                                        &
286               salsa_init_arrays,                                              &
287               salsa_init,                                                     &
288               salsa_header,                                                   &
289               salsa_actions,                                                  &
290               salsa_prognostic_equations,                                     &
291               salsa_swap_timelevel,                                           &
292               salsa_3d_data_averaging,                                        &
293               salsa_data_output_2d,                                           &
294               salsa_data_output_3d,                                           &
295               salsa_rrd_local,                                                &
296               salsa_wrd_local
297
298    USE spectra_mod,                                                           &
299        ONLY:  calculate_spectra,                                              &
300               spectra_parin,                                                  &
301               spectra_check_parameters,                                       &
302               spectra_header
303
304    USE surface_data_output_mod,                                               &
305        ONLY:  surface_data_output_parin,                                      &
306               surface_data_output_check_parameters,                           &
307               surface_data_output_init_arrays,                                &
308               surface_data_output_rrd_local,                                  &
309               surface_data_output_rrd_global,                                 &
310               surface_data_output_wrd_local,                                  &
311               surface_data_output_wrd_global
312
313    USE synthetic_turbulence_generator_mod,                                    &
314        ONLY:  stg_parin,                                                      &
315               stg_check_parameters,                                           &
316               stg_header,                                                     &
317               stg_rrd_global,                                                 &
318               stg_wrd_global
319
320    USE urban_surface_mod,                                                     &
321        ONLY:  usm_parin,                                                      &
322               usm_check_parameters,                                           &
323               usm_check_data_output,                                          &
324               usm_init_arrays,                                                &
325               usm_init,                                                       &
326               usm_swap_timelevel,                                             &
327               usm_3d_data_averaging,                                          &
328               usm_rrd_local,                                                  &
329               usm_wrd_local
330
331    USE user,                                                                  &
332        ONLY:  user_module_enabled,                                            &
333               user_parin,                                                     &
334               user_check_parameters,                                          &
335               user_check_data_output_ts,                                      &
336               user_check_data_output_pr,                                      &
337               user_check_data_output,                                         &
338               user_init,                                                      &
339               user_init_arrays,                                               &
340               user_header,                                                    &
341               user_actions,                                                   &
342               user_3d_data_averaging,                                         &
343               user_data_output_2d,                                            &
344               user_data_output_3d,                                            &
345               user_statistics,                                                &
346               user_rrd_global,                                                &
347               user_rrd_local,                                                 &
348               user_wrd_global,                                                &
349               user_wrd_local,                                                 &
350               user_last_actions
351
352    USE virtual_measurement_mod,                                               &
353        ONLY:  vm_check_parameters,                                            &
354               vm_init,                                                        &
355               vm_last_actions,                                                &
356               vm_parin
357
358    USE wind_turbine_model_mod,                                                &
359        ONLY:  wtm_parin,                                                      &
360               wtm_check_parameters,                                           &
361               wtm_init_arrays,                                                &
362               wtm_init,                                                       &
363               wtm_actions,                                                    &
364               wtm_rrd_global,                                                 &
365               wtm_wrd_global
366
367    IMPLICIT NONE
368
369    PRIVATE
370
371!
372!-- Public functions
373    PUBLIC                                                                     &
374       module_interface_parin,                                                 &
375       module_interface_check_parameters,                                      &
376       module_interface_check_data_output_ts,                                  &
377       module_interface_check_data_output_pr,                                  &
378       module_interface_check_data_output,                                     &
379       module_interface_init_masks,                                            &
380       module_interface_define_netcdf_grid,                                    &
381       module_interface_init_arrays,                                           &
382       module_interface_init,                                                  &
383       module_interface_init_checks,                                           &
384       module_interface_header,                                                &
385       module_interface_actions,                                               &
386       module_interface_non_transport_physics,                                 &
387       module_interface_prognostic_equations,                                  &
388       module_interface_swap_timelevel,                                        &
389       module_interface_3d_data_averaging,                                     &
390       module_interface_data_output_2d,                                        &
391       module_interface_data_output_3d,                                        &
392       module_interface_statistics,                                            &
393       module_interface_rrd_global,                                            &
394       module_interface_wrd_global,                                            &
395       module_interface_rrd_local,                                             &
396       module_interface_wrd_local,                                             &
397       module_interface_last_actions
398
399
400    INTERFACE module_interface_parin
401       MODULE PROCEDURE module_interface_parin
402    END INTERFACE module_interface_parin
403
404    INTERFACE module_interface_check_parameters
405       MODULE PROCEDURE module_interface_check_parameters
406    END INTERFACE module_interface_check_parameters
407
408    INTERFACE module_interface_check_data_output_ts
409       MODULE PROCEDURE module_interface_check_data_output_ts
410    END INTERFACE module_interface_check_data_output_ts
411
412    INTERFACE module_interface_check_data_output_pr
413       MODULE PROCEDURE module_interface_check_data_output_pr
414    END INTERFACE module_interface_check_data_output_pr
415
416    INTERFACE module_interface_check_data_output
417       MODULE PROCEDURE module_interface_check_data_output
418    END INTERFACE module_interface_check_data_output
419
420    INTERFACE module_interface_init_masks
421       MODULE PROCEDURE module_interface_init_masks
422    END INTERFACE module_interface_init_masks
423
424    INTERFACE module_interface_define_netcdf_grid
425       MODULE PROCEDURE module_interface_define_netcdf_grid
426    END INTERFACE module_interface_define_netcdf_grid
427
428    INTERFACE module_interface_init_arrays
429       MODULE PROCEDURE module_interface_init_arrays
430    END INTERFACE module_interface_init_arrays
431
432    INTERFACE module_interface_init
433       MODULE PROCEDURE module_interface_init
434    END INTERFACE module_interface_init
435
436    INTERFACE module_interface_init_checks
437       MODULE PROCEDURE module_interface_init_checks
438    END INTERFACE module_interface_init_checks
439
440    INTERFACE module_interface_header
441       MODULE PROCEDURE module_interface_header
442    END INTERFACE module_interface_header
443
444    INTERFACE module_interface_actions
445       MODULE PROCEDURE module_interface_actions
446       MODULE PROCEDURE module_interface_actions_ij
447    END INTERFACE module_interface_actions
448
449    INTERFACE module_interface_non_transport_physics
450       MODULE PROCEDURE module_interface_non_transport_physics
451       MODULE PROCEDURE module_interface_non_transport_physics_ij
452    END INTERFACE module_interface_non_transport_physics
453
454    INTERFACE module_interface_prognostic_equations
455       MODULE PROCEDURE module_interface_prognostic_equations
456       MODULE PROCEDURE module_interface_prognostic_equations_ij
457    END INTERFACE module_interface_prognostic_equations
458
459    INTERFACE module_interface_swap_timelevel
460       MODULE PROCEDURE module_interface_swap_timelevel
461    END INTERFACE module_interface_swap_timelevel
462
463    INTERFACE module_interface_3d_data_averaging
464       MODULE PROCEDURE module_interface_3d_data_averaging
465    END INTERFACE module_interface_3d_data_averaging
466
467    INTERFACE module_interface_data_output_2d
468       MODULE PROCEDURE module_interface_data_output_2d
469    END INTERFACE module_interface_data_output_2d
470
471    INTERFACE module_interface_data_output_3d
472       MODULE PROCEDURE module_interface_data_output_3d
473    END INTERFACE module_interface_data_output_3d
474
475    INTERFACE module_interface_statistics
476       MODULE PROCEDURE module_interface_statistics
477    END INTERFACE module_interface_statistics
478
479    INTERFACE module_interface_rrd_global
480       MODULE PROCEDURE module_interface_rrd_global
481    END INTERFACE module_interface_rrd_global
482
483    INTERFACE module_interface_wrd_global
484       MODULE PROCEDURE module_interface_wrd_global
485    END INTERFACE module_interface_wrd_global
486
487    INTERFACE module_interface_rrd_local
488       MODULE PROCEDURE module_interface_rrd_local
489    END INTERFACE module_interface_rrd_local
490
491    INTERFACE module_interface_wrd_local
492       MODULE PROCEDURE module_interface_wrd_local
493    END INTERFACE module_interface_wrd_local
494
495    INTERFACE module_interface_last_actions
496       MODULE PROCEDURE module_interface_last_actions
497    END INTERFACE module_interface_last_actions
498
499
500 CONTAINS
501
502
503!------------------------------------------------------------------------------!
504! Description:
505! ------------
506!> Read module-specific parameter namelists
507!------------------------------------------------------------------------------!
508 SUBROUTINE module_interface_parin
509
510
511    CALL bio_parin
512    CALL bcm_parin
513    CALL chem_parin
514    CALL flight_parin ! ToDo: rename module to match filename
515    CALL gust_parin
516    CALL im_parin
517    CALL lsm_parin
518    ! ToDo: create parin routine for large_scale_forcing and nudging (should be seperate modules or new module switch)
519    CALL mas_parin
520    CALL nesting_offl_parin
521    CALL ocean_parin
522    CALL pcm_parin
523    CALL radiation_parin
524    CALL salsa_parin
525    CALL spectra_parin
526    CALL surface_data_output_parin
527    CALL stg_parin
528    CALL user_parin ! ToDo: make user code a single Fortran module
529    CALL usm_parin
530    CALL vm_parin
531    CALL wtm_parin
532
533    CALL package_parin ! ToDo: deprecated, needs to be dissolved
534
535
536 END SUBROUTINE module_interface_parin
537
538
539!------------------------------------------------------------------------------!
540! Description:
541! ------------
542!> Perform module-specific initialization checks
543!------------------------------------------------------------------------------!
544 SUBROUTINE module_interface_check_parameters
545
546
547    IF ( bulk_cloud_model )     CALL bcm_check_parameters
548    IF ( air_chemistry )        CALL chem_check_parameters
549    IF ( gust_module_enabled )  CALL gust_check_parameters
550    IF ( indoor_model )         CALL im_check_parameters
551    IF ( land_surface )         CALL lsm_check_parameters
552    IF ( large_scale_forcing  .OR.  nudging )  CALL lsf_nudging_check_parameters ! ToDo: create single module switch
553    IF ( nesting_offline )      CALL nesting_offl_check_parameters
554    IF ( ocean_mode )           CALL ocean_check_parameters
555    IF ( plant_canopy )         CALL pcm_check_parameters
556    IF ( radiation )            CALL radiation_check_parameters
557    IF ( salsa )                CALL salsa_check_parameters
558    IF ( calculate_spectra )    CALL spectra_check_parameters
559    IF ( surface_output )       CALL surface_data_output_check_parameters
560    IF ( syn_turb_gen )         CALL stg_check_parameters
561    IF ( urban_surface )        CALL usm_check_parameters
562    IF ( virtual_measurement )  CALL vm_check_parameters
563    IF ( wind_turbine )         CALL wtm_check_parameters
564    IF ( user_module_enabled )  CALL user_check_parameters
565
566
567 END SUBROUTINE module_interface_check_parameters
568
569
570!------------------------------------------------------------------------------!
571! Description:
572! ------------
573!> Check module-specific data output of timeseries
574!------------------------------------------------------------------------------!
575 SUBROUTINE module_interface_check_data_output_ts( dots_max, dots_num, dots_label, dots_unit )
576
577
578    INTEGER(iwp),      INTENT(IN)    ::  dots_max !< variable output array index
579    INTEGER(iwp),      INTENT(INOUT)    ::  dots_num !< variable output array index
580    CHARACTER (LEN=*), DIMENSION(dots_max), INTENT(INOUT) :: dots_label
581    CHARACTER (LEN=*), DIMENSION(dots_max), INTENT(INOUT) :: dots_unit
582
583
584    IF ( radiation )  THEN
585       CALL radiation_check_data_output_ts( dots_max, dots_num )
586    ENDIF
587
588    IF ( user_module_enabled )  THEN
589       CALL user_check_data_output_ts( dots_max, dots_num, dots_label, dots_unit )
590    ENDIF
591
592
593 END SUBROUTINE module_interface_check_data_output_ts
594
595
596!------------------------------------------------------------------------------!
597! Description:
598! ------------
599!> Check module-specific data output of profiles
600!------------------------------------------------------------------------------!
601 SUBROUTINE module_interface_check_data_output_pr( variable, var_count, unit,  &
602                                                   dopr_unit )
603
604
605    CHARACTER (LEN=*), INTENT(IN)    ::  variable  !< variable name
606    INTEGER(iwp),      INTENT(IN)    ::  var_count !< variable output array index
607    CHARACTER (LEN=*), INTENT(INOUT) ::  unit      !< physical unit of variable
608    CHARACTER (LEN=*), INTENT(OUT)   ::  dopr_unit !< local value of dopr_unit
609
610    IF ( unit == 'illegal' .AND.  bulk_cloud_model )  THEN
611       CALL bcm_check_data_output_pr( variable, var_count, unit, dopr_unit )
612    ENDIF
613
614    IF ( unit == 'illegal' .AND.  air_chemistry )  THEN
615       CALL chem_check_data_output_pr( variable, var_count, unit, dopr_unit )
616    ENDIF
617
618    IF ( unit == 'illegal'  .AND.  gust_module_enabled  )  THEN
619       CALL gust_check_data_output_pr( variable, var_count, unit, dopr_unit )
620    ENDIF
621
622    IF ( unit == 'illegal' )  THEN ! ToDo: add module switch if possible
623       CALL lsm_check_data_output_pr( variable, var_count, unit, dopr_unit )
624    ENDIF
625
626    IF ( unit == 'illegal' )  THEN ! ToDo: add module switch if possible
627       CALL lsf_nudging_check_data_output_pr( variable, var_count, unit, dopr_unit )
628    ENDIF
629
630    IF ( unit == 'illegal'  .AND.  ocean_mode )  THEN
631       CALL ocean_check_data_output_pr( variable, var_count, unit, dopr_unit )
632    ENDIF
633
634    IF ( unit == 'illegal'  .AND.  radiation )  THEN
635       CALL radiation_check_data_output_pr( variable, var_count, unit, dopr_unit )
636    ENDIF
637
638    IF ( unit == 'illegal'  .AND.  user_module_enabled )  THEN
639       unit = '' ! ToDo: Seems like a hack. Find a general soultion!
640       CALL user_check_data_output_pr( variable, var_count, unit, dopr_unit )
641    ENDIF
642
643
644 END SUBROUTINE module_interface_check_data_output_pr
645
646!------------------------------------------------------------------------------!
647! Description:
648! ------------
649!> Check module-specific 2D and 3D data output
650!------------------------------------------------------------------------------!
651 SUBROUTINE module_interface_check_data_output( variable, unit, i, j, ilen, k )
652
653
654    CHARACTER (LEN=*), INTENT(IN)    ::  variable !< variable name
655    CHARACTER (LEN=*), INTENT(INOUT) ::  unit     !< physical unit of variable
656
657    INTEGER(iwp),      INTENT(IN)    :: i         !< ToDo: remove dummy argument, instead pass string from data_output
658    INTEGER(iwp),      INTENT(IN)    :: j         !< average quantity? 0 = no, 1 = yes
659    INTEGER(iwp),      INTENT(IN)    :: ilen      !< ToDo: remove dummy argument, instead pass string from data_output
660    INTEGER(iwp),      INTENT(IN)    :: k         !< ToDo: remove dummy argument, instead pass string from data_output
661
662    IF ( unit == 'illegal'  .AND.  biometeorology )  THEN
663       CALL bio_check_data_output( variable, unit, i, j, ilen, k )
664    ENDIF
665
666    IF ( unit == 'illegal'  .AND.  bulk_cloud_model  )  THEN
667       CALL bcm_check_data_output( variable, unit )
668    ENDIF
669
670    IF ( unit == 'illegal'  .AND.  air_chemistry                               &
671         .AND.  (variable(1:3) == 'kc_' .OR. variable(1:3) == 'em_') )  THEN  ! ToDo: remove aditional conditions
672       CALL chem_check_data_output( variable, unit, i, ilen, k )
673    ENDIF
674
675    IF ( unit == 'illegal'  .AND.  gust_module_enabled  )  THEN
676       CALL gust_check_data_output( variable, unit )
677    ENDIF
678
679    IF ( unit == 'illegal' )  THEN  ! ToDo: add module switch if possible
680       CALL lsm_check_data_output( variable, unit, i, ilen, k )
681    ENDIF
682
683    IF ( unit == 'illegal'  .AND.  ocean_mode )  THEN
684       CALL ocean_check_data_output( variable, unit )
685    ENDIF
686
687    IF ( unit == 'illegal'  .AND.  plant_canopy                                &
688         .AND.  variable(1:4) == 'pcm_' )  THEN  ! ToDo: remove aditional conditions
689       CALL pcm_check_data_output( variable, unit )
690    ENDIF
691
692    IF ( unit == 'illegal'  .AND.  radiation )  THEN
693       CALL radiation_check_data_output( variable, unit, i, ilen, k )
694    ENDIF
695
696    IF ( unit == 'illegal' .AND. salsa ) THEN
697       CALL salsa_check_data_output( variable, unit )
698    ENDIF
699
700    IF ( unit == 'illegal' .AND. indoor_model ) THEN
701       CALL im_check_data_output( variable, unit )
702    ENDIF
703   
704    IF ( unit == 'illegal'  .AND.  urban_surface                      &
705        .AND.  variable(1:4) == 'usm_' )  THEN  ! ToDo: remove aditional conditions
706       CALL usm_check_data_output( variable, unit )
707    ENDIF
708
709    IF ( unit == 'illegal'  .AND.  user_module_enabled )  THEN
710       unit = ''
711       CALL user_check_data_output( variable, unit )
712    ENDIF
713
714
715 END SUBROUTINE module_interface_check_data_output
716
717
718!------------------------------------------------------------------------------!
719!
720! Description:
721! ------------
722!> Interface for init_masks. ToDo: get rid of these redundant calls!
723!------------------------------------------------------------------------------!
724 SUBROUTINE module_interface_init_masks( variable, unit )
725
726
727    CHARACTER (LEN=*), INTENT(IN)    ::  variable !< variable name
728    CHARACTER (LEN=*), INTENT(INOUT) ::  unit     !< physical unit of variable
729
730    IF ( unit == 'illegal'  .AND.  air_chemistry                               &
731         .AND.  (variable(1:3) == 'kc_' .OR. variable(1:3) == 'em_') )  THEN  ! ToDo: remove aditional conditions
732       CALL chem_check_data_output( variable, unit, 0, 0, 0 )
733    ENDIF
734
735    IF ( unit == 'illegal'  .AND.  radiation )  THEN
736       CALL radiation_check_data_output( variable, unit, 0, 0, 0 )
737    ENDIF
738
739    IF ( unit == 'illegal'  .AND.  salsa )  THEN
740       CALL salsa_check_data_output( variable, unit )
741    ENDIF
742
743    IF ( unit == 'illegal'  .AND.  user_module_enabled )  THEN
744       unit = ''
745       CALL user_check_data_output( variable, unit )
746    ENDIF
747
748
749 END SUBROUTINE module_interface_init_masks
750
751
752!------------------------------------------------------------------------------!
753!
754! Description:
755! ------------
756!> Define appropriate grid for module-specific netcdf output variables.
757!------------------------------------------------------------------------------!
758 SUBROUTINE module_interface_define_netcdf_grid( var, found,                   &
759                                                 grid_x, grid_y, grid_z )
760
761
762    CHARACTER (LEN=*), INTENT(IN)  ::  var    !< variable name
763    LOGICAL,           INTENT(OUT) ::  found  !< indicates if variable was found
764    CHARACTER (LEN=*), INTENT(OUT) ::  grid_x !< netcdf dimension in x-direction
765    CHARACTER (LEN=*), INTENT(OUT) ::  grid_y !< netcdf dimension in y-direction
766    CHARACTER (LEN=*), INTENT(OUT) ::  grid_z !< netcdf dimension in z-direction
767!
768!-- As long as no action is done in this subroutine, initialize strings with
769!-- intent(out) attribute, in order to avoid compiler warnings.
770    found  = .FALSE.
771    grid_x = 'none'
772    grid_y = 'none'
773    grid_z = 'none'
774!
775!-- Use var to avoid compiler warning about unused variable
776    IF ( var == ' ' )  RETURN
777
778 END SUBROUTINE module_interface_define_netcdf_grid
779
780
781!------------------------------------------------------------------------------!
782! Description:
783! ------------
784!> Allocate module-specific arrays and pointers
785!------------------------------------------------------------------------------!
786 SUBROUTINE module_interface_init_arrays
787
788
789    IF ( bulk_cloud_model    )  CALL bcm_init_arrays
790    IF ( air_chemistry       )  CALL chem_init_arrays
791    IF ( gust_module_enabled )  CALL gust_init_arrays
792    IF ( land_surface        )  CALL lsm_init_arrays
793    IF ( ocean_mode          )  CALL ocean_init_arrays
794    IF ( salsa               )  CALL salsa_init_arrays
795    IF ( urban_surface       )  CALL usm_init_arrays
796    IF ( surface_output      )  CALL surface_data_output_init_arrays
797    IF ( wind_turbine        )  CALL wtm_init_arrays
798    IF ( user_module_enabled )  CALL user_init_arrays
799
800
801 END SUBROUTINE module_interface_init_arrays
802
803
804!------------------------------------------------------------------------------!
805! Description:
806! ------------
807!> Perform module-specific initialization
808!------------------------------------------------------------------------------!
809 SUBROUTINE module_interface_init
810
811
812    IF ( biometeorology      )  CALL bio_init
813    IF ( bulk_cloud_model    )  CALL bcm_init
814    IF ( air_chemistry       )  CALL chem_init
815    IF ( virtual_flight      )  CALL flight_init
816    IF ( gust_module_enabled )  CALL gust_init
817    IF ( indoor_model        )  CALL im_init
818    IF ( large_scale_forcing )  CALL lsf_init
819    IF ( land_surface        )  CALL lsm_init
820    IF ( nudging             )  CALL nudge_init
821    IF ( ocean_mode          )  CALL ocean_init
822    IF ( plant_canopy        )  CALL pcm_init
823    IF ( salsa               )  CALL salsa_init
824    IF ( urban_surface       )  CALL usm_init
825    IF ( virtual_measurement )  CALL vm_init
826    IF ( wind_turbine        )  CALL wtm_init
827    IF ( radiation           )  CALL radiation_init
828    IF ( user_module_enabled )  CALL user_init
829
830
831 END SUBROUTINE module_interface_init
832
833
834!------------------------------------------------------------------------------!
835! Description:
836! ------------
837!> Perform module-specific post-initialization checks
838!------------------------------------------------------------------------------!
839 SUBROUTINE module_interface_init_checks
840
841
842    IF ( biometeorology      )  CALL bio_init_checks
843
844
845 END SUBROUTINE module_interface_init_checks
846
847
848!------------------------------------------------------------------------------!
849! Description:
850! ------------
851!> Gather module-specific header output
852!------------------------------------------------------------------------------!
853 SUBROUTINE module_interface_header( io )
854
855
856    INTEGER(iwp), INTENT(IN) ::  io  !< unit of the output file
857
858
859    IF ( biometeorology      )  CALL bio_header ( io )
860    IF ( bulk_cloud_model    )  CALL bcm_header( io )
861    IF ( air_chemistry       )  CALL chem_header ( io )
862    IF ( virtual_flight      )  CALL flight_header( io )
863    IF ( gust_module_enabled )  CALL gust_header( io )
864    IF ( land_surface        )  CALL lsm_header( io )
865    IF ( large_scale_forcing )  CALL lsf_nudging_header( io )
866    IF ( nesting_offline     )  CALL nesting_offl_header( io )
867    IF ( ocean_mode          )  CALL ocean_header( io )
868    IF ( plant_canopy        )  CALL pcm_header( io )
869    IF ( radiation           )  CALL radiation_header( io )
870    IF ( salsa               )  CALL salsa_header( io )
871    IF ( calculate_spectra   )  CALL spectra_header( io )
872    IF ( syn_turb_gen        )  CALL stg_header( io )
873    IF ( user_module_enabled )  CALL user_header( io )
874
875
876 END SUBROUTINE module_interface_header
877
878
879!------------------------------------------------------------------------------!
880! Description:
881! ------------
882!> Perform module-specific actions while in time-integration (vector-optimized)
883!------------------------------------------------------------------------------!
884 SUBROUTINE module_interface_actions( location )
885
886
887    CHARACTER (LEN=*), INTENT(IN) ::  location !< call location string
888
889
890    IF ( bulk_cloud_model    )  CALL bcm_actions( location )
891    IF ( gust_module_enabled )  CALL gust_actions( location )
892    IF ( ocean_mode          )  CALL ocean_actions( location )
893    IF ( salsa               )  CALL salsa_actions( location )
894    IF ( wind_turbine        )  CALL wtm_actions( location )
895    IF ( user_module_enabled )  CALL user_actions( location )
896
897
898 END SUBROUTINE module_interface_actions
899
900
901!------------------------------------------------------------------------------!
902! Description:
903! ------------
904!> Perform module-specific actions while in time-integration (cache-optimized)
905!------------------------------------------------------------------------------!
906 SUBROUTINE module_interface_actions_ij( i, j, location )
907
908
909    INTEGER(iwp),      INTENT(IN) ::  i         !< grid index in x-direction
910    INTEGER(iwp),      INTENT(IN) ::  j         !< grid index in y-direction
911    CHARACTER (LEN=*), INTENT(IN) ::  location  !< call location string
912
913
914    IF ( bulk_cloud_model    )  CALL bcm_actions( i, j, location )
915    IF ( gust_module_enabled )  CALL gust_actions( i, j, location )
916    IF ( ocean_mode          )  CALL ocean_actions( i, j, location )
917    IF ( salsa               )  CALL salsa_actions( i, j, location )
918    IF ( wind_turbine        )  CALL wtm_actions( i, j, location )
919    IF ( user_module_enabled )  CALL user_actions( i, j, location )
920
921
922 END SUBROUTINE module_interface_actions_ij
923
924
925!------------------------------------------------------------------------------!
926! Description:
927! ------------
928!> Compute module-specific prognostic_equations (vector-optimized)
929!------------------------------------------------------------------------------!
930 SUBROUTINE module_interface_non_transport_physics()
931
932
933    IF ( bulk_cloud_model    )  CALL bcm_non_transport_physics()
934
935
936 END SUBROUTINE module_interface_non_transport_physics
937
938
939!------------------------------------------------------------------------------!
940! Description:
941! ------------
942!> Compute module-specific prognostic_equations (cache-optimized)
943!------------------------------------------------------------------------------!
944 SUBROUTINE module_interface_non_transport_physics_ij( i, j )
945
946
947    INTEGER(iwp), INTENT(IN) ::  i            !< grid index in x-direction
948    INTEGER(iwp), INTENT(IN) ::  j            !< grid index in y-direction
949
950
951    IF ( bulk_cloud_model    )  CALL bcm_non_transport_physics( i, j )
952
953
954 END SUBROUTINE module_interface_non_transport_physics_ij
955
956
957!------------------------------------------------------------------------------!
958! Description:
959! ------------
960!> Compute module-specific prognostic_equations (vector-optimized)
961!------------------------------------------------------------------------------!
962 SUBROUTINE module_interface_prognostic_equations()
963
964
965    IF ( bulk_cloud_model    )  CALL bcm_prognostic_equations()
966    IF ( gust_module_enabled )  CALL gust_prognostic_equations()
967    IF ( ocean_mode          )  CALL ocean_prognostic_equations()
968    IF ( salsa               )  CALL salsa_prognostic_equations()
969
970
971 END SUBROUTINE module_interface_prognostic_equations
972
973
974!------------------------------------------------------------------------------!
975! Description:
976! ------------
977!> Compute module-specific prognostic_equations (cache-optimized)
978!------------------------------------------------------------------------------!
979 SUBROUTINE module_interface_prognostic_equations_ij( i, j, i_omp_start, tn )
980
981
982    INTEGER(iwp), INTENT(IN) ::  i            !< grid index in x-direction
983    INTEGER(iwp), INTENT(IN) ::  j            !< grid index in y-direction
984    INTEGER(iwp), INTENT(IN) ::  i_omp_start  !< first loop index of i-loop in prognostic_equations
985    INTEGER(iwp), INTENT(IN) ::  tn           !< task number of openmp task
986
987
988    IF ( bulk_cloud_model    )  CALL bcm_prognostic_equations( i, j, i_omp_start, tn )
989    IF ( gust_module_enabled )  CALL gust_prognostic_equations( i, j, i_omp_start, tn )
990    IF ( ocean_mode          )  CALL ocean_prognostic_equations( i, j, i_omp_start, tn )
991    IF ( salsa               )  CALL salsa_prognostic_equations( i, j, i_omp_start, tn )
992
993
994 END SUBROUTINE module_interface_prognostic_equations_ij
995
996
997!------------------------------------------------------------------------------!
998! Description:
999! ------------
1000!> Swap the timelevel pointers for module-specific arrays
1001!------------------------------------------------------------------------------!
1002 SUBROUTINE module_interface_swap_timelevel ( swap_mode )
1003
1004
1005    INTEGER(iwp), INTENT(IN) :: swap_mode !< determines procedure of pointer swap
1006
1007    IF ( bulk_cloud_model    )  CALL bcm_swap_timelevel( swap_mode )
1008    IF ( air_chemistry       )  CALL chem_swap_timelevel( swap_mode )
1009    IF ( gust_module_enabled )  CALL gust_swap_timelevel( swap_mode )
1010    IF ( land_surface        )  CALL lsm_swap_timelevel( swap_mode )
1011    IF ( ocean_mode          )  CALL ocean_swap_timelevel( swap_mode )
1012    IF ( salsa               )  CALL salsa_swap_timelevel( swap_mode )
1013    IF ( urban_surface       )  CALL usm_swap_timelevel( swap_mode )
1014
1015
1016 END SUBROUTINE module_interface_swap_timelevel
1017
1018
1019!------------------------------------------------------------------------------!
1020!
1021! Description:
1022! ------------
1023!> Perform module-specific averaging of 3D data
1024!------------------------------------------------------------------------------!
1025 SUBROUTINE module_interface_3d_data_averaging( mode, variable )
1026
1027
1028    CHARACTER (LEN=*), INTENT(IN) ::  mode     !< averaging interface mode
1029    CHARACTER (LEN=*), INTENT(IN) ::  variable !< variable name
1030
1031    IF ( biometeorology      )  CALL bio_3d_data_averaging( mode, variable )
1032    IF ( bulk_cloud_model    )  CALL bcm_3d_data_averaging( mode, variable )
1033    IF ( air_chemistry       )  CALL chem_3d_data_averaging( mode, variable )
1034    IF ( gust_module_enabled )  CALL gust_3d_data_averaging( mode, variable )
1035    IF ( land_surface        )  CALL lsm_3d_data_averaging( mode, variable )
1036    IF ( ocean_mode          )  CALL ocean_3d_data_averaging( mode, variable )
1037    IF ( radiation           )  CALL radiation_3d_data_averaging( mode, variable )
1038    IF ( salsa               )  CALL salsa_3d_data_averaging( mode, variable )
1039    IF ( urban_surface       )  CALL usm_3d_data_averaging( mode, variable )
1040    IF ( user_module_enabled )  CALL user_3d_data_averaging( mode, variable )
1041
1042
1043 END SUBROUTINE module_interface_3d_data_averaging
1044
1045!------------------------------------------------------------------------------!
1046!
1047! Description:
1048! ------------
1049!> Define module-specific 2D output variables
1050!------------------------------------------------------------------------------!
1051 SUBROUTINE module_interface_data_output_2d( av, variable, found, grid, mode,  &
1052                                             local_pf, two_d, nzb_do, nzt_do,  &
1053                                             fill_value )
1054
1055    INTEGER(iwp),      INTENT(IN)    ::  av         !< flag for (non-)average output
1056    CHARACTER (LEN=*), INTENT(IN)    ::  variable   !< variable name
1057    LOGICAL,           INTENT(INOUT) ::  found      !< flag if output variable is found
1058    CHARACTER (LEN=*), INTENT(INOUT) ::  grid       !< name of vertical grid
1059    CHARACTER (LEN=*), INTENT(IN)    ::  mode       !< either 'xy', 'xz' or 'yz'
1060    LOGICAL,           INTENT(OUT)   ::  two_d      !< flag for 2D variables
1061    INTEGER(iwp),      INTENT(IN)    ::  nzb_do     !< vertical output index (bottom) (usually 0)
1062    INTEGER(iwp),      INTENT(IN)    ::  nzt_do     !< vertical output index (top) (usually nz_do3d)
1063    REAL(wp),          INTENT(IN)    ::  fill_value !< to be removed
1064
1065    REAL(wp), DIMENSION(nxl:nxr,nys:nyn,nzb_do:nzt_do), INTENT(OUT) ::  local_pf !< ToDo: can also be kind=sp
1066
1067
1068    IF ( .NOT. found  .AND.  biometeorology )  THEN
1069       CALL bio_data_output_2d(                                                &
1070               av, variable, found, grid, local_pf, two_d, nzb_do, nzt_do      &
1071            )
1072    ENDIF
1073
1074    IF ( .NOT. found  .AND.  bulk_cloud_model )  THEN
1075       CALL bcm_data_output_2d(                                                &
1076               av, variable, found, grid, mode, local_pf, two_d, nzb_do, nzt_do&
1077            )
1078    ENDIF
1079
1080    IF ( .NOT. found  .AND.  air_chemistry )  THEN
1081       CALL chem_data_output_2d(                                               &
1082               av, variable, found, grid, mode, local_pf, two_d, nzb_do, nzt_do, fill_value &
1083            )
1084    ENDIF
1085
1086    IF ( .NOT. found  .AND.  gust_module_enabled )  THEN
1087       CALL gust_data_output_2d(                                               &
1088               av, variable, found, grid, mode, local_pf, two_d, nzb_do, nzt_do, fill_value &
1089            )
1090    ENDIF
1091
1092    IF ( .NOT. found  .AND.  land_surface )  THEN
1093       CALL lsm_data_output_2d(                                                &
1094               av, variable, found, grid, mode, local_pf, two_d, nzb_do, nzt_do&
1095            )
1096    ENDIF
1097
1098    IF ( .NOT. found  .AND.  ocean_mode )  THEN
1099       CALL ocean_data_output_2d(                                              &
1100               av, variable, found, grid, mode, local_pf, nzb_do, nzt_do       &
1101            )
1102    ENDIF
1103
1104    IF ( .NOT. found  .AND.  radiation )  THEN
1105       CALL radiation_data_output_2d(                                          &
1106               av, variable, found, grid, mode, local_pf, two_d, nzb_do, nzt_do&
1107            )
1108    ENDIF
1109
1110    IF ( .NOT. found  .AND.  salsa )  THEN
1111       CALL salsa_data_output_2d(                                              &
1112               av, variable, found, grid, mode, local_pf, two_d, nzb_do, nzt_do&
1113            )
1114    ENDIF
1115
1116    IF ( .NOT. found  .AND.  user_module_enabled )  THEN
1117       CALL user_data_output_2d(                                               &
1118               av, variable, found, grid, local_pf, two_d, nzb_do, nzt_do      &
1119            )
1120    ENDIF
1121
1122 END SUBROUTINE module_interface_data_output_2d
1123
1124
1125!------------------------------------------------------------------------------!
1126!
1127! Description:
1128! ------------
1129!> Define module-specific 3D output variables
1130!------------------------------------------------------------------------------!
1131 SUBROUTINE module_interface_data_output_3d( av, variable, found, local_pf,    &
1132                                             fill_value, resorted, nzb_do, nzt_do )
1133
1134
1135    INTEGER(iwp),      INTENT(IN)    ::  av         !< flag for (non-)average output
1136    CHARACTER (LEN=*), INTENT(IN)    ::  variable   !< variable name
1137    LOGICAL,           INTENT(INOUT) ::  found      !< flag if output variable is found
1138    REAL(wp),          INTENT(IN)    ::  fill_value !< ToDo: refactor
1139    LOGICAL,           INTENT(OUT)   ::  resorted   !< flag if output has been resorted
1140    INTEGER(iwp),      INTENT(IN)    ::  nzb_do     !< vertical output index (bottom) (usually 0)
1141    INTEGER(iwp),      INTENT(IN)    ::  nzt_do     !< vertical output index (top) (usually nz_do3d)
1142
1143    REAL(sp), DIMENSION(nxl:nxr,nys:nyn,nzb_do:nzt_do), INTENT(OUT) ::  local_pf
1144
1145
1146    IF ( .NOT. found  .AND.  biometeorology )  THEN
1147       CALL bio_data_output_3d( av, variable, found, local_pf, nzb_do, nzt_do )
1148       resorted = .FALSE.
1149    ENDIF
1150
1151    IF ( .NOT. found  .AND.  bulk_cloud_model )  THEN
1152       CALL bcm_data_output_3d( av, variable, found, local_pf, nzb_do, nzt_do )
1153       resorted = .TRUE.
1154    ENDIF
1155
1156    IF ( .NOT. found  .AND.  air_chemistry )  THEN
1157       CALL chem_data_output_3d( av, variable, found, local_pf, fill_value, nzb_do, nzt_do )
1158       resorted = .TRUE.
1159    ENDIF
1160
1161    IF ( .NOT. found  .AND.  gust_module_enabled )  THEN
1162       CALL gust_data_output_3d( av, variable, found, local_pf, fill_value, nzb_do, nzt_do )
1163       resorted = .TRUE.
1164    ENDIF
1165   
1166    IF ( .NOT. found  .AND.  indoor_model )  THEN
1167       CALL im_data_output_3d( av, variable, found, local_pf, fill_value, nzb_do, nzt_do )
1168       resorted = .TRUE.
1169    ENDIF
1170
1171    IF ( .NOT. found  .AND.  ocean_mode )  THEN
1172       CALL ocean_data_output_3d( av, variable, found, local_pf, nzb_do, nzt_do )
1173       resorted = .TRUE.
1174    ENDIF
1175
1176    IF ( .NOT. found  .AND.  plant_canopy )  THEN
1177       CALL pcm_data_output_3d( av, variable, found, local_pf, fill_value, nzb_do, nzt_do )
1178       resorted = .TRUE.
1179    ENDIF
1180
1181    IF ( .NOT. found  .AND.  radiation )  THEN
1182       CALL radiation_data_output_3d( av, variable, found, local_pf, nzb_do, nzt_do )
1183       resorted = .TRUE.
1184    ENDIF
1185
1186    IF ( .NOT. found  .AND.  salsa )  THEN
1187       CALL salsa_data_output_3d( av, variable, found, local_pf, nzb_do, nzt_do )
1188       resorted = .TRUE.
1189    ENDIF
1190
1191    IF ( .NOT. found  .AND.  user_module_enabled )  THEN
1192       CALL user_data_output_3d( av, variable, found, local_pf, nzb_do, nzt_do )
1193       resorted = .TRUE.
1194    ENDIF
1195
1196
1197 END SUBROUTINE module_interface_data_output_3d
1198
1199
1200!------------------------------------------------------------------------------!
1201! Description:
1202! ------------
1203!> Compute module-specific profile and timeseries data
1204!------------------------------------------------------------------------------!
1205 SUBROUTINE module_interface_statistics( mode, sr, tn, dots_max )
1206
1207
1208    CHARACTER (LEN=*), INTENT(IN) ::  mode     !< statistical analysis mode
1209    INTEGER(iwp),      INTENT(IN) ::  sr       !<
1210    INTEGER(iwp),      INTENT(IN) ::  tn       !<
1211    INTEGER(iwp),      INTENT(IN) ::  dots_max !< maximum number of timeseries
1212
1213    IF ( gust_module_enabled )  CALL gust_statistics( mode, sr, tn, dots_max )
1214    IF ( air_chemistry       )  CALL chem_statistics( mode, sr, tn )
1215    IF ( user_module_enabled )  CALL user_statistics( mode, sr, tn )
1216
1217
1218 END SUBROUTINE module_interface_statistics
1219
1220
1221!------------------------------------------------------------------------------!
1222! Description:
1223! ------------
1224!> Read module-specific restart data globaly shared by all MPI ranks
1225!------------------------------------------------------------------------------!
1226 SUBROUTINE module_interface_rrd_global( found )
1227
1228
1229    LOGICAL, INTENT(INOUT) ::  found    !< flag if variable was found
1230
1231    IF ( .NOT. found )  CALL bio_rrd_global( found ) ! ToDo: change interface to pass variable
1232    IF ( .NOT. found )  CALL bcm_rrd_global( found ) ! ToDo: change interface to pass variable
1233    IF ( .NOT. found )  CALL flight_rrd_global( found ) ! ToDo: change interface to pass variable
1234    IF ( .NOT. found )  CALL gust_rrd_global( found ) ! ToDo: change interface to pass variable
1235    IF ( .NOT. found )  CALL ocean_rrd_global( found ) ! ToDo: change interface to pass variable
1236    IF ( .NOT. found )  CALL stg_rrd_global ( found ) ! ToDo: change interface to pass variable
1237    IF ( .NOT. found )  CALL wtm_rrd_global( found ) ! ToDo: change interface to pass variable
1238    IF ( .NOT. found )  CALL surface_data_output_rrd_global( found )
1239    IF ( .NOT. found )  CALL user_rrd_global( found ) ! ToDo: change interface to pass variable
1240
1241
1242 END SUBROUTINE module_interface_rrd_global
1243
1244
1245!------------------------------------------------------------------------------!
1246! Description:
1247! ------------
1248!> Write module-specific restart data globaly shared by all MPI ranks
1249!------------------------------------------------------------------------------!
1250 SUBROUTINE module_interface_wrd_global
1251
1252
1253    IF ( biometeorology )       CALL bio_wrd_global
1254    IF ( bulk_cloud_model )     CALL bcm_wrd_global
1255    IF ( virtual_flight )       CALL flight_wrd_global
1256    IF ( gust_module_enabled )  CALL gust_wrd_global
1257    IF ( ocean_mode )           CALL ocean_wrd_global
1258    IF ( syn_turb_gen )         CALL stg_wrd_global
1259    IF ( wind_turbine )         CALL wtm_wrd_global
1260    IF ( surface_output )       CALL surface_data_output_wrd_global
1261    IF ( user_module_enabled )  CALL user_wrd_global
1262
1263
1264 END SUBROUTINE module_interface_wrd_global
1265
1266
1267!------------------------------------------------------------------------------!
1268! Description:
1269! ------------
1270!> Read module-specific restart data specific to local MPI ranks
1271!------------------------------------------------------------------------------!
1272 SUBROUTINE module_interface_rrd_local( map_index,                             &
1273                                        nxlf, nxlc, nxl_on_file,               &
1274                                        nxrf, nxrc, nxr_on_file,               &
1275                                        nynf, nync, nyn_on_file,               &
1276                                        nysf, nysc, nys_on_file,               &
1277                                        tmp_2d, tmp_3d, found )
1278
1279
1280    INTEGER(iwp), INTENT(IN)  ::  map_index    !<
1281    INTEGER(iwp), INTENT(IN)  ::  nxlc         !<
1282    INTEGER(iwp), INTENT(IN)  ::  nxlf         !<
1283    INTEGER(iwp), INTENT(IN)  ::  nxl_on_file  !<
1284    INTEGER(iwp), INTENT(IN)  ::  nxrc         !<
1285    INTEGER(iwp), INTENT(IN)  ::  nxrf         !<
1286    INTEGER(iwp), INTENT(IN)  ::  nxr_on_file  !<
1287    INTEGER(iwp), INTENT(IN)  ::  nync         !<
1288    INTEGER(iwp), INTENT(IN)  ::  nynf         !<
1289    INTEGER(iwp), INTENT(IN)  ::  nyn_on_file  !<
1290    INTEGER(iwp), INTENT(IN)  ::  nysc         !<
1291    INTEGER(iwp), INTENT(IN)  ::  nysf         !<
1292    INTEGER(iwp), INTENT(IN)  ::  nys_on_file  !<
1293    LOGICAL,      INTENT(INOUT) ::  found        !< flag if variable was found
1294
1295    REAL(wp), DIMENSION(nys_on_file-nbgp:nyn_on_file+nbgp,nxl_on_file-nbgp:nxr_on_file+nbgp), INTENT(OUT) :: tmp_2d   !<
1296    REAL(wp), DIMENSION(nzb:nzt+1,nys_on_file-nbgp:nyn_on_file+nbgp,nxl_on_file-nbgp:nxr_on_file+nbgp), INTENT(OUT) :: tmp_3d   !<
1297
1298
1299    IF ( .NOT. found ) CALL bio_rrd_local(                                     &
1300                               found                                           &
1301                            )
1302
1303    IF ( .NOT. found ) CALL bcm_rrd_local(                                     &
1304                               map_index,                                      &
1305                               nxlf, nxlc, nxl_on_file,                        &
1306                               nxrf, nxrc, nxr_on_file,                        &
1307                               nynf, nync, nyn_on_file,                        &
1308                               nysf, nysc, nys_on_file,                        &
1309                               tmp_2d, tmp_3d, found                           &
1310                            ) ! ToDo: change interface to pass variable
1311
1312    IF ( .NOT. found ) CALL chem_rrd_local(                                    &
1313                               map_index,                                      &
1314                               nxlf, nxlc, nxl_on_file,                        &
1315                               nxrf, nxrc, nxr_on_file,                        &
1316                               nynf, nync, nyn_on_file,                        &
1317                               nysf, nysc, nys_on_file,                        &
1318                               tmp_3d, found                                   &
1319                            ) ! ToDo: change interface to pass variable
1320
1321    IF ( .NOT. found ) CALL gust_rrd_local(                                    &
1322                               map_index,                                      &
1323                               nxlf, nxlc, nxl_on_file,                        &
1324                               nxrf, nxrc, nxr_on_file,                        &
1325                               nynf, nync, nyn_on_file,                        &
1326                               nysf, nysc, nys_on_file,                        &
1327                               tmp_2d, tmp_3d, found                           &
1328                            ) ! ToDo: change interface to pass variable
1329
1330    IF ( .NOT. found ) CALL lsm_rrd_local(                                     &
1331                               map_index,                                      &
1332                               nxlf, nxlc, nxl_on_file,                        &
1333                               nxrf, nxrc, nxr_on_file,                        &
1334                               nynf, nync, nyn_on_file,                        &
1335                               nysf, nysc, nys_on_file,                        &
1336                               tmp_2d, found                                   &
1337                            ) ! ToDo: change interface to pass variable
1338
1339    IF ( .NOT. found ) CALL ocean_rrd_local(                                   &
1340                               map_index,                                      &
1341                               nxlf, nxlc, nxl_on_file,                        &
1342                               nxrf, nxrc, nxr_on_file,                        &
1343                               nynf, nync, nyn_on_file,                        &
1344                               nysf, nysc, nys_on_file,                        &
1345                               tmp_3d, found                                   &
1346                            ) ! ToDo: change interface to pass variable
1347
1348    IF ( .NOT. found ) CALL radiation_rrd_local(                               &
1349                               map_index,                                      &
1350                               nxlf, nxlc, nxl_on_file,                        &
1351                               nxrf, nxrc, nxr_on_file,                        &
1352                               nynf, nync, nyn_on_file,                        &
1353                               nysf, nysc, nys_on_file,                        &
1354                               tmp_2d, tmp_3d, found                           &
1355                            ) ! ToDo: change interface to pass variable
1356
1357    IF ( .NOT. found ) CALL salsa_rrd_local(                                   &
1358                               map_index,                                      &
1359                               nxlf, nxlc, nxl_on_file,                        &
1360                               nxrf, nxrc, nxr_on_file,                        &
1361                               nynf, nync, nyn_on_file,                        &
1362                               nysf, nysc, nys_on_file,                        &
1363                               tmp_3d, found                                   &
1364                            ) ! ToDo: change interface to pass variable
1365
1366    IF ( .NOT. found ) CALL usm_rrd_local(                                     &
1367                               map_index,                                      &
1368                               nxlf, nxlc, nxl_on_file,                        &
1369                               nxrf, nxr_on_file,                              &
1370                               nynf, nyn_on_file,                              &
1371                               nysf, nysc, nys_on_file,                        &
1372                               found                                           &
1373                            ) ! ToDo: change interface to pass variable
1374!
1375!-- Surface data do not need overlap data, so do not pass these information.
1376    IF ( .NOT. found ) CALL surface_data_output_rrd_local( found )
1377                           
1378    IF ( .NOT. found ) CALL user_rrd_local(                                    &
1379                               map_index,                                      &
1380                               nxlf, nxlc, nxl_on_file,                        &
1381                               nxrf, nxrc, nxr_on_file,                        &
1382                               nynf, nync, nyn_on_file,                        &
1383                               nysf, nysc, nys_on_file,                        &
1384                               tmp_3d, found                                   &
1385                            ) ! ToDo: change interface to pass variable
1386
1387
1388 END SUBROUTINE module_interface_rrd_local
1389
1390
1391!------------------------------------------------------------------------------!
1392! Description:
1393! ------------
1394!> Write module-specific restart data specific to local MPI ranks
1395!------------------------------------------------------------------------------!
1396 SUBROUTINE module_interface_wrd_local
1397
1398
1399    IF ( biometeorology )       CALL bio_wrd_local
1400    IF ( bulk_cloud_model )     CALL bcm_wrd_local
1401    IF ( air_chemistry )        CALL chem_wrd_local
1402    IF ( gust_module_enabled )  CALL gust_wrd_local
1403    IF ( land_surface )         CALL lsm_wrd_local
1404    IF ( ocean_mode )           CALL ocean_wrd_local
1405    IF ( radiation )            CALL radiation_wrd_local
1406    IF ( salsa )                CALL salsa_wrd_local
1407    IF ( urban_surface )        CALL usm_wrd_local
1408    IF ( surface_output )       CALL surface_data_output_wrd_local
1409    IF ( user_module_enabled )  CALL user_wrd_local
1410
1411
1412 END SUBROUTINE module_interface_wrd_local
1413
1414
1415!------------------------------------------------------------------------------!
1416! Description:
1417! ------------
1418!> Perform module-specific last actions before the program terminates
1419!------------------------------------------------------------------------------!
1420 SUBROUTINE module_interface_last_actions
1421
1422
1423    IF ( virtual_measurement )  CALL vm_last_actions
1424    IF ( user_module_enabled )  CALL user_last_actions
1425
1426
1427 END SUBROUTINE module_interface_last_actions
1428
1429
1430 END MODULE module_interface
Note: See TracBrowser for help on using the repository browser.