Home

Context Navigation

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

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

Note: See TracBrowser for help on using the repository browser.

Download in other formats:

| Impressum | ©Leibniz Universität Hannover |