Home

Context Navigation

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

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

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

Download in other formats:

| Impressum | ©Leibniz Universität Hannover |