Home

Context Navigation

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

Last change on this file since 4755 was 4753, checked in by raasch, 4 years ago
files re-formatted to follow the PALM coding standard
Property svn:keywords set to `Id`
File size: 102.3 KB

Line
1	!> @file module_interface.f90
2	!--------------------------------------------------------------------------------------------------!
3	! This file is part of the PALM model system.
4	!
5	! PALM is free software: you can redistribute it and/or modify it under the terms of the GNU General
6	! Public License as published by the Free Software Foundation, either version 3 of the License, or
7	! (at your option) any later version.
8	!
9	! PALM is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the
10	! implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
11	! Public License for more details.
12	!
13	! You should have received a copy of the GNU General Public License along with PALM. If not, see
14	! <http://www.gnu.org/licenses/>.
15	!
16	! Copyright 1997-2020 Leibniz Universitaet Hannover
17	!--------------------------------------------------------------------------------------------------!
18	!
19	! Current revisions:
20	! -----------------
21	!
22	!
23	! Former revisions:
24	! -----------------
25	! $Id: module_interface.f90 4753 2020-10-21 14:55:41Z schwenkel $
26	! file re-formatted to follow the PALM coding standard
27	!
28	! 4731 2020-10-07 13:25:11Z schwenkel
29	! Move exchange_horiz from time_integration to modules
30	!
31	! 4708 2020-09-28 17:42:58Z suehring
32	! pass fillvalue attribute to radiation output
33	!
34	! 4590 2020-07-06 14:34:59Z suehring
35	! Enable mpi-io for biomet
36	!
37	! 4525 2020-05-10 17:05:07Z raasch
38	! added restart I/O for global salsa data,
39	! added restart with MPI-IO for salsa
40	!
41	! 4518 2020-05-04 15:44:28Z suehring
42	! Call of doq_rrd_local enabled
43	!
44	! 4517 2020-05-03 14:29:30Z raasch
45	! added restart with MPI-IO for reading local arrays
46	!
47	! 4514 2020-04-30 16:29:59Z suehring
48	! Added global restart routines for plant-canopy model
49	!
50	! 4495 2020-04-13 20:11:20Z raasch
51	! restart data handling with MPI-IO added
52	!
53	! 4414 2020-02-19 20:16:04Z suehring
54	! Add module interface for basic initialization of numerics.
55	!
56	! 4411 2020-02-18 14:28:02Z maronga
57	! Added output routines for WTM
58	!
59	! 4407 2020-02-13 20:31:44Z knoop
60	! Changed program_debug_output_unit to 9 in dom_init call
61	!
62	! 4400 2020-02-10 20:32:41Z suehring
63	! - Use data-output module for virtual measurement output
64	! - Remove deprecated routines for virtual measurement module
65	!
66	! 4361 2020-01-07 12:22:38Z suehring
67	! Remove unused arrays in pmc_rrd_local
68	!
69	! 4360 2020-01-07 11:25:50Z suehring
70	! Add pcm_rrd_local and pcm_wrd_local
71	!
72	! 4331 2019-12-10 18:25:02Z suehring
73	! Change interface for doq_check_data_output, in order to perform further output checks.
74	!
75	! 4281 2019-10-29 15:15:39Z schwenkel
76	! Added dynamics boundary conditions
77	!
78	! 4272 2019-10-23 15:18:57Z schwenkel
79	! Further modularization of boundary conditions: moved boundary conditions to respective modules
80	!
81	! 4268 2019-10-17 11:29:38Z schwenkel
82	! Introduction of module_interface_boundary_conditions
83	!
84	! 4182 2019-08-22 15:20:23Z scharf
85	! Corrected "Former revisions" section
86	!
87	! 4173 2019-08-20 12:04:06Z gronemeier
88	! add vdi_internal_controls
89	!
90	! 4157 2019-08-14 09:19:12Z suehring
91	! Call doq_init from module interface
92	!
93	! 4132 2019-08-02 12:34:17Z suehring
94	! Bugfix in masked data output for diagnostic quantities
95	!
96	! 4131 2019-08-02 11:06:18Z monakurppa
97	! Add output of 3D plant-canopy outputs (merge from branch resler)
98	!
99	! 4048 2019-06-21 21:00:21Z knoop
100	! Moved turbulence_closure_mod calls into this module_interface
101	!
102	! 4047 2019-06-21 18:58:09Z knoop
103	! Introduction of the dynamics module
104	!
105	! 4039 2019-06-18 10:32:41Z suehring
106	! Introduce diagnostic output
107	!
108	! 4028 2019-06-13 12:21:37Z schwenkel
109	! Further modularization of particle code components
110	!
111	! 4017 2019-06-06 12:16:46Z schwenkel
112	! local_pf need INTENT(INOUT) attribute rather than INTENT(OUT). This is because INTENT(OUT) sets
113	! the array to not-defined. Especially for outputs that are not defined everywhere, e.g.
114	! land-surface outputs, this will be problematic as NaN will be output.
115	!
116	! 3987 2019-05-22 09:52:13Z kanani
117	! Introduce switchable DEBUG file output via debug_message routine
118	!
119	! 3956 2019-05-07 12:32:52Z monakurppa
120	! - Added calls for salsa_non_advective_processes and salsa_exchange_horiz_bounds
121	! - Moved the call for salsa_data_output_2d/3d before that of radiation_data_output_2d/3d.
122	! radiation_data_output_2d/3d tries to read a salsa output variable and encounters a segmentation
123	! fault for "Ntot" due to the shortoutput name
124	!
125	! 3931 2019-04-24 16:34:28Z schwenkel
126	! Changed non_transport_physics to non_advective_processes
127	!
128	! 3930 2019-04-24 14:57:18Z forkel
129	! Correct/complete module_interface introduction for chemistry model
130	!
131	! 3887 2019 -04-12 08:47:41Z schwenkel
132	! Changes related to global restructuring of location messages and introduction of additional debug
133	! messages
134	!
135	! 3880 2019 -04-08 21:43:02Z knoop
136	! Add a call for salsa_prognostic_equations
137	!
138	! 3840 2019-03-29 10:35:52Z knoop
139	! bugfix: intent of dummy arguments changed to inout
140	!
141	! 3770 2019-02-28 11:22:32Z moh.hefny
142	! removed unused variables in module_interface_check_data_output_ts
143	!
144	! 3767 08:18:02Z raasch
145	! unused variable file_index removed from subroutine parameter list
146	!
147	! 3766 2019-02-26 16:23:41Z raasch
148	! first argument removed from module_interface_rrd_*, statement added to avoid compiler warning
149	! about unused variable, file reformatted with respect to coding standards
150	!
151	! 3762 2019-02-25 16:54:16Z suehring
152	! only pass required arguments to surface_data_output_rrd_local
153	!
154	! 3747 2019-02-16 15:15:23Z gronemeier
155	! Call user_init_arrays
156	!
157	! 3745 2019-02-15 18:57:56Z suehring
158	! Add indoor model
159	!
160	! 3744 2019-02-15 18:38:58Z suehring
161	! Removed bio_check_parameters as the method is empty.
162	!
163	! 3735 2019-02-12 09:52:40Z dom_dwd_user
164	! Accepting variable j from check_parameters and passing it to bio_check_data_output
165	! Add required restart data for surface output module
166	!
167	! 3731 2019-02-11 13:06:27Z suehring
168	! Add check_parameters routine for virtual measurements
169	!
170	! 3711 2019-01-31 13:44:26Z knoop
171	! Introduced module_interface_init_checks for post-init checks
172	!
173	! 3705 2019-01-29 19:56:39Z suehring
174	! Add last_actions for virtual measurements
175	!
176	! 3704 2019-01-29 19:51:41Z suehring
177	! Some interface calls moved to module_interface + cleanup
178	!
179	! 3684 2019-01-20 20:20:58Z knoop
180	! Bugfix: made unit intend INOUT
181	!
182	! 3650 2019-01-04 13:01:33Z kanani
183	! Add restart routines for biometeorology
184	!
185	! 3649 2019-01-02 16:52:21Z suehring
186	! Initialize strings, in order to avoid compiler warnings for non-initialized characters with
187	! intent(out) attribute
188	!
189	! 3648 2019-01-02 16:35:46Z suehring
190	! 3641 2018-12-23 22:10:01Z knoop
191	! Initial implementation of the PALM module interface
192	!
193	!
194	! Description:
195	! ------------
196	!> This is the interface between the PALM model core and all its modules.
197	!>
198	!> @todo Re-format module to be consistent with coding standard
199	!--------------------------------------------------------------------------------------------------!
200	MODULE module_interface
201
202	USE indices, &
203	ONLY: nbgp, nxl, nxlg, nxr, nxrg, nys, nysg, nyn, nyng, nzb, nzt
204
205	USE kinds
206
207	USE pegrid, &
208	ONLY: comm2d
209
210	!
211	!-- load module-specific control parameters.
212	!-- ToDo: move all of them to respective module or a dedicated central module
213	USE data_output_module, &
214	ONLY: dom_def_end, &
215	dom_finalize_output, &
216	dom_init
217
218	USE dynamics_mod, &
219	ONLY: dynamics_3d_data_averaging, &
220	dynamics_actions, &
221	dynamics_boundary_conditions, &
222	dynamics_check_data_output, &
223	dynamics_check_data_output_pr, &
224	dynamics_check_data_output_ts, &
225	dynamics_check_parameters, &
226	dynamics_data_output_2d, &
227	dynamics_data_output_3d, &
228	dynamics_define_netcdf_grid, &
229	dynamics_exchange_horiz, &
230	dynamics_header, &
231	dynamics_init, &
232	dynamics_init_arrays, &
233	dynamics_init_checks, &
234	dynamics_init_masks, &
235	dynamics_last_actions, &
236	dynamics_non_advective_processes, &
237	dynamics_parin, &
238	dynamics_prognostic_equations, &
239	dynamics_rrd_global, &
240	dynamics_rrd_local, &
241	dynamics_statistics, &
242	dynamics_swap_timelevel, &
243	dynamics_wrd_global, &
244	dynamics_wrd_local
245
246	USE turbulence_closure_mod, &
247	ONLY: tcm_3d_data_averaging, &
248	tcm_actions, &
249	tcm_boundary_conds, &
250	tcm_check_data_output, &
251	tcm_check_parameters, &
252	tcm_data_output_2d, &
253	tcm_data_output_3d, &
254	tcm_init, &
255	tcm_init_arrays, &
256	tcm_prognostic_equations, &
257	tcm_swap_timelevel
258
259	USE control_parameters, &
260	ONLY: air_chemistry, &
261	biometeorology, &
262	coupling_char, &
263	debug_output, &
264	debug_output_timestep, &
265	indoor_model, &
266	land_surface, &
267	large_scale_forcing, &
268	nesting_offline, &
269	nudging, &
270	ocean_mode, &
271	plant_canopy, &
272	salsa, &
273	surface_output, &
274	syn_turb_gen, &
275	urban_surface, &
276	vdi_checks, &
277	virtual_flight, &
278	virtual_measurement, &
279	wind_turbine
280
281	!
282	!-- Load interface routines of all PALM modules
283	USE biometeorology_mod, &
284	ONLY: bio_3d_data_averaging, &
285	bio_check_data_output, &
286	bio_data_output_2d, &
287	bio_data_output_3d, &
288	bio_init, &
289	bio_init_checks, &
290	bio_header, &
291	bio_parin, &
292	bio_rrd_global, &
293	bio_rrd_local, &
294	bio_wrd_global, &
295	bio_wrd_local
296
297	USE bulk_cloud_model_mod, &
298	ONLY: bcm_3d_data_averaging, &
299	bcm_actions, &
300	bcm_boundary_conditions, &
301	bcm_check_data_output_pr, &
302	bcm_check_data_output, &
303	bcm_check_parameters, &
304	bcm_data_output_2d, &
305	bcm_data_output_3d, &
306	bcm_exchange_horiz, &
307	bcm_header, &
308	bcm_init_arrays, &
309	bcm_init, &
310	bcm_non_advective_processes, &
311	bcm_parin, &
312	bcm_prognostic_equations, &
313	bcm_rrd_global, &
314	bcm_rrd_local, &
315	bcm_swap_timelevel, &
316	bcm_wrd_global, &
317	bcm_wrd_local, &
318	bulk_cloud_model
319
320	USE chemistry_model_mod, &
321	ONLY: chem_3d_data_averaging, &
322	chem_actions, &
323	chem_boundary_conditions, &
324	chem_check_data_output, &
325	chem_check_data_output_pr, &
326	chem_check_parameters, &
327	chem_data_output_2d, &
328	chem_data_output_3d, &
329	chem_exchange_horiz_bounds, &
330	chem_header, &
331	chem_init, &
332	chem_init_arrays, &
333	chem_non_advective_processes, &
334	chem_parin, &
335	chem_prognostic_equations, &
336	chem_rrd_local, &
337	chem_statistics, &
338	chem_swap_timelevel, &
339	chem_wrd_local
340
341	USE diagnostic_output_quantities_mod, &
342	ONLY: doq_3d_data_averaging, &
343	doq_check_data_output, &
344	doq_define_netcdf_grid, &
345	doq_init, &
346	doq_output_2d, &
347	doq_output_3d, &
348	doq_rrd_local, &
349	doq_wrd_local
350
351	USE flight_mod, &
352	ONLY: flight_header, &
353	flight_init, &
354	flight_parin, &
355	flight_rrd_global, &
356	flight_wrd_global
357
358	USE gust_mod, &
359	ONLY: gust_3d_data_averaging, &
360	gust_actions, &
361	gust_check_parameters, &
362	gust_check_data_output, &
363	gust_check_data_output_pr, &
364	gust_data_output_2d, &
365	gust_data_output_3d, &
366	gust_header, &
367	gust_init, &
368	gust_init_arrays, &
369	gust_module_enabled, &
370	gust_parin, &
371	gust_prognostic_equations, &
372	gust_rrd_global, &
373	gust_rrd_local, &
374	gust_statistics, &
375	gust_swap_timelevel, &
376	gust_wrd_global, &
377	gust_wrd_local
378
379	USE indoor_model_mod, &
380	ONLY: im_check_data_output, &
381	im_check_parameters, &
382	im_data_output_3d, &
383	im_init, &
384	im_parin
385
386	USE lagrangian_particle_model_mod, &
387	ONLY: lpm_actions, &
388	lpm_check_parameters, &
389	lpm_exchange_horiz_bounds, &
390	lpm_header, &
391	lpm_init, &
392	lpm_init_arrays, &
393	lpm_parin, &
394	lpm_rrd_global, &
395	lpm_rrd_local, &
396	lpm_wrd_local, &
397	lpm_wrd_global
398
399	USE land_surface_model_mod, &
400	ONLY: lsm_3d_data_averaging, &
401	lsm_check_parameters, &
402	lsm_check_data_output, &
403	lsm_check_data_output_pr, &
404	lsm_data_output_2d, &
405	lsm_header, &
406	lsm_init, &
407	lsm_init_arrays, &
408	lsm_parin, &
409	lsm_rrd_local, &
410	lsm_swap_timelevel, &
411	lsm_wrd_local
412
413	USE lsf_nudging_mod, &
414	ONLY: lsf_nudging_check_parameters, &
415	lsf_nudging_check_data_output_pr, &
416	lsf_nudging_header, &
417	lsf_init, &
418	nudge_init
419
420	USE multi_agent_system_mod, &
421	ONLY: mas_parin
422
423	USE nesting_offl_mod, &
424	ONLY: nesting_offl_check_parameters, &
425	nesting_offl_header, &
426	nesting_offl_parin
427
428	USE ocean_mod, &
429	ONLY: ocean_3d_data_averaging, &
430	ocean_actions, &
431	ocean_boundary_conditions, &
432	ocean_check_parameters, &
433	ocean_check_data_output, &
434	ocean_check_data_output_pr, &
435	ocean_data_output_2d, &
436	ocean_data_output_3d, &
437	ocean_exchange_horiz, &
438	ocean_init_arrays, &
439	ocean_init, &
440	ocean_header, &
441	ocean_parin, &
442	ocean_prognostic_equations, &
443	ocean_rrd_global, &
444	ocean_rrd_local, &
445	ocean_swap_timelevel, &
446	ocean_wrd_global, &
447	ocean_wrd_local
448
449	USE particle_attributes, &
450	ONLY: particle_advection
451
452	USE poismg_noopt_mod, &
453	ONLY: poismg_noopt_init
454
455	USE plant_canopy_model_mod, &
456	ONLY: pcm_3d_data_averaging, &
457	pcm_check_parameters, &
458	pcm_check_data_output, &
459	pcm_data_output_3d, &
460	pcm_header, &
461	pcm_init, &
462	pcm_parin, &
463	pcm_rrd_global, &
464	pcm_rrd_local, &
465	pcm_wrd_global, &
466	pcm_wrd_local
467
468	USE radiation_model_mod, &
469	ONLY: radiation, &
470	radiation_3d_data_averaging, &
471	radiation_check_parameters, &
472	radiation_check_data_output, &
473	radiation_check_data_output_pr, &
474	radiation_check_data_output_ts, &
475	radiation_data_output_2d, &
476	radiation_data_output_3d, &
477	radiation_header, &
478	radiation_init, &
479	radiation_parin, &
480	radiation_rrd_local, &
481	radiation_wrd_local
482
483	USE salsa_mod, &
484	ONLY: salsa_3d_data_averaging, &
485	salsa_actions, &
486	salsa_boundary_conditions, &
487	salsa_check_data_output, &
488	salsa_check_data_output_pr, &
489	salsa_check_parameters, &
490	salsa_data_output_2d, &
491	salsa_data_output_3d, &
492	salsa_exchange_horiz_bounds, &
493	salsa_header, &
494	salsa_init, &
495	salsa_init_arrays, &
496	salsa_non_advective_processes, &
497	salsa_parin, &
498	salsa_prognostic_equations, &
499	salsa_rrd_global, &
500	salsa_rrd_local, &
501	salsa_statistics, &
502	salsa_swap_timelevel, &
503	salsa_wrd_global, &
504	salsa_wrd_local
505
506	USE spectra_mod, &
507	ONLY: calculate_spectra, &
508	spectra_check_parameters, &
509	spectra_header, &
510	spectra_parin
511
512	USE surface_data_output_mod, &
513	ONLY: surface_data_output_check_parameters, &
514	surface_data_output_init_arrays, &
515	surface_data_output_parin, &
516	surface_data_output_rrd_global, &
517	surface_data_output_rrd_local, &
518	surface_data_output_wrd_global, &
519	surface_data_output_wrd_local
520
521	USE surface_mod, &
522	ONLY: init_bc
523
524	USE synthetic_turbulence_generator_mod, &
525	ONLY: stg_check_parameters, &
526	stg_header, &
527	stg_parin, &
528	stg_rrd_global, &
529	stg_wrd_global
530
531	USE urban_surface_mod, &
532	ONLY: usm_3d_data_averaging, &
533	usm_check_data_output, &
534	usm_check_parameters, &
535	usm_init, &
536	usm_init_arrays, &
537	usm_parin, &
538	usm_swap_timelevel, &
539	usm_rrd_local, &
540	usm_wrd_local
541
542	USE vdi_internal_controls, &
543	ONLY: vdi_actions
544
545	USE virtual_measurement_mod, &
546	ONLY: vm_check_parameters, &
547	vm_init, &
548	vm_init_output, &
549	vm_parin
550
551	USE wind_turbine_model_mod, &
552	ONLY: wtm_actions, &
553	wtm_check_parameters, &
554	wtm_init, &
555	wtm_init_arrays, &
556	wtm_init_output, &
557	wtm_parin, &
558	wtm_rrd_global, &
559	wtm_wrd_global
560
561	USE user, &
562	ONLY: user_3d_data_averaging, &
563	user_actions, &
564	user_check_data_output, &
565	user_check_data_output_pr, &
566	user_check_data_output_ts, &
567	user_check_parameters, &
568	user_data_output_2d, &
569	user_data_output_3d, &
570	user_header, &
571	user_init, &
572	user_init_arrays, &
573	user_last_actions, &
574	user_module_enabled, &
575	user_parin, &
576	user_statistics, &
577	user_rrd_global, &
578	user_rrd_local, &
579	user_wrd_global, &
580	user_wrd_local
581
582	IMPLICIT NONE
583
584	PRIVATE
585
586	!
587	!-- Public functions
588	PUBLIC &
589	module_interface_parin, &
590	module_interface_check_parameters, &
591	module_interface_check_data_output_ts, &
592	module_interface_check_data_output_pr, &
593	module_interface_check_data_output, &
594	module_interface_init_masks, &
595	module_interface_define_netcdf_grid, &
596	module_interface_init_arrays, &
597	module_interface_init, &
598	module_interface_init_checks, &
599	module_interface_init_numerics, &
600	module_interface_init_output, &
601	module_interface_header, &
602	module_interface_actions, &
603	module_interface_non_advective_processes, &
604	module_interface_exchange_horiz, &
605	module_interface_prognostic_equations, &
606	module_interface_boundary_conditions, &
607	module_interface_swap_timelevel, &
608	module_interface_3d_data_averaging, &
609	module_interface_data_output_2d, &
610	module_interface_data_output_3d, &
611	module_interface_statistics, &
612	module_interface_rrd_global, &
613	module_interface_wrd_global, &
614	module_interface_rrd_local, &
615	module_interface_wrd_local, &
616	module_interface_last_actions
617
618
619	INTERFACE module_interface_parin
620	MODULE PROCEDURE module_interface_parin
621	END INTERFACE module_interface_parin
622
623	INTERFACE module_interface_check_parameters
624	MODULE PROCEDURE module_interface_check_parameters
625	END INTERFACE module_interface_check_parameters
626
627	INTERFACE module_interface_check_data_output_ts
628	MODULE PROCEDURE module_interface_check_data_output_ts
629	END INTERFACE module_interface_check_data_output_ts
630
631	INTERFACE module_interface_check_data_output_pr
632	MODULE PROCEDURE module_interface_check_data_output_pr
633	END INTERFACE module_interface_check_data_output_pr
634
635	INTERFACE module_interface_check_data_output
636	MODULE PROCEDURE module_interface_check_data_output
637	END INTERFACE module_interface_check_data_output
638
639	INTERFACE module_interface_init_masks
640	MODULE PROCEDURE module_interface_init_masks
641	END INTERFACE module_interface_init_masks
642
643	INTERFACE module_interface_define_netcdf_grid
644	MODULE PROCEDURE module_interface_define_netcdf_grid
645	END INTERFACE module_interface_define_netcdf_grid
646
647	INTERFACE module_interface_init_arrays
648	MODULE PROCEDURE module_interface_init_arrays
649	END INTERFACE module_interface_init_arrays
650
651	INTERFACE module_interface_init
652	MODULE PROCEDURE module_interface_init
653	END INTERFACE module_interface_init
654
655	INTERFACE module_interface_init_checks
656	MODULE PROCEDURE module_interface_init_checks
657	END INTERFACE module_interface_init_checks
658
659	INTERFACE module_interface_init_numerics
660	MODULE PROCEDURE module_interface_init_numerics
661	END INTERFACE module_interface_init_numerics
662
663	INTERFACE module_interface_init_output
664	MODULE PROCEDURE module_interface_init_output
665	END INTERFACE module_interface_init_output
666
667	INTERFACE module_interface_header
668	MODULE PROCEDURE module_interface_header
669	END INTERFACE module_interface_header
670
671	INTERFACE module_interface_actions
672	MODULE PROCEDURE module_interface_actions
673	MODULE PROCEDURE module_interface_actions_ij
674	END INTERFACE module_interface_actions
675
676	INTERFACE module_interface_non_advective_processes
677	MODULE PROCEDURE module_interface_non_advective_processes
678	MODULE PROCEDURE module_interface_non_advective_processes_ij
679	END INTERFACE module_interface_non_advective_processes
680
681	INTERFACE module_interface_exchange_horiz
682	MODULE PROCEDURE module_interface_exchange_horiz
683	END INTERFACE module_interface_exchange_horiz
684
685	INTERFACE module_interface_prognostic_equations
686	MODULE PROCEDURE module_interface_prognostic_equations
687	MODULE PROCEDURE module_interface_prognostic_equations_ij
688	END INTERFACE module_interface_prognostic_equations
689
690	INTERFACE module_interface_swap_timelevel
691	MODULE PROCEDURE module_interface_swap_timelevel
692	END INTERFACE module_interface_swap_timelevel
693
694	INTERFACE module_interface_boundary_conditions
695	MODULE PROCEDURE module_interface_boundary_conditions
696	END INTERFACE module_interface_boundary_conditions
697
698	INTERFACE module_interface_3d_data_averaging
699	MODULE PROCEDURE module_interface_3d_data_averaging
700	END INTERFACE module_interface_3d_data_averaging
701
702	INTERFACE module_interface_data_output_2d
703	MODULE PROCEDURE module_interface_data_output_2d
704	END INTERFACE module_interface_data_output_2d
705
706	INTERFACE module_interface_data_output_3d
707	MODULE PROCEDURE module_interface_data_output_3d
708	END INTERFACE module_interface_data_output_3d
709
710	INTERFACE module_interface_statistics
711	MODULE PROCEDURE module_interface_statistics
712	END INTERFACE module_interface_statistics
713
714	INTERFACE module_interface_rrd_global
715	MODULE PROCEDURE module_interface_rrd_global_ftn
716	MODULE PROCEDURE module_interface_rrd_global_mpi
717	END INTERFACE module_interface_rrd_global
718
719	INTERFACE module_interface_wrd_global
720	MODULE PROCEDURE module_interface_wrd_global
721	END INTERFACE module_interface_wrd_global
722
723	INTERFACE module_interface_rrd_local
724	MODULE PROCEDURE module_interface_rrd_local_ftn
725	MODULE PROCEDURE module_interface_rrd_local_mpi
726	END INTERFACE module_interface_rrd_local
727
728	INTERFACE module_interface_wrd_local
729	MODULE PROCEDURE module_interface_wrd_local
730	END INTERFACE module_interface_wrd_local
731
732	INTERFACE module_interface_last_actions
733	MODULE PROCEDURE module_interface_last_actions
734	END INTERFACE module_interface_last_actions
735
736
737	CONTAINS
738
739
740	!--------------------------------------------------------------------------------------------------!
741	! Description:
742	! ------------
743	!> Read module-specific parameter namelists
744	!------------------------------------------------------------------------------ !
745	SUBROUTINE module_interface_parin
746
747
748	IF ( debug_output ) CALL debug_message( 'reading module-specific parameters', 'start' )
749
750	CALL dynamics_parin
751
752	CALL bio_parin
753	CALL bcm_parin
754	CALL chem_parin
755	CALL flight_parin ! ToDo: rename module to match filename
756	CALL gust_parin
757	CALL im_parin
758	CALL lpm_parin
759	CALL lsm_parin
760	! ToDo: create parin routine for large_scale_forcing and nudging (should be seperate modules or new module switch)
761	CALL mas_parin
762	CALL nesting_offl_parin
763	CALL ocean_parin
764	CALL pcm_parin
765	CALL radiation_parin
766	CALL salsa_parin
767	CALL spectra_parin
768	CALL surface_data_output_parin
769	CALL stg_parin
770	CALL usm_parin
771	CALL vm_parin
772	CALL wtm_parin
773
774	CALL user_parin
775
776	IF ( debug_output ) CALL debug_message( 'reading module-specific parameters', 'end' )
777
778
779	END SUBROUTINE module_interface_parin
780
781
782	!--------------------------------------------------------------------------------------------------!
783	! Description:
784	! ------------
785	!> Perform module-specific initialization checks
786	!--------------------------------------------------------------------------------------------------!
787	SUBROUTINE module_interface_check_parameters
788
789
790	IF ( debug_output ) CALL debug_message( 'checking module-specific parameters', 'start' )
791
792	CALL dynamics_check_parameters
793	CALL tcm_check_parameters
794
795	IF ( bulk_cloud_model ) CALL bcm_check_parameters
796	IF ( air_chemistry ) CALL chem_check_parameters
797	IF ( gust_module_enabled ) CALL gust_check_parameters
798	IF ( indoor_model ) CALL im_check_parameters
799	IF ( particle_advection ) CALL lpm_check_parameters
800	IF ( land_surface ) CALL lsm_check_parameters
801	IF ( large_scale_forcing .OR. nudging ) CALL lsf_nudging_check_parameters ! ToDo: create single module switch
802	IF ( nesting_offline ) CALL nesting_offl_check_parameters
803	IF ( ocean_mode ) CALL ocean_check_parameters
804	IF ( plant_canopy ) CALL pcm_check_parameters
805	IF ( radiation ) CALL radiation_check_parameters
806	IF ( salsa ) CALL salsa_check_parameters
807	IF ( calculate_spectra ) CALL spectra_check_parameters
808	IF ( surface_output ) CALL surface_data_output_check_parameters
809	IF ( syn_turb_gen ) CALL stg_check_parameters
810	IF ( urban_surface ) CALL usm_check_parameters
811	IF ( virtual_measurement ) CALL vm_check_parameters
812	IF ( wind_turbine ) CALL wtm_check_parameters
813
814	IF ( user_module_enabled ) CALL user_check_parameters
815
816	IF ( debug_output ) CALL debug_message( 'checking module-specific parameters', 'end' )
817
818
819	END SUBROUTINE module_interface_check_parameters
820
821
822	!--------------------------------------------------------------------------------------------------!
823	! Description:
824	! ------------
825	!> Check module-specific data output of timeseries
826	!--------------------------------------------------------------------------------------------------!
827	SUBROUTINE module_interface_check_data_output_ts( dots_max, dots_num, dots_label, dots_unit )
828
829	INTEGER(iwp), INTENT(IN) :: dots_max !< variable output array index
830	INTEGER(iwp), INTENT(INOUT) :: dots_num !< variable output array index
831
832	CHARACTER (LEN=*), DIMENSION(dots_max), INTENT(INOUT) :: dots_label
833	CHARACTER (LEN=*), DIMENSION(dots_max), INTENT(INOUT) :: dots_unit
834
835
836	IF ( debug_output ) CALL debug_message( 'checking module-specific data output ts', 'start' )
837
838	CALL dynamics_check_data_output_ts( dots_max, dots_num, dots_label, dots_unit )
839
840	IF ( radiation ) THEN
841	CALL radiation_check_data_output_ts( dots_max, dots_num )
842	ENDIF
843
844	IF ( user_module_enabled ) THEN
845	CALL user_check_data_output_ts( dots_max, dots_num, dots_label, dots_unit )
846	ENDIF
847
848	IF ( debug_output ) CALL debug_message( 'checking module-specific data output ts', 'end' )
849
850
851	END SUBROUTINE module_interface_check_data_output_ts
852
853
854	!--------------------------------------------------------------------------------------------------!
855	! Description:
856	! ------------
857	!> Check module-specific data output of profiles
858	!--------------------------------------------------------------------------------------------------!
859	SUBROUTINE module_interface_check_data_output_pr( variable, var_count, unit, dopr_unit )
860
861
862	CHARACTER (LEN=*), INTENT(IN) :: variable !< variable name
863	CHARACTER (LEN=*), INTENT(INOUT) :: unit !< physical unit of variable
864	CHARACTER (LEN=*), INTENT(OUT) :: dopr_unit !< local value of dopr_unit
865
866	INTEGER(iwp), INTENT(IN) :: var_count !< variable output array index
867
868
869	IF ( debug_output ) CALL debug_message( 'checking module-specific data output pr', 'start' )
870
871	CALL dynamics_check_data_output_pr( variable, var_count, unit, dopr_unit )
872
873	IF ( unit == 'illegal' .AND. bulk_cloud_model ) THEN
874	CALL bcm_check_data_output_pr( variable, var_count, unit, dopr_unit )
875	ENDIF
876
877	IF ( unit == 'illegal' .AND. air_chemistry ) THEN
878	CALL chem_check_data_output_pr( variable, var_count, unit, dopr_unit )
879	ENDIF
880
881	IF ( unit == 'illegal' .AND. gust_module_enabled ) THEN
882	CALL gust_check_data_output_pr( variable, var_count, unit, dopr_unit )
883	ENDIF
884
885	IF ( unit == 'illegal' ) THEN ! ToDo: add module switch if possible
886	CALL lsm_check_data_output_pr( variable, var_count, unit, dopr_unit )
887	ENDIF
888
889	IF ( unit == 'illegal' ) THEN ! ToDo: add module switch if possible
890	CALL lsf_nudging_check_data_output_pr( variable, var_count, unit, dopr_unit )
891	ENDIF
892
893	IF ( unit == 'illegal' .AND. ocean_mode ) THEN
894	CALL ocean_check_data_output_pr( variable, var_count, unit, dopr_unit )
895	ENDIF
896
897	IF ( unit == 'illegal' .AND. radiation ) THEN
898	CALL radiation_check_data_output_pr( variable, var_count, unit, dopr_unit )
899	ENDIF
900
901	IF ( unit == 'illegal' .AND. salsa ) THEN
902	CALL salsa_check_data_output_pr( variable, var_count, unit, dopr_unit )
903	ENDIF
904
905	IF ( unit == 'illegal' .AND. user_module_enabled ) THEN
906	unit = '' ! ToDo: Seems like a hack. Find a general soultion!
907	CALL user_check_data_output_pr( variable, var_count, unit, dopr_unit )
908	ENDIF
909
910	IF ( debug_output ) CALL debug_message( 'checking module-specific data output pr', 'end' )
911
912
913	END SUBROUTINE module_interface_check_data_output_pr
914
915	!--------------------------------------------------------------------------------------------------!
916	! Description:
917	! ------------
918	!> Check module-specific 2D and 3D data output
919	!--------------------------------------------------------------------------------------------------!
920	SUBROUTINE module_interface_check_data_output( variable, unit, i, j, ilen, k )
921
922
923	CHARACTER (LEN=*), INTENT(IN) :: variable !< variable name
924	CHARACTER (LEN=*), INTENT(INOUT) :: unit !< physical unit of variable
925
926	INTEGER(iwp), INTENT(IN) :: i !< ToDo: remove dummy argument, instead pass string from data_output
927	INTEGER(iwp), INTENT(IN) :: j !< average quantity? 0 = no, 1 = yes
928	INTEGER(iwp), INTENT(IN) :: ilen !< ToDo: remove dummy argument, instead pass string from data_output
929	INTEGER(iwp), INTENT(IN) :: k !< ToDo: remove dummy argument, instead pass string from data_output
930
931
932	IF ( debug_output ) CALL debug_message( 'checking module-specific data output 2d/3d', 'start' )
933
934	CALL dynamics_check_data_output( variable, unit )
935
936	CALL tcm_check_data_output( variable, unit )
937
938	IF ( unit == 'illegal' .AND. biometeorology ) THEN
939	CALL bio_check_data_output( variable, unit, i, j, ilen, k )
940	ENDIF
941
942	IF ( unit == 'illegal' .AND. bulk_cloud_model ) THEN
943	CALL bcm_check_data_output( variable, unit )
944	ENDIF
945
946	IF ( unit == 'illegal' .AND. air_chemistry .AND. (variable(1:3) == 'kc_' .OR. &
947	variable(1:3) == 'em_') ) THEN ! ToDo: remove aditional conditions
948	CALL chem_check_data_output( variable, unit, i, ilen, k )
949	ENDIF
950
951	IF ( unit == 'illegal' ) THEN
952	CALL doq_check_data_output( variable, unit, i, ilen, k )
953	ENDIF
954
955	IF ( unit == 'illegal' .AND. gust_module_enabled ) THEN
956	CALL gust_check_data_output( variable, unit )
957	ENDIF
958
959	IF ( unit == 'illegal' ) THEN ! ToDo: add module switch if possible
960	CALL lsm_check_data_output( variable, unit, i, ilen, k )
961	ENDIF
962
963	IF ( unit == 'illegal' .AND. ocean_mode ) THEN
964	CALL ocean_check_data_output( variable, unit )
965	ENDIF
966
967	IF ( unit == 'illegal' .AND. plant_canopy .AND. variable(1:4) == 'pcm_' ) THEN ! ToDo: remove aditional conditions
968	CALL pcm_check_data_output( variable, unit )
969	ENDIF
970
971	IF ( unit == 'illegal' .AND. radiation ) THEN
972	CALL radiation_check_data_output( variable, unit, i, ilen, k )
973	ENDIF
974
975	IF ( unit == 'illegal' .AND. salsa ) THEN
976	CALL salsa_check_data_output( variable, unit )
977	ENDIF
978
979	IF ( unit == 'illegal' .AND. indoor_model ) THEN
980	CALL im_check_data_output( variable, unit )
981	ENDIF
982
983	IF ( unit == 'illegal' .AND. urban_surface .AND. variable(1:4) == 'usm_' ) THEN ! ToDo: remove aditional conditions
984	CALL usm_check_data_output( variable, unit )
985	ENDIF
986
987	IF ( unit == 'illegal' .AND. user_module_enabled ) THEN
988	unit = ''
989	CALL user_check_data_output( variable, unit )
990	ENDIF
991
992	IF ( debug_output ) CALL debug_message( 'checking module-specific data output 2d/3d', 'end' )
993
994
995	END SUBROUTINE module_interface_check_data_output
996
997
998	!--------------------------------------------------------------------------------------------------!
999	!
1000	! Description:
1001	! ------------
1002	!> Interface for init_masks. ToDo: get rid of these redundant calls!
1003	!--------------------------------------------------------------------------------------------------!
1004	SUBROUTINE module_interface_init_masks( variable, unit )
1005
1006
1007	CHARACTER (LEN=*), INTENT(IN) :: variable !< variable name
1008	CHARACTER (LEN=*), INTENT(INOUT) :: unit !< physical unit of variable
1009
1010
1011	IF ( debug_output ) CALL debug_message( 'initializing module-specific masks', 'start' )
1012
1013	CALL dynamics_init_masks( variable, unit )
1014
1015	IF ( unit == 'illegal' .AND. air_chemistry .AND. (variable(1:3) == 'kc_' .OR. &
1016	variable(1:3) == 'em_') ) THEN ! ToDo: remove aditional conditions
1017	CALL chem_check_data_output( variable, unit, 0, 0, 0 )
1018	ENDIF
1019
1020	IF ( unit == 'illegal' ) THEN
1021	CALL doq_check_data_output( variable, unit )
1022	ENDIF
1023
1024	IF ( unit == 'illegal' .AND. radiation ) THEN
1025	CALL radiation_check_data_output( variable, unit, 0, 0, 0 )
1026	ENDIF
1027
1028	IF ( unit == 'illegal' .AND. salsa ) THEN
1029	CALL salsa_check_data_output( variable, unit )
1030	ENDIF
1031
1032	IF ( unit == 'illegal' .AND. user_module_enabled ) THEN
1033	unit = ''
1034	CALL user_check_data_output( variable, unit )
1035	ENDIF
1036
1037	IF ( debug_output ) CALL debug_message( 'initializing module-specific masks', 'end' )
1038
1039
1040	END SUBROUTINE module_interface_init_masks
1041
1042
1043	!--------------------------------------------------------------------------------------------------!
1044	!
1045	! Description:
1046	! ------------
1047	!> Define appropriate grid for module-specific netcdf output variables.
1048	!--------------------------------------------------------------------------------------------------!
1049	SUBROUTINE module_interface_define_netcdf_grid( var, found, grid_x, grid_y, grid_z )
1050
1051
1052	CHARACTER (LEN=*), INTENT(IN) :: var !< variable name
1053	CHARACTER (LEN=*), INTENT(OUT) :: grid_x !< netcdf dimension in x-direction
1054	CHARACTER (LEN=*), INTENT(OUT) :: grid_y !< netcdf dimension in y-direction
1055	CHARACTER (LEN=*), INTENT(OUT) :: grid_z !< netcdf dimension in z-direction
1056
1057	LOGICAL, INTENT(OUT) :: found !< indicates if variable was found
1058
1059
1060	IF ( debug_output ) CALL debug_message( 'defining module-specific netcdf grids', 'start' )
1061	!
1062	!-- As long as no action is done in this subroutine, initialize strings with intent(out) attribute,
1063	!-- in order to avoid compiler warnings.
1064	found = .FALSE.
1065	grid_x = 'none'
1066	grid_y = 'none'
1067	grid_z = 'none'
1068	!
1069	!-- Use var to avoid compiler warning about unused variable
1070	IF ( var == ' ' ) RETURN
1071
1072	IF ( debug_output ) CALL debug_message( 'defining module-specific netcdf grids', 'end' )
1073
1074
1075	END SUBROUTINE module_interface_define_netcdf_grid
1076
1077
1078	!--------------------------------------------------------------------------------------------------!
1079	! Description:
1080	! ------------
1081	!> Allocate module-specific arrays and pointers
1082	!--------------------------------------------------------------------------------------------------!
1083	SUBROUTINE module_interface_init_arrays
1084
1085
1086	IF ( debug_output ) CALL debug_message( 'initializing module-specific arrays', 'start' )
1087
1088	CALL dynamics_init_arrays
1089	CALL tcm_init_arrays
1090
1091	IF ( bulk_cloud_model ) CALL bcm_init_arrays
1092	IF ( air_chemistry ) CALL chem_init_arrays
1093	IF ( gust_module_enabled ) CALL gust_init_arrays
1094	IF ( particle_advection ) CALL lpm_init_arrays
1095	IF ( land_surface ) CALL lsm_init_arrays
1096	IF ( ocean_mode ) CALL ocean_init_arrays
1097	IF ( salsa ) CALL salsa_init_arrays
1098	IF ( urban_surface ) CALL usm_init_arrays
1099	IF ( surface_output ) CALL surface_data_output_init_arrays
1100	IF ( wind_turbine ) CALL wtm_init_arrays
1101
1102	IF ( user_module_enabled ) CALL user_init_arrays
1103
1104	IF ( debug_output ) CALL debug_message( 'initializing module-specific arrays', 'end' )
1105
1106
1107	END SUBROUTINE module_interface_init_arrays
1108
1109
1110	!--------------------------------------------------------------------------------------------------!
1111	! Description:
1112	! ------------
1113	!> Perform module-specific initialization
1114	!--------------------------------------------------------------------------------------------------!
1115	SUBROUTINE module_interface_init
1116
1117
1118	IF ( debug_output ) CALL debug_message( 'module-specific initialization', 'start' )
1119
1120	CALL dynamics_init
1121	CALL tcm_init
1122
1123	IF ( biometeorology ) CALL bio_init
1124	IF ( bulk_cloud_model ) CALL bcm_init
1125	IF ( air_chemistry ) CALL chem_init
1126	IF ( virtual_flight ) CALL flight_init
1127	IF ( gust_module_enabled ) CALL gust_init
1128	IF ( indoor_model ) CALL im_init
1129	IF ( particle_advection ) CALL lpm_init
1130	IF ( large_scale_forcing ) CALL lsf_init
1131	IF ( land_surface ) CALL lsm_init
1132	IF ( nudging ) CALL nudge_init
1133	IF ( ocean_mode ) CALL ocean_init
1134	IF ( plant_canopy ) CALL pcm_init
1135	IF ( salsa ) CALL salsa_init
1136	IF ( urban_surface ) CALL usm_init
1137	IF ( virtual_measurement ) CALL vm_init
1138	IF ( wind_turbine ) CALL wtm_init
1139	IF ( radiation ) CALL radiation_init
1140
1141	CALL doq_init
1142
1143	IF ( user_module_enabled ) CALL user_init
1144
1145	IF ( debug_output ) CALL debug_message( 'module-specific initialization', 'end' )
1146
1147	END SUBROUTINE module_interface_init
1148
1149	!--------------------------------------------------------------------------------------------------!
1150	! Description:
1151	! ------------
1152	!> Initialize boundary conditions and numerical schemes.
1153	!--------------------------------------------------------------------------------------------------!
1154	SUBROUTINE module_interface_init_numerics
1155
1156	!
1157	!-- Initialize boundary conditions via surface type
1158	CALL init_bc
1159	!
1160	!-- Calculate wall flag arrays for the multigrid method.
1161	!-- Please note, wall flags are only applied in the non-optimized version.
1162	CALL poismg_noopt_init
1163
1164	END SUBROUTINE module_interface_init_numerics
1165
1166
1167	!--------------------------------------------------------------------------------------------------!
1168	! Description:
1169	! ------------
1170	!> Initialize data output
1171	!--------------------------------------------------------------------------------------------------!
1172	SUBROUTINE module_interface_init_output
1173
1174	INTEGER(iwp) :: return_value !< returned status value of called function
1175
1176	!
1177	!-- Initialize data-output module
1178	CALL dom_init( file_suffix_of_output_group=coupling_char, &
1179	mpi_comm_of_output_group=comm2d, &
1180	program_debug_output_unit=9, &
1181	debug_output=debug_output )
1182	!
1183	!-- Define module-specific output quantities
1184	IF ( virtual_measurement ) CALL vm_init_output
1185	IF ( wind_turbine ) CALL wtm_init_output
1186	!
1187	!-- Leave output-definition state
1188	return_value = dom_def_end()
1189
1190	END SUBROUTINE module_interface_init_output
1191
1192	!--------------------------------------------------------------------------------------------------!
1193	! Description:
1194	! ------------
1195	!> Perform module-specific post-initialization checks
1196	!--------------------------------------------------------------------------------------------------!
1197	SUBROUTINE module_interface_init_checks
1198
1199
1200	IF ( debug_output ) CALL debug_message( 'module-specific post-initialization checks', 'start' )
1201
1202	CALL dynamics_init_checks
1203
1204	IF ( biometeorology ) CALL bio_init_checks
1205
1206	IF ( debug_output ) CALL debug_message( 'module-specific post-initialization checks', 'end' )
1207
1208
1209	END SUBROUTINE module_interface_init_checks
1210
1211
1212	!--------------------------------------------------------------------------------------------------!
1213	! Description:
1214	! ------------
1215	!> Gather module-specific header output
1216	!--------------------------------------------------------------------------------------------------!
1217	SUBROUTINE module_interface_header( io )
1218
1219
1220	INTEGER(iwp), INTENT(IN) :: io !< unit of the output file
1221
1222
1223	IF ( debug_output ) CALL debug_message( 'module-specific header output', 'start' )
1224
1225	CALL dynamics_header( io )
1226
1227	IF ( biometeorology ) CALL bio_header ( io )
1228	IF ( bulk_cloud_model ) CALL bcm_header( io )
1229	IF ( air_chemistry ) CALL chem_header ( io )
1230	IF ( virtual_flight ) CALL flight_header( io )
1231	IF ( gust_module_enabled ) CALL gust_header( io )
1232	IF ( particle_advection ) CALL lpm_header( io )
1233	IF ( land_surface ) CALL lsm_header( io )
1234	IF ( large_scale_forcing ) CALL lsf_nudging_header( io )
1235	IF ( nesting_offline ) CALL nesting_offl_header( io )
1236	IF ( ocean_mode ) CALL ocean_header( io )
1237	IF ( plant_canopy ) CALL pcm_header( io )
1238	IF ( radiation ) CALL radiation_header( io )
1239	IF ( salsa ) CALL salsa_header( io )
1240	IF ( calculate_spectra ) CALL spectra_header( io )
1241	IF ( syn_turb_gen ) CALL stg_header( io )
1242
1243	IF ( user_module_enabled ) CALL user_header( io )
1244
1245	IF ( debug_output ) CALL debug_message( 'module-specific header output', 'end' )
1246
1247
1248	END SUBROUTINE module_interface_header
1249
1250
1251	!--------------------------------------------------------------------------------------------------!
1252	! Description:
1253	! ------------
1254	!> Perform module-specific actions while in time-integration (vector-optimized)
1255	!--------------------------------------------------------------------------------------------------!
1256	SUBROUTINE module_interface_actions( location )
1257
1258
1259	CHARACTER (LEN=*), INTENT(IN) :: location !< call location string
1260
1261	CALL dynamics_actions( location )
1262	CALL tcm_actions( location )
1263
1264	IF ( bulk_cloud_model ) CALL bcm_actions( location )
1265	IF ( air_chemistry ) CALL chem_actions( location )
1266	IF ( gust_module_enabled ) CALL gust_actions( location )
1267	IF ( particle_advection ) CALL lpm_actions( location )
1268	IF ( ocean_mode ) CALL ocean_actions( location )
1269	IF ( salsa ) CALL salsa_actions( location )
1270	IF ( wind_turbine ) CALL wtm_actions( location )
1271
1272	IF ( user_module_enabled ) CALL user_actions( location )
1273	IF ( vdi_checks ) CALL vdi_actions( location )
1274
1275
1276	END SUBROUTINE module_interface_actions
1277
1278
1279	!--------------------------------------------------------------------------------------------------!
1280	! Description:
1281	! ------------
1282	!> Perform module-specific actions while in time-integration (cache-optimized)
1283	!--------------------------------------------------------------------------------------------------!
1284	SUBROUTINE module_interface_actions_ij( i, j, location )
1285
1286	CHARACTER (LEN=*), INTENT(IN) :: location !< call location string
1287
1288	INTEGER(iwp), INTENT(IN) :: i !< grid index in x-direction
1289	INTEGER(iwp), INTENT(IN) :: j !< grid index in y-direction
1290
1291	CALL dynamics_actions( i, j, location )
1292	CALL tcm_actions( i, j, location )
1293
1294	IF ( bulk_cloud_model ) CALL bcm_actions( i, j, location )
1295	IF ( air_chemistry ) CALL chem_actions( i, j, location )
1296	IF ( gust_module_enabled ) CALL gust_actions( i, j, location )
1297	IF ( ocean_mode ) CALL ocean_actions( i, j, location )
1298	IF ( salsa ) CALL salsa_actions( i, j, location )
1299	IF ( wind_turbine ) CALL wtm_actions( i, j, location )
1300
1301	IF ( user_module_enabled ) CALL user_actions( i, j, location )
1302
1303
1304	END SUBROUTINE module_interface_actions_ij
1305
1306
1307	!--------------------------------------------------------------------------------------------------!
1308	! Description:
1309	! ------------
1310	!> Compute module-specific non_advective_processes (vector-optimized)
1311	!--------------------------------------------------------------------------------------------------!
1312	SUBROUTINE module_interface_non_advective_processes
1313
1314
1315	CALL dynamics_non_advective_processes
1316
1317	IF ( bulk_cloud_model ) CALL bcm_non_advective_processes
1318	IF ( air_chemistry ) CALL chem_non_advective_processes
1319	IF ( salsa ) CALL salsa_non_advective_processes
1320
1321
1322	END SUBROUTINE module_interface_non_advective_processes
1323
1324
1325	!--------------------------------------------------------------------------------------------------!
1326	! Description:
1327	! ------------
1328	!> Compute module-specific non_advective_processes (cache-optimized)
1329	!--------------------------------------------------------------------------------------------------!
1330	SUBROUTINE module_interface_non_advective_processes_ij( i, j )
1331
1332
1333	INTEGER(iwp), INTENT(IN) :: i !< grid index in x-direction
1334	INTEGER(iwp), INTENT(IN) :: j !< grid index in y-direction
1335
1336	CALL dynamics_non_advective_processes( i, j )
1337
1338	IF ( bulk_cloud_model ) CALL bcm_non_advective_processes( i, j )
1339	IF ( air_chemistry ) CALL chem_non_advective_processes( i, j )
1340	IF ( salsa ) CALL salsa_non_advective_processes( i, j )
1341
1342
1343	END SUBROUTINE module_interface_non_advective_processes_ij
1344
1345	!--------------------------------------------------------------------------------------------------!
1346	! Description:
1347	! ------------
1348	!> Exchange horiz for module-specific quantities
1349	!--------------------------------------------------------------------------------------------------!
1350	SUBROUTINE module_interface_exchange_horiz( location )
1351
1352	CHARACTER (LEN=*), INTENT(IN) :: location !< call location string
1353
1354
1355	IF ( debug_output_timestep ) CALL debug_message( 'module-specific exchange_horiz', 'start' )
1356
1357	CALL dynamics_exchange_horiz( location )
1358
1359	IF ( bulk_cloud_model ) CALL bcm_exchange_horiz( location )
1360	IF ( air_chemistry ) CALL chem_exchange_horiz_bounds( location )
1361	IF ( ocean_mode ) CALL ocean_exchange_horiz( location )
1362	IF ( particle_advection ) CALL lpm_exchange_horiz_bounds( location )
1363	IF ( salsa ) CALL salsa_exchange_horiz_bounds( location )
1364
1365	IF ( debug_output_timestep ) CALL debug_message( 'module-specific exchange_horiz', 'end' )
1366
1367
1368	END SUBROUTINE module_interface_exchange_horiz
1369
1370
1371	!--------------------------------------------------------------------------------------------------!
1372	! Description:
1373	! ------------
1374	!> Compute module-specific prognostic_equations (vector-optimized)
1375	!--------------------------------------------------------------------------------------------------!
1376	SUBROUTINE module_interface_prognostic_equations
1377
1378
1379	CALL dynamics_prognostic_equations
1380	CALL tcm_prognostic_equations
1381
1382	IF ( bulk_cloud_model ) CALL bcm_prognostic_equations
1383	IF ( air_chemistry ) CALL chem_prognostic_equations
1384	IF ( gust_module_enabled ) CALL gust_prognostic_equations
1385	IF ( ocean_mode ) CALL ocean_prognostic_equations
1386	IF ( salsa ) CALL salsa_prognostic_equations
1387
1388
1389	END SUBROUTINE module_interface_prognostic_equations
1390
1391
1392	!--------------------------------------------------------------------------------------------------!
1393	! Description:
1394	! ------------
1395	!> Compute module-specific prognostic_equations (cache-optimized)
1396	!--------------------------------------------------------------------------------------------------!
1397	SUBROUTINE module_interface_prognostic_equations_ij( i, j, i_omp_start, tn )
1398
1399
1400	INTEGER(iwp), INTENT(IN) :: i !< grid index in x-direction
1401	INTEGER(iwp), INTENT(IN) :: j !< grid index in y-direction
1402	INTEGER(iwp), INTENT(IN) :: i_omp_start !< first loop index of i-loop in prognostic_equations
1403	INTEGER(iwp), INTENT(IN) :: tn !< task number of openmp task
1404
1405	CALL dynamics_prognostic_equations( i, j, i_omp_start, tn )
1406	CALL tcm_prognostic_equations( i, j, i_omp_start, tn )
1407
1408	IF ( bulk_cloud_model ) CALL bcm_prognostic_equations( i, j, i_omp_start, tn )
1409	IF ( air_chemistry ) CALL chem_prognostic_equations( i, j, i_omp_start, tn )
1410	IF ( gust_module_enabled ) CALL gust_prognostic_equations( i, j, i_omp_start, tn )
1411	IF ( ocean_mode ) CALL ocean_prognostic_equations( i, j, i_omp_start, tn )
1412	IF ( salsa ) CALL salsa_prognostic_equations( i, j, i_omp_start, tn )
1413
1414
1415	END SUBROUTINE module_interface_prognostic_equations_ij
1416
1417	!--------------------------------------------------------------------------------------------------!
1418	! Description:
1419	! ------------
1420	!> Compute module-specific boundary conditions
1421	!--------------------------------------------------------------------------------------------------!
1422	SUBROUTINE module_interface_boundary_conditions
1423
1424
1425	IF ( debug_output_timestep ) CALL debug_message( 'module-specific boundary_conditions', 'start' )
1426
1427	CALL dynamics_boundary_conditions
1428	CALL tcm_boundary_conds
1429
1430	IF ( bulk_cloud_model ) CALL bcm_boundary_conditions
1431	IF ( air_chemistry ) CALL chem_boundary_conditions
1432	IF ( ocean_mode ) CALL ocean_boundary_conditions
1433	IF ( salsa ) CALL salsa_boundary_conditions
1434
1435	IF ( debug_output_timestep ) CALL debug_message( 'module-specific boundary_conditions', 'end' )
1436
1437
1438	END SUBROUTINE module_interface_boundary_conditions
1439
1440	!--------------------------------------------------------------------------------------------------!
1441	! Description:
1442	! ------------
1443	!> Swap the timelevel pointers for module-specific arrays
1444	!--------------------------------------------------------------------------------------------------!
1445	SUBROUTINE module_interface_swap_timelevel ( swap_mode )
1446
1447
1448	INTEGER(iwp), INTENT(IN) :: swap_mode !< determines procedure of pointer swap
1449
1450
1451	IF ( debug_output_timestep ) CALL debug_message( 'module-specific swap timelevel', 'start' )
1452
1453	CALL dynamics_swap_timelevel( swap_mode )
1454	CALL tcm_swap_timelevel( swap_mode )
1455
1456	IF ( bulk_cloud_model ) CALL bcm_swap_timelevel( swap_mode )
1457	IF ( air_chemistry ) CALL chem_swap_timelevel( swap_mode )
1458	IF ( gust_module_enabled ) CALL gust_swap_timelevel( swap_mode )
1459	IF ( land_surface ) CALL lsm_swap_timelevel( swap_mode )
1460	IF ( ocean_mode ) CALL ocean_swap_timelevel( swap_mode )
1461	IF ( salsa ) CALL salsa_swap_timelevel( swap_mode )
1462	IF ( urban_surface ) CALL usm_swap_timelevel( swap_mode )
1463
1464	IF ( debug_output_timestep ) CALL debug_message( 'module-specific swap timelevel', 'end' )
1465
1466
1467	END SUBROUTINE module_interface_swap_timelevel
1468
1469
1470	!--------------------------------------------------------------------------------------------------!
1471	!
1472	! Description:
1473	! ------------
1474	!> Perform module-specific averaging of 3D data
1475	!--------------------------------------------------------------------------------------------------!
1476	SUBROUTINE module_interface_3d_data_averaging( mode, variable )
1477
1478
1479	CHARACTER (LEN=*), INTENT(IN) :: mode !< averaging interface mode
1480	CHARACTER (LEN=*), INTENT(IN) :: variable !< variable name
1481
1482
1483	IF ( debug_output_timestep ) CALL debug_message( 'module-specific 3d data averaging', 'start' )
1484
1485	CALL dynamics_3d_data_averaging( mode, variable )
1486	CALL tcm_3d_data_averaging( mode, variable )
1487
1488	IF ( biometeorology ) CALL bio_3d_data_averaging( mode, variable )
1489	IF ( bulk_cloud_model ) CALL bcm_3d_data_averaging( mode, variable )
1490	IF ( air_chemistry ) CALL chem_3d_data_averaging( mode, variable )
1491	CALL doq_3d_data_averaging( mode, variable ) ! ToDo: this seems to be not according to the design
1492	IF ( gust_module_enabled ) CALL gust_3d_data_averaging( mode, variable )
1493	IF ( land_surface ) CALL lsm_3d_data_averaging( mode, variable )
1494	IF ( ocean_mode ) CALL ocean_3d_data_averaging( mode, variable )
1495	IF ( plant_canopy ) CALL pcm_3d_data_averaging( mode, variable )
1496	IF ( radiation ) CALL radiation_3d_data_averaging( mode, variable )
1497	IF ( salsa ) CALL salsa_3d_data_averaging( mode, variable )
1498	IF ( urban_surface ) CALL usm_3d_data_averaging( mode, variable )
1499
1500	IF ( user_module_enabled ) CALL user_3d_data_averaging( mode, variable )
1501
1502	IF ( debug_output_timestep ) CALL debug_message( 'module-specific 3d data averaging', 'end' )
1503
1504
1505	END SUBROUTINE module_interface_3d_data_averaging
1506
1507	!--------------------------------------------------------------------------------------------------!
1508	!
1509	! Description:
1510	! ------------
1511	!> Define module-specific 2D output variables
1512	!--------------------------------------------------------------------------------------------------!
1513	SUBROUTINE module_interface_data_output_2d( av, variable, found, grid, mode, local_pf, two_d, &
1514	nzb_do, nzt_do, fill_value )
1515
1516	CHARACTER (LEN=*), INTENT(IN) :: mode !< either 'xy', 'xz' or 'yz'
1517	CHARACTER (LEN=*), INTENT(IN) :: variable !< variable name
1518	CHARACTER (LEN=*), INTENT(INOUT) :: grid !< name of vertical grid
1519
1520	INTEGER(iwp), INTENT(IN) :: av !< flag for (non-)average output
1521	INTEGER(iwp), INTENT(IN) :: nzb_do !< vertical output index (bottom) (usually 0)
1522	INTEGER(iwp), INTENT(IN) :: nzt_do !< vertical output index (top) (usually nz_do3d)
1523
1524	LOGICAL, INTENT(INOUT) :: found !< flag if output variable is found
1525	LOGICAL, INTENT(OUT) :: two_d !< flag for 2D variables
1526
1527	REAL(wp), INTENT(IN) :: fill_value !< to be removed
1528
1529	REAL(wp), DIMENSION(nxl:nxr,nys:nyn,nzb_do:nzt_do), INTENT(INOUT) :: local_pf !< ToDo: can also be kind=sp
1530
1531
1532	IF ( debug_output_timestep ) CALL debug_message( 'module-specific 2d data output', 'start' )
1533
1534	CALL dynamics_data_output_2d( av, variable, found, grid, mode, local_pf, two_d, nzb_do, nzt_do,&
1535	fill_value )
1536
1537	IF ( .NOT. found ) THEN
1538	CALL tcm_data_output_2d( av, variable, found, grid, mode, local_pf, nzb_do, nzt_do )
1539	ENDIF
1540
1541	IF ( .NOT. found .AND. biometeorology ) THEN
1542	CALL bio_data_output_2d( av, variable, found, grid, local_pf, two_d, nzb_do, nzt_do )
1543	ENDIF
1544
1545	IF ( .NOT. found .AND. bulk_cloud_model ) THEN
1546	CALL bcm_data_output_2d( av, variable, found, grid, mode, local_pf, two_d, nzb_do, nzt_do )
1547	ENDIF
1548
1549	IF ( .NOT. found .AND. air_chemistry ) THEN
1550	CALL chem_data_output_2d( av, variable, found, grid, mode, local_pf, two_d, nzb_do, nzt_do, &
1551	fill_value )
1552	ENDIF
1553
1554	IF ( .NOT. found ) THEN
1555	CALL doq_output_2d( av, variable, found, grid, mode, local_pf, two_d, nzb_do, nzt_do, &
1556	fill_value )
1557	ENDIF
1558
1559	IF ( .NOT. found .AND. gust_module_enabled ) THEN
1560	CALL gust_data_output_2d( av, variable, found, grid, mode, local_pf, two_d, nzb_do, nzt_do, &
1561	fill_value )
1562	ENDIF
1563
1564	IF ( .NOT. found .AND. land_surface ) THEN
1565	CALL lsm_data_output_2d( av, variable, found, grid, mode, local_pf, two_d, nzb_do, nzt_do )
1566	ENDIF
1567
1568	IF ( .NOT. found .AND. ocean_mode ) THEN
1569	CALL ocean_data_output_2d( av, variable, found, grid, mode, local_pf, nzb_do, nzt_do )
1570	ENDIF
1571
1572	IF ( .NOT. found .AND. radiation ) THEN
1573	CALL radiation_data_output_2d( av, variable, found, grid, mode, local_pf, two_d, nzb_do, &
1574	nzt_do, fill_value )
1575	ENDIF
1576
1577	IF ( .NOT. found .AND. salsa ) THEN
1578	CALL salsa_data_output_2d( av, variable, found, grid, mode, local_pf, two_d, nzb_do, nzt_do )
1579	ENDIF
1580
1581	IF ( .NOT. found .AND. user_module_enabled ) THEN
1582	CALL user_data_output_2d( av, variable, found, grid, local_pf, two_d, nzb_do, nzt_do )
1583	ENDIF
1584
1585	IF ( debug_output_timestep ) CALL debug_message( 'module-specific 2d data output', 'end' )
1586
1587
1588	END SUBROUTINE module_interface_data_output_2d
1589
1590
1591	!--------------------------------------------------------------------------------------------------!
1592	!
1593	! Description:
1594	! ------------
1595	!> Define module-specific 3D output variables
1596	!--------------------------------------------------------------------------------------------------!
1597	SUBROUTINE module_interface_data_output_3d( av, variable, found, local_pf, fill_value, resorted, &
1598	nzb_do, nzt_do )
1599
1600	CHARACTER (LEN=*), INTENT(IN) :: variable !< variable name
1601
1602	INTEGER(iwp), INTENT(IN) :: av !< flag for (non-)average output
1603	INTEGER(iwp), INTENT(IN) :: nzb_do !< vertical output index (bottom) (usually 0)
1604	INTEGER(iwp), INTENT(IN) :: nzt_do !< vertical output index (top) (usually nz_do3d)
1605
1606	LOGICAL, INTENT(INOUT) :: found !< flag if output variable is found
1607	LOGICAL, INTENT(OUT) :: resorted !< flag if output has been resorted
1608
1609	REAL(wp), INTENT(IN) :: fill_value !< ToDo: refactor
1610
1611	REAL(sp), DIMENSION(nxl:nxr,nys:nyn,nzb_do:nzt_do), INTENT(INOUT) :: local_pf
1612
1613
1614	IF ( debug_output_timestep ) CALL debug_message( 'module-specific 3d data output', 'start' )
1615
1616	CALL dynamics_data_output_3d( av, variable, found, local_pf, fill_value, nzb_do, nzt_do )
1617	resorted = .FALSE.
1618
1619	IF ( .NOT. found ) THEN
1620	CALL tcm_data_output_3d( av, variable, found, local_pf, nzb_do, nzt_do )
1621	resorted = .TRUE.
1622	ENDIF
1623
1624	IF ( .NOT. found .AND. biometeorology ) THEN
1625	CALL bio_data_output_3d( av, variable, found, local_pf, nzb_do, nzt_do )
1626	resorted = .FALSE.
1627	ENDIF
1628
1629	IF ( .NOT. found .AND. bulk_cloud_model ) THEN
1630	CALL bcm_data_output_3d( av, variable, found, local_pf, nzb_do, nzt_do )
1631	resorted = .TRUE.
1632	ENDIF
1633
1634	IF ( .NOT. found .AND. air_chemistry ) THEN
1635	CALL chem_data_output_3d( av, variable, found, local_pf, fill_value, nzb_do, nzt_do )
1636	resorted = .TRUE.
1637	ENDIF
1638
1639	IF ( .NOT. found ) THEN
1640	CALL doq_output_3d( av, variable, found, local_pf, fill_value, nzb_do, nzt_do )
1641	resorted = .TRUE.
1642	ENDIF
1643
1644	IF ( .NOT. found .AND. gust_module_enabled ) THEN
1645	CALL gust_data_output_3d( av, variable, found, local_pf, fill_value, nzb_do, nzt_do )
1646	resorted = .TRUE.
1647	ENDIF
1648
1649	IF ( .NOT. found .AND. indoor_model ) THEN
1650	CALL im_data_output_3d( av, variable, found, local_pf, fill_value, nzb_do, nzt_do )
1651	resorted = .TRUE.
1652	ENDIF
1653
1654	IF ( .NOT. found .AND. ocean_mode ) THEN
1655	CALL ocean_data_output_3d( av, variable, found, local_pf, nzb_do, nzt_do )
1656	resorted = .TRUE.
1657	ENDIF
1658
1659	IF ( .NOT. found .AND. plant_canopy ) THEN
1660	CALL pcm_data_output_3d( av, variable, found, local_pf, fill_value, nzb_do, nzt_do )
1661	resorted = .TRUE.
1662	ENDIF
1663
1664	IF ( .NOT. found .AND. radiation ) THEN
1665	CALL radiation_data_output_3d( av, variable, found, local_pf, fill_value, nzb_do, nzt_do )
1666	resorted = .TRUE.
1667	ENDIF
1668
1669	IF ( .NOT. found .AND. salsa ) THEN
1670	CALL salsa_data_output_3d( av, variable, found, local_pf, nzb_do, nzt_do )
1671	resorted = .TRUE.
1672	ENDIF
1673
1674	IF ( .NOT. found .AND. user_module_enabled ) THEN
1675	CALL user_data_output_3d( av, variable, found, local_pf, nzb_do, nzt_do )
1676	resorted = .TRUE.
1677	ENDIF
1678
1679	IF ( debug_output_timestep ) CALL debug_message( 'module-specific 3d data output', 'end' )
1680
1681
1682	END SUBROUTINE module_interface_data_output_3d
1683
1684
1685	!--------------------------------------------------------------------------------------------------!
1686	! Description:
1687	! ------------
1688	!> Compute module-specific profile and timeseries data
1689	!--------------------------------------------------------------------------------------------------!
1690	SUBROUTINE module_interface_statistics( mode, sr, tn, dots_max )
1691
1692
1693	CHARACTER (LEN=*), INTENT(IN) :: mode !< statistical analysis mode
1694
1695	INTEGER(iwp), INTENT(IN) :: dots_max !< maximum number of timeseries
1696	INTEGER(iwp), INTENT(IN) :: sr !<
1697	INTEGER(iwp), INTENT(IN) :: tn !<
1698
1699
1700	IF ( debug_output_timestep ) CALL debug_message( 'module-specific statistics', 'start' )
1701
1702	CALL dynamics_statistics( mode, sr, tn )
1703
1704	IF ( gust_module_enabled ) CALL gust_statistics( mode, sr, tn, dots_max )
1705	IF ( air_chemistry ) CALL chem_statistics( mode, sr, tn )
1706	IF ( salsa ) CALL salsa_statistics( mode, sr, tn )
1707
1708	IF ( user_module_enabled ) CALL user_statistics( mode, sr, tn )
1709
1710	IF ( debug_output_timestep ) CALL debug_message( 'module-specific statistics', 'end' )
1711
1712
1713	END SUBROUTINE module_interface_statistics
1714
1715
1716	!--------------------------------------------------------------------------------------------------!
1717	! Description:
1718	! ------------
1719	!> Read module-specific restart data in Fortran binary format globaly shared by all MPI ranks
1720	!--------------------------------------------------------------------------------------------------!
1721	SUBROUTINE module_interface_rrd_global_ftn( found )
1722
1723
1724	LOGICAL, INTENT(INOUT) :: found !< flag if variable was found
1725
1726
1727	IF ( debug_output ) CALL debug_message( 'module-specific read global restart data', 'start' )
1728
1729	CALL dynamics_rrd_global( found ) ! ToDo: change interface to pass variable
1730
1731	IF ( .NOT. found ) CALL bio_rrd_global( found ) ! ToDo: change interface to pass variable
1732	IF ( .NOT. found ) CALL bcm_rrd_global( found ) ! ToDo: change interface to pass variable
1733	IF ( .NOT. found ) CALL flight_rrd_global( found ) ! ToDo: change interface to pass variable
1734	IF ( .NOT. found ) CALL gust_rrd_global( found ) ! ToDo: change interface to pass variable
1735	IF ( .NOT. found ) CALL lpm_rrd_global( found ) ! ToDo: change interface to pass variable
1736	IF ( .NOT. found ) CALL pcm_rrd_global( found )
1737	IF ( .NOT. found ) CALL ocean_rrd_global( found ) ! ToDo: change interface to pass variable
1738	IF ( .NOT. found ) CALL salsa_rrd_global( found )
1739	IF ( .NOT. found ) CALL stg_rrd_global ( found ) ! ToDo: change interface to pass variable
1740	IF ( .NOT. found ) CALL wtm_rrd_global( found ) ! ToDo: change interface to pass variable
1741	IF ( .NOT. found ) CALL surface_data_output_rrd_global( found )
1742
1743	IF ( .NOT. found ) CALL user_rrd_global( found ) ! ToDo: change interface to pass variable
1744
1745	IF ( debug_output ) CALL debug_message( 'module-specific read global restart data', 'end' )
1746
1747
1748	END SUBROUTINE module_interface_rrd_global_ftn
1749
1750
1751	!--------------------------------------------------------------------------------------------------!
1752	! Description:
1753	! ------------
1754	!> Read module-specific restart data in MPI format globaly shared by all MPI ranks
1755	!--------------------------------------------------------------------------------------------------!
1756	SUBROUTINE module_interface_rrd_global_mpi
1757
1758
1759	IF ( debug_output ) CALL debug_message( 'module-specific read global restart data', 'start' )
1760
1761	CALL dynamics_rrd_global
1762
1763	IF ( biometeorology ) CALL bio_rrd_global
1764	IF ( bulk_cloud_model ) CALL bcm_rrd_global
1765	IF ( virtual_flight ) CALL flight_rrd_global
1766	IF ( gust_module_enabled ) CALL gust_rrd_global
1767	IF ( particle_advection ) CALL lpm_rrd_global
1768	IF ( plant_canopy ) CALL pcm_rrd_global
1769	IF ( ocean_mode ) CALL ocean_rrd_global
1770	IF ( salsa ) CALL salsa_rrd_global
1771	IF ( syn_turb_gen ) CALL stg_rrd_global
1772	IF ( wind_turbine ) CALL wtm_rrd_global
1773	IF ( surface_output ) CALL surface_data_output_rrd_global
1774
1775	IF ( user_module_enabled ) CALL user_rrd_global
1776
1777	IF ( debug_output ) CALL debug_message( 'module-specific read global restart data', 'end' )
1778
1779
1780	END SUBROUTINE module_interface_rrd_global_mpi
1781
1782
1783	!--------------------------------------------------------------------------------------------------!
1784	! Description:
1785	! ------------
1786	!> Write module-specific restart data globaly shared by all MPI ranks
1787	!--------------------------------------------------------------------------------------------------!
1788	SUBROUTINE module_interface_wrd_global
1789
1790
1791	IF ( debug_output ) CALL debug_message( 'module-specific write global restart data', 'start' )
1792
1793	CALL dynamics_wrd_global
1794
1795	IF ( biometeorology ) CALL bio_wrd_global
1796	IF ( bulk_cloud_model ) CALL bcm_wrd_global
1797	IF ( virtual_flight ) CALL flight_wrd_global
1798	IF ( gust_module_enabled ) CALL gust_wrd_global
1799	IF ( particle_advection ) CALL lpm_wrd_global
1800	IF ( plant_canopy ) CALL pcm_wrd_global
1801	IF ( ocean_mode ) CALL ocean_wrd_global
1802	IF ( salsa ) CALL salsa_wrd_global
1803	IF ( syn_turb_gen ) CALL stg_wrd_global
1804	IF ( wind_turbine ) CALL wtm_wrd_global
1805	IF ( surface_output ) CALL surface_data_output_wrd_global
1806
1807	IF ( user_module_enabled ) CALL user_wrd_global
1808
1809	IF ( debug_output ) CALL debug_message( 'module-specific write global restart data', 'end' )
1810
1811
1812	END SUBROUTINE module_interface_wrd_global
1813
1814
1815	!--------------------------------------------------------------------------------------------------!
1816	! Description:
1817	! ------------
1818	!> Read module-specific local restart data arrays (Fortran binary format).
1819	!--------------------------------------------------------------------------------------------------!
1820	SUBROUTINE module_interface_rrd_local_ftn( map_index, &
1821	nxlf, nxlc, nxl_on_file, &
1822	nxrf, nxrc, nxr_on_file, &
1823	nynf, nync, nyn_on_file, &
1824	nysf, nysc, nys_on_file, &
1825	tmp_2d, tmp_3d, found )
1826
1827
1828	INTEGER(iwp), INTENT(IN) :: map_index !<
1829	INTEGER(iwp), INTENT(IN) :: nxlc !<
1830	INTEGER(iwp), INTENT(IN) :: nxlf !<
1831	INTEGER(iwp), INTENT(IN) :: nxl_on_file !<
1832	INTEGER(iwp), INTENT(IN) :: nxrc !<
1833	INTEGER(iwp), INTENT(IN) :: nxrf !<
1834	INTEGER(iwp), INTENT(IN) :: nxr_on_file !<
1835	INTEGER(iwp), INTENT(IN) :: nync !<
1836	INTEGER(iwp), INTENT(IN) :: nynf !<
1837	INTEGER(iwp), INTENT(IN) :: nyn_on_file !<
1838	INTEGER(iwp), INTENT(IN) :: nysc !<
1839	INTEGER(iwp), INTENT(IN) :: nysf !<
1840	INTEGER(iwp), INTENT(IN) :: nys_on_file !<
1841
1842	LOGICAL, INTENT(INOUT) :: found !< flag if variable was found
1843
1844	REAL(wp), &
1845	DIMENSION(nys_on_file-nbgp:nyn_on_file+nbgp,nxl_on_file-nbgp:nxr_on_file+nbgp), &
1846	INTENT(OUT) :: tmp_2d !<
1847	REAL(wp), &
1848	DIMENSION(nzb:nzt+1,nys_on_file-nbgp:nyn_on_file+nbgp,nxl_on_file-nbgp:nxr_on_file+nbgp), &
1849	INTENT(OUT) :: tmp_3d !<
1850
1851
1852	IF ( debug_output ) THEN
1853	CALL debug_message( 'module-specific read local restart data (Fortran binary)', 'start' )
1854	ENDIF
1855
1856	CALL dynamics_rrd_local( map_index, &
1857	nxlf, nxlc, nxl_on_file, &
1858	nxrf, nxrc, nxr_on_file, &
1859	nynf, nync, nyn_on_file, &
1860	nysf, nysc, nys_on_file, &
1861	tmp_2d, tmp_3d, found &
1862	) ! ToDo: change interface to pass variable
1863
1864	IF ( .NOT. found ) CALL bio_rrd_local( found )
1865
1866	IF ( .NOT. found ) CALL bcm_rrd_local( map_index, &
1867	nxlf, nxlc, nxl_on_file, &
1868	nxrf, nxrc, nxr_on_file, &
1869	nynf, nync, nyn_on_file, &
1870	nysf, nysc, nys_on_file, &
1871	tmp_2d, tmp_3d, found &
1872	) ! ToDo: change interface to pass variable
1873
1874	IF ( .NOT. found ) CALL chem_rrd_local( map_index, &
1875	nxlf, nxlc, nxl_on_file, &
1876	nxrf, nxrc, nxr_on_file, &
1877	nynf, nync, nyn_on_file, &
1878	nysf, nysc, nys_on_file, &
1879	tmp_3d, found &
1880	) ! ToDo: change interface to pass variable
1881
1882	IF ( .NOT. found ) CALL doq_rrd_local( map_index, &
1883	nxlf, nxlc, nxl_on_file, &
1884	nxrf, nxrc, nxr_on_file, &
1885	nynf, nync, nyn_on_file, &
1886	nysf, nysc, nys_on_file, &
1887	tmp_2d, tmp_3d, found &
1888	) ! ToDo: change interface to pass variable
1889
1890	IF ( .NOT. found ) CALL gust_rrd_local( map_index, &
1891	nxlf, nxlc, nxl_on_file, &
1892	nxrf, nxrc, nxr_on_file, &
1893	nynf, nync, nyn_on_file, &
1894	nysf, nysc, nys_on_file, &
1895	tmp_2d, tmp_3d, found &
1896	) ! ToDo: change interface to pass variable
1897
1898	IF ( .NOT. found ) CALL lpm_rrd_local( map_index, &
1899	nxlf, nxlc, nxl_on_file, &
1900	nxrf, nxrc, nxr_on_file, &
1901	nynf, nync, nyn_on_file, &
1902	nysf, nysc, nys_on_file, &
1903	tmp_3d, found &
1904	) ! ToDo: change interface to pass variable
1905
1906	IF ( .NOT. found ) CALL lsm_rrd_local( map_index, &
1907	nxlf, nxlc, nxl_on_file, &
1908	nxrf, nxrc, nxr_on_file, &
1909	nynf, nync, nyn_on_file, &
1910	nysf, nysc, nys_on_file, &
1911	tmp_2d, found &
1912	) ! ToDo: change interface to pass variable
1913
1914	IF ( .NOT. found ) CALL pcm_rrd_local( map_index, &
1915	nxlf, nxlc, nxl_on_file, &
1916	nxrf, nxrc, nxr_on_file, &
1917	nynf, nync, nyn_on_file, &
1918	nysf, nysc, nys_on_file, &
1919	found &
1920	)
1921
1922	IF ( .NOT. found ) CALL ocean_rrd_local( map_index, &
1923	nxlf, nxlc, nxl_on_file, &
1924	nxrf, nxrc, nxr_on_file, &
1925	nynf, nync, nyn_on_file, &
1926	nysf, nysc, nys_on_file, &
1927	tmp_3d, found &
1928	) ! ToDo: change interface to pass variable
1929
1930	IF ( .NOT. found ) CALL radiation_rrd_local( map_index, &
1931	nxlf, nxlc, nxl_on_file, &
1932	nxrf, nxrc, nxr_on_file, &
1933	nynf, nync, nyn_on_file, &
1934	nysf, nysc, nys_on_file, &
1935	tmp_2d, tmp_3d, found &
1936	) ! ToDo: change interface to pass variable
1937
1938	IF ( .NOT. found ) CALL salsa_rrd_local( map_index, &
1939	nxlf, nxlc, nxl_on_file, &
1940	nxrf, nxrc, nxr_on_file, &
1941	nynf, nync, nyn_on_file, &
1942	nysf, nysc, nys_on_file, &
1943	tmp_3d, found &
1944	) ! ToDo: change interface to pass variable
1945
1946	IF ( .NOT. found ) CALL usm_rrd_local( map_index, &
1947	nxlf, nxlc, nxl_on_file, &
1948	nxrf, nxr_on_file, &
1949	nynf, nyn_on_file, &
1950	nysf, nysc, nys_on_file, &
1951	found &
1952	) ! ToDo: change interface to pass variable
1953	!
1954	!-- Surface data do not need overlap data, so do not pass these information.
1955	IF ( .NOT. found ) CALL surface_data_output_rrd_local( found )
1956
1957	IF ( .NOT. found ) CALL user_rrd_local( map_index, &
1958	nxlf, nxlc, nxl_on_file, &
1959	nxrf, nxrc, nxr_on_file, &
1960	nynf, nync, nyn_on_file, &
1961	nysf, nysc, nys_on_file, &
1962	tmp_3d, found &
1963	) ! ToDo: change interface to pass variable
1964
1965	IF ( debug_output ) THEN
1966	CALL debug_message( 'module-specific read local restart data (Fortran binary)', 'end' )
1967	ENDIF
1968
1969	END SUBROUTINE module_interface_rrd_local_ftn
1970
1971
1972	!--------------------------------------------------------------------------------------------------!
1973	! Description:
1974	! ------------
1975	!> Read module-specific local restart data arrays (MPI-IO).
1976	!--------------------------------------------------------------------------------------------------!
1977	SUBROUTINE module_interface_rrd_local_mpi
1978
1979	IF ( debug_output ) THEN
1980	CALL debug_message( 'module-specific read local restart data (MPI-IO)', 'start' )
1981	ENDIF
1982
1983	CALL dynamics_rrd_local
1984
1985	IF ( biometeorology ) CALL bio_rrd_local
1986	IF ( bulk_cloud_model ) CALL bcm_rrd_local
1987	IF ( air_chemistry ) CALL chem_rrd_local
1988	CALL doq_rrd_local
1989	IF ( gust_module_enabled ) CALL gust_rrd_local
1990	IF ( particle_advection ) CALL lpm_rrd_local
1991	IF ( land_surface ) CALL lsm_rrd_local
1992	IF ( plant_canopy ) CALL pcm_rrd_local
1993	IF ( ocean_mode ) CALL ocean_rrd_local
1994	IF ( radiation ) CALL radiation_rrd_local
1995	IF ( salsa ) CALL salsa_rrd_local
1996	IF ( urban_surface ) CALL usm_rrd_local
1997	IF ( surface_output ) CALL surface_data_output_rrd_local
1998
1999	IF ( user_module_enabled ) CALL user_rrd_local
2000
2001	IF ( debug_output ) THEN
2002	CALL debug_message( 'module-specific read local restart data (Fortran binary)', 'end' )
2003	ENDIF
2004
2005	END SUBROUTINE module_interface_rrd_local_mpi
2006
2007
2008	!--------------------------------------------------------------------------------------------------!
2009	! Description:
2010	! ------------
2011	!> Write module-specific restart data specific to local MPI ranks
2012	!--------------------------------------------------------------------------------------------------!
2013	SUBROUTINE module_interface_wrd_local
2014
2015
2016	IF ( debug_output ) CALL debug_message( 'module-specific write local restart data', 'start' )
2017
2018	CALL dynamics_wrd_local
2019
2020	IF ( biometeorology ) CALL bio_wrd_local
2021	IF ( bulk_cloud_model ) CALL bcm_wrd_local
2022	IF ( air_chemistry ) CALL chem_wrd_local
2023	CALL doq_wrd_local
2024	IF ( gust_module_enabled ) CALL gust_wrd_local
2025	IF ( particle_advection ) CALL lpm_wrd_local
2026	IF ( land_surface ) CALL lsm_wrd_local
2027	IF ( plant_canopy ) CALL pcm_wrd_local
2028	IF ( ocean_mode ) CALL ocean_wrd_local
2029	IF ( radiation ) CALL radiation_wrd_local
2030	IF ( salsa ) CALL salsa_wrd_local
2031	IF ( urban_surface ) CALL usm_wrd_local
2032	IF ( surface_output ) CALL surface_data_output_wrd_local
2033
2034	IF ( user_module_enabled ) CALL user_wrd_local
2035
2036	IF ( debug_output ) CALL debug_message( 'module-specific write local restart data', 'end' )
2037
2038
2039	END SUBROUTINE module_interface_wrd_local
2040
2041
2042	!--------------------------------------------------------------------------------------------------!
2043	! Description:
2044	! ------------
2045	!> Perform module-specific last actions before the program terminates
2046	!--------------------------------------------------------------------------------------------------!
2047	SUBROUTINE module_interface_last_actions
2048
2049	INTEGER :: return_value !< returned status value of a called function
2050
2051
2052	IF ( debug_output ) CALL debug_message( 'module-specific last actions', 'start' )
2053
2054	return_value = dom_finalize_output()
2055
2056	CALL dynamics_last_actions
2057
2058	IF ( user_module_enabled ) CALL user_last_actions
2059
2060	IF ( debug_output ) CALL debug_message( 'module-specific last actions', 'end' )
2061
2062
2063	END SUBROUTINE module_interface_last_actions
2064
2065
2066	END MODULE module_interface

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

Download in other formats:

| Impressum | ©Leibniz Universität Hannover |