source: palm/trunk/SOURCE/netcdf_data_input_mod.f90 @ 3518

Last change on this file since 3518 was 3518, checked in by suehring, 6 years ago

additional checks for static input file

  • Property svn:keywords set to Id
File size: 280.0 KB
Line 
1!> @file netcdf_data_input_mod.f90
2!------------------------------------------------------------------------------!
3! This file is part of the PALM model system.
4!
5! PALM is free software: you can redistribute it and/or modify it under the
6! terms of the GNU General Public License as published by the Free Software
7! Foundation, either version 3 of the License, or (at your option) any later
8! version.
9!
10! PALM is distributed in the hope that it will be useful, but WITHOUT ANY
11! WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
12! A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
13!
14! You should have received a copy of the GNU General Public License along with
15! PALM. If not, see <http://www.gnu.org/licenses/>.
16!
17! Copyright 1997-2018 Leibniz Universitaet Hannover
18!------------------------------------------------------------------------------!
19!
20! Current revisions:
21! -----------------
22!
23!
24! Former revisions:
25! -----------------
26! $Id: netcdf_data_input_mod.f90 3518 2018-11-12 18:10:23Z suehring $
27! Additional checks
28!
29! 3516 2018-11-12 15:49:39Z gronemeier
30! bugfix: - difference in z coordinate between file and PALM must be <1e-6
31!         - output of error 553 for all PEs
32!
33! 3498 2018-11-07 10:53:03Z gronemeier
34! Bugfix: print error message by processor which encounters the error
35!
36! 3485 2018-11-03 17:09:40Z gronemeier
37! - get central meridian from origin_lon if crs does not exist
38! - set default origin_lon to 0
39!
40! 3483 2018-11-02 14:19:26Z raasch
41! bugfix: misplaced directives for netCDF fixed
42!
43! 3474 2018-10-30 21:07:39Z kanani
44! Add UV exposure model input (Schrempf)
45!
46! 3472 2018-10-30 20:43:50Z suehring
47! Salsa implemented
48!
49! 3464 2018-10-30 18:08:55Z kanani
50! Define coordinate reference system (crs) and read from input dataset
51! Revise default values for reference coordinates
52!
53! 3459 2018-10-30 15:04:11Z gronemeier
54! from chemistry branch r3443, banzhafs, Russo:
55! Uncommented lines on dimension of surface_fractions
56! Removed par_emis_time_factor variable, moved to chem_emissions_mod
57! Initialized nspec and other emission variables at time of declaration
58! Modified EXPERT mode to PRE-PROCESSED mode
59! Introduced Chemistry static netcdf file
60! Added the routine for reading-in netcdf data for chemistry
61! Added routines to get_variable interface specific for chemistry files
62!
63! 3429 2018-10-25 13:04:23Z knoop
64! add default values of origin_x/y/z
65!
66! 3404 2018-10-23 13:29:11Z suehring
67! Consider time-dependent geostrophic wind components in offline nesting
68!
69! 3376 2018-10-19 10:15:32Z suehring
70! Additional check for consistent building initialization implemented
71!
72! 3347 2018-10-15 14:21:08Z suehring
73! Subroutine renamed
74!
75! 3257 2018-09-17 17:11:46Z suehring
76! (from branch resler)
77! Formatting
78!
79! 3298 2018-10-02 12:21:11Z kanani
80! Modified EXPERT mode to PRE-PROCESSED mode (Russo)
81! Introduced Chemistry static netcdf file (Russo)
82! Added the routine for reading-in netcdf data for chemistry (Russo)
83! Added routines to get_variable interface specific for chemistry files (Russo)
84!
85! 3257 2018-09-17 17:11:46Z suehring
86! Adjust checks for building_type and building_id, which is necessary after
87! topography filtering (building_type and id can be modified by the filtering).
88!
89! 3254 2018-09-17 10:53:57Z suehring
90! Additional check for surface_fractions and and checks for building_id and
91! building_type extended.
92!
93! 3241 2018-09-12 15:02:00Z raasch
94! unused variables removed
95!
96! 3215 2018-08-29 09:58:59Z suehring
97! - Separate input of soil properties from input of atmospheric data. This
98!   enables input of soil properties also in child domains without any
99!   dependence on atmospheric input
100! - Check for missing initial 1D/3D data in dynamic input file
101! - Revise checks for matching grid spacing in model and input file
102! - Bugfix, add netcdf4_parallel directive for collective read operation
103! - Revise error message numbers
104!
105! 3209 2018-08-27 16:58:37Z suehring
106! Read zsoil dimension length only if soil variables are provided
107!
108! 3183 2018-07-27 14:25:55Z suehring
109! Adjust input of dynamic driver according to revised Inifor version.
110! Replace simulated_time by time_since_reference_point.
111! Rename variables in mesoscale-offline nesting mode.
112!
113! 3182 2018-07-27 13:36:03Z suehring
114! Slightly revise check for surface_fraction in order to check only the relevant
115! fractions
116!
117! 3103 2018-07-04 17:30:52Z suehring
118! New check for negative terrain heights
119!
120! 3089 2018-06-27 13:20:38Z suehring
121! Revise call for message routine in case of local data inconsistencies.
122!
123! 3054 2018-06-01 16:08:59Z gronemeier
124! Bugfix: force an MPI abort if errors occur while reading building heights
125! from ASCII file
126!
127! 3053 2018-06-01 12:59:07Z suehring
128! Revise checks for variable surface_fraction
129!
130! 3051 2018-05-30 17:43:55Z suehring
131! - Speed-up NetCDF input
132! - Revise input routines and remove NetCDF input via IO-blocks since this is
133!   not working in parallel mode in case blocking collective read operations
134!   are done
135! - Temporarily revoke renaming of input variables in dynamic driver (tend_ug,
136!   tend_vg, zsoil) in order to keep dynamic input file working with current
137!   model version
138! - More detailed error messages created
139!
140! 3045 2018-05-28 07:55:41Z Giersch
141! Error messages revised
142!
143! 3041 2018-05-25 10:39:54Z gronemeier
144! Add data type for global file attributes
145! Add read of global attributes of static driver
146!
147! 3037 2018-05-24 10:39:29Z gronemeier
148! renamed 'depth' to 'zsoil'
149!
150! 3036 2018-05-24 10:18:26Z gronemeier
151! Revision of input vars according to UC2 data standard
152!  - renamed 'orography_2D' to 'zt'
153!  - renamed 'buildings_2D' to 'buildings_2d'
154!  - renamed 'buildings_3D' to 'buildings_3d'
155!  - renamed 'leaf_are_density' to 'lad'
156!  - renamed 'basal_are_density' to 'bad'
157!  - renamed 'root_are_density_lad' to 'root_area_dens_r'
158!  - renamed 'root_are_density_lsm' to 'root_area_dens_s'
159!  - renamed 'ls_forcing_ug' to 'tend_ug'
160!  - renamed 'ls_forcing_vg' to 'tend_vg'
161!
162! 3019 2018-05-13 07:05:43Z maronga
163! Improved reading speed of large NetCDF files
164!
165! 2963 2018-04-12 14:47:44Z suehring
166! - Revise checks for static input variables.
167! - Introduce index for vegetation/wall, pavement/green-wall and water/window
168!   surfaces, for clearer access of surface fraction, albedo, emissivity, etc. .
169!
170! 2958 2018-04-11 15:38:13Z suehring
171! Synchronize longitude and latitude between nested model domains, values are
172! taken from the root model.
173!
174! 2955 2018-04-09 15:14:01Z suehring
175! Extend checks for consistent setting of buildings, its ID and type.
176! Add log-points to measure CPU time of NetCDF data input.
177!
178! 2953 2018-04-09 11:26:02Z suehring
179! Bugfix in checks for initialization data
180!
181! 2947 2018-04-04 18:01:41Z suehring
182! Checks for dynamic input revised
183!
184! 2946 2018-04-04 17:01:23Z suehring
185! Bugfix for revision 2945, perform checks only if dynamic input file is
186! available.
187!
188! 2945 2018-04-04 16:27:14Z suehring
189! - Mimic for topography input slightly revised, in order to enable consistency
190!   checks
191! - Add checks for dimensions in dynamic input file and move already existing
192!   checks
193!
194! 2938 2018-03-27 15:52:42Z suehring
195! Initial read of geostrophic wind components from dynamic driver.
196!
197! 2773 2018-01-30 14:12:54Z suehring
198! Revise checks for surface_fraction.
199!
200! 2925 2018-03-23 14:54:11Z suehring
201! Check for further inconsistent settings of surface_fractions.
202! Some messages slightly rephrased and error numbers renamed.
203!
204! 2898 2018-03-15 13:03:01Z suehring
205! Check if each building has a type. Further, check if dimensions in static
206! input file match the model dimensions.
207!
208! 2897 2018-03-15 11:47:16Z suehring
209! Relax restrictions for topography input, terrain and building heights can be
210! input separately and are not mandatory any more.
211!
212! 2874 2018-03-13 10:55:42Z knoop
213! Bugfix: wrong placement of netcdf cpp-macros fixed
214!
215! 2794 2018-02-07 14:09:43Z knoop
216! Check if 3D building input is consistent to numeric grid.
217!
218! 2773 2018-01-30 14:12:54Z suehring
219! - Enable initialization with 3D topography.
220! - Move check for correct initialization in nesting mode to check_parameters.
221!
222! 2772 2018-01-29 13:10:35Z suehring
223! Initialization of simulation independent on land-surface model.
224!
225! 2746 2018-01-15 12:06:04Z suehring
226! Read plant-canopy variables independently on land-surface model usage
227!
228! 2718 2018-01-02 08:49:38Z maronga
229! Corrected "Former revisions" section
230!
231! 2711 2017-12-20 17:04:49Z suehring
232! Rename subroutine close_file to avoid double-naming.
233!
234! 2700 2017-12-15 14:12:35Z suehring
235!
236! 2696 2017-12-14 17:12:51Z kanani
237! Initial revision (suehring)
238!
239!
240!
241!
242! Authors:
243! --------
244! @author Matthias Suehring
245!
246! Description:
247! ------------
248!> Modulue contains routines to input data according to Palm input data
249!> standart using dynamic and static input files.
250!> @todo - Chemistry: revise reading of netcdf file and ajdust formatting according to standard!!!
251!> @todo - Order input alphabetically
252!> @todo - Revise error messages and error numbers
253!> @todo - Input of missing quantities (chemical species, emission rates)
254!> @todo - Defninition and input of still missing variable attributes
255!> @todo - Input of initial geostrophic wind profiles with cyclic conditions.
256!------------------------------------------------------------------------------!
257 MODULE netcdf_data_input_mod
258
259    USE control_parameters,                                                    &
260        ONLY:  coupling_char, io_blocks, io_group
261
262    USE cpulog,                                                                &
263        ONLY:  cpu_log, log_point_s
264
265    USE kinds
266
267#if defined ( __netcdf )
268    USE NETCDF
269#endif
270
271    USE pegrid
272
273    USE surface_mod,                                                           &
274        ONLY:  ind_pav_green, ind_veg_wall, ind_wat_win
275!
276!-- Define type for dimensions.
277    TYPE dims_xy
278       INTEGER(iwp) :: nx                             !< dimension length in x
279       INTEGER(iwp) :: ny                             !< dimension length in y
280       INTEGER(iwp) :: nz                             !< dimension length in z
281       REAL(wp), DIMENSION(:), ALLOCATABLE :: x       !< dimension array in x
282       REAL(wp), DIMENSION(:), ALLOCATABLE :: y       !< dimension array in y
283       REAL(wp), DIMENSION(:), ALLOCATABLE :: z       !< dimension array in z
284    END TYPE dims_xy
285!
286!-- Define data type for nesting in larger-scale models like COSMO.
287!-- Data type comprises u, v, w, pt, and q at lateral and top boundaries.
288    TYPE nest_offl_type
289
290       CHARACTER(LEN=100), DIMENSION(:), ALLOCATABLE ::  var_names
291
292       INTEGER(iwp) ::  nt     !< number of time levels in dynamic input file
293       INTEGER(iwp) ::  nzu    !< number of vertical levels on scalar grid in dynamic input file
294       INTEGER(iwp) ::  nzw    !< number of vertical levels on w grid in dynamic input file
295       INTEGER(iwp) ::  tind   !< time index for reference time in mesoscale-offline nesting
296       INTEGER(iwp) ::  tind_p !< time index for following time in mesoscale-offline nesting
297
298       LOGICAL      ::  init         = .FALSE.
299       LOGICAL      ::  from_file    = .FALSE.
300
301       REAL(wp), DIMENSION(:), ALLOCATABLE ::  surface_pressure !< time dependent surface pressure
302       REAL(wp), DIMENSION(:), ALLOCATABLE ::  time             !< time levels in dynamic input file
303       REAL(wp), DIMENSION(:), ALLOCATABLE ::  zu_atmos         !< vertical levels at scalar grid in dynamic input file
304       REAL(wp), DIMENSION(:), ALLOCATABLE ::  zw_atmos         !< vertical levels at w grid in dynamic input file
305
306       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  ug         !< domain-averaged geostrophic component
307       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  vg         !< domain-averaged geostrophic component
308
309       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  u_left   !< u-component at left boundary
310       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  v_left   !< v-component at left boundary
311       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  w_left   !< w-component at left boundary
312       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  q_left   !< mixing ratio at left boundary
313       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  pt_left  !< potentital temperautre at left boundary
314
315       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  u_north  !< u-component at north boundary
316       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  v_north  !< v-component at north boundary
317       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  w_north  !< w-component at north boundary
318       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  q_north  !< mixing ratio at north boundary
319       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  pt_north !< potentital temperautre at north boundary
320
321       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  u_right  !< u-component at right boundary
322       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  v_right  !< v-component at right boundary
323       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  w_right  !< w-component at right boundary
324       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  q_right  !< mixing ratio at right boundary
325       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  pt_right !< potentital temperautre at right boundary
326
327       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  u_south  !< u-component at south boundary
328       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  v_south  !< v-component at south boundary
329       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  w_south  !< w-component at south boundary
330       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  q_south  !< mixing ratio at south boundary
331       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  pt_south !< potentital temperautre at south boundary
332
333       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  u_top    !< u-component at top boundary
334       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  v_top    !< v-component at top boundary
335       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  w_top    !< w-component at top boundary
336       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  q_top    !< mixing ratio at top boundary
337       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  pt_top   !< potentital temperautre at top boundary
338
339    END TYPE nest_offl_type
340
341    TYPE init_type
342
343       CHARACTER(LEN=23) ::  origin_time !< reference time of input data
344
345       INTEGER(iwp) ::  lod_msoil !< level of detail - soil moisture
346       INTEGER(iwp) ::  lod_pt    !< level of detail - pt
347       INTEGER(iwp) ::  lod_q     !< level of detail - q
348       INTEGER(iwp) ::  lod_tsoil !< level of detail - soil temperature
349       INTEGER(iwp) ::  lod_u     !< level of detail - u-component
350       INTEGER(iwp) ::  lod_v     !< level of detail - v-component
351       INTEGER(iwp) ::  lod_w     !< level of detail - w-component
352       INTEGER(iwp) ::  nx        !< number of scalar grid points along x in dynamic input file
353       INTEGER(iwp) ::  nxu       !< number of u grid points along x in dynamic input file
354       INTEGER(iwp) ::  ny        !< number of scalar grid points along y in dynamic input file
355       INTEGER(iwp) ::  nyv       !< number of v grid points along y in dynamic input file
356       INTEGER(iwp) ::  nzs       !< number of vertical soil levels in dynamic input file
357       INTEGER(iwp) ::  nzu       !< number of vertical levels on scalar grid in dynamic input file
358       INTEGER(iwp) ::  nzw       !< number of vertical levels on w grid in dynamic input file
359
360       LOGICAL ::  from_file_msoil  = .FALSE. !< flag indicating whether soil moisture is already initialized from file
361       LOGICAL ::  from_file_pt     = .FALSE. !< flag indicating whether pt is already initialized from file
362       LOGICAL ::  from_file_q      = .FALSE. !< flag indicating whether q is already initialized from file
363       LOGICAL ::  from_file_tsoil  = .FALSE. !< flag indicating whether soil temperature is already initialized from file
364       LOGICAL ::  from_file_u      = .FALSE. !< flag indicating whether u is already initialized from file
365       LOGICAL ::  from_file_ug     = .FALSE. !< flag indicating whether ug is already initialized from file
366       LOGICAL ::  from_file_v      = .FALSE. !< flag indicating whether v is already initialized from file
367       LOGICAL ::  from_file_vg     = .FALSE. !< flag indicating whether ug is already initialized from file
368       LOGICAL ::  from_file_w      = .FALSE. !< flag indicating whether w is already initialized from file
369
370       REAL(wp) ::  fill_msoil              !< fill value for soil moisture
371       REAL(wp) ::  fill_pt                 !< fill value for pt
372       REAL(wp) ::  fill_q                  !< fill value for q
373       REAL(wp) ::  fill_tsoil              !< fill value for soil temperature
374       REAL(wp) ::  fill_u                  !< fill value for u
375       REAL(wp) ::  fill_v                  !< fill value for v
376       REAL(wp) ::  fill_w                  !< fill value for w
377       REAL(wp) ::  latitude = 0.0_wp       !< latitude of the lower left corner
378       REAL(wp) ::  longitude = 0.0_wp      !< longitude of the lower left corner
379       REAL(wp) ::  origin_x = 500000.0_wp  !< UTM easting of the lower left corner
380       REAL(wp) ::  origin_y = 0.0_wp       !< UTM northing of the lower left corner
381       REAL(wp) ::  origin_z = 0.0_wp       !< reference height of input data
382       REAL(wp) ::  rotation_angle = 0.0_wp !< rotation angle of input data
383
384       REAL(wp), DIMENSION(:), ALLOCATABLE ::  msoil_1d     !< initial vertical profile of soil moisture
385       REAL(wp), DIMENSION(:), ALLOCATABLE ::  pt_init      !< initial vertical profile of pt
386       REAL(wp), DIMENSION(:), ALLOCATABLE ::  q_init       !< initial vertical profile of q
387       REAL(wp), DIMENSION(:), ALLOCATABLE ::  tsoil_1d     !< initial vertical profile of soil temperature
388       REAL(wp), DIMENSION(:), ALLOCATABLE ::  u_init       !< initial vertical profile of u
389       REAL(wp), DIMENSION(:), ALLOCATABLE ::  ug_init      !< initial vertical profile of ug
390       REAL(wp), DIMENSION(:), ALLOCATABLE ::  v_init       !< initial vertical profile of v
391       REAL(wp), DIMENSION(:), ALLOCATABLE ::  vg_init      !< initial vertical profile of ug
392       REAL(wp), DIMENSION(:), ALLOCATABLE ::  w_init       !< initial vertical profile of w
393       REAL(wp), DIMENSION(:), ALLOCATABLE ::  z_soil       !< vertical levels in soil in dynamic input file, used for interpolation
394       REAL(wp), DIMENSION(:), ALLOCATABLE ::  zu_atmos     !< vertical levels at scalar grid in dynamic input file, used for interpolation
395       REAL(wp), DIMENSION(:), ALLOCATABLE ::  zw_atmos     !< vertical levels at w grid in dynamic input file, used for interpolation
396
397
398       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  msoil_3d !< initial 3d soil moisture provide by Inifor and interpolated onto soil grid
399       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  tsoil_3d !< initial 3d soil temperature provide by Inifor and interpolated onto soil grid
400
401    END TYPE init_type
402
403!-- Data type for the general information of chemistry emissions, do not dependent on the particular chemical species
404    TYPE chem_emis_att_type 
405
406       !-DIMENSIONS
407       INTEGER(iwp)                                 :: nspec=0                   !< number of chem species for which emission values are provided
408       INTEGER(iwp)                                 :: ncat=0                    !< number of emission categories
409       INTEGER(iwp)                                 :: nvoc=0                    !< number of VOCs components
410       INTEGER(iwp)                                 :: npm=0                     !< number of PMs components
411       INTEGER(iwp)                                 :: nnox=2                    !< number of NOx components: NO and NO2
412       INTEGER(iwp)                                 :: nsox=2                    !< number of SOx components: SO and SO4
413       INTEGER(iwp)                                 :: nhoursyear                !< number of hours of a specific year in the HOURLY mode
414                                                                                 !  of the default mode
415       INTEGER(iwp)                                 :: nmonthdayhour             !< number of month days and hours in the MDH mode
416                                                                                 !  of the default mode
417       INTEGER(iwp)                                 :: dt_emission               !< Number of emissions timesteps for one year
418                                                                                 !  in the pre-processed emissions case
419       !-- 1d emission input variables
420       CHARACTER (LEN=25),ALLOCATABLE, DIMENSION(:) :: pm_name                   !< Names of PMs components
421       CHARACTER (LEN=25),ALLOCATABLE, DIMENSION(:) :: cat_name                  !< Emission categories names
422       CHARACTER (LEN=25),ALLOCATABLE, DIMENSION(:) :: species_name              !< Names of emission chemical species
423       CHARACTER (LEN=25),ALLOCATABLE, DIMENSION(:) :: voc_name                  !< Names of VOCs components
424       CHARACTER (LEN=25)                           :: units                     !< Units
425
426       INTEGER(iwp)                                 :: i_hour                    !< indices for assigning the emission values at different timesteps
427       INTEGER(iwp),ALLOCATABLE, DIMENSION(:)       :: cat_index                 !< Index of emission categories
428       INTEGER(iwp),ALLOCATABLE, DIMENSION(:)       :: species_index             !< Index of emission chem species
429
430       REAL(wp),ALLOCATABLE, DIMENSION(:)           :: xm                        !< Molecular masses of emission chem species
431
432       !-- 2d emission input variables
433       REAL(wp),ALLOCATABLE, DIMENSION(:,:)         :: hourly_emis_time_factor   !< Time factors for HOURLY emissions (DEFAULT mode)
434       REAL(wp),ALLOCATABLE, DIMENSION(:,:)         :: mdh_emis_time_factor      !< Time factors for MDH emissions (DEFAULT mode)
435       REAL(wp),ALLOCATABLE, DIMENSION(:,:)         :: nox_comp                  !< Composition of NO and NO2
436       REAL(wp),ALLOCATABLE, DIMENSION(:,:)         :: sox_comp                  !< Composition of SO2 and SO4
437       REAL(wp),ALLOCATABLE, DIMENSION(:,:)         :: voc_comp                  !< Composition of different VOC components (number not fixed)
438
439       !-- 3d emission input variables
440       REAL(wp),ALLOCATABLE, DIMENSION(:,:,:)       :: pm_comp                   !< Composition of different PMs components (number not fixed)
441 
442    END TYPE chem_emis_att_type
443
444
445!-- Data type for the values of chemistry emissions ERUSSO
446    TYPE chem_emis_val_type 
447
448       !REAL(wp),ALLOCATABLE, DIMENSION(:,:)         :: stack_height              !< stack height
449
450       !-- 3d emission input variables
451       REAL(wp),ALLOCATABLE, DIMENSION(:,:,:)     :: default_emission_data     !< Input Values emissions DEFAULT mode
452
453       !-- 4d emission input variables
454       REAL(wp),ALLOCATABLE, DIMENSION(:,:,:,:)   :: preproc_emission_data      !< Input Values emissions PRE-PROCESSED mode
455
456    END TYPE chem_emis_val_type
457
458!
459!-- Define data structures for different input data types.
460!-- 8-bit Integer 2D
461    TYPE int_2d_8bit
462       INTEGER(KIND=1) ::  fill = -127                      !< fill value
463       INTEGER(KIND=1), DIMENSION(:,:), ALLOCATABLE ::  var !< respective variable
464
465       LOGICAL ::  from_file = .FALSE.  !< flag indicating whether an input variable is available and read from file or default values are used
466    END TYPE int_2d_8bit
467!
468!-- 8-bit Integer 3D
469    TYPE int_3d_8bit
470       INTEGER(KIND=1) ::  fill = -127                           !< fill value
471       INTEGER(KIND=1), DIMENSION(:,:,:), ALLOCATABLE ::  var_3d !< respective variable
472
473       LOGICAL ::  from_file = .FALSE.  !< flag indicating whether an input variable is available and read from file or default values are used
474    END TYPE int_3d_8bit
475!
476!-- 32-bit Integer 2D
477    TYPE int_2d_32bit
478       INTEGER(iwp) ::  fill = -9999                      !< fill value
479       INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  var  !< respective variable
480
481       LOGICAL ::  from_file = .FALSE. !< flag indicating whether an input variable is available and read from file or default values are used
482    END TYPE int_2d_32bit
483
484!
485!-- Define data type to read 2D real variables
486    TYPE real_2d
487       LOGICAL ::  from_file = .FALSE.  !< flag indicating whether an input variable is available and read from file or default values are used
488
489       REAL(wp) ::  fill = -9999.9_wp                !< fill value
490       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  var !< respective variable
491    END TYPE real_2d
492
493!
494!-- Define data type to read 3D real variables
495    TYPE real_3d
496       LOGICAL ::  from_file = .FALSE.  !< flag indicating whether an input variable is available and read from file or default values are used
497
498       INTEGER(iwp) ::  nz   !< number of grid points along vertical dimension
499
500       REAL(wp) ::  fill = -9999.9_wp                  !< fill value
501       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  var !< respective variable
502    END TYPE real_3d
503!
504!-- Define data structure where the dimension and type of the input depends
505!-- on the given level of detail.
506!-- For buildings, the input is either 2D float, or 3d byte.
507    TYPE build_in
508       INTEGER(iwp)    ::  lod = 1                               !< level of detail
509       INTEGER(KIND=1) ::  fill2 = -127                          !< fill value for lod = 2
510       INTEGER(iwp)    ::  nz                                    !< number of vertical layers in file
511       INTEGER(KIND=1), DIMENSION(:,:,:), ALLOCATABLE ::  var_3d !< 3d variable (lod = 2)
512
513       REAL(wp), DIMENSION(:), ALLOCATABLE ::  z                 !< vertical coordinate for 3D building, used for consistency check
514
515       LOGICAL ::  from_file = .FALSE.  !< flag indicating whether an input variable is available and read from file or default values are used
516
517       REAL(wp)                              ::  fill1 = -9999.9_wp !< fill values for lod = 1
518       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  var_2d             !< 2d variable (lod = 1)
519    END TYPE build_in
520
521!
522!-- For soil_type, the input is either 2D or 3D one-byte integer.
523    TYPE soil_in
524       INTEGER(iwp)                                   ::  lod = 1      !< level of detail
525       INTEGER(KIND=1)                                ::  fill = -127  !< fill value for lod = 2
526       INTEGER(KIND=1), DIMENSION(:,:), ALLOCATABLE   ::  var_2d       !< 2d variable (lod = 1)
527       INTEGER(KIND=1), DIMENSION(:,:,:), ALLOCATABLE ::  var_3d       !< 3d variable (lod = 2)
528
529       LOGICAL ::  from_file = .FALSE.  !< flag indicating whether an input variable is available and read from file or default values are used
530    END TYPE soil_in
531
532!
533!-- Define data type for fractions between surface types
534    TYPE fracs
535       INTEGER(iwp)                            ::  nf             !< total number of fractions
536       INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  nfracs         !< dimension array for fraction
537
538       LOGICAL ::  from_file = .FALSE. !< flag indicating whether an input variable is available and read from file or default values are used
539
540       REAL(wp)                                ::  fill = -9999.9_wp !< fill value
541       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  frac              !< respective fraction between different surface types
542    END TYPE fracs
543!
544!-- Data type for parameter lists, Depending on the given level of detail,
545!-- the input is 3D or 4D
546    TYPE pars
547       INTEGER(iwp)                            ::  lod = 1         !< level of detail
548       INTEGER(iwp)                            ::  np              !< total number of parameters
549       INTEGER(iwp)                            ::  nz              !< vertical dimension - number of soil layers
550       INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  layers          !< dimension array for soil layers
551       INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  pars            !< dimension array for parameters
552
553       LOGICAL ::  from_file = .FALSE.  !< flag indicating whether an input variable is available and read from file or default values are used
554
555       REAL(wp)                                  ::  fill = -9999.9_wp !< fill value
556       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE   ::  pars_xy           !< respective parameters, level of detail = 1
557       REAL(wp), DIMENSION(:,:,:,:), ALLOCATABLE ::  pars_xyz          !< respective parameters, level of detail = 2
558    END TYPE pars
559!
560!-- Define type for global file attributes
561!-- Please refer to the PALM data standard for a detailed description of each
562!-- attribute.
563    TYPE global_atts_type
564       CHARACTER(LEN=12 ) ::  acronym                            !< acronym of institution
565       CHARACTER(LEN=7)   ::  acronym_char = 'acronym'           !< name of attribute
566       CHARACTER(LEN=200) ::  author                             !< first name, last name, email adress
567       CHARACTER(LEN=6)   ::  author_char = 'author'             !< name of attribute
568       CHARACTER(LEN=12 ) ::  campaign                           !< name of campaign
569       CHARACTER(LEN=8)   ::  campaign_char = 'campaign'         !< name of attribute
570       CHARACTER(LEN=200) ::  comment                            !< comment to data
571       CHARACTER(LEN=7)   ::  comment_char = 'comment'           !< name of attribute
572       CHARACTER(LEN=200) ::  contact_person                     !< first name, last name, email adress
573       CHARACTER(LEN=14)  ::  contact_person_char = 'contact_person'  !< name of attribute
574       CHARACTER(LEN=200) ::  conventions = 'CF-1.7'             !< netCDF convention
575       CHARACTER(LEN=11)  ::  conventions_char = 'Conventions'   !< name of attribute
576       CHARACTER(LEN=23 ) ::  creation_time                      !< creation time of data set
577       CHARACTER(LEN=13)  ::  creation_time_char = 'creation_time'  !< name of attribute
578       CHARACTER(LEN=16 ) ::  data_content                       !< content of data set
579       CHARACTER(LEN=12)  ::  data_content_char = 'data_content' !< name of attribute
580       CHARACTER(LEN=200) ::  dependencies                       !< dependencies of data set
581       CHARACTER(LEN=12)  ::  dependencies_char = 'dependencies' !< name of attribute
582       CHARACTER(LEN=200) ::  history                            !< information about data processing
583       CHARACTER(LEN=7)   ::  history_char = 'history'           !< name of attribute
584       CHARACTER(LEN=200) ::  institution                        !< name of responsible institution
585       CHARACTER(LEN=11)  ::  institution_char = 'institution'   !< name of attribute
586       CHARACTER(LEN=200) ::  keywords                           !< keywords of data set
587       CHARACTER(LEN=8)   ::  keywords_char = 'keywords'         !< name of attribute
588       CHARACTER(LEN=200) ::  license                            !< license of data set
589       CHARACTER(LEN=7)   ::  license_char = 'license'           !< name of attribute
590       CHARACTER(LEN=200) ::  location                           !< place which refers to data set
591       CHARACTER(LEN=8)   ::  location_char = 'location'         !< name of attribute
592       CHARACTER(LEN=10)  ::  origin_lat_char = 'origin_lat'     !< name of attribute
593       CHARACTER(LEN=10)  ::  origin_lon_char = 'origin_lon'     !< name of attribute
594       CHARACTER(LEN=23 ) ::  origin_time                        !< reference time
595       CHARACTER(LEN=11)  ::  origin_time_char = 'origin_time'   !< name of attribute
596       CHARACTER(LEN=8)   ::  origin_x_char = 'origin_x'         !< name of attribute
597       CHARACTER(LEN=8)   ::  origin_y_char = 'origin_y'         !< name of attribute
598       CHARACTER(LEN=8)   ::  origin_z_char = 'origin_z'         !< name of attribute
599       CHARACTER(LEN=12)  ::  palm_version_char = 'palm_version' !< name of attribute
600       CHARACTER(LEN=200) ::  references                         !< literature referring to data set
601       CHARACTER(LEN=10)  ::  references_char = 'references'     !< name of attribute
602       CHARACTER(LEN=14)  ::  rotation_angle_char = 'rotation_angle'  !< name of attribute
603       CHARACTER(LEN=12 ) ::  site                               !< name of model domain
604       CHARACTER(LEN=4)   ::  site_char = 'site'                 !< name of attribute
605       CHARACTER(LEN=200) ::  source                             !< source of data set
606       CHARACTER(LEN=6)   ::  source_char = 'source'             !< name of attribute
607       CHARACTER(LEN=200) ::  title                              !< title of data set
608       CHARACTER(LEN=5)   ::  title_char = 'title'               !< name of attribute
609       CHARACTER(LEN=7)   ::  version_char = 'version'           !< name of attribute
610
611       INTEGER(iwp) ::  version              !< version of data set
612
613       REAL(wp) ::  origin_lat               !< latitude of lower left corner
614       REAL(wp) ::  origin_lon               !< longitude of lower left corner
615       REAL(wp) ::  origin_x                 !< easting (UTM coordinate) of lower left corner
616       REAL(wp) ::  origin_y                 !< northing (UTM coordinate) of lower left corner
617       REAL(wp) ::  origin_z                 !< reference height
618       REAL(wp) ::  palm_version             !< PALM version of data set
619       REAL(wp) ::  rotation_angle           !< rotation angle of coordinate system of data set
620    END TYPE global_atts_type
621!
622!-- Define type for coordinate reference system (crs)
623    TYPE crs_type
624       CHARACTER(LEN=200) ::  epsg_code = 'EPSG:25831'                   !< EPSG code
625       CHARACTER(LEN=200) ::  grid_mapping_name = 'transverse_mercator'  !< name of grid mapping
626       CHARACTER(LEN=200) ::  long_name = 'coordinate reference system'  !< name of variable crs
627       CHARACTER(LEN=200) ::  units = 'm'                                !< unit of crs
628
629       REAL(wp) ::  false_easting = 500000.0_wp                  !< false easting
630       REAL(wp) ::  false_northing = 0.0_wp                      !< false northing
631       REAL(wp) ::  inverse_flattening = 298.257223563_wp        !< 1/f (default for WGS84)
632       REAL(wp) ::  latitude_of_projection_origin = 0.0_wp       !< latitude of projection origin
633       REAL(wp) ::  longitude_of_central_meridian = 3.0_wp       !< longitude of central meridian of UTM zone (default: zone 31)
634       REAL(wp) ::  longitude_of_prime_meridian = 0.0_wp         !< longitude of prime meridian
635       REAL(wp) ::  scale_factor_at_central_meridian = 0.9996_wp !< scale factor of UTM coordinates
636       REAL(wp) ::  semi_major_axis = 6378137.0_wp               !< length of semi major axis (default for WGS84)
637    END TYPE crs_type
638
639!
640!-- Define variables
641    TYPE(crs_type)   ::  coord_ref_sys  !< coordinate reference system
642
643    TYPE(dims_xy)    ::  dim_static     !< data structure for x, y-dimension in static input file
644
645    TYPE(nest_offl_type) ::  nest_offl  !< data structure for data input at lateral and top boundaries (provided by Inifor) 
646
647    TYPE(init_type) ::  init_3d    !< data structure for the initialization of the 3D flow and soil fields
648    TYPE(init_type) ::  init_model !< data structure for the initialization of the model
649
650!
651!-- Define 2D variables of type NC_BYTE
652    TYPE(int_2d_8bit)  ::  albedo_type_f     !< input variable for albedo type
653    TYPE(int_2d_8bit)  ::  building_type_f   !< input variable for building type
654    TYPE(int_2d_8bit)  ::  pavement_type_f   !< input variable for pavenment type
655    TYPE(int_2d_8bit)  ::  street_crossing_f !< input variable for water type
656    TYPE(int_2d_8bit)  ::  street_type_f     !< input variable for water type
657    TYPE(int_2d_8bit)  ::  vegetation_type_f !< input variable for vegetation type
658    TYPE(int_2d_8bit)  ::  water_type_f      !< input variable for water type
659!
660!-- Define 3D variables of type NC_BYTE
661    TYPE(int_3d_8bit)  ::  building_obstruction_f    !< input variable for building obstruction
662    TYPE(int_3d_8bit)  ::  building_obstruction_full !< input variable for building obstruction
663!
664!-- Define 2D variables of type NC_INT
665    TYPE(int_2d_32bit) ::  building_id_f     !< input variable for building ID
666!
667!-- Define 2D variables of type NC_FLOAT
668    TYPE(real_2d) ::  terrain_height_f       !< input variable for terrain height
669    TYPE(real_2d) ::  uvem_irradiance_f      !< input variable for uvem irradiance lookup table
670    TYPE(real_2d) ::  uvem_integration_f     !< input variable for uvem integration
671!
672!-- Define 3D variables of type NC_FLOAT
673    TYPE(real_3d) ::  basal_area_density_f    !< input variable for basal area density - resolved vegetation
674    TYPE(real_3d) ::  leaf_area_density_f     !< input variable for leaf area density - resolved vegetation
675    TYPE(real_3d) ::  root_area_density_lad_f !< input variable for root area density - resolved vegetation
676    TYPE(real_3d) ::  root_area_density_lsm_f !< input variable for root area density - parametrized vegetation
677    TYPE(real_3d) ::  uvem_radiance_f         !< input variable for uvem radiance lookup table
678    TYPE(real_3d) ::  uvem_projarea_f         !< input variable for uvem projection area lookup table
679!
680!-- Define input variable for buildings
681    TYPE(build_in) ::  buildings_f           !< input variable for buildings
682!
683!-- Define input variables for soil_type
684    TYPE(soil_in)  ::  soil_type_f           !< input variable for soil type
685
686    TYPE(fracs) ::  surface_fraction_f       !< input variable for surface fraction
687
688    TYPE(pars)  ::  albedo_pars_f              !< input variable for albedo parameters
689    TYPE(pars)  ::  building_pars_f            !< input variable for building parameters
690    TYPE(pars)  ::  pavement_pars_f            !< input variable for pavement parameters
691    TYPE(pars)  ::  pavement_subsurface_pars_f !< input variable for pavement parameters
692    TYPE(pars)  ::  soil_pars_f                !< input variable for soil parameters
693    TYPE(pars)  ::  vegetation_pars_f          !< input variable for vegetation parameters
694    TYPE(pars)  ::  water_pars_f               !< input variable for water parameters
695
696    TYPE(chem_emis_att_type)                             ::  chem_emis_att    !< Input Information of Chemistry Emission Data from netcdf 
697    TYPE(chem_emis_val_type), ALLOCATABLE, DIMENSION(:)  ::  chem_emis        !< Input Chemistry Emission Data from netcdf 
698
699    CHARACTER(LEN=3)  ::  char_lod  = 'lod'         !< name of level-of-detail attribute in NetCDF file
700
701    CHARACTER(LEN=10) ::  char_fill = '_FillValue'        !< name of fill value attribute in NetCDF file
702
703    CHARACTER(LEN=100) ::  input_file_static  = 'PIDS_STATIC'  !< Name of file which comprises static input data
704    CHARACTER(LEN=100) ::  input_file_dynamic = 'PIDS_DYNAMIC' !< Name of file which comprises dynamic input data
705    CHARACTER(LEN=100) ::  input_file_chem    = 'PIDS_CHEM'    !< Name of file which comprises chemistry input data
706    CHARACTER(LEN=100) ::  input_file_uvem    = 'PIDS_UVEM'    !< Name of file which comprises static uv_exposure model input data
707    CHARACTER(LEN=100) ::  input_file_vm      = 'PIDS_VM'      !< Name of file which comprises virtual measurement data
708
709    CHARACTER (LEN=25), ALLOCATABLE, DIMENSION(:)    ::  string_values  !< output of string variables read from netcdf input files
710
711    INTEGER(iwp)                                     ::  id_emis        !< NetCDF id of input file for chemistry emissions: TBD: It has to be removed
712
713    INTEGER(iwp) ::  nc_stat         !< return value of nf90 function call
714
715    LOGICAL ::  input_pids_static  = .FALSE.   !< Flag indicating whether Palm-input-data-standard file containing static information exists
716    LOGICAL ::  input_pids_dynamic = .FALSE.   !< Flag indicating whether Palm-input-data-standard file containing dynamic information exists
717    LOGICAL ::  input_pids_chem    = .FALSE.   !< Flag indicating whether Palm-input-data-standard file containing chemistry information exists
718    LOGICAL ::  input_pids_uvem    = .FALSE.   !< Flag indicating whether uv-expoure-model input file containing static information exists
719    LOGICAL ::  input_pids_vm      = .FALSE.   !< Flag indicating whether input file for virtual measurements exist
720
721    LOGICAL ::  collective_read = .FALSE.      !< Enable NetCDF collective read
722
723    TYPE(global_atts_type) ::  input_file_atts !< global attributes of input file
724
725    SAVE
726
727    PRIVATE
728
729    INTERFACE netcdf_data_input_interpolate
730       MODULE PROCEDURE netcdf_data_input_interpolate_1d
731       MODULE PROCEDURE netcdf_data_input_interpolate_1d_soil
732       MODULE PROCEDURE netcdf_data_input_interpolate_2d
733       MODULE PROCEDURE netcdf_data_input_interpolate_3d
734    END INTERFACE netcdf_data_input_interpolate
735
736    INTERFACE netcdf_data_input_check_dynamic
737       MODULE PROCEDURE netcdf_data_input_check_dynamic
738    END INTERFACE netcdf_data_input_check_dynamic
739
740    INTERFACE netcdf_data_input_check_static
741       MODULE PROCEDURE netcdf_data_input_check_static
742    END INTERFACE netcdf_data_input_check_static
743
744    INTERFACE netcdf_data_input_chemistry_data                       
745       MODULE PROCEDURE netcdf_data_input_chemistry_data
746    END INTERFACE netcdf_data_input_chemistry_data
747   
748    INTERFACE netcdf_data_input_get_dimension_length                       
749       MODULE PROCEDURE netcdf_data_input_get_dimension_length
750    END INTERFACE netcdf_data_input_get_dimension_length
751
752    INTERFACE netcdf_data_input_inquire_file
753       MODULE PROCEDURE netcdf_data_input_inquire_file
754    END INTERFACE netcdf_data_input_inquire_file
755
756    INTERFACE netcdf_data_input_init
757       MODULE PROCEDURE netcdf_data_input_init
758    END INTERFACE netcdf_data_input_init
759   
760    INTERFACE netcdf_data_input_att
761       MODULE PROCEDURE netcdf_data_input_att_int
762       MODULE PROCEDURE netcdf_data_input_att_real
763       MODULE PROCEDURE netcdf_data_input_att_string
764    END INTERFACE netcdf_data_input_att
765
766    INTERFACE netcdf_data_input_init_3d
767       MODULE PROCEDURE netcdf_data_input_init_3d
768    END INTERFACE netcdf_data_input_init_3d
769   
770    INTERFACE netcdf_data_input_init_lsm
771       MODULE PROCEDURE netcdf_data_input_init_lsm
772    END INTERFACE netcdf_data_input_init_lsm
773
774    INTERFACE netcdf_data_input_offline_nesting
775       MODULE PROCEDURE netcdf_data_input_offline_nesting
776    END INTERFACE netcdf_data_input_offline_nesting
777
778    INTERFACE netcdf_data_input_surface_data
779       MODULE PROCEDURE netcdf_data_input_surface_data
780    END INTERFACE netcdf_data_input_surface_data
781
782    INTERFACE netcdf_data_input_var
783       MODULE PROCEDURE netcdf_data_input_var_char
784       MODULE PROCEDURE netcdf_data_input_var_real_1d
785       MODULE PROCEDURE netcdf_data_input_var_real_2d
786    END INTERFACE netcdf_data_input_var
787
788    INTERFACE netcdf_data_input_uvem
789       MODULE PROCEDURE netcdf_data_input_uvem
790    END INTERFACE netcdf_data_input_uvem
791
792    INTERFACE get_variable
793       MODULE PROCEDURE get_variable_1d_char
794       MODULE PROCEDURE get_variable_1d_int
795       MODULE PROCEDURE get_variable_1d_real
796       MODULE PROCEDURE get_variable_2d_int8
797       MODULE PROCEDURE get_variable_2d_int32
798       MODULE PROCEDURE get_variable_2d_real
799       MODULE PROCEDURE get_variable_3d_int8
800       MODULE PROCEDURE get_variable_3d_real
801       MODULE PROCEDURE get_variable_3d_real_dynamic
802       MODULE PROCEDURE get_variable_4d_to_3d_real
803       MODULE PROCEDURE get_variable_4d_real
804       MODULE PROCEDURE get_variable_5d_to_4d_real
805       MODULE PROCEDURE get_variable_string       
806    END INTERFACE get_variable
807
808    INTERFACE get_variable_pr
809       MODULE PROCEDURE get_variable_pr
810    END INTERFACE get_variable_pr
811
812    INTERFACE get_attribute
813       MODULE PROCEDURE get_attribute_real
814       MODULE PROCEDURE get_attribute_int8
815       MODULE PROCEDURE get_attribute_int32
816       MODULE PROCEDURE get_attribute_string
817    END INTERFACE get_attribute
818
819!
820!-- Public variables
821    PUBLIC albedo_pars_f, albedo_type_f, basal_area_density_f, buildings_f,    &
822           building_id_f, building_pars_f, building_type_f,                    &
823           chem_emis, chem_emis_att, chem_emis_att_type, chem_emis_val_type,   &
824           coord_ref_sys,                                                      &
825           init_3d, init_model, input_file_static, input_pids_static,          &
826           input_pids_dynamic, input_pids_vm, input_file_vm,                   &
827           leaf_area_density_f, nest_offl,                                     &
828           pavement_pars_f, pavement_subsurface_pars_f, pavement_type_f,       &
829           root_area_density_lad_f, root_area_density_lsm_f, soil_pars_f,      &
830           soil_type_f, street_crossing_f, street_type_f, surface_fraction_f,  &
831           terrain_height_f, vegetation_pars_f, vegetation_type_f,             &
832           water_pars_f, water_type_f
833!
834!-- Public uv exposure variables
835    PUBLIC building_obstruction_f, input_file_uvem, input_pids_uvem,           &
836           netcdf_data_input_uvem,                                             &
837           uvem_integration_f, uvem_irradiance_f,                              &
838           uvem_projarea_f, uvem_radiance_f
839
840!
841!-- Public subroutines
842    PUBLIC netcdf_data_input_check_dynamic, netcdf_data_input_check_static,    &
843           netcdf_data_input_chemistry_data,                                   &
844           netcdf_data_input_get_dimension_length,                             &
845           netcdf_data_input_inquire_file,                                     &
846           netcdf_data_input_init, netcdf_data_input_init_lsm,                 &
847           netcdf_data_input_init_3d, netcdf_data_input_att,                   &
848           netcdf_data_input_interpolate, netcdf_data_input_offline_nesting,   &
849           netcdf_data_input_surface_data, netcdf_data_input_topo,             &
850           netcdf_data_input_var, get_attribute, get_variable, open_read_file
851
852
853 CONTAINS
854
855!------------------------------------------------------------------------------!
856! Description:
857! ------------
858!> Inquires whether NetCDF input files according to Palm-input-data standard
859!> exist. Moreover, basic checks are performed.
860!------------------------------------------------------------------------------!
861    SUBROUTINE netcdf_data_input_inquire_file
862
863       USE control_parameters,                                                 &
864           ONLY:  topo_no_distinct
865
866       IMPLICIT NONE
867
868#if defined ( __netcdf )
869       INQUIRE( FILE = TRIM( input_file_static )   // TRIM( coupling_char ),   &
870                EXIST = input_pids_static  )
871       INQUIRE( FILE = TRIM( input_file_dynamic ) // TRIM( coupling_char ),    &
872                EXIST = input_pids_dynamic )
873       INQUIRE( FILE = TRIM( input_file_chem )    // TRIM( coupling_char ),    &
874                EXIST = input_pids_chem )
875       INQUIRE( FILE = TRIM( input_file_uvem ) // TRIM( coupling_char ),       &
876                EXIST = input_pids_uvem  )
877       INQUIRE( FILE = TRIM( input_file_vm )      // TRIM( coupling_char ),    &
878                EXIST = input_pids_vm )
879#endif
880
881!
882!--    As long as topography can be input via ASCII format, no distinction
883!--    between building and terrain can be made. This case, classify all
884!--    surfaces as default type. Same in case land-surface and urban-surface
885!--    model are not applied.
886       IF ( .NOT. input_pids_static )  THEN
887          topo_no_distinct = .TRUE.
888       ENDIF
889
890    END SUBROUTINE netcdf_data_input_inquire_file
891
892!------------------------------------------------------------------------------!
893! Description:
894! ------------
895!> Reads global attributes and coordinate reference system required for
896!> initialization of the model.
897!------------------------------------------------------------------------------!
898    SUBROUTINE netcdf_data_input_init
899
900       IMPLICIT NONE
901
902       INTEGER(iwp) ::  id_mod     !< NetCDF id of input file
903       INTEGER(iwp) ::  var_id_crs !< NetCDF id of variable crs
904
905       IF ( .NOT. input_pids_static )  RETURN
906
907#if defined ( __netcdf )
908!
909!--    Open file in read-only mode
910       CALL open_read_file( TRIM( input_file_static ) //                       &
911                            TRIM( coupling_char ), id_mod )
912!
913!--    Read global attributes
914       CALL get_attribute( id_mod, input_file_atts%origin_lat_char,            &
915                           input_file_atts%origin_lat, .TRUE. )
916
917       CALL get_attribute( id_mod, input_file_atts%origin_lon_char,            &
918                           input_file_atts%origin_lon, .TRUE. )
919
920       CALL get_attribute( id_mod, input_file_atts%origin_time_char,           &
921                           input_file_atts%origin_time, .TRUE. )
922
923       CALL get_attribute( id_mod, input_file_atts%origin_x_char,              &
924                           input_file_atts%origin_x, .TRUE. )
925
926       CALL get_attribute( id_mod, input_file_atts%origin_y_char,              &
927                           input_file_atts%origin_y, .TRUE. )
928
929       CALL get_attribute( id_mod, input_file_atts%origin_z_char,              &
930                           input_file_atts%origin_z, .TRUE. )
931
932       CALL get_attribute( id_mod, input_file_atts%rotation_angle_char,        &
933                           input_file_atts%rotation_angle, .TRUE. )
934!
935!--    Read coordinate reference system if available
936       nc_stat = NF90_INQ_VARID( id_mod, 'crs', var_id_crs )
937       IF ( nc_stat == NF90_NOERR )  THEN
938          CALL get_attribute( id_mod, 'epsg_code',                             &
939                              coord_ref_sys%epsg_code,                         &
940                              .FALSE., 'crs' )
941          CALL get_attribute( id_mod, 'false_easting',                         &
942                              coord_ref_sys%false_easting,                     &
943                              .FALSE., 'crs' )
944          CALL get_attribute( id_mod, 'false_northing',                        &
945                              coord_ref_sys%false_northing,                    &
946                              .FALSE., 'crs' )
947          CALL get_attribute( id_mod, 'grid_mapping_name',                     &
948                              coord_ref_sys%grid_mapping_name,                 &
949                              .FALSE., 'crs' )
950          CALL get_attribute( id_mod, 'inverse_flattening',                    &
951                              coord_ref_sys%inverse_flattening,                &
952                              .FALSE., 'crs' )
953          CALL get_attribute( id_mod, 'latitude_of_projection_origin',         &
954                              coord_ref_sys%latitude_of_projection_origin,     &
955                              .FALSE., 'crs' )
956          CALL get_attribute( id_mod, 'long_name',                             &
957                              coord_ref_sys%long_name,                         &
958                              .FALSE., 'crs' )
959          CALL get_attribute( id_mod, 'longitude_of_central_meridian',         &
960                              coord_ref_sys%longitude_of_central_meridian,     &
961                              .FALSE., 'crs' )
962          CALL get_attribute( id_mod, 'longitude_of_prime_meridian',           &
963                              coord_ref_sys%longitude_of_prime_meridian,       &
964                              .FALSE., 'crs' )
965          CALL get_attribute( id_mod, 'scale_factor_at_central_meridian',      &
966                              coord_ref_sys%scale_factor_at_central_meridian,  &
967                              .FALSE., 'crs' )
968          CALL get_attribute( id_mod, 'semi_major_axis',                       &
969                              coord_ref_sys%semi_major_axis,                   &
970                              .FALSE., 'crs' )
971          CALL get_attribute( id_mod, 'units',                                 &
972                              coord_ref_sys%units,                             &
973                              .FALSE., 'crs' )
974       ELSE
975!
976!--       Calculate central meridian from origin_lon
977          coord_ref_sys%longitude_of_central_meridian = &
978             CEILING( input_file_atts%origin_lon / 6.0_wp ) * 6.0_wp - 3.0_wp
979       ENDIF
980!
981!--    Finally, close input file
982       CALL close_input_file( id_mod )
983#endif
984!
985!--    Copy latitude, longitude, origin_z, rotation angle on init type
986       init_model%latitude        = input_file_atts%origin_lat
987       init_model%longitude       = input_file_atts%origin_lon
988       init_model%origin_time     = input_file_atts%origin_time 
989       init_model%origin_x        = input_file_atts%origin_x
990       init_model%origin_y        = input_file_atts%origin_y
991       init_model%origin_z        = input_file_atts%origin_z 
992       init_model%rotation_angle  = input_file_atts%rotation_angle 
993           
994!
995!--    In case of nested runs, each model domain might have different longitude
996!--    and latitude, which would result in different Coriolis parameters and
997!--    sun-zenith angles. To avoid this, longitude and latitude in each model
998!--    domain will be set to the values of the root model. Please note, this
999!--    synchronization is required already here.
1000#if defined( __parallel )
1001       CALL MPI_BCAST( init_model%latitude,  1, MPI_REAL, 0,                   &
1002                       MPI_COMM_WORLD, ierr )
1003       CALL MPI_BCAST( init_model%longitude, 1, MPI_REAL, 0,                   &
1004                       MPI_COMM_WORLD, ierr )
1005#endif
1006
1007    END SUBROUTINE netcdf_data_input_init
1008   
1009!------------------------------------------------------------------------------!
1010! Description:
1011! ------------
1012!> Read an array of characters.
1013!------------------------------------------------------------------------------!
1014    SUBROUTINE netcdf_data_input_var_char( val, search_string, id_mod )
1015
1016       IMPLICIT NONE
1017
1018       CHARACTER(LEN=*) ::  search_string     !< name of the variable
1019       CHARACTER(LEN=*), DIMENSION(:) ::  val !< variable which should be read
1020       
1021       INTEGER(iwp) ::  id_mod   !< NetCDF id of input file
1022
1023#if defined ( __netcdf )
1024!
1025!--    Read variable
1026       CALL get_variable( id_mod, search_string, val )
1027#endif           
1028
1029    END SUBROUTINE netcdf_data_input_var_char
1030   
1031!------------------------------------------------------------------------------!
1032! Description:
1033! ------------
1034!> Read an 1D array of REAL values.
1035!------------------------------------------------------------------------------!
1036    SUBROUTINE netcdf_data_input_var_real_1d( val, search_string, id_mod )
1037
1038       IMPLICIT NONE
1039
1040       CHARACTER(LEN=*) ::  search_string     !< name of the variable     
1041       
1042       INTEGER(iwp) ::  id_mod        !< NetCDF id of input file
1043       
1044       REAL(wp), DIMENSION(:) ::  val !< variable which should be read
1045
1046#if defined ( __netcdf )
1047!
1048!--    Read variable
1049       CALL get_variable( id_mod, search_string, val )
1050#endif           
1051
1052    END SUBROUTINE netcdf_data_input_var_real_1d
1053   
1054!------------------------------------------------------------------------------!
1055! Description:
1056! ------------
1057!> Read an 1D array of REAL values.
1058!------------------------------------------------------------------------------!
1059    SUBROUTINE netcdf_data_input_var_real_2d( val, search_string,              &
1060                                              id_mod, d1s, d1e, d2s, d2e )
1061
1062       IMPLICIT NONE
1063
1064       CHARACTER(LEN=*) ::  search_string     !< name of the variable     
1065       
1066       INTEGER(iwp) ::  id_mod  !< NetCDF id of input file
1067       INTEGER(iwp) ::  d1e     !< end index of first dimension to be read
1068       INTEGER(iwp) ::  d2e     !< end index of second dimension to be read
1069       INTEGER(iwp) ::  d1s     !< start index of first dimension to be read
1070       INTEGER(iwp) ::  d2s     !< start index of second dimension to be read
1071       
1072       REAL(wp), DIMENSION(:,:) ::  val !< variable which should be read
1073
1074#if defined ( __netcdf )
1075!
1076!--    Read character variable
1077       CALL get_variable( id_mod, search_string, val, d1s, d1e, d2s, d2e )
1078#endif           
1079
1080    END SUBROUTINE netcdf_data_input_var_real_2d
1081   
1082!------------------------------------------------------------------------------!
1083! Description:
1084! ------------
1085!> Read a global string attribute
1086!------------------------------------------------------------------------------!
1087    SUBROUTINE netcdf_data_input_att_string( val, search_string, id_mod,       &
1088                                             input_file, global, openclose,    &
1089                                             variable_name )
1090
1091       IMPLICIT NONE
1092
1093       CHARACTER(LEN=*) ::  search_string !< name of the attribue
1094       CHARACTER(LEN=*) ::  val           !< attribute
1095       
1096       CHARACTER(LEN=*) ::  input_file    !< name of input file
1097       CHARACTER(LEN=*) ::  openclose     !< string indicating whether NetCDF needs to be opend or closed
1098       CHARACTER(LEN=*) ::  variable_name !< string indicating whether NetCDF needs to be opend or closed 
1099       
1100       INTEGER(iwp) ::  id_mod   !< NetCDF id of input file
1101       
1102       LOGICAL ::  global                 !< flag indicating a global or a variable's attribute
1103
1104#if defined ( __netcdf )
1105!
1106!--    Open file in read-only mode if necessary
1107       IF ( openclose == 'open' )  THEN
1108          CALL open_read_file( TRIM( input_file ) // TRIM( coupling_char ), &
1109                                  id_mod )
1110       ENDIF
1111!
1112!--    Read global attribute
1113       IF ( global )  THEN
1114          CALL get_attribute( id_mod, search_string, val, global )
1115!
1116!--    Read variable attribute
1117       ELSE
1118          CALL get_attribute( id_mod, search_string, val, global, variable_name )
1119       ENDIF
1120!
1121!--    Close input file
1122       IF ( openclose == 'close' )  CALL close_input_file( id_mod )
1123#endif           
1124
1125    END SUBROUTINE netcdf_data_input_att_string
1126   
1127!------------------------------------------------------------------------------!
1128! Description:
1129! ------------
1130!> Read a global integer attribute
1131!------------------------------------------------------------------------------!
1132    SUBROUTINE netcdf_data_input_att_int( val, search_string, id_mod,          &
1133                                          input_file, global, openclose,       &
1134                                          variable_name )
1135
1136       IMPLICIT NONE
1137
1138       CHARACTER(LEN=*) ::  search_string !< name of the attribue
1139       
1140       CHARACTER(LEN=*) ::  input_file    !< name of input file
1141       CHARACTER(LEN=*) ::  openclose     !< string indicating whether NetCDF needs to be opend or closed
1142       CHARACTER(LEN=*) ::  variable_name !< string indicating whether NetCDF needs to be opend or closed
1143       
1144       INTEGER(iwp) ::  id_mod   !< NetCDF id of input file
1145       INTEGER(iwp) ::  val      !< value of the attribute
1146       
1147       LOGICAL ::  global                 !< flag indicating a global or a variable's attribute
1148
1149#if defined ( __netcdf )
1150!
1151!--    Open file in read-only mode
1152       IF ( openclose == 'open' )  THEN
1153          CALL open_read_file( TRIM( input_file ) // TRIM( coupling_char ), &
1154                                  id_mod )
1155       ENDIF
1156!
1157!--    Read global attribute
1158       IF ( global )  THEN
1159          CALL get_attribute( id_mod, search_string, val, global )
1160!
1161!--    Read variable attribute
1162       ELSE
1163          CALL get_attribute( id_mod, search_string, val, global, variable_name )
1164       ENDIF
1165!
1166!--    Finally, close input file
1167       IF ( openclose == 'close' )  CALL close_input_file( id_mod )
1168#endif           
1169
1170    END SUBROUTINE netcdf_data_input_att_int
1171   
1172!------------------------------------------------------------------------------!
1173! Description:
1174! ------------
1175!> Read a global real attribute
1176!------------------------------------------------------------------------------!
1177    SUBROUTINE netcdf_data_input_att_real( val, search_string, id_mod,         &
1178                                           input_file, global, openclose,      &
1179                                           variable_name )
1180
1181       IMPLICIT NONE
1182
1183       CHARACTER(LEN=*) ::  search_string !< name of the attribue
1184       
1185       CHARACTER(LEN=*) ::  input_file    !< name of input file
1186       CHARACTER(LEN=*) ::  openclose     !< string indicating whether NetCDF needs to be opend or closed
1187       CHARACTER(LEN=*) ::  variable_name !< string indicating whether NetCDF needs to be opend or closed
1188       
1189       INTEGER(iwp) ::  id_mod            !< NetCDF id of input file
1190       
1191       LOGICAL ::  global                 !< flag indicating a global or a variable's attribute
1192       
1193       REAL(wp) ::  val                   !< value of the attribute
1194
1195#if defined ( __netcdf )
1196!
1197!--    Open file in read-only mode
1198       IF ( openclose == 'open' )  THEN
1199          CALL open_read_file( TRIM( input_file ) // TRIM( coupling_char ), &
1200                                  id_mod )
1201       ENDIF
1202!
1203!--    Read global attribute
1204       IF ( global )  THEN
1205          CALL get_attribute( id_mod, search_string, val, global )
1206!
1207!--    Read variable attribute
1208       ELSE
1209          CALL get_attribute( id_mod, search_string, val, global, variable_name )
1210       ENDIF
1211!
1212!--    Finally, close input file
1213       IF ( openclose == 'close' )  CALL close_input_file( id_mod )
1214#endif           
1215
1216    END SUBROUTINE netcdf_data_input_att_real
1217
1218!------------------------------------------------------------------------------!
1219! Description:
1220! ------------
1221!> Reads Chemistry NETCDF Input data, such as emission values, emission species, etc. .
1222!------------------------------------------------------------------------------!
1223    SUBROUTINE netcdf_data_input_chemistry_data(emt_att,emt)
1224
1225       USE chem_modules,                                       &
1226           ONLY:  do_emis, mode_emis, time_fac_type,           & 
1227                  surface_csflux_name 
1228
1229       USE control_parameters,                                 &
1230           ONLY:  message_string
1231
1232       USE indices,                                            &
1233           ONLY:  nz, nx, ny, nxl, nxr, nys, nyn, nzb, nzt
1234
1235       IMPLICIT NONE
1236
1237       TYPE(chem_emis_att_type), INTENT(INOUT)                                        :: emt_att
1238       TYPE(chem_emis_val_type), ALLOCATABLE, DIMENSION(:), INTENT(INOUT)             :: emt
1239   
1240       CHARACTER (LEN=80)                               :: units=''              !< units of chemistry inputs
1241 
1242       INTEGER(iwp)                                     :: ispec                 !< index for number of emission species in input
1243
1244       INTEGER(iwp), ALLOCATABLE, DIMENSION(:)          :: dum_var               !< value of variable read from netcdf input
1245       INTEGER(iwp)                                     :: errno                 !< error number NF90_???? function
1246       INTEGER(iwp)                                     :: id_var                !< variable id
1247!       INTEGER(iwp)                                     :: id_emis               !< NetCDF id of input file
1248       INTEGER(iwp)                                     :: num_vars              !< number of variables in netcdf input file
1249       INTEGER(iwp)                                     :: len_dims,len_dims_2   !< Length of dimensions
1250
1251       INTEGER(iwp)                                     :: max_string_length=25  !< Variable for the maximum length of a string
1252 
1253       CHARACTER(LEN=100), DIMENSION(:), ALLOCATABLE    :: var_names             !< Name of Variables
1254
1255       REAL(wp), ALLOCATABLE, DIMENSION(:,:,:)          :: dum_var_3d            !< variable for storing temporary data of 3-dimensional
1256                                                                                 !  variables read from netcdf for chemistry emissions
1257
1258       REAL(wp), ALLOCATABLE, DIMENSION(:,:,:,:)        :: dum_var_4d            !< variable for storing temporary data of 5-dimensional
1259                                                                                 !< variables read from netcdf for chemistry emissions
1260!--
1261       !> Start the processing of the data
1262       CALL location_message( 'starting allocation of chemistry emissions arrays', .FALSE. )
1263
1264       !> Parameterized mode of the emissions
1265       IF (TRIM(mode_emis)=="PARAMETERIZED" .OR. TRIM(mode_emis)=="parameterized") THEN
1266
1267           ispec=1
1268           emt_att%nspec=0
1269
1270          !number of species
1271           DO  WHILE (TRIM( surface_csflux_name( ispec ) ) /= 'novalue' )
1272
1273             emt_att%nspec=emt_att%nspec+1
1274             ispec=ispec+1
1275
1276           ENDDO
1277
1278          !-- allocate emission values data type arrays
1279          ALLOCATE(emt(emt_att%nspec))
1280
1281          !-- Read EMISSION SPECIES NAMES
1282
1283          !Assign values
1284          ALLOCATE(emt_att%species_name(emt_att%nspec))
1285 
1286         DO ispec=1,emt_att%nspec
1287            emt_att%species_name(ispec) = TRIM(surface_csflux_name(ispec))
1288         ENDDO
1289
1290
1291       !> DEFAULT AND PRE-PROCESSED MODE
1292       ELSE
1293
1294#if defined ( __netcdf )       
1295          IF ( .NOT. input_pids_chem )  RETURN
1296
1297          !-- Open file in read-only mode
1298          CALL open_read_file( TRIM( input_file_chem ) //                       &
1299                               TRIM( coupling_char ), id_emis )
1300          !-- inquire number of variables
1301          CALL inquire_num_variables( id_emis, num_vars )
1302
1303          !-- Get General Dimension Lengths: only number of species and number of categories.
1304          !                                  the other dimensions depend on the mode of the emissions or on the presence of specific components
1305          !nspecies
1306          CALL netcdf_data_input_get_dimension_length( id_emis, emt_att%nspec, 'nspecies' )
1307
1308 
1309          !-- Allocate emission values data type arrays
1310          ALLOCATE(emt(1:emt_att%nspec))
1311
1312
1313          !-- Read EMISSION SPECIES NAMES
1314          !Allocate Arrays
1315          ALLOCATE(emt_att%species_name(emt_att%nspec)) 
1316
1317          !Call get Variable
1318          CALL get_variable( id_emis, 'emission_name', string_values, emt_att%nspec )
1319          emt_att%species_name=string_values
1320          ! If allocated, Deallocate var_string, an array only used for reading-in strings
1321          IF (ALLOCATED(string_values)) DEALLOCATE(string_values) 
1322
1323          !-- Read EMISSION SPECIES INDEX
1324          !Allocate Arrays
1325          ALLOCATE(emt_att%species_index(emt_att%nspec))
1326          !Call get Variable
1327          CALL get_variable( id_emis, 'emission_index', emt_att%species_index )
1328
1329
1330          !-- Now the routine has to distinguish between DEFAULT and PRE-PROCESSED chemistry emission modes
1331
1332          IF (TRIM(mode_emis)=="DEFAULT" .OR. TRIM(mode_emis)=="default") THEN
1333 
1334             !number of categories
1335             CALL netcdf_data_input_get_dimension_length( id_emis, emt_att%ncat, 'ncat' )
1336
1337             !-- Read EMISSION CATEGORIES INDEX
1338             !Allocate Arrays
1339             ALLOCATE(emt_att%cat_index(emt_att%ncat))
1340             !Call get Variable
1341             CALL get_variable( id_emis, 'emission_cat_index', emt_att%cat_index )
1342
1343 
1344             DO ispec=1,emt_att%nspec
1345                !-- EMISSION_VOC_NAME (1-DIMENSIONAL)
1346                IF (TRIM(emt_att%species_name(ispec))=="VOC" .OR. TRIM(emt_att%species_name(ispec))=="voc") THEN
1347                   !Allocate Array
1348                   CALL netcdf_data_input_get_dimension_length( id_emis, emt_att%nvoc, 'nvoc' )
1349                   ALLOCATE(emt_att%voc_name(1:emt_att%nvoc))
1350                   !Read-in Variable
1351                   CALL get_variable( id_emis,"emission_voc_name",string_values, emt_att%nvoc)
1352                   emt_att%voc_name=string_values
1353                   IF (ALLOCATED(string_values)) DEALLOCATE(string_values)
1354 
1355                !-- COMPOSITION VOC (2-DIMENSIONAL)
1356                   !Allocate Array
1357                   ALLOCATE(emt_att%voc_comp(1:emt_att%ncat,1:emt_att%nvoc))
1358                   !Read-in Variable
1359!               CALL get_variable(id_emis,"composition_voc",emt%voc_comp,1,1,emt%ncat,emt%nvoc)
1360                   CALL get_variable(id_emis,"composition_voc",emt_att%voc_comp,1,emt_att%ncat,1,emt_att%nvoc)
1361                ENDIF
1362
1363                !-- EMISSION_PM_NAME (1-DIMENSIONAL)
1364                IF (TRIM(emt_att%species_name(ispec))=="PM" .OR. TRIM(emt_att%species_name(ispec))=="pm") THEN
1365                   CALL netcdf_data_input_get_dimension_length( id_emis, emt_att%npm, 'npm' )
1366                   ALLOCATE(emt_att%pm_name(1:emt_att%npm))
1367                   !Read-in Variable
1368                   CALL get_variable( id_emis,"pm_name",string_values, emt_att%npm)
1369                   emt_att%pm_name=string_values
1370                   IF (ALLOCATED(string_values)) DEALLOCATE(string_values)     
1371
1372                !-- COMPOSITION PM (3-DIMENSIONAL)
1373                   !Allocate
1374                   len_dims=3  !> number of PMs: PM1, PM2.5 and PM10
1375                   ALLOCATE(emt_att%pm_comp(1:emt_att%ncat,1:emt_att%npm,1:len_dims))
1376                   !Read-in Variable
1377                   CALL get_variable(id_emis,"composition_pm",emt_att%pm_comp,1,emt_att%ncat,1,emt_att%npm,1,len_dims)                   
1378                ENDIF
1379
1380                !-- COMPOSITION_NOX (2-DIMENSIONAL)
1381                IF (TRIM(emt_att%species_name(ispec))=="NOx" .OR. TRIM(emt_att%species_name(ispec))=="nox") THEN
1382                   !Allocate array
1383                   ALLOCATE(emt_att%nox_comp(1:emt_att%ncat,1:emt_att%nnox))
1384                   !Read-in Variable
1385                   CALL get_variable(id_emis,"composition_nox",emt_att%nox_comp,1,emt_att%ncat,1,emt_att%nnox)
1386                ENDIF
1387
1388                !-- COMPOSITION-SOX (2-DIMENSIONAL)
1389                IF (TRIM(emt_att%species_name(ispec))=="SOx" .OR. TRIM(emt_att%species_name(ispec))=="sox") THEN
1390                   ALLOCATE(emt_att%sox_comp(1:emt_att%ncat,1:emt_att%nsox))
1391                   !Read-in Variable
1392                   CALL get_variable(id_emis,"composition_sox",emt_att%sox_comp,1,emt_att%ncat,1,emt_att%nsox)
1393                ENDIF
1394             ENDDO !>ispec
1395
1396!-- For reading the emission time factors, the distinction between HOUR and MDH data is necessary
1397     
1398             !-- EMISSION_TIME_SCALING_FACTORS
1399                !-- HOUR   
1400             IF (TRIM(time_fac_type)=="HOUR" .OR. TRIM(time_fac_type)=="hour") THEN
1401                !-- Allocate Array
1402                CALL netcdf_data_input_get_dimension_length( id_emis, emt_att%nhoursyear, 'nhoursyear' )
1403                ALLOCATE(emt_att%hourly_emis_time_factor(1:emt_att%ncat,1:emt_att%nhoursyear))
1404                !Read-in Variable
1405                CALL get_variable(id_emis,"emission_time_factors",emt_att%hourly_emis_time_factor,1,   &
1406                                  emt_att%ncat,1,emt_att%nhoursyear)
1407
1408                !-- MDH
1409             ELSE IF (TRIM(time_fac_type) == "MDH" .OR. TRIM(time_fac_type) == "mdh") THEN
1410                !-- Allocate Array
1411                CALL netcdf_data_input_get_dimension_length( id_emis, emt_att%nmonthdayhour, 'nmonthdayhour' )
1412                ALLOCATE(emt_att%mdh_emis_time_factor(1:emt_att%ncat,1:emt_att%nmonthdayhour))
1413                !-- Read-in Variable
1414                CALL get_variable(id_emis,"emission_time_factors",emt_att%mdh_emis_time_factor,1,       &
1415                                  emt_att%ncat,1,emt_att%nmonthdayhour)
1416
1417             ELSE
1418
1419             message_string = 'We are in the DEFAULT chemistry emissions mode: '            //          &
1420                              '     !no time-factor type specified!'                        //          &
1421                              'Please, specify the value of time_fac_type:'                 //          &
1422                              '         either "MDH" or "HOUR"'                 
1423             CALL message( 'netcdf_data_input_chemistry_data', 'CM0200', 2, 2, 0, 6, 0 ) 
1424 
1425
1426             ENDIF
1427
1428             !-- Finally read-in the emission values and their units (DEFAULT mode)
1429
1430             DO ispec=1,emt_att%nspec
1431
1432                IF ( .NOT. ALLOCATED( emt(ispec)%default_emission_data ) )                              &
1433                    ALLOCATE(emt(ispec)%default_emission_data(1:emt_att%ncat,1:ny+1,1:nx+1))
1434
1435                ALLOCATE(dum_var_3d(1:emt_att%ncat,nys+1:nyn+1,nxl+1:nxr+1))
1436
1437                CALL get_variable(id_emis,"emission_values",dum_var_3d,ispec,1,emt_att%ncat,nys,nyn,nxl,nxr)         
1438
1439                emt(ispec)%default_emission_data(:,nys+1:nyn+1,nxl+1:nxr+1) =                           &
1440                    dum_var_3d(1:emt_att%ncat,nys+1:nyn+1,nxl+1:nxr+1)
1441
1442                DEALLOCATE (dum_var_3d)
1443
1444             ENDDO
1445
1446             !-- UNITS
1447             CALL get_attribute(id_emis,"units",emt_att%units,.FALSE.,"emission_values")
1448
1449
1450          !-- PRE-PROCESSED MODE --
1451
1452          ELSE IF (TRIM(mode_emis)=="PRE-PROCESSED" .OR. TRIM(mode_emis)=="pre-processed") THEN
1453          !-- In the PRE-PROCESSED mode, only the VOC names, the VOC_composition, the emission values and their units remain to be read at this point
1454
1455             DO ispec=1,emt_att%nspec
1456
1457             !-- EMISSION_VOC_NAME (1-DIMENSIONAL)
1458                IF (TRIM(emt_att%species_name(ispec))=="VOC" .OR. TRIM(emt_att%species_name(ispec))=="voc") THEN
1459                   !Allocate Array
1460                   CALL netcdf_data_input_get_dimension_length( id_emis, emt_att%nvoc, 'nvoc' )
1461                   ALLOCATE(emt_att%voc_name(1:emt_att%nvoc))
1462                   !Read-in Variable
1463                   CALL get_variable( id_emis,"emission_voc_name",string_values, emt_att%nvoc)
1464                   emt_att%voc_name=string_values
1465                   IF (ALLOCATED(string_values)) DEALLOCATE(string_values)
1466 
1467             !-- COMPOSITION VOC (2-DIMENSIONAL)
1468                   !Allocate Array
1469                   ALLOCATE(emt_att%voc_comp(1:emt_att%ncat,1:emt_att%nvoc))
1470                   !Read-in Variable
1471                   CALL get_variable(id_emis,"composition_voc",emt_att%voc_comp,1,emt_att%ncat,1,emt_att%nvoc)
1472                ENDIF
1473 
1474             ENDDO !> ispec
1475
1476             !-- EMISSION_VALUES (4-DIMENSIONAL)
1477             !Calculate temporal dimension length
1478             CALL netcdf_data_input_get_dimension_length( id_emis, emt_att%dt_emission, 'time' )   
1479         
1480
1481             DO ispec=1,emt_att%nspec
1482
1483                !Allocation for the entire domain has to be done only for the first processor between all the subdomains     
1484                IF ( .NOT. ALLOCATED( emt(ispec)%preproc_emission_data ) )                              &
1485                    ALLOCATE(emt(ispec)%preproc_emission_data(emt_att%dt_emission,1,1:ny+1,1:nx+1))
1486
1487                !> allocate variable where to pass emission values read from netcdf
1488                ALLOCATE(dum_var_4d(1:emt_att%dt_emission,1,nys+1:nyn+1,nxl+1:nxr+1))
1489
1490                !Read-in Variable
1491                CALL get_variable(id_emis,"emission_values",dum_var_4d,ispec,1,emt_att%dt_emission,1,1,nys,nyn,nxl,nxr)         
1492
1493     
1494                emt(ispec)%preproc_emission_data(:,1,nys+1:nyn+1,nxl+1:nxr+1) =                         &
1495                      dum_var_4d(1:emt_att%dt_emission,1,nys+1:nyn+1,nxl+1:nxr+1)
1496
1497                DEALLOCATE ( dum_var_4d )
1498
1499             ENDDO
1500
1501             !-- UNITS
1502             CALL get_attribute(id_emis,"units",emt_att%units,.FALSE.,"emission_values")
1503       
1504          ENDIF
1505
1506       CALL close_input_file( id_emis )
1507
1508#endif
1509       ENDIF
1510
1511    END SUBROUTINE netcdf_data_input_chemistry_data
1512
1513!------------------------------------------------------------------------------!
1514! Description:
1515! ------------
1516!> Reads surface classification data, such as vegetation and soil type, etc. .
1517!------------------------------------------------------------------------------!
1518    SUBROUTINE netcdf_data_input_surface_data
1519
1520       USE control_parameters,                                                 &
1521           ONLY:  bc_lr_cyc, bc_ns_cyc, land_surface, plant_canopy,            &
1522                  urban_surface
1523
1524       USE indices,                                                            &
1525           ONLY:  nbgp, nx, nxl, nxlg, nxr, nxrg, ny, nyn, nyng, nys, nysg
1526
1527
1528       IMPLICIT NONE
1529
1530       CHARACTER(LEN=100), DIMENSION(:), ALLOCATABLE ::  var_names  !< variable names in static input file
1531
1532       INTEGER(iwp) ::  id_surf   !< NetCDF id of input file
1533       INTEGER(iwp) ::  k         !< running index along z-direction
1534       INTEGER(iwp) ::  k2        !< running index
1535       INTEGER(iwp) ::  num_vars  !< number of variables in input file
1536       INTEGER(iwp) ::  nz_soil   !< number of soil layers in file
1537
1538       INTEGER(iwp), DIMENSION(nysg:nyng,nxlg:nxrg) ::  var_exchange_int !< dummy variables used to exchange 32-bit Integer arrays
1539       INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE  ::  var_dum_int_3d !< dummy variables used to exchange real arrays
1540
1541       REAL(wp), DIMENSION(nysg:nyng,nxlg:nxrg) ::  var_exchange_real !< dummy variables used to exchange real arrays
1542
1543       REAL(wp), DIMENSION(:,:,:),   ALLOCATABLE ::  var_dum_real_3d !< dummy variables used to exchange real arrays
1544       REAL(wp), DIMENSION(:,:,:,:), ALLOCATABLE ::  var_dum_real_4d !< dummy variables used to exchange real arrays
1545
1546!
1547!--    If not static input file is available, skip this routine
1548       IF ( .NOT. input_pids_static )  RETURN
1549!
1550!--    Measure CPU time
1551       CALL cpu_log( log_point_s(82), 'NetCDF input', 'start' )
1552!
1553!--    Read plant canopy variables.
1554       IF ( plant_canopy )  THEN
1555#if defined ( __netcdf )
1556!
1557!--       Open file in read-only mode
1558          CALL open_read_file( TRIM( input_file_static ) //                    &
1559                               TRIM( coupling_char ) , id_surf )
1560!
1561!--       At first, inquire all variable names.
1562!--       This will be used to check whether an optional input variable
1563!--       exist or not.
1564          CALL inquire_num_variables( id_surf, num_vars )
1565
1566          ALLOCATE( var_names(1:num_vars) )
1567          CALL inquire_variable_names( id_surf, var_names )
1568
1569!
1570!--       Read leaf area density - resolved vegetation
1571          IF ( check_existence( var_names, 'lad' ) )  THEN
1572             leaf_area_density_f%from_file = .TRUE.
1573             CALL get_attribute( id_surf, char_fill,                           &
1574                                 leaf_area_density_f%fill,                     &
1575                                 .FALSE., 'lad' )
1576!
1577!--          Inquire number of vertical vegetation layer
1578             CALL netcdf_data_input_get_dimension_length( id_surf,             &
1579                                                 leaf_area_density_f%nz,       &
1580                                                 'zlad' )
1581!
1582!--          Allocate variable for leaf-area density
1583             ALLOCATE( leaf_area_density_f%var( 0:leaf_area_density_f%nz-1,    &
1584                                                nys:nyn,nxl:nxr) )
1585
1586             CALL get_variable( id_surf, 'lad', leaf_area_density_f%var,       &
1587                                nxl, nxr, nys, nyn,                            &
1588                                0, leaf_area_density_f%nz-1 )
1589
1590          ELSE
1591             leaf_area_density_f%from_file = .FALSE.
1592          ENDIF
1593
1594!
1595!--       Read basal area density - resolved vegetation
1596          IF ( check_existence( var_names, 'bad' ) )  THEN
1597             basal_area_density_f%from_file = .TRUE.
1598             CALL get_attribute( id_surf, char_fill,                           &
1599                                 basal_area_density_f%fill,                    &
1600                                 .FALSE., 'bad' )
1601!
1602!--          Inquire number of vertical vegetation layer
1603             CALL netcdf_data_input_get_dimension_length( id_surf,             &
1604                                                 basal_area_density_f%nz,      &
1605                                                 'zlad' )
1606!
1607!--          Allocate variable
1608             ALLOCATE( basal_area_density_f%var(0:basal_area_density_f%nz-1,   &
1609                                                nys:nyn,nxl:nxr) )
1610
1611             CALL get_variable( id_surf, 'bad', basal_area_density_f%var,      &
1612                                nxl, nxr, nys, nyn,                            &
1613                                0,  basal_area_density_f%nz-1 )
1614          ELSE
1615             basal_area_density_f%from_file = .FALSE.
1616          ENDIF
1617
1618!
1619!--       Read root area density - resolved vegetation
1620          IF ( check_existence( var_names, 'root_area_dens_r' ) )  THEN
1621             root_area_density_lad_f%from_file = .TRUE.
1622             CALL get_attribute( id_surf, char_fill,                           &
1623                                 root_area_density_lad_f%fill,                 &
1624                                 .FALSE., 'root_area_dens_r' )
1625!
1626!--          Inquire number of vertical soil layers
1627             CALL netcdf_data_input_get_dimension_length( id_surf,             &
1628                                                   root_area_density_lad_f%nz, &
1629                                                  'zsoil' )
1630!
1631!--          Allocate variable
1632             ALLOCATE( root_area_density_lad_f%var                             &
1633                                         (0:root_area_density_lad_f%nz-1,      &
1634                                          nys:nyn,nxl:nxr) )
1635
1636             CALL get_variable( id_surf, 'root_area_dens_r',                   &
1637                                root_area_density_lad_f%var,                   &
1638                                nxl, nxr, nys, nyn,                            &
1639                                0,  root_area_density_lad_f%nz-1 )
1640          ELSE
1641             root_area_density_lad_f%from_file = .FALSE.
1642          ENDIF
1643!
1644!--       Finally, close input file
1645          CALL close_input_file( id_surf )
1646#endif
1647       ENDIF
1648!
1649!--    Deallocate variable list. Will be re-allocated in case further
1650!--    variables are read from file.
1651       IF ( ALLOCATED( var_names ) )  DEALLOCATE( var_names )
1652!
1653!--    Skip the following if no land-surface or urban-surface module are
1654!--    applied. This case, no one of the following variables is used anyway.
1655       IF (  .NOT. land_surface  .AND.  .NOT. urban_surface )  RETURN
1656!
1657!--    Initialize dummy arrays used for ghost-point exchange
1658       var_exchange_int  = 0
1659       var_exchange_real = 0.0_wp
1660
1661#if defined ( __netcdf )
1662!
1663!--    Open file in read-only mode
1664       CALL open_read_file( TRIM( input_file_static ) //                       &
1665                            TRIM( coupling_char ) , id_surf )
1666!
1667!--    Inquire all variable names.
1668!--    This will be used to check whether an optional input variable exist
1669!--    or not.
1670       CALL inquire_num_variables( id_surf, num_vars )
1671
1672       ALLOCATE( var_names(1:num_vars) )
1673       CALL inquire_variable_names( id_surf, var_names )
1674!
1675!--    Read vegetation type and required attributes
1676       IF ( check_existence( var_names, 'vegetation_type' ) )  THEN
1677          vegetation_type_f%from_file = .TRUE.
1678          CALL get_attribute( id_surf, char_fill,                              &
1679                              vegetation_type_f%fill,                          &
1680                              .FALSE., 'vegetation_type' )
1681
1682          ALLOCATE ( vegetation_type_f%var(nys:nyn,nxl:nxr)  )
1683
1684          CALL get_variable( id_surf, 'vegetation_type',                       &
1685                             vegetation_type_f%var, nxl, nxr, nys, nyn )
1686       ELSE
1687          vegetation_type_f%from_file = .FALSE.
1688       ENDIF
1689
1690!
1691!--    Read soil type and required attributes
1692       IF ( check_existence( var_names, 'soil_type' ) )  THEN
1693             soil_type_f%from_file = .TRUE.
1694!
1695!--       Note, lod is currently not on file; skip for the moment
1696!           CALL get_attribute( id_surf, char_lod,                       &
1697!                                      soil_type_f%lod,                  &
1698!                                      .FALSE., 'soil_type' )
1699          CALL get_attribute( id_surf, char_fill,                              &
1700                              soil_type_f%fill,                                &
1701                              .FALSE., 'soil_type' )
1702
1703          IF ( soil_type_f%lod == 1 )  THEN
1704
1705             ALLOCATE ( soil_type_f%var_2d(nys:nyn,nxl:nxr)  )
1706
1707             CALL get_variable( id_surf, 'soil_type', soil_type_f%var_2d,      &
1708                                nxl, nxr, nys, nyn )
1709
1710          ELSEIF ( soil_type_f%lod == 2 )  THEN
1711!
1712!--          Obtain number of soil layers from file.
1713             CALL netcdf_data_input_get_dimension_length( id_surf, nz_soil,    &
1714                                                          'zsoil' )
1715
1716             ALLOCATE ( soil_type_f%var_3d(0:nz_soil,nys:nyn,nxl:nxr) )
1717
1718             CALL get_variable( id_surf, 'soil_type', soil_type_f%var_3d,      &
1719                                nxl, nxr, nys, nyn, 0, nz_soil )
1720 
1721          ENDIF
1722       ELSE
1723          soil_type_f%from_file = .FALSE.
1724       ENDIF
1725
1726!
1727!--    Read pavement type and required attributes
1728       IF ( check_existence( var_names, 'pavement_type' ) )  THEN
1729          pavement_type_f%from_file = .TRUE.
1730          CALL get_attribute( id_surf, char_fill,                              &
1731                              pavement_type_f%fill, .FALSE.,                   &
1732                              'pavement_type' )
1733
1734          ALLOCATE ( pavement_type_f%var(nys:nyn,nxl:nxr)  )
1735
1736          CALL get_variable( id_surf, 'pavement_type', pavement_type_f%var,    &
1737                             nxl, nxr, nys, nyn )
1738       ELSE
1739          pavement_type_f%from_file = .FALSE.
1740       ENDIF
1741
1742!
1743!--    Read water type and required attributes
1744       IF ( check_existence( var_names, 'water_type' ) )  THEN
1745          water_type_f%from_file = .TRUE.
1746          CALL get_attribute( id_surf, char_fill, water_type_f%fill,           &
1747                              .FALSE., 'water_type' )
1748
1749          ALLOCATE ( water_type_f%var(nys:nyn,nxl:nxr)  )
1750
1751          CALL get_variable( id_surf, 'water_type', water_type_f%var,          &
1752                             nxl, nxr, nys, nyn )
1753
1754       ELSE
1755          water_type_f%from_file = .FALSE.
1756       ENDIF
1757!
1758!--    Read relative surface fractions of vegetation, pavement and water.
1759       IF ( check_existence( var_names, 'surface_fraction' ) )  THEN
1760          surface_fraction_f%from_file = .TRUE.
1761          CALL get_attribute( id_surf, char_fill,                              &
1762                              surface_fraction_f%fill,                         &
1763                              .FALSE., 'surface_fraction' )
1764!
1765!--       Inquire number of surface fractions
1766          CALL netcdf_data_input_get_dimension_length( id_surf,                &
1767                                                       surface_fraction_f%nf,  &
1768                                                       'nsurface_fraction' )
1769!
1770!--       Allocate dimension array and input array for surface fractions
1771          ALLOCATE( surface_fraction_f%nfracs(0:surface_fraction_f%nf-1) )
1772          ALLOCATE( surface_fraction_f%frac(0:surface_fraction_f%nf-1,         &
1773                                            nys:nyn,nxl:nxr) )
1774!
1775!--       Get dimension of surface fractions
1776          CALL get_variable( id_surf, 'nsurface_fraction',                     &
1777                             surface_fraction_f%nfracs )
1778!
1779!--       Read surface fractions
1780          CALL get_variable( id_surf, 'surface_fraction',                      &
1781                             surface_fraction_f%frac, nxl, nxr, nys, nyn,      &
1782                             0, surface_fraction_f%nf-1 )
1783       ELSE
1784          surface_fraction_f%from_file = .FALSE.
1785       ENDIF
1786!
1787!--    Read building parameters and related information
1788       IF ( check_existence( var_names, 'building_pars' ) )  THEN
1789          building_pars_f%from_file = .TRUE.
1790          CALL get_attribute( id_surf, char_fill,                              &
1791                              building_pars_f%fill,                            &
1792                              .FALSE., 'building_pars' )
1793!
1794!--       Inquire number of building parameters
1795          CALL netcdf_data_input_get_dimension_length( id_surf,                &
1796                                                       building_pars_f%np,     &
1797                                                       'nbuilding_pars' )
1798!
1799!--       Allocate dimension array and input array for building parameters
1800          ALLOCATE( building_pars_f%pars(0:building_pars_f%np-1) )
1801          ALLOCATE( building_pars_f%pars_xy(0:building_pars_f%np-1,            &
1802                                            nys:nyn,nxl:nxr) )
1803!
1804!--       Get dimension of building parameters
1805          CALL get_variable( id_surf, 'nbuilding_pars',                        &
1806                             building_pars_f%pars )
1807!
1808!--       Read building_pars
1809          CALL get_variable( id_surf, 'building_pars',                         &
1810                             building_pars_f%pars_xy, nxl, nxr, nys, nyn,      &
1811                             0, building_pars_f%np-1 )
1812       ELSE
1813          building_pars_f%from_file = .FALSE.
1814       ENDIF
1815
1816!
1817!--    Read albedo type and required attributes
1818       IF ( check_existence( var_names, 'albedo_type' ) )  THEN
1819          albedo_type_f%from_file = .TRUE.
1820          CALL get_attribute( id_surf, char_fill, albedo_type_f%fill,          &
1821                              .FALSE.,  'albedo_type' )
1822
1823          ALLOCATE ( albedo_type_f%var(nys:nyn,nxl:nxr)  )
1824         
1825          CALL get_variable( id_surf, 'albedo_type', albedo_type_f%var,        &
1826                             nxl, nxr, nys, nyn )
1827       ELSE
1828          albedo_type_f%from_file = .FALSE.
1829       ENDIF
1830!
1831!--    Read albedo parameters and related information
1832       IF ( check_existence( var_names, 'albedo_pars' ) )  THEN
1833          albedo_pars_f%from_file = .TRUE.
1834          CALL get_attribute( id_surf, char_fill, albedo_pars_f%fill,          &
1835                              .FALSE., 'albedo_pars' )
1836!
1837!--       Inquire number of albedo parameters
1838          CALL netcdf_data_input_get_dimension_length( id_surf,                &
1839                                                       albedo_pars_f%np,       &
1840                                                       'nalbedo_pars' )
1841!
1842!--       Allocate dimension array and input array for albedo parameters
1843          ALLOCATE( albedo_pars_f%pars(0:albedo_pars_f%np-1) )
1844          ALLOCATE( albedo_pars_f%pars_xy(0:albedo_pars_f%np-1,                &
1845                                          nys:nyn,nxl:nxr) )
1846!
1847!--       Get dimension of albedo parameters
1848          CALL get_variable( id_surf, 'nalbedo_pars', albedo_pars_f%pars )
1849
1850          CALL get_variable( id_surf, 'albedo_pars', albedo_pars_f%pars_xy,    &
1851                             nxl, nxr, nys, nyn,                               &
1852                             0, albedo_pars_f%np-1 )
1853       ELSE
1854          albedo_pars_f%from_file = .FALSE.
1855       ENDIF
1856
1857!
1858!--    Read pavement parameters and related information
1859       IF ( check_existence( var_names, 'pavement_pars' ) )  THEN
1860          pavement_pars_f%from_file = .TRUE.
1861          CALL get_attribute( id_surf, char_fill,                              &
1862                              pavement_pars_f%fill,                            &
1863                              .FALSE., 'pavement_pars' )
1864!
1865!--       Inquire number of pavement parameters
1866          CALL netcdf_data_input_get_dimension_length( id_surf,                &
1867                                                       pavement_pars_f%np,     &
1868                                                       'npavement_pars' )
1869!
1870!--       Allocate dimension array and input array for pavement parameters
1871          ALLOCATE( pavement_pars_f%pars(0:pavement_pars_f%np-1) )
1872          ALLOCATE( pavement_pars_f%pars_xy(0:pavement_pars_f%np-1,            &
1873                                            nys:nyn,nxl:nxr) )
1874!
1875!--       Get dimension of pavement parameters
1876          CALL get_variable( id_surf, 'npavement_pars', pavement_pars_f%pars )
1877
1878          CALL get_variable( id_surf, 'pavement_pars', pavement_pars_f%pars_xy,&
1879                             nxl, nxr, nys, nyn,                               &
1880                             0, pavement_pars_f%np-1 )
1881       ELSE
1882          pavement_pars_f%from_file = .FALSE.
1883       ENDIF
1884
1885!
1886!--    Read pavement subsurface parameters and related information
1887       IF ( check_existence( var_names, 'pavement_subsurface_pars' ) )         &
1888       THEN
1889          pavement_subsurface_pars_f%from_file = .TRUE.
1890          CALL get_attribute( id_surf, char_fill,                              &
1891                              pavement_subsurface_pars_f%fill,                 &
1892                              .FALSE., 'pavement_subsurface_pars' )
1893!
1894!--       Inquire number of parameters
1895          CALL netcdf_data_input_get_dimension_length( id_surf,                &
1896                                                pavement_subsurface_pars_f%np, &
1897                                               'npavement_subsurface_pars' )
1898!
1899!--       Inquire number of soil layers
1900          CALL netcdf_data_input_get_dimension_length( id_surf,                &
1901                                                pavement_subsurface_pars_f%nz, &
1902                                                'zsoil' )
1903!
1904!--       Allocate dimension array and input array for pavement parameters
1905          ALLOCATE( pavement_subsurface_pars_f%pars                            &
1906                            (0:pavement_subsurface_pars_f%np-1) )
1907          ALLOCATE( pavement_subsurface_pars_f%pars_xyz                        &
1908                            (0:pavement_subsurface_pars_f%np-1,                &
1909                             0:pavement_subsurface_pars_f%nz-1,                &
1910                             nys:nyn,nxl:nxr) )
1911!
1912!--       Get dimension of pavement parameters
1913          CALL get_variable( id_surf, 'npavement_subsurface_pars',             &
1914                             pavement_subsurface_pars_f%pars )
1915
1916          CALL get_variable( id_surf, 'pavement_subsurface_pars',              &
1917                             pavement_subsurface_pars_f%pars_xyz,              &
1918                             nxl, nxr, nys, nyn,                               &
1919                             0, pavement_subsurface_pars_f%nz-1,               &
1920                             0, pavement_subsurface_pars_f%np-1 )
1921       ELSE
1922          pavement_subsurface_pars_f%from_file = .FALSE.
1923       ENDIF
1924
1925
1926!
1927!--    Read vegetation parameters and related information
1928       IF ( check_existence( var_names, 'vegetation_pars' ) )  THEN
1929          vegetation_pars_f%from_file = .TRUE.
1930          CALL get_attribute( id_surf, char_fill,                              &
1931                              vegetation_pars_f%fill,                          &
1932                              .FALSE.,  'vegetation_pars' )
1933!
1934!--       Inquire number of vegetation parameters
1935          CALL netcdf_data_input_get_dimension_length( id_surf,                &
1936                                                       vegetation_pars_f%np,   &
1937                                                       'nvegetation_pars' )
1938!
1939!--       Allocate dimension array and input array for surface fractions
1940          ALLOCATE( vegetation_pars_f%pars(0:vegetation_pars_f%np-1) )
1941          ALLOCATE( vegetation_pars_f%pars_xy(0:vegetation_pars_f%np-1,        &
1942                                              nys:nyn,nxl:nxr) )
1943!
1944!--       Get dimension of the parameters
1945          CALL get_variable( id_surf, 'nvegetation_pars',                      &
1946                             vegetation_pars_f%pars )
1947
1948          CALL get_variable( id_surf, 'vegetation_pars',                       &
1949                             vegetation_pars_f%pars_xy, nxl, nxr, nys, nyn,    &
1950                             0, vegetation_pars_f%np-1 )
1951       ELSE
1952          vegetation_pars_f%from_file = .FALSE.
1953       ENDIF
1954
1955!
1956!--    Read root parameters/distribution and related information
1957       IF ( check_existence( var_names, 'soil_pars' ) )  THEN
1958          soil_pars_f%from_file = .TRUE.
1959          CALL get_attribute( id_surf, char_fill,                              &
1960                              soil_pars_f%fill,                                &
1961                              .FALSE., 'soil_pars' )
1962
1963          CALL get_attribute( id_surf, char_lod,                               &
1964                              soil_pars_f%lod,                                 &
1965                              .FALSE., 'soil_pars' )
1966
1967!
1968!--       Inquire number of soil parameters
1969          CALL netcdf_data_input_get_dimension_length( id_surf,                &
1970                                                       soil_pars_f%np,         &
1971                                                       'nsoil_pars' )
1972!
1973!--       Read parameters array
1974          ALLOCATE( soil_pars_f%pars(0:soil_pars_f%np-1) )
1975          CALL get_variable( id_surf, 'nsoil_pars', soil_pars_f%pars )
1976
1977!
1978!--       In case of level of detail 2, also inquire number of vertical
1979!--       soil layers, allocate memory and read the respective dimension
1980          IF ( soil_pars_f%lod == 2 )  THEN
1981             CALL netcdf_data_input_get_dimension_length( id_surf,             &
1982                                                          soil_pars_f%nz,      &
1983                                                          'zsoil' )
1984
1985             ALLOCATE( soil_pars_f%layers(0:soil_pars_f%nz-1) )
1986             CALL get_variable( id_surf, 'zsoil', soil_pars_f%layers )
1987
1988          ENDIF
1989
1990!
1991!--       Read soil parameters, depending on level of detail
1992          IF ( soil_pars_f%lod == 1 )  THEN
1993             ALLOCATE( soil_pars_f%pars_xy(0:soil_pars_f%np-1,                 &
1994                                           nys:nyn,nxl:nxr) )
1995                 
1996             CALL get_variable( id_surf, 'soil_pars', soil_pars_f%pars_xy,     &
1997                                nxl, nxr, nys, nyn, 0, soil_pars_f%np-1 )
1998
1999          ELSEIF ( soil_pars_f%lod == 2 )  THEN
2000             ALLOCATE( soil_pars_f%pars_xyz(0:soil_pars_f%np-1,                &
2001                                            0:soil_pars_f%nz-1,                &
2002                                            nys:nyn,nxl:nxr) )
2003             CALL get_variable( id_surf, 'soil_pars',                          &
2004                                soil_pars_f%pars_xyz,                          &
2005                                nxl, nxr, nys, nyn, 0, soil_pars_f%nz-1,       &
2006                                0, soil_pars_f%np-1 )
2007
2008          ENDIF
2009       ELSE
2010          soil_pars_f%from_file = .FALSE.
2011       ENDIF
2012
2013!
2014!--    Read water parameters and related information
2015       IF ( check_existence( var_names, 'water_pars' ) )  THEN
2016          water_pars_f%from_file = .TRUE.
2017          CALL get_attribute( id_surf, char_fill,                              &
2018                              water_pars_f%fill,                               &
2019                              .FALSE., 'water_pars' )
2020!
2021!--       Inquire number of water parameters
2022          CALL netcdf_data_input_get_dimension_length( id_surf,                &
2023                                                       water_pars_f%np,        &
2024                                                       'nwater_pars' )
2025!
2026!--       Allocate dimension array and input array for water parameters
2027          ALLOCATE( water_pars_f%pars(0:water_pars_f%np-1) )
2028          ALLOCATE( water_pars_f%pars_xy(0:water_pars_f%np-1,                  &
2029                                         nys:nyn,nxl:nxr) )
2030!
2031!--       Get dimension of water parameters
2032          CALL get_variable( id_surf, 'nwater_pars', water_pars_f%pars )
2033
2034          CALL get_variable( id_surf, 'water_pars', water_pars_f%pars_xy,      &
2035                             nxl, nxr, nys, nyn, 0, water_pars_f%np-1 )
2036       ELSE
2037          water_pars_f%from_file = .FALSE.
2038       ENDIF
2039!
2040!--    Read root area density - parametrized vegetation
2041       IF ( check_existence( var_names, 'root_area_dens_s' ) )  THEN
2042          root_area_density_lsm_f%from_file = .TRUE.
2043          CALL get_attribute( id_surf, char_fill,                              &
2044                              root_area_density_lsm_f%fill,                    &
2045                              .FALSE., 'root_area_dens_s' )
2046!
2047!--       Obtain number of soil layers from file and allocate variable
2048          CALL netcdf_data_input_get_dimension_length( id_surf,                &
2049                                                   root_area_density_lsm_f%nz, &
2050                                                   'zsoil' )
2051          ALLOCATE( root_area_density_lsm_f%var                                &
2052                                        (0:root_area_density_lsm_f%nz-1,       &
2053                                         nys:nyn,nxl:nxr) )
2054
2055!
2056!--       Read root-area density
2057          CALL get_variable( id_surf, 'root_area_dens_s',                      &
2058                             root_area_density_lsm_f%var,                      &
2059                             nxl, nxr, nys, nyn,                               &
2060                             0, root_area_density_lsm_f%nz-1 )
2061
2062       ELSE
2063          root_area_density_lsm_f%from_file = .FALSE.
2064       ENDIF
2065!
2066!--    Read street type and street crossing
2067       IF ( check_existence( var_names, 'street_type' ) )  THEN
2068          street_type_f%from_file = .TRUE.
2069          CALL get_attribute( id_surf, char_fill,                              &
2070                              street_type_f%fill, .FALSE.,                     &
2071                              'street_type' )
2072
2073          ALLOCATE ( street_type_f%var(nys:nyn,nxl:nxr)  )
2074         
2075          CALL get_variable( id_surf, 'street_type', street_type_f%var,        &
2076                             nxl, nxr, nys, nyn )
2077       ELSE
2078          street_type_f%from_file = .FALSE.
2079       ENDIF
2080
2081       IF ( check_existence( var_names, 'street_crossing' ) )  THEN
2082          street_crossing_f%from_file = .TRUE.
2083          CALL get_attribute( id_surf, char_fill,                              &
2084                              street_crossing_f%fill, .FALSE.,                 &
2085                              'street_crossing' )
2086
2087          ALLOCATE ( street_crossing_f%var(nys:nyn,nxl:nxr)  )
2088
2089          CALL get_variable( id_surf, 'street_crossing',                       &
2090                             street_crossing_f%var, nxl, nxr, nys, nyn )
2091
2092       ELSE
2093          street_crossing_f%from_file = .FALSE.
2094       ENDIF
2095!
2096!--    Still missing: root_resolved and building_surface_pars.
2097!--    Will be implemented as soon as they are available.
2098
2099!
2100!--    Finally, close input file
2101       CALL close_input_file( id_surf )
2102#endif
2103!
2104!--    End of CPU measurement
2105       CALL cpu_log( log_point_s(82), 'NetCDF input', 'stop' )
2106!
2107!--    Exchange 1 ghost points for surface variables. Please note, ghost point
2108!--    exchange for 3D parameter lists should be revised by using additional
2109!--    MPI datatypes or rewriting exchange_horiz.
2110!--    Moreover, varialbes will be resized in the following, including ghost
2111!--    points.
2112!--    Start with 2D Integer variables. Please note, for 8-bit integer
2113!--    variables must be swapt to 32-bit integer before calling exchange_horiz.
2114       IF ( albedo_type_f%from_file )  THEN
2115          var_exchange_int                  = INT( albedo_type_f%fill, KIND = 1 )
2116          var_exchange_int(nys:nyn,nxl:nxr) =                                  &
2117                            INT( albedo_type_f%var(nys:nyn,nxl:nxr), KIND = 4 )
2118          CALL exchange_horiz_2d_int( var_exchange_int, nys, nyn, nxl, nxr, nbgp )
2119          DEALLOCATE( albedo_type_f%var )
2120          ALLOCATE( albedo_type_f%var(nysg:nyng,nxlg:nxrg) )
2121          albedo_type_f%var = INT( var_exchange_int, KIND = 1 )
2122       ENDIF
2123       IF ( pavement_type_f%from_file )  THEN
2124          var_exchange_int                  = INT( pavement_type_f%fill, KIND = 1 )
2125          var_exchange_int(nys:nyn,nxl:nxr) =                                  &
2126                          INT( pavement_type_f%var(nys:nyn,nxl:nxr), KIND = 4 )
2127          CALL exchange_horiz_2d_int( var_exchange_int, nys, nyn, nxl, nxr, nbgp )
2128          DEALLOCATE( pavement_type_f%var )
2129          ALLOCATE( pavement_type_f%var(nysg:nyng,nxlg:nxrg) )
2130          pavement_type_f%var = INT( var_exchange_int, KIND = 1 )
2131       ENDIF
2132       IF ( soil_type_f%from_file  .AND.  ALLOCATED( soil_type_f%var_2d ) )  THEN
2133          var_exchange_int                  = INT( soil_type_f%fill, KIND = 1 )
2134          var_exchange_int(nys:nyn,nxl:nxr) =                                  &
2135                            INT( soil_type_f%var_2d(nys:nyn,nxl:nxr), KIND = 4 )
2136          CALL exchange_horiz_2d_int( var_exchange_int, nys, nyn, nxl, nxr, nbgp )
2137          DEALLOCATE( soil_type_f%var_2d )
2138          ALLOCATE( soil_type_f%var_2d(nysg:nyng,nxlg:nxrg) )
2139          soil_type_f%var_2d = INT( var_exchange_int, KIND = 1 )
2140       ENDIF
2141       IF ( vegetation_type_f%from_file )  THEN
2142          var_exchange_int                  = INT( vegetation_type_f%fill, KIND = 1 )
2143          var_exchange_int(nys:nyn,nxl:nxr) =                                  &
2144                        INT( vegetation_type_f%var(nys:nyn,nxl:nxr), KIND = 4 )
2145          CALL exchange_horiz_2d_int( var_exchange_int, nys, nyn, nxl, nxr, nbgp )
2146          DEALLOCATE( vegetation_type_f%var )
2147          ALLOCATE( vegetation_type_f%var(nysg:nyng,nxlg:nxrg) )
2148          vegetation_type_f%var = INT( var_exchange_int, KIND = 1 )
2149       ENDIF
2150       IF ( water_type_f%from_file )  THEN
2151          var_exchange_int                  = INT( water_type_f%fill, KIND = 1 )
2152          var_exchange_int(nys:nyn,nxl:nxr) =                                  &
2153                         INT( water_type_f%var(nys:nyn,nxl:nxr), KIND = 4 )
2154          CALL exchange_horiz_2d_int( var_exchange_int, nys, nyn, nxl, nxr, nbgp )
2155          DEALLOCATE( water_type_f%var )
2156          ALLOCATE( water_type_f%var(nysg:nyng,nxlg:nxrg) )
2157          water_type_f%var = INT( var_exchange_int, KIND = 1 )
2158       ENDIF
2159!
2160!--    Exchange 1 ghost point for 3/4-D variables. For the sake of simplicity,
2161!--    loop further dimensions to use 2D exchange routines.
2162!--    This should be revised later by introducing new MPI datatypes.
2163       IF ( soil_type_f%from_file  .AND.  ALLOCATED( soil_type_f%var_3d ) )    &
2164       THEN
2165          ALLOCATE( var_dum_int_3d(0:nz_soil,nys:nyn,nxl:nxr) )
2166          var_dum_int_3d = soil_type_f%var_3d
2167          DEALLOCATE( soil_type_f%var_3d )
2168          ALLOCATE( soil_type_f%var_3d(0:nz_soil,nysg:nyng,nxlg:nxrg) )
2169          soil_type_f%var_3d = soil_type_f%fill
2170
2171          DO  k = 0, nz_soil
2172             var_exchange_int(nys:nyn,nxl:nxr) = var_dum_int_3d(k,nys:nyn,nxl:nxr)
2173             CALL exchange_horiz_2d_int( var_exchange_int, nys, nyn, nxl, nxr, nbgp )
2174             soil_type_f%var_3d(k,:,:) = INT( var_exchange_int(:,:), KIND = 1 )
2175          ENDDO
2176          DEALLOCATE( var_dum_int_3d )
2177       ENDIF
2178
2179       IF ( surface_fraction_f%from_file )  THEN
2180          ALLOCATE( var_dum_real_3d(0:surface_fraction_f%nf-1,nys:nyn,nxl:nxr) )
2181          var_dum_real_3d = surface_fraction_f%frac
2182          DEALLOCATE( surface_fraction_f%frac )
2183          ALLOCATE( surface_fraction_f%frac(0:surface_fraction_f%nf-1,         &
2184                                            nysg:nyng,nxlg:nxrg) )
2185          surface_fraction_f%frac = surface_fraction_f%fill
2186
2187          DO  k = 0, surface_fraction_f%nf-1
2188             var_exchange_real(nys:nyn,nxl:nxr) = var_dum_real_3d(k,nys:nyn,nxl:nxr)
2189             CALL exchange_horiz_2d( var_exchange_real, nbgp )
2190             surface_fraction_f%frac(k,:,:) = var_exchange_real(:,:)
2191          ENDDO
2192          DEALLOCATE( var_dum_real_3d )
2193       ENDIF
2194
2195       IF ( building_pars_f%from_file )  THEN
2196          ALLOCATE( var_dum_real_3d(0:building_pars_f%np-1,nys:nyn,nxl:nxr) )
2197          var_dum_real_3d = building_pars_f%pars_xy
2198          DEALLOCATE( building_pars_f%pars_xy )
2199          ALLOCATE( building_pars_f%pars_xy(0:building_pars_f%np-1,            &
2200                                            nysg:nyng,nxlg:nxrg) )
2201          building_pars_f%pars_xy = building_pars_f%fill
2202          DO  k = 0, building_pars_f%np-1
2203             var_exchange_real(nys:nyn,nxl:nxr) =                              &
2204                                              var_dum_real_3d(k,nys:nyn,nxl:nxr)
2205             CALL exchange_horiz_2d( var_exchange_real, nbgp )
2206             building_pars_f%pars_xy(k,:,:) = var_exchange_real(:,:)
2207          ENDDO
2208          DEALLOCATE( var_dum_real_3d )
2209       ENDIF
2210
2211       IF ( albedo_pars_f%from_file )  THEN
2212          ALLOCATE( var_dum_real_3d(0:albedo_pars_f%np-1,nys:nyn,nxl:nxr) )
2213          var_dum_real_3d = albedo_pars_f%pars_xy
2214          DEALLOCATE( albedo_pars_f%pars_xy )
2215          ALLOCATE( albedo_pars_f%pars_xy(0:albedo_pars_f%np-1,                &
2216                                          nysg:nyng,nxlg:nxrg) )
2217          albedo_pars_f%pars_xy = albedo_pars_f%fill
2218          DO  k = 0, albedo_pars_f%np-1
2219             var_exchange_real(nys:nyn,nxl:nxr) =                              &
2220                                              var_dum_real_3d(k,nys:nyn,nxl:nxr)
2221             CALL exchange_horiz_2d( var_exchange_real, nbgp )
2222             albedo_pars_f%pars_xy(k,:,:) = var_exchange_real(:,:)
2223          ENDDO
2224          DEALLOCATE( var_dum_real_3d )
2225       ENDIF
2226
2227       IF ( pavement_pars_f%from_file )  THEN
2228          ALLOCATE( var_dum_real_3d(0:pavement_pars_f%np-1,nys:nyn,nxl:nxr) )
2229          var_dum_real_3d = pavement_pars_f%pars_xy
2230          DEALLOCATE( pavement_pars_f%pars_xy )
2231          ALLOCATE( pavement_pars_f%pars_xy(0:pavement_pars_f%np-1,            &
2232                                            nysg:nyng,nxlg:nxrg) )
2233          pavement_pars_f%pars_xy = pavement_pars_f%fill
2234          DO  k = 0, pavement_pars_f%np-1
2235             var_exchange_real(nys:nyn,nxl:nxr) =                              &
2236                                              var_dum_real_3d(k,nys:nyn,nxl:nxr)
2237             CALL exchange_horiz_2d( var_exchange_real, nbgp )
2238             pavement_pars_f%pars_xy(k,:,:) = var_exchange_real(:,:)
2239          ENDDO
2240          DEALLOCATE( var_dum_real_3d )
2241       ENDIF
2242
2243       IF ( vegetation_pars_f%from_file )  THEN
2244          ALLOCATE( var_dum_real_3d(0:vegetation_pars_f%np-1,nys:nyn,nxl:nxr) )
2245          var_dum_real_3d = vegetation_pars_f%pars_xy
2246          DEALLOCATE( vegetation_pars_f%pars_xy )
2247          ALLOCATE( vegetation_pars_f%pars_xy(0:vegetation_pars_f%np-1,        &
2248                                            nysg:nyng,nxlg:nxrg) )
2249          vegetation_pars_f%pars_xy = vegetation_pars_f%fill
2250          DO  k = 0, vegetation_pars_f%np-1
2251             var_exchange_real(nys:nyn,nxl:nxr) =                              &
2252                                              var_dum_real_3d(k,nys:nyn,nxl:nxr)
2253             CALL exchange_horiz_2d( var_exchange_real, nbgp )
2254             vegetation_pars_f%pars_xy(k,:,:) = var_exchange_real(:,:)
2255          ENDDO
2256          DEALLOCATE( var_dum_real_3d )
2257       ENDIF
2258
2259       IF ( water_pars_f%from_file )  THEN
2260          ALLOCATE( var_dum_real_3d(0:water_pars_f%np-1,nys:nyn,nxl:nxr) )
2261          var_dum_real_3d = water_pars_f%pars_xy
2262          DEALLOCATE( water_pars_f%pars_xy )
2263          ALLOCATE( water_pars_f%pars_xy(0:water_pars_f%np-1,                  &
2264                                         nysg:nyng,nxlg:nxrg) )
2265          water_pars_f%pars_xy = water_pars_f%fill
2266          DO  k = 0, water_pars_f%np-1
2267             var_exchange_real(nys:nyn,nxl:nxr) =                              &
2268                                              var_dum_real_3d(k,nys:nyn,nxl:nxr)
2269             CALL exchange_horiz_2d( var_exchange_real, nbgp )
2270             water_pars_f%pars_xy(k,:,:) = var_exchange_real(:,:)
2271          ENDDO
2272          DEALLOCATE( var_dum_real_3d )
2273       ENDIF
2274
2275       IF ( root_area_density_lsm_f%from_file )  THEN
2276          ALLOCATE( var_dum_real_3d(0:root_area_density_lsm_f%nz-1,nys:nyn,nxl:nxr) )
2277          var_dum_real_3d = root_area_density_lsm_f%var
2278          DEALLOCATE( root_area_density_lsm_f%var )
2279          ALLOCATE( root_area_density_lsm_f%var(0:root_area_density_lsm_f%nz-1,&
2280                                                nysg:nyng,nxlg:nxrg) )
2281          root_area_density_lsm_f%var = root_area_density_lsm_f%fill
2282
2283          DO  k = 0, root_area_density_lsm_f%nz-1
2284             var_exchange_real(nys:nyn,nxl:nxr) =                              &
2285                                              var_dum_real_3d(k,nys:nyn,nxl:nxr)
2286             CALL exchange_horiz_2d( var_exchange_real, nbgp )
2287             root_area_density_lsm_f%var(k,:,:) = var_exchange_real(:,:)
2288          ENDDO
2289          DEALLOCATE( var_dum_real_3d )
2290       ENDIF
2291
2292       IF ( soil_pars_f%from_file )  THEN
2293          IF ( soil_pars_f%lod == 1 )  THEN
2294
2295             ALLOCATE( var_dum_real_3d(0:soil_pars_f%np-1,nys:nyn,nxl:nxr) )
2296             var_dum_real_3d = soil_pars_f%pars_xy
2297             DEALLOCATE( soil_pars_f%pars_xy )
2298             ALLOCATE( soil_pars_f%pars_xy(0:soil_pars_f%np-1,                 &
2299                                            nysg:nyng,nxlg:nxrg) )
2300             soil_pars_f%pars_xy = soil_pars_f%fill
2301
2302             DO  k = 0, soil_pars_f%np-1
2303                var_exchange_real(nys:nyn,nxl:nxr) =                           &
2304                                              var_dum_real_3d(k,nys:nyn,nxl:nxr)
2305                CALL exchange_horiz_2d( var_exchange_real, nbgp )
2306                soil_pars_f%pars_xy(k,:,:) = var_exchange_real(:,:)
2307             ENDDO
2308             DEALLOCATE( var_dum_real_3d )
2309          ELSEIF ( soil_pars_f%lod == 2 )  THEN
2310             ALLOCATE( var_dum_real_4d(0:soil_pars_f%np-1,                     &
2311                                       0:soil_pars_f%nz-1,                     &
2312                                       nys:nyn,nxl:nxr) )
2313             var_dum_real_4d = soil_pars_f%pars_xyz
2314             DEALLOCATE( soil_pars_f%pars_xyz )
2315             ALLOCATE( soil_pars_f%pars_xyz(0:soil_pars_f%np-1,                &
2316                                            0:soil_pars_f%nz-1,                &
2317                                            nysg:nyng,nxlg:nxrg) )
2318             soil_pars_f%pars_xyz = soil_pars_f%fill
2319
2320             DO  k2 = 0, soil_pars_f%nz-1
2321                DO  k = 0, soil_pars_f%np-1
2322                   var_exchange_real(nys:nyn,nxl:nxr) =                        &
2323                                           var_dum_real_4d(k,k2,nys:nyn,nxl:nxr)
2324                   CALL exchange_horiz_2d( var_exchange_real, nbgp )
2325
2326                   soil_pars_f%pars_xyz(k,k2,:,:) = var_exchange_real(:,:)
2327                ENDDO
2328             ENDDO
2329             DEALLOCATE( var_dum_real_4d )
2330          ENDIF
2331       ENDIF
2332
2333       IF ( pavement_subsurface_pars_f%from_file )  THEN
2334          ALLOCATE( var_dum_real_4d(0:pavement_subsurface_pars_f%np-1,         &
2335                                    0:pavement_subsurface_pars_f%nz-1,         &
2336                                    nys:nyn,nxl:nxr) )
2337          var_dum_real_4d = pavement_subsurface_pars_f%pars_xyz
2338          DEALLOCATE( pavement_subsurface_pars_f%pars_xyz )
2339          ALLOCATE( pavement_subsurface_pars_f%pars_xyz                        &
2340                                          (0:pavement_subsurface_pars_f%np-1,  &
2341                                           0:pavement_subsurface_pars_f%nz-1,  &
2342                                           nysg:nyng,nxlg:nxrg) )
2343          pavement_subsurface_pars_f%pars_xyz = pavement_subsurface_pars_f%fill
2344
2345          DO  k2 = 0, pavement_subsurface_pars_f%nz-1
2346             DO  k = 0, pavement_subsurface_pars_f%np-1
2347                var_exchange_real(nys:nyn,nxl:nxr) =                           &
2348                                          var_dum_real_4d(k,k2,nys:nyn,nxl:nxr)
2349                CALL exchange_horiz_2d( var_exchange_real, nbgp )
2350                pavement_subsurface_pars_f%pars_xyz(k,k2,:,:) =                &
2351                                                        var_exchange_real(:,:)
2352             ENDDO
2353          ENDDO
2354          DEALLOCATE( var_dum_real_4d )
2355       ENDIF
2356
2357!
2358!--    In case of non-cyclic boundary conditions, set Neumann conditions at the
2359!--    lateral boundaries.
2360       IF ( .NOT. bc_ns_cyc )  THEN
2361          IF ( nys == 0  )  THEN
2362             IF ( albedo_type_f%from_file )                                    &
2363                albedo_type_f%var(-1,:) = albedo_type_f%var(0,:)
2364             IF ( pavement_type_f%from_file )                                  &
2365                pavement_type_f%var(-1,:) = pavement_type_f%var(0,:)
2366             IF ( soil_type_f%from_file )  THEN
2367                IF ( ALLOCATED( soil_type_f%var_2d ) )  THEN
2368                   soil_type_f%var_2d(-1,:) = soil_type_f%var_2d(0,:)
2369                ELSE
2370                   soil_type_f%var_3d(:,-1,:) = soil_type_f%var_3d(:,0,:)
2371                ENDIF
2372             ENDIF
2373             IF ( vegetation_type_f%from_file )                                &
2374                vegetation_type_f%var(-1,:) = vegetation_type_f%var(0,:)
2375             IF ( water_type_f%from_file )                                     &
2376                water_type_f%var(-1,:) = water_type_f%var(0,:)
2377             IF ( surface_fraction_f%from_file )                               &
2378                surface_fraction_f%frac(:,-1,:) = surface_fraction_f%frac(:,0,:)
2379             IF ( building_pars_f%from_file )                                  &
2380                building_pars_f%pars_xy(:,-1,:) = building_pars_f%pars_xy(:,0,:)
2381             IF ( albedo_pars_f%from_file )                                    &
2382                albedo_pars_f%pars_xy(:,-1,:) = albedo_pars_f%pars_xy(:,0,:)
2383             IF ( pavement_pars_f%from_file )                                  &
2384                pavement_pars_f%pars_xy(:,-1,:) = pavement_pars_f%pars_xy(:,0,:)
2385             IF ( vegetation_pars_f%from_file )                                &
2386                vegetation_pars_f%pars_xy(:,-1,:) =                            &
2387                                               vegetation_pars_f%pars_xy(:,0,:)
2388             IF ( water_pars_f%from_file )                                     &
2389                water_pars_f%pars_xy(:,-1,:) = water_pars_f%pars_xy(:,0,:)
2390             IF ( root_area_density_lsm_f%from_file )                          &
2391                root_area_density_lsm_f%var(:,-1,:) =                          &
2392                                            root_area_density_lsm_f%var(:,0,:)
2393             IF ( soil_pars_f%from_file )  THEN
2394                IF ( soil_pars_f%lod == 1 )  THEN
2395                   soil_pars_f%pars_xy(:,-1,:) = soil_pars_f%pars_xy(:,0,:)
2396                ELSE
2397                   soil_pars_f%pars_xyz(:,:,-1,:) = soil_pars_f%pars_xyz(:,:,0,:)
2398                ENDIF
2399             ENDIF
2400             IF ( pavement_subsurface_pars_f%from_file )                       &
2401                pavement_subsurface_pars_f%pars_xyz(:,:,-1,:) =                &
2402                                   pavement_subsurface_pars_f%pars_xyz(:,:,0,:)
2403          ENDIF
2404
2405          IF ( nyn == ny )  THEN
2406             IF ( albedo_type_f%from_file )                                    &
2407                albedo_type_f%var(ny+1,:) = albedo_type_f%var(ny,:)
2408             IF ( pavement_type_f%from_file )                                  &
2409                pavement_type_f%var(ny+1,:) = pavement_type_f%var(ny,:)
2410             IF ( soil_type_f%from_file )  THEN
2411                IF ( ALLOCATED( soil_type_f%var_2d ) )  THEN
2412                   soil_type_f%var_2d(ny+1,:) = soil_type_f%var_2d(ny,:)
2413                ELSE
2414                   soil_type_f%var_3d(:,ny+1,:) = soil_type_f%var_3d(:,ny,:)
2415                ENDIF
2416             ENDIF
2417             IF ( vegetation_type_f%from_file )                                &
2418                vegetation_type_f%var(ny+1,:) = vegetation_type_f%var(ny,:)
2419             IF ( water_type_f%from_file )                                     &
2420                water_type_f%var(ny+1,:) = water_type_f%var(ny,:)
2421             IF ( surface_fraction_f%from_file )                               &
2422                surface_fraction_f%frac(:,ny+1,:) =                            &
2423                                             surface_fraction_f%frac(:,ny,:)
2424             IF ( building_pars_f%from_file )                                  &
2425                building_pars_f%pars_xy(:,ny+1,:) =                            &
2426                                             building_pars_f%pars_xy(:,ny,:)
2427             IF ( albedo_pars_f%from_file )                                    &
2428                albedo_pars_f%pars_xy(:,ny+1,:) = albedo_pars_f%pars_xy(:,ny,:)
2429             IF ( pavement_pars_f%from_file )                                  &
2430                pavement_pars_f%pars_xy(:,ny+1,:) =                            &
2431                                             pavement_pars_f%pars_xy(:,ny,:)
2432             IF ( vegetation_pars_f%from_file )                                &
2433                vegetation_pars_f%pars_xy(:,ny+1,:) =                          &
2434                                               vegetation_pars_f%pars_xy(:,ny,:)
2435             IF ( water_pars_f%from_file )                                     &
2436                water_pars_f%pars_xy(:,ny+1,:) = water_pars_f%pars_xy(:,ny,:)
2437             IF ( root_area_density_lsm_f%from_file )                          &
2438                root_area_density_lsm_f%var(:,ny+1,:) =                        &
2439                                            root_area_density_lsm_f%var(:,ny,:)
2440             IF ( soil_pars_f%from_file )  THEN
2441                IF ( soil_pars_f%lod == 1 )  THEN
2442                   soil_pars_f%pars_xy(:,ny+1,:) = soil_pars_f%pars_xy(:,ny,:)
2443                ELSE
2444                   soil_pars_f%pars_xyz(:,:,ny+1,:) =                          &
2445                                              soil_pars_f%pars_xyz(:,:,ny,:)
2446                ENDIF
2447             ENDIF
2448             IF ( pavement_subsurface_pars_f%from_file )                       &
2449                pavement_subsurface_pars_f%pars_xyz(:,:,ny+1,:) =              &
2450                                   pavement_subsurface_pars_f%pars_xyz(:,:,ny,:)
2451          ENDIF
2452       ENDIF
2453
2454       IF ( .NOT. bc_lr_cyc )  THEN
2455          IF ( nxl == 0 )  THEN
2456            IF ( albedo_type_f%from_file )                                     &
2457                albedo_type_f%var(:,-1) = albedo_type_f%var(:,0)
2458             IF ( pavement_type_f%from_file )                                  &
2459                pavement_type_f%var(:,-1) = pavement_type_f%var(:,0)
2460             IF ( soil_type_f%from_file )  THEN
2461                IF ( ALLOCATED( soil_type_f%var_2d ) )  THEN
2462                   soil_type_f%var_2d(:,-1) = soil_type_f%var_2d(:,0)
2463                ELSE
2464                   soil_type_f%var_3d(:,:,-1) = soil_type_f%var_3d(:,:,0)
2465                ENDIF
2466             ENDIF
2467             IF ( vegetation_type_f%from_file )                                &
2468                vegetation_type_f%var(:,-1) = vegetation_type_f%var(:,0)
2469             IF ( water_type_f%from_file )                                     &
2470                water_type_f%var(:,-1) = water_type_f%var(:,0)
2471             IF ( surface_fraction_f%from_file )                               &
2472                surface_fraction_f%frac(:,:,-1) = surface_fraction_f%frac(:,:,0)
2473             IF ( building_pars_f%from_file )                                  &
2474                building_pars_f%pars_xy(:,:,-1) = building_pars_f%pars_xy(:,:,0)
2475             IF ( albedo_pars_f%from_file )                                    &
2476                albedo_pars_f%pars_xy(:,:,-1) = albedo_pars_f%pars_xy(:,:,0)
2477             IF ( pavement_pars_f%from_file )                                  &
2478                pavement_pars_f%pars_xy(:,:,-1) = pavement_pars_f%pars_xy(:,:,0)
2479             IF ( vegetation_pars_f%from_file )                                &
2480                vegetation_pars_f%pars_xy(:,:,-1) =                            &
2481                                               vegetation_pars_f%pars_xy(:,:,0)
2482             IF ( water_pars_f%from_file )                                     &
2483                water_pars_f%pars_xy(:,:,-1) = water_pars_f%pars_xy(:,:,0)
2484             IF ( root_area_density_lsm_f%from_file )                          &
2485                root_area_density_lsm_f%var(:,:,-1) =                          &
2486                                            root_area_density_lsm_f%var(:,:,0)
2487             IF ( soil_pars_f%from_file )  THEN
2488                IF ( soil_pars_f%lod == 1 )  THEN
2489                   soil_pars_f%pars_xy(:,:,-1) = soil_pars_f%pars_xy(:,:,0)
2490                ELSE
2491                   soil_pars_f%pars_xyz(:,:,:,-1) = soil_pars_f%pars_xyz(:,:,:,0)
2492                ENDIF
2493             ENDIF
2494             IF ( pavement_subsurface_pars_f%from_file )                       &
2495                pavement_subsurface_pars_f%pars_xyz(:,:,:,-1) =                &
2496                                    pavement_subsurface_pars_f%pars_xyz(:,:,:,0)
2497          ENDIF
2498
2499          IF ( nxr == nx )  THEN
2500             IF ( albedo_type_f%from_file )                                    &
2501                albedo_type_f%var(:,nx+1) = albedo_type_f%var(:,nx)
2502             IF ( pavement_type_f%from_file )                                  &
2503                pavement_type_f%var(:,nx+1) = pavement_type_f%var(:,nx)
2504             IF ( soil_type_f%from_file )  THEN
2505                IF ( ALLOCATED( soil_type_f%var_2d ) )  THEN
2506                   soil_type_f%var_2d(:,nx+1) = soil_type_f%var_2d(:,nx)
2507                ELSE
2508                   soil_type_f%var_3d(:,:,nx+1) = soil_type_f%var_3d(:,:,nx)
2509                ENDIF
2510             ENDIF
2511             IF ( vegetation_type_f%from_file )                                &
2512                vegetation_type_f%var(:,nx+1) = vegetation_type_f%var(:,nx)
2513             IF ( water_type_f%from_file )                                     &
2514                water_type_f%var(:,nx+1) = water_type_f%var(:,nx)
2515             IF ( surface_fraction_f%from_file )                               &
2516                surface_fraction_f%frac(:,:,nx+1) =                            &
2517                                             surface_fraction_f%frac(:,:,nx)
2518             IF ( building_pars_f%from_file )                                  &
2519                building_pars_f%pars_xy(:,:,nx+1) =                            &
2520                                             building_pars_f%pars_xy(:,:,nx)
2521             IF ( albedo_pars_f%from_file )                                    &
2522                albedo_pars_f%pars_xy(:,:,nx+1) = albedo_pars_f%pars_xy(:,:,nx)
2523             IF ( pavement_pars_f%from_file )                                  &
2524                pavement_pars_f%pars_xy(:,:,nx+1) =                            &
2525                                             pavement_pars_f%pars_xy(:,:,nx)
2526             IF ( vegetation_pars_f%from_file )                                &
2527                vegetation_pars_f%pars_xy(:,:,nx+1) =                          &
2528                                               vegetation_pars_f%pars_xy(:,:,nx)
2529             IF ( water_pars_f%from_file )                                     &
2530                water_pars_f%pars_xy(:,:,nx+1) = water_pars_f%pars_xy(:,:,nx)
2531             IF ( root_area_density_lsm_f%from_file )                          &
2532                root_area_density_lsm_f%var(:,:,nx+1) =                        &
2533                                            root_area_density_lsm_f%var(:,:,nx)
2534             IF ( soil_pars_f%from_file )  THEN
2535                IF ( soil_pars_f%lod == 1 )  THEN
2536                   soil_pars_f%pars_xy(:,:,nx+1) = soil_pars_f%pars_xy(:,:,nx)
2537                ELSE
2538                   soil_pars_f%pars_xyz(:,:,:,nx+1) =                          &
2539                                              soil_pars_f%pars_xyz(:,:,:,nx)
2540                ENDIF
2541             ENDIF
2542             IF ( pavement_subsurface_pars_f%from_file )                       &
2543                pavement_subsurface_pars_f%pars_xyz(:,:,:,nx+1) =              &
2544                                   pavement_subsurface_pars_f%pars_xyz(:,:,:,nx)
2545          ENDIF
2546       ENDIF
2547
2548    END SUBROUTINE netcdf_data_input_surface_data
2549
2550!------------------------------------------------------------------------------!
2551! Description:
2552! ------------
2553!> Reads uvem lookup table information.
2554!------------------------------------------------------------------------------!
2555    SUBROUTINE netcdf_data_input_uvem
2556       
2557       USE indices,                                                            &
2558           ONLY:  nxl, nxr, nyn, nys
2559
2560       IMPLICIT NONE
2561
2562       CHARACTER(LEN=100), DIMENSION(:), ALLOCATABLE ::  var_names  !< variable names in static input file
2563
2564
2565       INTEGER(iwp) ::  id_uvem       !< NetCDF id of uvem lookup table input file
2566       INTEGER(iwp) ::  nli = 35      !< dimension length of lookup table in x
2567       INTEGER(iwp) ::  nlj =  9      !< dimension length of lookup table in y
2568       INTEGER(iwp) ::  nlk = 90      !< dimension length of lookup table in z
2569       INTEGER(iwp) ::  num_vars      !< number of variables in netcdf input file
2570!
2571!--    Input via uv exposure model lookup table input
2572       IF ( input_pids_uvem )  THEN
2573
2574#if defined ( __netcdf )
2575!
2576!--       Open file in read-only mode
2577          CALL open_read_file( TRIM( input_file_uvem ) //                    &
2578                               TRIM( coupling_char ), id_uvem )
2579!
2580!--       At first, inquire all variable names.
2581!--       This will be used to check whether an input variable exist or not.
2582          CALL inquire_num_variables( id_uvem, num_vars )
2583!
2584!--       Allocate memory to store variable names and inquire them.
2585          ALLOCATE( var_names(1:num_vars) )
2586          CALL inquire_variable_names( id_uvem, var_names )
2587!
2588!--       uvem integration
2589          IF ( check_existence( var_names, 'int_factors' ) )  THEN
2590             uvem_integration_f%from_file = .TRUE.
2591!
2592!--          Input 2D uvem integration.
2593             ALLOCATE ( uvem_integration_f%var(0:nlj,0:nli)  )
2594             
2595             CALL get_variable( id_uvem, 'int_factors', uvem_integration_f%var, 0, nli, 0, nlj )
2596          ELSE
2597             uvem_integration_f%from_file = .FALSE.
2598          ENDIF
2599!
2600!--       uvem irradiance
2601          IF ( check_existence( var_names, 'irradiance' ) )  THEN
2602             uvem_irradiance_f%from_file = .TRUE.
2603!
2604!--          Input 2D uvem irradiance.
2605             ALLOCATE ( uvem_irradiance_f%var(0:nlk, 0:2)  )
2606             
2607             CALL get_variable( id_uvem, 'irradiance', uvem_irradiance_f%var, 0, 2, 0, nlk )
2608          ELSE
2609             uvem_irradiance_f%from_file = .FALSE.
2610          ENDIF
2611!
2612!--       uvem porjection areas
2613          IF ( check_existence( var_names, 'projarea' ) )  THEN
2614             uvem_projarea_f%from_file = .TRUE.
2615!
2616!--          Input 3D uvem projection area (human geometgry)
2617             ALLOCATE ( uvem_projarea_f%var(0:2,0:nlj,0:nli)  )
2618           
2619             CALL get_variable( id_uvem, 'projarea', uvem_projarea_f%var, 0, nli, 0, nlj, 0, 2 )
2620          ELSE
2621             uvem_projarea_f%from_file = .FALSE.
2622          ENDIF
2623!
2624!--       uvem radiance
2625          IF ( check_existence( var_names, 'radiance' ) )  THEN
2626             uvem_radiance_f%from_file = .TRUE.
2627!
2628!--          Input 3D uvem radiance
2629             ALLOCATE ( uvem_radiance_f%var(0:nlk,0:nlj,0:nli)  )
2630             
2631             CALL get_variable( id_uvem, 'radiance', uvem_radiance_f%var, 0, nli, 0, nlj, 0, nlk )
2632          ELSE
2633             uvem_radiance_f%from_file = .FALSE.
2634          ENDIF
2635!
2636!--       Read building obstruction
2637          IF ( check_existence( var_names, 'obstruction' ) )  THEN
2638             building_obstruction_full%from_file = .TRUE.
2639!--          Input 3D uvem building obstruction
2640              ALLOCATE ( building_obstruction_full%var_3d(0:44,0:2,0:2) )
2641              CALL get_variable( id_uvem, 'obstruction', building_obstruction_full%var_3d,0, 2, 0, 2, 0, 44 )       
2642          ELSE
2643             building_obstruction_full%from_file = .FALSE.
2644          ENDIF
2645!
2646          IF ( check_existence( var_names, 'obstruction' ) )  THEN
2647             building_obstruction_f%from_file = .TRUE.
2648!
2649!--          Input 3D uvem building obstruction
2650             ALLOCATE ( building_obstruction_f%var_3d(0:44,nys:nyn,nxl:nxr) )
2651!
2652             CALL get_variable( id_uvem, 'obstruction', building_obstruction_f%var_3d,      &
2653                                nxl, nxr, nys, nyn, 0, 44 )       
2654          ELSE
2655             building_obstruction_f%from_file = .FALSE.
2656          ENDIF
2657!
2658!--       Close uvem lookup table input file
2659          CALL close_input_file( id_uvem )
2660#else
2661          CONTINUE
2662#endif
2663       ENDIF
2664    END SUBROUTINE netcdf_data_input_uvem
2665
2666!------------------------------------------------------------------------------!
2667! Description:
2668! ------------
2669!> Reads orography and building information.
2670!------------------------------------------------------------------------------!
2671    SUBROUTINE netcdf_data_input_topo
2672
2673       USE control_parameters,                                                 &
2674           ONLY:  bc_lr_cyc, bc_ns_cyc, message_string, topography
2675
2676       USE indices,                                                            &
2677           ONLY:  nbgp, nx, nxl, nxr, ny, nyn, nys, nzb
2678
2679
2680       IMPLICIT NONE
2681
2682       CHARACTER(LEN=100), DIMENSION(:), ALLOCATABLE ::  var_names  !< variable names in static input file
2683
2684
2685       INTEGER(iwp) ::  i             !< running index along x-direction
2686       INTEGER(iwp) ::  ii            !< running index for IO blocks
2687       INTEGER(iwp) ::  id_topo       !< NetCDF id of topograhy input file
2688       INTEGER(iwp) ::  j             !< running index along y-direction
2689       INTEGER(iwp) ::  num_vars      !< number of variables in netcdf input file
2690       INTEGER(iwp) ::  skip_n_rows   !< counting variable to skip rows while reading topography file
2691
2692       INTEGER(iwp), DIMENSION(nys-nbgp:nyn+nbgp,nxl-nbgp:nxr+nbgp) ::  var_exchange_int !< dummy variables used to exchange 32-bit Integer arrays
2693
2694       REAL(wp) ::  dum           !< dummy variable to skip columns while reading topography file
2695!
2696!--    CPU measurement
2697       CALL cpu_log( log_point_s(83), 'NetCDF/ASCII input topo', 'start' )
2698
2699!
2700!--    Input via palm-input data standard
2701       IF ( input_pids_static )  THEN
2702#if defined ( __netcdf )
2703!
2704!--       Open file in read-only mode
2705          CALL open_read_file( TRIM( input_file_static ) //                    &
2706                               TRIM( coupling_char ), id_topo )
2707!
2708!--       At first, inquire all variable names.
2709!--       This will be used to check whether an  input variable exist
2710!--       or not.
2711          CALL inquire_num_variables( id_topo, num_vars )
2712!
2713!--       Allocate memory to store variable names and inquire them.
2714          ALLOCATE( var_names(1:num_vars) )
2715          CALL inquire_variable_names( id_topo, var_names )
2716!
2717!--       Read x, y - dimensions. Only required for consistency checks.
2718          CALL netcdf_data_input_get_dimension_length( id_topo, dim_static%nx, 'x' )
2719          CALL netcdf_data_input_get_dimension_length( id_topo, dim_static%ny, 'y' )
2720          ALLOCATE( dim_static%x(0:dim_static%nx-1) )
2721          ALLOCATE( dim_static%y(0:dim_static%ny-1) )
2722          CALL get_variable( id_topo, 'x', dim_static%x )
2723          CALL get_variable( id_topo, 'y', dim_static%y )
2724!
2725!--       Terrain height. First, get variable-related _FillValue attribute
2726          IF ( check_existence( var_names, 'zt' ) )  THEN
2727             terrain_height_f%from_file = .TRUE.
2728             CALL get_attribute( id_topo, char_fill, terrain_height_f%fill,    &
2729                                 .FALSE., 'zt' )
2730!
2731!--          Input 2D terrain height.
2732             ALLOCATE ( terrain_height_f%var(nys:nyn,nxl:nxr)  )
2733             
2734             CALL get_variable( id_topo, 'zt', terrain_height_f%var,           &
2735                                nxl, nxr, nys, nyn )
2736
2737          ELSE
2738             terrain_height_f%from_file = .FALSE.
2739          ENDIF
2740
2741!
2742!--       Read building height. First, read its _FillValue attribute,
2743!--       as well as lod attribute
2744          buildings_f%from_file = .FALSE.
2745          IF ( check_existence( var_names, 'buildings_2d' ) )  THEN
2746             buildings_f%from_file = .TRUE.
2747             CALL get_attribute( id_topo, char_lod, buildings_f%lod,           &
2748                                 .FALSE., 'buildings_2d' )
2749
2750             CALL get_attribute( id_topo, char_fill, buildings_f%fill1,        &
2751                                 .FALSE., 'buildings_2d' )
2752
2753!
2754!--          Read 2D buildings
2755             IF ( buildings_f%lod == 1 )  THEN
2756                ALLOCATE ( buildings_f%var_2d(nys:nyn,nxl:nxr) )
2757
2758                CALL get_variable( id_topo, 'buildings_2d',                    &
2759                                   buildings_f%var_2d,                         &
2760                                   nxl, nxr, nys, nyn )
2761             ELSE
2762                message_string = 'NetCDF attribute lod ' //                    &
2763                                 '(level of detail) is not set ' //            &
2764                                 'properly for buildings_2d.'
2765                CALL message( 'netcdf_data_input_mod', 'PA0540',               &
2766                               1, 2, 0, 6, 0 )
2767             ENDIF
2768          ENDIF
2769!
2770!--       If available, also read 3D building information. If both are
2771!--       available, use 3D information.
2772          IF ( check_existence( var_names, 'buildings_3d' ) )  THEN
2773             buildings_f%from_file = .TRUE.
2774             CALL get_attribute( id_topo, char_lod, buildings_f%lod,           &
2775                                 .FALSE., 'buildings_3d' )     
2776
2777             CALL get_attribute( id_topo, char_fill, buildings_f%fill2,        &
2778                                 .FALSE., 'buildings_3d' )
2779
2780             CALL netcdf_data_input_get_dimension_length( id_topo,             &
2781                                                          buildings_f%nz, 'z' )
2782!
2783!--          Read 3D buildings
2784             IF ( buildings_f%lod == 2 )  THEN
2785                ALLOCATE( buildings_f%z(nzb:buildings_f%nz-1) )
2786                CALL get_variable( id_topo, 'z', buildings_f%z )
2787
2788                ALLOCATE( buildings_f%var_3d(nzb:buildings_f%nz-1,             &
2789                                             nys:nyn,nxl:nxr) )
2790                buildings_f%var_3d = 0
2791               
2792                CALL get_variable( id_topo, 'buildings_3d',                    &
2793                                   buildings_f%var_3d,                         &
2794                                   nxl, nxr, nys, nyn, 0, buildings_f%nz-1 )
2795             ELSE
2796                message_string = 'NetCDF attribute lod ' //                    &
2797                                 '(level of detail) is not set ' //            &
2798                                 'properly for buildings_3d.'
2799                CALL message( 'netcdf_data_input_mod', 'PA0541',               &
2800                               1, 2, 0, 6, 0 )
2801             ENDIF
2802          ENDIF
2803!
2804!--       Read building IDs and its FillValue attribute. Further required
2805!--       for mapping buildings on top of orography.
2806          IF ( check_existence( var_names, 'building_id' ) )  THEN
2807             building_id_f%from_file = .TRUE.
2808             CALL get_attribute( id_topo, char_fill,                           &
2809                                 building_id_f%fill, .FALSE.,                  &
2810                                 'building_id' )
2811
2812             ALLOCATE ( building_id_f%var(nys:nyn,nxl:nxr) )
2813             
2814             CALL get_variable( id_topo, 'building_id', building_id_f%var,     &
2815                                nxl, nxr, nys, nyn )
2816          ELSE
2817             building_id_f%from_file = .FALSE.
2818          ENDIF
2819!
2820!--       Read building_type and required attributes.
2821          IF ( check_existence( var_names, 'building_type' ) )  THEN
2822             building_type_f%from_file = .TRUE.
2823             CALL get_attribute( id_topo, char_fill,                           &
2824                                 building_type_f%fill, .FALSE.,                &
2825                                 'building_type' )
2826
2827             ALLOCATE ( building_type_f%var(nys:nyn,nxl:nxr) )
2828
2829             CALL get_variable( id_topo, 'building_type', building_type_f%var, &
2830                                nxl, nxr, nys, nyn )
2831
2832          ELSE
2833             building_type_f%from_file = .FALSE.
2834          ENDIF
2835!
2836!--       Close topography input file
2837          CALL close_input_file( id_topo )
2838#else
2839          CONTINUE
2840#endif
2841!
2842!--    ASCII input
2843       ELSEIF ( TRIM( topography ) == 'read_from_file' )  THEN
2844             
2845          DO  ii = 0, io_blocks-1
2846             IF ( ii == io_group )  THEN
2847
2848                OPEN( 90, FILE='TOPOGRAPHY_DATA'//TRIM( coupling_char ),       &
2849                      STATUS='OLD', FORM='FORMATTED', ERR=10 )
2850!
2851!--             Read topography PE-wise. Rows are read from nyn to nys, columns
2852!--             are read from nxl to nxr. At first, ny-nyn rows need to be skipped.
2853                skip_n_rows = 0
2854                DO WHILE ( skip_n_rows < ny - nyn )
2855                   READ( 90, * )
2856                   skip_n_rows = skip_n_rows + 1
2857                ENDDO
2858!
2859!--             Read data from nyn to nys and nxl to nxr. Therefore, skip
2860!--             column until nxl-1 is reached
2861                ALLOCATE ( buildings_f%var_2d(nys:nyn,nxl:nxr) )
2862                DO  j = nyn, nys, -1
2863                   READ( 90, *, ERR=11, END=11 )                               &
2864                                   ( dum, i = 0, nxl-1 ),                      &
2865                                   ( buildings_f%var_2d(j,i), i = nxl, nxr )
2866                ENDDO
2867
2868                GOTO 12
2869
2870 10             message_string = 'file TOPOGRAPHY_DATA'//                      &
2871                                 TRIM( coupling_char )// ' does not exist'
2872                CALL message( 'netcdf_data_input_mod', 'PA0208', 1, 2, 0, 6, 0 )
2873
2874 11             message_string = 'errors in file TOPOGRAPHY_DATA'//            &
2875                                 TRIM( coupling_char )
2876                CALL message( 'netcdf_data_input_mod', 'PA0209', 2, 2, 0, 6, 0 )
2877
2878 12             CLOSE( 90 )
2879                buildings_f%from_file = .TRUE.
2880
2881             ENDIF
2882#if defined( __parallel )
2883             CALL MPI_BARRIER( comm2d, ierr )
2884#endif
2885          ENDDO
2886
2887       ENDIF
2888!
2889!--    End of CPU measurement
2890       CALL cpu_log( log_point_s(83), 'NetCDF/ASCII input topo', 'stop' )
2891!
2892!--    Check for minimum requirement to setup building topography. If buildings
2893!--    are provided, also an ID and a type are required.
2894!--    Note, doing this check in check_parameters
2895!--    will be too late (data will be used for grid inititialization before).
2896       IF ( input_pids_static )  THEN
2897          IF ( buildings_f%from_file  .AND.                                    &
2898               .NOT. building_id_f%from_file )  THEN
2899             message_string = 'If building heigths are prescribed in ' //      &
2900                              'static input file, also an ID is required.'
2901             CALL message( 'netcdf_data_input_mod', 'PA0542', 1, 2, 0, 6, 0 )
2902          ENDIF
2903       ENDIF
2904!
2905!--    In case no terrain height is provided by static input file, allocate
2906!--    array nevertheless and set terrain height to 0, which simplifies
2907!--    topography initialization.
2908       IF ( .NOT. terrain_height_f%from_file )  THEN
2909          ALLOCATE ( terrain_height_f%var(nys:nyn,nxl:nxr) )
2910          terrain_height_f%var = 0.0_wp
2911       ENDIF
2912!
2913!--    Finally, exchange 1 ghost point for building ID and type.
2914!--    In case of non-cyclic boundary conditions set Neumann conditions at the
2915!--    lateral boundaries.
2916       IF ( building_id_f%from_file )  THEN
2917          var_exchange_int                  = building_id_f%fill
2918          var_exchange_int(nys:nyn,nxl:nxr) = building_id_f%var(nys:nyn,nxl:nxr)
2919          CALL exchange_horiz_2d_int( var_exchange_int, nys, nyn, nxl, nxr, nbgp )
2920          DEALLOCATE( building_id_f%var )
2921          ALLOCATE( building_id_f%var(nys-nbgp:nyn+nbgp,nxl-nbgp:nxr+nbgp) )
2922          building_id_f%var = var_exchange_int
2923
2924          IF ( .NOT. bc_ns_cyc )  THEN
2925             IF ( nys == 0  )  building_id_f%var(-1,:)   = building_id_f%var(0,:)
2926             IF ( nyn == ny )  building_id_f%var(ny+1,:) = building_id_f%var(ny,:)
2927          ENDIF
2928          IF ( .NOT. bc_lr_cyc )  THEN
2929             IF ( nxl == 0  )  building_id_f%var(:,-1)   = building_id_f%var(:,0)
2930             IF ( nxr == nx )  building_id_f%var(:,nx+1) = building_id_f%var(:,nx)
2931          ENDIF
2932       ENDIF
2933
2934       IF ( building_type_f%from_file )  THEN
2935          var_exchange_int                  = INT( building_type_f%fill, KIND = 4 )
2936          var_exchange_int(nys:nyn,nxl:nxr) =                                  &
2937                          INT( building_type_f%var(nys:nyn,nxl:nxr), KIND = 4 )
2938          CALL exchange_horiz_2d_int( var_exchange_int, nys, nyn, nxl, nxr, nbgp )
2939          DEALLOCATE( building_type_f%var )
2940          ALLOCATE( building_type_f%var(nys-nbgp:nyn+nbgp,nxl-nbgp:nxr+nbgp) )
2941          building_type_f%var = INT( var_exchange_int, KIND = 1 )
2942
2943          IF ( .NOT. bc_ns_cyc )  THEN
2944             IF ( nys == 0  )  building_type_f%var(-1,:)   = building_type_f%var(0,:)
2945             IF ( nyn == ny )  building_type_f%var(ny+1,:) = building_type_f%var(ny,:)
2946          ENDIF
2947          IF ( .NOT. bc_lr_cyc )  THEN
2948             IF ( nxl == 0  )  building_type_f%var(:,-1)   = building_type_f%var(:,0)
2949             IF ( nxr == nx )  building_type_f%var(:,nx+1) = building_type_f%var(:,nx)
2950          ENDIF
2951       ENDIF
2952
2953    END SUBROUTINE netcdf_data_input_topo
2954
2955!------------------------------------------------------------------------------!
2956! Description:
2957! ------------
2958!> Reads initialization data of u, v, w, pt, q, geostrophic wind components,
2959!> as well as soil moisture and soil temperature, derived from larger-scale
2960!> model (COSMO) by Inifor.
2961!------------------------------------------------------------------------------!
2962    SUBROUTINE netcdf_data_input_init_3d
2963
2964       USE arrays_3d,                                                          &
2965           ONLY:  q, pt, u, v, w, zu, zw
2966
2967       USE control_parameters,                                                 &
2968           ONLY:  bc_lr_cyc, bc_ns_cyc, humidity, message_string, neutral
2969
2970       USE indices,                                                            &
2971           ONLY:  nx, nxl, nxlu, nxr, ny, nyn, nys, nysv, nzb, nz, nzt
2972
2973       IMPLICIT NONE
2974
2975       CHARACTER(LEN=100), DIMENSION(:), ALLOCATABLE ::  var_names
2976
2977       LOGICAL      ::  dynamic_3d = .TRUE. !< flag indicating that 3D data is read from dynamic file
2978       
2979       INTEGER(iwp) ::  id_dynamic !< NetCDF id of dynamic input file
2980       INTEGER(iwp) ::  num_vars   !< number of variables in netcdf input file
2981
2982       LOGICAL      ::  check_passed !< flag indicating if a check passed
2983
2984!
2985!--    Skip routine if no input file with dynamic input data is available.
2986       IF ( .NOT. input_pids_dynamic )  RETURN
2987!
2988!--    Please note, Inifor is designed to provide initial data for u and v for
2989!--    the prognostic grid points in case of lateral Dirichlet conditions.
2990!--    This means that Inifor provides data from nxlu:nxr (for u) and
2991!--    from nysv:nyn (for v) at the left and south domain boundary, respectively.
2992!--    However, as work-around for the moment, PALM will run with cyclic
2993!--    conditions and will be initialized with data provided by Inifor
2994!--    boundaries in case of Dirichlet.
2995!--    Hence, simply set set nxlu/nysv to 1 (will be reset to its original value
2996!--    at the end of this routine.
2997       IF ( bc_lr_cyc  .AND.  nxl == 0 )  nxlu = 1
2998       IF ( bc_ns_cyc  .AND.  nys == 0 )  nysv = 1
2999
3000!
3001!--    CPU measurement
3002       CALL cpu_log( log_point_s(85), 'NetCDF input init', 'start' )
3003
3004#if defined ( __netcdf )
3005!
3006!--    Open file in read-only mode
3007       CALL open_read_file( TRIM( input_file_dynamic ) //                      &
3008                            TRIM( coupling_char ), id_dynamic )
3009
3010!
3011!--    At first, inquire all variable names.
3012       CALL inquire_num_variables( id_dynamic, num_vars )
3013!
3014!--    Allocate memory to store variable names.
3015       ALLOCATE( var_names(1:num_vars) )
3016       CALL inquire_variable_names( id_dynamic, var_names )
3017!
3018!--    Read vertical dimension of scalar und w grid.
3019       CALL netcdf_data_input_get_dimension_length( id_dynamic, init_3d%nzu, 'z'     )
3020       CALL netcdf_data_input_get_dimension_length( id_dynamic, init_3d%nzw, 'zw'    )
3021!
3022!--    Read also the horizontal dimensions. These are used just used fo
3023!--    checking the compatibility with the PALM grid before reading.
3024       CALL netcdf_data_input_get_dimension_length( id_dynamic, init_3d%nx,  'x'  )
3025       CALL netcdf_data_input_get_dimension_length( id_dynamic, init_3d%nxu, 'xu' )
3026       CALL netcdf_data_input_get_dimension_length( id_dynamic, init_3d%ny,  'y'  )
3027       CALL netcdf_data_input_get_dimension_length( id_dynamic, init_3d%nyv, 'yv' )
3028
3029!
3030!--    Check for correct horizontal and vertical dimension. Please note,
3031!--    checks are performed directly here and not called from
3032!--    check_parameters as some varialbes are still not allocated there.
3033!--    Moreover, please note, u- and v-grid has 1 grid point less on
3034!--    Inifor grid.
3035       IF ( init_3d%nx-1 /= nx  .OR.  init_3d%nxu-1 /= nx - 1  .OR.            &
3036            init_3d%ny-1 /= ny  .OR.  init_3d%nyv-1 /= ny - 1 )  THEN
3037          message_string = 'Number of inifor horizontal grid points  '//       &
3038                           'does not match the number of numeric grid '//      &
3039                           'points.'
3040          CALL message( 'netcdf_data_input_mod', 'PA0543', 1, 2, 0, 6, 0 )
3041       ENDIF
3042
3043       IF ( init_3d%nzu /= nz )  THEN
3044          message_string = 'Number of inifor vertical grid points ' //         &
3045                           'does not match the number of numeric grid '//      &
3046                           'points.'
3047          CALL message( 'netcdf_data_input_mod', 'PA0543', 1, 2, 0, 6, 0 )
3048       ENDIF
3049!
3050!--    Read vertical dimensions. Later, these are required for eventual
3051!--    inter- and extrapolations of the initialization data.
3052       IF ( check_existence( var_names, 'z' ) )  THEN
3053          ALLOCATE( init_3d%zu_atmos(1:init_3d%nzu) )
3054          CALL get_variable( id_dynamic, 'z', init_3d%zu_atmos )
3055       ENDIF
3056       IF ( check_existence( var_names, 'zw' ) )  THEN
3057          ALLOCATE( init_3d%zw_atmos(1:init_3d%nzw) )
3058          CALL get_variable( id_dynamic, 'zw', init_3d%zw_atmos )
3059       ENDIF
3060!
3061!--    Check for consistency between vertical coordinates in dynamic
3062!--    driver and numeric grid.
3063!--    Please note, depending on compiler options both may be
3064!--    equal up to a certain threshold, and differences between
3065!--    the numeric grid and vertical coordinate in the driver can built-
3066!--    up to 10E-1-10E-0 m. For this reason, the check is performed not
3067!--    for exactly matching values.
3068       IF ( ANY( ABS( zu(1:nzt)   - init_3d%zu_atmos(1:init_3d%nzu) )    &
3069                      > 10E-1 )  .OR.                                    &
3070            ANY( ABS( zw(1:nzt-1) - init_3d%zw_atmos(1:init_3d%nzw) )    &
3071                      > 10E-1 ) )  THEN
3072          message_string = 'Vertical grid in dynamic driver does not '// &
3073                           'match the numeric grid.'
3074          CALL message( 'netcdf_data_input_mod', 'PA0543', 1, 2, 0, 6, 0 )
3075       ENDIF
3076!
3077!--    Read initial geostrophic wind components at
3078!--    t = 0 (index 1 in file).
3079       IF ( check_existence( var_names, 'ls_forcing_ug' ) )  THEN
3080          ALLOCATE( init_3d%ug_init(nzb:nzt+1) )
3081          init_3d%ug_init = 0.0_wp
3082
3083          CALL get_variable_pr( id_dynamic, 'ls_forcing_ug', 1,          &
3084                                init_3d%ug_init(1:nzt) )
3085!
3086!--       Set top-boundary condition (Neumann)
3087          init_3d%ug_init(nzt+1) = init_3d%ug_init(nzt)
3088
3089          init_3d%from_file_ug = .TRUE.
3090       ELSE
3091          init_3d%from_file_ug = .FALSE.
3092       ENDIF
3093       IF ( check_existence( var_names, 'ls_forcing_vg' ) )  THEN
3094          ALLOCATE( init_3d%vg_init(nzb:nzt+1) )
3095          init_3d%vg_init = 0.0_wp
3096
3097          CALL get_variable_pr( id_dynamic, 'ls_forcing_vg', 1,          &
3098                                init_3d%vg_init(1:nzt) )
3099!
3100!--       Set top-boundary condition (Neumann)
3101          init_3d%vg_init(nzt+1) = init_3d%vg_init(nzt)
3102
3103          init_3d%from_file_vg = .TRUE.
3104       ELSE
3105          init_3d%from_file_vg = .FALSE.
3106       ENDIF
3107!
3108!--    Read inital 3D data of u, v, w, pt and q,
3109!--    derived from COSMO model. Read PE-wise yz-slices.
3110!--    Please note, the u-, v- and w-component are defined on different
3111!--    grids with one element less in the x-, y-,
3112!--    and z-direction, respectively. Hence, reading is subdivided
3113!--    into separate loops. 
3114!--    Read u-component
3115       IF ( check_existence( var_names, 'init_atmosphere_u' ) )  THEN
3116!
3117!--       Read attributes for the fill value and level-of-detail
3118          CALL get_attribute( id_dynamic, char_fill, init_3d%fill_u,           &
3119                              .FALSE., 'init_atmosphere_u' )
3120          CALL get_attribute( id_dynamic, char_lod, init_3d%lod_u,             &
3121                              .FALSE., 'init_atmosphere_u' )
3122!
3123!--       level-of-detail 1 - read initialization profile
3124          IF ( init_3d%lod_u == 1 )  THEN
3125             ALLOCATE( init_3d%u_init(nzb:nzt+1) )
3126             init_3d%u_init = 0.0_wp
3127
3128             CALL get_variable( id_dynamic, 'init_atmosphere_u',               &
3129                                init_3d%u_init(nzb+1:nzt) )
3130!
3131!--          Set top-boundary condition (Neumann)
3132             init_3d%u_init(nzt+1) = init_3d%u_init(nzt)
3133!
3134!--       level-of-detail 2 - read 3D initialization data
3135          ELSEIF ( init_3d%lod_u == 2 )  THEN
3136             CALL get_variable( id_dynamic, 'init_atmosphere_u',               &
3137                                u(nzb+1:nzt,nys:nyn,nxlu:nxr),                 &
3138                                nxlu, nys+1, nzb+1,                            &
3139                                nxr-nxlu+1, nyn-nys+1, init_3d%nzu,            &
3140                                dynamic_3d )
3141!
3142!--          Set value at leftmost model grid point nxl = 0. This is because
3143!--          Inifor provides data only from 1:nx-1 since it assumes non-cyclic
3144!--          conditions.
3145             IF ( nxl == 0 )                                                   &
3146                u(nzb+1:nzt,nys:nyn,nxl) = u(nzb+1:nzt,nys:nyn,nxlu)
3147!
3148!--          Set bottom and top-boundary
3149             u(nzb,:,:)   = u(nzb+1,:,:)
3150             u(nzt+1,:,:) = u(nzt,:,:)
3151             
3152          ENDIF
3153          init_3d%from_file_u = .TRUE.
3154       ELSE
3155          message_string = 'Missing initial data for u-component'
3156          CALL message( 'netcdf_data_input_mod', 'PA0544', 1, 2, 0, 6, 0 )
3157       ENDIF
3158!
3159!--    Read v-component
3160       IF ( check_existence( var_names, 'init_atmosphere_v' ) )  THEN
3161!
3162!--       Read attributes for the fill value and level-of-detail
3163          CALL get_attribute( id_dynamic, char_fill, init_3d%fill_v,           &
3164                              .FALSE., 'init_atmosphere_v' )
3165          CALL get_attribute( id_dynamic, char_lod, init_3d%lod_v,             &
3166                              .FALSE., 'init_atmosphere_v' )
3167!
3168!--       level-of-detail 1 - read initialization profile
3169          IF ( init_3d%lod_v == 1 )  THEN
3170             ALLOCATE( init_3d%v_init(nzb:nzt+1) )
3171             init_3d%v_init = 0.0_wp
3172
3173             CALL get_variable( id_dynamic, 'init_atmosphere_v',               &
3174                                init_3d%v_init(nzb+1:nzt) )
3175!
3176!--          Set top-boundary condition (Neumann)
3177             init_3d%v_init(nzt+1) = init_3d%v_init(nzt)
3178!
3179!--       level-of-detail 2 - read 3D initialization data
3180          ELSEIF ( init_3d%lod_v == 2 )  THEN
3181         
3182             CALL get_variable( id_dynamic, 'init_atmosphere_v',               &
3183                                v(nzb+1:nzt,nysv:nyn,nxl:nxr),                 &
3184                                nxl+1, nysv, nzb+1,                            &
3185                                nxr-nxl+1, nyn-nysv+1, init_3d%nzu,            &
3186                                dynamic_3d )
3187!
3188!--          Set value at southmost model grid point nys = 0. This is because
3189!--          Inifor provides data only from 1:ny-1 since it assumes non-cyclic
3190!--          conditions.
3191             IF ( nys == 0 )                                                   &
3192                v(nzb+1:nzt,nys,nxl:nxr) = v(nzb+1:nzt,nysv,nxl:nxr)                               
3193!
3194!--          Set bottom and top-boundary
3195             v(nzb,:,:)   = v(nzb+1,:,:)
3196             v(nzt+1,:,:) = v(nzt,:,:)
3197             
3198          ENDIF
3199          init_3d%from_file_v = .TRUE.
3200       ELSE
3201          message_string = 'Missing initial data for v-component'
3202          CALL message( 'netcdf_data_input_mod', 'PA0544', 1, 2, 0, 6, 0 )
3203       ENDIF
3204!
3205!--    Read w-component
3206       IF ( check_existence( var_names, 'init_atmosphere_w' ) )  THEN
3207!
3208!--       Read attributes for the fill value and level-of-detail
3209          CALL get_attribute( id_dynamic, char_fill, init_3d%fill_w,           &
3210                              .FALSE., 'init_atmosphere_w' )
3211          CALL get_attribute( id_dynamic, char_lod, init_3d%lod_w,             &
3212                              .FALSE., 'init_atmosphere_w' )
3213!
3214!--       level-of-detail 1 - read initialization profile
3215          IF ( init_3d%lod_w == 1 )  THEN
3216             ALLOCATE( init_3d%w_init(nzb:nzt+1) )
3217             init_3d%w_init = 0.0_wp
3218
3219             CALL get_variable( id_dynamic, 'init_atmosphere_w',               &
3220                                init_3d%w_init(nzb+1:nzt-1) )
3221!
3222!--          Set top-boundary condition (Neumann)
3223             init_3d%w_init(nzt:nzt+1) = init_3d%w_init(nzt-1)
3224!
3225!--       level-of-detail 2 - read 3D initialization data
3226          ELSEIF ( init_3d%lod_w == 2 )  THEN
3227
3228             CALL get_variable( id_dynamic, 'init_atmosphere_w',                &
3229                                w(nzb+1:nzt-1,nys:nyn,nxl:nxr),                 &
3230                                nxl+1, nys+1, nzb+1,                            &
3231                                nxr-nxl+1, nyn-nys+1, init_3d%nzw,              &
3232                                dynamic_3d )
3233!
3234!--          Set bottom and top-boundary                               
3235             w(nzb,:,:)   = 0.0_wp 
3236             w(nzt,:,:)   = w(nzt-1,:,:)
3237             w(nzt+1,:,:) = w(nzt-1,:,:)
3238
3239          ENDIF
3240          init_3d%from_file_w = .TRUE.
3241       ELSE
3242          message_string = 'Missing initial data for w-component'
3243          CALL message( 'netcdf_data_input_mod', 'PA0544', 1, 2, 0, 6, 0 )
3244       ENDIF
3245!
3246!--    Read potential temperature
3247       IF ( .NOT. neutral )  THEN
3248          IF ( check_existence( var_names, 'init_atmosphere_pt' ) )  THEN
3249!
3250!--          Read attributes for the fill value and level-of-detail
3251             CALL get_attribute( id_dynamic, char_fill, init_3d%fill_pt,       &
3252                                 .FALSE., 'init_atmosphere_pt' )
3253             CALL get_attribute( id_dynamic, char_lod, init_3d%lod_pt,         &
3254                                 .FALSE., 'init_atmosphere_pt' )
3255!
3256!--          level-of-detail 1 - read initialization profile
3257             IF ( init_3d%lod_pt == 1 )  THEN
3258                ALLOCATE( init_3d%pt_init(nzb:nzt+1) )
3259
3260                CALL get_variable( id_dynamic, 'init_atmosphere_pt',           &
3261                                   init_3d%pt_init(nzb+1:nzt) )
3262!
3263!--             Set Neumann top and surface boundary condition for initial
3264!--             profil
3265                init_3d%pt_init(nzb)   = init_3d%pt_init(nzb+1)
3266                init_3d%pt_init(nzt+1) = init_3d%pt_init(nzt)
3267!
3268!--          level-of-detail 2 - read 3D initialization data
3269             ELSEIF ( init_3d%lod_pt == 2 )  THEN
3270
3271                CALL get_variable( id_dynamic, 'init_atmosphere_pt',           &
3272                                   pt(nzb+1:nzt,nys:nyn,nxl:nxr),              &
3273                                   nxl+1, nys+1, nzb+1,                        &
3274                                   nxr-nxl+1, nyn-nys+1, init_3d%nzu,          &
3275                                   dynamic_3d )
3276                                   
3277!
3278!--             Set bottom and top-boundary
3279                pt(nzb,:,:)   = pt(nzb+1,:,:)
3280                pt(nzt+1,:,:) = pt(nzt,:,:)             
3281
3282             ENDIF
3283             init_3d%from_file_pt = .TRUE.
3284          ELSE
3285             message_string = 'Missing initial data for ' //                   &
3286                              'potential temperature'
3287             CALL message( 'netcdf_data_input_mod', 'PA0544', 1, 2, 0, 6, 0 )
3288          ENDIF
3289       ENDIF
3290!
3291!--    Read mixing ratio
3292       IF ( humidity )  THEN
3293          IF ( check_existence( var_names, 'init_atmosphere_qv' ) )  THEN
3294!
3295!--          Read attributes for the fill value and level-of-detail
3296             CALL get_attribute( id_dynamic, char_fill, init_3d%fill_q,        &
3297                                 .FALSE., 'init_atmosphere_qv' )
3298             CALL get_attribute( id_dynamic, char_lod, init_3d%lod_q,          &
3299                                 .FALSE., 'init_atmosphere_qv' )
3300!
3301!--          level-of-detail 1 - read initialization profile
3302             IF ( init_3d%lod_q == 1 )  THEN
3303                ALLOCATE( init_3d%q_init(nzb:nzt+1) )
3304
3305                CALL get_variable( id_dynamic, 'init_atmosphere_qv',           &
3306                                    init_3d%q_init(nzb+1:nzt) )
3307!
3308!--             Set bottom and top boundary condition (Neumann)
3309                init_3d%q_init(nzb)   = init_3d%q_init(nzb+1)
3310                init_3d%q_init(nzt+1) = init_3d%q_init(nzt)
3311!
3312!--          level-of-detail 2 - read 3D initialization data
3313             ELSEIF ( init_3d%lod_q == 2 )  THEN
3314             
3315                CALL get_variable( id_dynamic, 'init_atmosphere_qv',           &
3316                                   q(nzb+1:nzt,nys:nyn,nxl:nxr),               &
3317                                   nxl+1, nys+1, nzb+1,                        &
3318                                   nxr-nxl+1, nyn-nys+1, init_3d%nzu,          &
3319                                   dynamic_3d )
3320                                   
3321!
3322!--             Set bottom and top-boundary
3323                q(nzb,:,:)   = q(nzb+1,:,:)
3324                q(nzt+1,:,:) = q(nzt,:,:)
3325               
3326             ENDIF
3327             init_3d%from_file_q = .TRUE.
3328          ELSE
3329             message_string = 'Missing initial data for ' //                   &
3330                              'mixing ratio'
3331             CALL message( 'netcdf_data_input_mod', 'PA0544', 1, 2, 0, 6, 0 )
3332          ENDIF
3333       ENDIF
3334!
3335!--    Close input file
3336       CALL close_input_file( id_dynamic )
3337#endif
3338!
3339!--    End of CPU measurement
3340       CALL cpu_log( log_point_s(85), 'NetCDF input init', 'stop' )
3341!
3342!--    Finally, check if the input data has any fill values. Please note,
3343!--    checks depend on the LOD of the input data.
3344       IF ( init_3d%from_file_u )  THEN
3345          check_passed = .TRUE.
3346          IF ( init_3d%lod_u == 1 )  THEN
3347             IF ( ANY( init_3d%u_init(nzb+1:nzt+1) == init_3d%fill_u ) )       &
3348                check_passed = .FALSE.
3349          ELSEIF ( init_3d%lod_u == 2 )  THEN
3350             IF ( ANY( u(nzb+1:nzt+1,nys:nyn,nxlu:nxr) == init_3d%fill_u ) )   &
3351                check_passed = .FALSE.
3352          ENDIF
3353          IF ( .NOT. check_passed )  THEN
3354             message_string = 'NetCDF input for init_atmosphere_u must ' //    &
3355                              'not contain any _FillValues'
3356             CALL message( 'netcdf_data_input_mod', 'PA0545', 2, 2, 0, 6, 0 )
3357          ENDIF
3358       ENDIF
3359
3360       IF ( init_3d%from_file_v )  THEN
3361          check_passed = .TRUE.
3362          IF ( init_3d%lod_v == 1 )  THEN
3363             IF ( ANY( init_3d%v_init(nzb+1:nzt+1) == init_3d%fill_v ) )       &
3364                check_passed = .FALSE.
3365          ELSEIF ( init_3d%lod_v == 2 )  THEN
3366             IF ( ANY( v(nzb+1:nzt+1,nysv:nyn,nxl:nxr) == init_3d%fill_v ) )   &
3367                check_passed = .FALSE.
3368          ENDIF
3369          IF ( .NOT. check_passed )  THEN
3370             message_string = 'NetCDF input for init_atmosphere_v must ' //    &
3371                              'not contain any _FillValues'
3372             CALL message( 'netcdf_data_input_mod', 'PA0545', 2, 2, 0, 6, 0 )
3373          ENDIF
3374       ENDIF
3375
3376       IF ( init_3d%from_file_w )  THEN
3377          check_passed = .TRUE.
3378          IF ( init_3d%lod_w == 1 )  THEN
3379             IF ( ANY( init_3d%w_init(nzb+1:nzt) == init_3d%fill_w ) )         &
3380                check_passed = .FALSE.
3381          ELSEIF ( init_3d%lod_w == 2 )  THEN
3382             IF ( ANY( w(nzb+1:nzt,nys:nyn,nxl:nxr) == init_3d%fill_w ) )      &
3383                check_passed = .FALSE.
3384          ENDIF
3385          IF ( .NOT. check_passed )  THEN
3386             message_string = 'NetCDF input for init_atmosphere_w must ' //    &
3387                              'not contain any _FillValues'
3388             CALL message( 'netcdf_data_input_mod', 'PA0545', 2, 2, 0, 6, 0 )
3389          ENDIF
3390       ENDIF
3391
3392       IF ( init_3d%from_file_pt )  THEN
3393          check_passed = .TRUE.
3394          IF ( init_3d%lod_pt == 1 )  THEN
3395             IF ( ANY( init_3d%pt_init(nzb+1:nzt+1) == init_3d%fill_pt ) )     &
3396                check_passed = .FALSE.
3397          ELSEIF ( init_3d%lod_pt == 2 )  THEN
3398             IF ( ANY( pt(nzb+1:nzt+1,nys:nyn,nxl:nxr) == init_3d%fill_pt ) )  &
3399                check_passed = .FALSE.
3400          ENDIF
3401          IF ( .NOT. check_passed )  THEN
3402             message_string = 'NetCDF input for init_atmosphere_pt must ' //   &
3403                              'not contain any _FillValues'
3404             CALL message( 'netcdf_data_input_mod', 'PA0545', 2, 2, 0, 6, 0 )
3405          ENDIF
3406       ENDIF
3407
3408       IF ( init_3d%from_file_q )  THEN
3409          check_passed = .TRUE.
3410          IF ( init_3d%lod_q == 1 )  THEN
3411             IF ( ANY( init_3d%q_init(nzb+1:nzt+1) == init_3d%fill_q ) )       &
3412                check_passed = .FALSE.
3413          ELSEIF ( init_3d%lod_q == 2 )  THEN
3414             IF ( ANY( q(nzb+1:nzt+1,nys:nyn,nxl:nxr) == init_3d%fill_q ) )    &
3415                check_passed = .FALSE.
3416          ENDIF
3417          IF ( .NOT. check_passed )  THEN
3418             message_string = 'NetCDF input for init_atmosphere_q must ' //    &
3419                              'not contain any _FillValues'
3420             CALL message( 'netcdf_data_input_mod', 'PA0545', 2, 2, 0, 6, 0 )
3421          ENDIF
3422       ENDIF
3423!
3424!--    Workaround for cyclic conditions. Please see above for further explanation.
3425       IF ( bc_lr_cyc  .AND.  nxl == 0 )  nxlu = nxl
3426       IF ( bc_ns_cyc  .AND.  nys == 0 )  nysv = nys
3427
3428    END SUBROUTINE netcdf_data_input_init_3d
3429   
3430!------------------------------------------------------------------------------!
3431! Description:
3432! ------------
3433!> Reads initialization data of u, v, w, pt, q, geostrophic wind components,
3434!> as well as soil moisture and soil temperature, derived from larger-scale
3435!> model (COSMO) by Inifor.
3436!------------------------------------------------------------------------------!
3437    SUBROUTINE netcdf_data_input_init_lsm
3438
3439       USE control_parameters,                                                 &
3440           ONLY:  message_string
3441
3442       USE indices,                                                            &
3443           ONLY:  nx, nxl, nxr, ny, nyn, nys
3444
3445       IMPLICIT NONE
3446
3447       CHARACTER(LEN=100), DIMENSION(:), ALLOCATABLE ::  var_names
3448     
3449       INTEGER(iwp) ::  id_dynamic !< NetCDF id of dynamic input file
3450       INTEGER(iwp) ::  num_vars   !< number of variables in netcdf input file
3451
3452!
3453!--    Skip routine if no input file with dynamic input data is available.
3454       IF ( .NOT. input_pids_dynamic )  RETURN
3455!
3456!--    CPU measurement
3457       CALL cpu_log( log_point_s(85), 'NetCDF input init', 'start' )
3458
3459#if defined ( __netcdf )
3460!
3461!--    Open file in read-only mode
3462       CALL open_read_file( TRIM( input_file_dynamic ) //                      &
3463                            TRIM( coupling_char ), id_dynamic )
3464
3465!
3466!--    At first, inquire all variable names.
3467       CALL inquire_num_variables( id_dynamic, num_vars )
3468!
3469!--    Allocate memory to store variable names.
3470       ALLOCATE( var_names(1:num_vars) )
3471       CALL inquire_variable_names( id_dynamic, var_names )
3472!
3473!--    Read vertical dimension for soil depth.
3474       IF ( check_existence( var_names, 'zsoil' ) )                            &
3475          CALL netcdf_data_input_get_dimension_length( id_dynamic, init_3d%nzs,&
3476                                                       'zsoil' )
3477!
3478!--    Read also the horizontal dimensions required for soil initialization.
3479!--    Please note, in case of non-nested runs or in case of root domain,
3480!--    these data is already available, but will be read again for the sake
3481!--    of clearness.
3482       CALL netcdf_data_input_get_dimension_length( id_dynamic, init_3d%nx,    &
3483                                                    'x'  )
3484       CALL netcdf_data_input_get_dimension_length( id_dynamic, init_3d%ny,    &
3485                                                    'y'  )
3486!
3487!--    Check for correct horizontal and vertical dimension. Please note,
3488!--    in case of non-nested runs or in case of root domain, these checks
3489!--    are already performed
3490       IF ( init_3d%nx-1 /= nx  .OR.  init_3d%ny-1 /= ny )  THEN
3491          message_string = 'Number of inifor horizontal grid points  '//       &
3492                           'does not match the number of numeric grid points.'
3493          CALL message( 'netcdf_data_input_mod', 'PA0543', 1, 2, 0, 6, 0 )
3494       ENDIF
3495!
3496!--    Read vertical dimensions. Later, these are required for eventual
3497!--    inter- and extrapolations of the initialization data.
3498       IF ( check_existence( var_names, 'zsoil' ) )  THEN
3499          ALLOCATE( init_3d%z_soil(1:init_3d%nzs) )
3500          CALL get_variable( id_dynamic, 'zsoil', init_3d%z_soil )
3501       ENDIF
3502!
3503!--    Read initial data for soil moisture
3504       IF ( check_existence( var_names, 'init_soil_m' ) )  THEN
3505!
3506!--       Read attributes for the fill value and level-of-detail
3507          CALL get_attribute( id_dynamic, char_fill,                           &
3508                              init_3d%fill_msoil,                              &
3509                              .FALSE., 'init_soil_m' )
3510          CALL get_attribute( id_dynamic, char_lod,                            &
3511                              init_3d%lod_msoil,                               &
3512                              .FALSE., 'init_soil_m' )
3513!
3514!--       level-of-detail 1 - read initialization profile
3515          IF ( init_3d%lod_msoil == 1 )  THEN
3516             ALLOCATE( init_3d%msoil_1d(0:init_3d%nzs-1) )
3517
3518             CALL get_variable( id_dynamic, 'init_soil_m',                     &
3519                                init_3d%msoil_1d(0:init_3d%nzs-1) )
3520!
3521!--       level-of-detail 2 - read 3D initialization data
3522          ELSEIF ( init_3d%lod_msoil == 2 )  THEN
3523             ALLOCATE ( init_3d%msoil_3d(0:init_3d%nzs-1,nys:nyn,nxl:nxr) )
3524
3525            CALL get_variable( id_dynamic, 'init_soil_m',                      &   
3526                             init_3d%msoil_3d(0:init_3d%nzs-1,nys:nyn,nxl:nxr),&
3527                             nxl, nxr, nys, nyn, 0, init_3d%nzs-1 )
3528
3529          ENDIF
3530          init_3d%from_file_msoil = .TRUE.
3531       ENDIF
3532!
3533!--    Read soil temperature
3534       IF ( check_existence( var_names, 'init_soil_t' ) )  THEN
3535!
3536!--       Read attributes for the fill value and level-of-detail
3537          CALL get_attribute( id_dynamic, char_fill,                           &
3538                              init_3d%fill_tsoil,                              &
3539                              .FALSE., 'init_soil_t' )
3540          CALL get_attribute( id_dynamic, char_lod,                            &
3541                              init_3d%lod_tsoil,                               &
3542                              .FALSE., 'init_soil_t' )
3543!
3544!--       level-of-detail 1 - read initialization profile
3545          IF ( init_3d%lod_tsoil == 1 )  THEN
3546             ALLOCATE( init_3d%tsoil_1d(0:init_3d%nzs-1) )
3547
3548             CALL get_variable( id_dynamic, 'init_soil_t',                     &
3549                                init_3d%tsoil_1d(0:init_3d%nzs-1) )
3550
3551!
3552!--       level-of-detail 2 - read 3D initialization data
3553          ELSEIF ( init_3d%lod_tsoil == 2 )  THEN
3554             ALLOCATE ( init_3d%tsoil_3d(0:init_3d%nzs-1,nys:nyn,nxl:nxr) )
3555             
3556             CALL get_variable( id_dynamic, 'init_soil_t',                     &   
3557                             init_3d%tsoil_3d(0:init_3d%nzs-1,nys:nyn,nxl:nxr),&
3558                             nxl, nxr, nys, nyn, 0, init_3d%nzs-1 )
3559          ENDIF
3560          init_3d%from_file_tsoil = .TRUE.
3561       ENDIF
3562!
3563!--    Close input file
3564       CALL close_input_file( id_dynamic )
3565#endif
3566!
3567!--    End of CPU measurement
3568       CALL cpu_log( log_point_s(85), 'NetCDF input init', 'stop' )
3569
3570    END SUBROUTINE netcdf_data_input_init_lsm   
3571
3572!------------------------------------------------------------------------------!
3573! Description:
3574! ------------
3575!> Reads data at lateral and top boundaries derived from larger-scale model
3576!> (COSMO) by Inifor.
3577!------------------------------------------------------------------------------!
3578    SUBROUTINE netcdf_data_input_offline_nesting
3579
3580       USE control_parameters,                                                 &
3581           ONLY:  bc_dirichlet_l, bc_dirichlet_n, bc_dirichlet_r,              &
3582                  bc_dirichlet_s, humidity, neutral, nesting_offline,          &
3583                  time_since_reference_point
3584
3585       USE indices,                                                            &
3586           ONLY:  nxl, nxlu, nxr, nyn, nys, nysv, nzb, nzt
3587
3588       IMPLICIT NONE
3589       
3590       INTEGER(iwp) ::  id_dynamic !< NetCDF id of dynamic input file
3591       INTEGER(iwp) ::  num_vars   !< number of variables in netcdf input file
3592       INTEGER(iwp) ::  t          !< running index time dimension
3593
3594       nest_offl%from_file = MERGE( .TRUE., .FALSE., input_pids_dynamic ) 
3595!
3596!--    Skip input if no forcing from larger-scale models is applied.
3597       IF ( .NOT. nesting_offline )  RETURN
3598
3599!
3600!--    CPU measurement
3601       CALL cpu_log( log_point_s(86), 'NetCDF input forcing', 'start' )
3602
3603#if defined ( __netcdf )
3604!
3605!--    Open file in read-only mode
3606       CALL open_read_file( TRIM( input_file_dynamic ) //                      &
3607                            TRIM( coupling_char ), id_dynamic )
3608!
3609!--    Initialize INIFOR forcing.
3610       IF ( .NOT. nest_offl%init )  THEN
3611!
3612!--       At first, inquire all variable names.
3613          CALL inquire_num_variables( id_dynamic, num_vars )
3614!
3615!--       Allocate memory to store variable names.
3616          ALLOCATE( nest_offl%var_names(1:num_vars) )
3617          CALL inquire_variable_names( id_dynamic, nest_offl%var_names )
3618!
3619!--       Read time dimension, allocate memory and finally read time array
3620          CALL netcdf_data_input_get_dimension_length( id_dynamic,             &
3621                                                       nest_offl%nt, 'time' )
3622
3623          IF ( check_existence( nest_offl%var_names, 'time' ) )  THEN
3624             ALLOCATE( nest_offl%time(0:nest_offl%nt-1) )
3625             CALL get_variable( id_dynamic, 'time', nest_offl%time )
3626          ENDIF
3627!
3628!--       Read vertical dimension of scalar und w grid
3629          CALL netcdf_data_input_get_dimension_length( id_dynamic,             &
3630                                                       nest_offl%nzu, 'z' )
3631          CALL netcdf_data_input_get_dimension_length( id_dynamic,             &
3632                                                       nest_offl%nzw, 'zw' )
3633
3634          IF ( check_existence( nest_offl%var_names, 'z' ) )  THEN
3635             ALLOCATE( nest_offl%zu_atmos(1:nest_offl%nzu) )
3636             CALL get_variable( id_dynamic, 'z', nest_offl%zu_atmos )
3637          ENDIF
3638          IF ( check_existence( nest_offl%var_names, 'zw' ) )  THEN
3639             ALLOCATE( nest_offl%zw_atmos(1:nest_offl%nzw) )
3640             CALL get_variable( id_dynamic, 'zw', nest_offl%zw_atmos )
3641          ENDIF
3642
3643!
3644!--       Read surface pressure
3645          IF ( check_existence( nest_offl%var_names,                           &
3646                                'surface_forcing_surface_pressure' ) )  THEN
3647             ALLOCATE( nest_offl%surface_pressure(0:nest_offl%nt-1) )
3648             CALL get_variable( id_dynamic,                                    &
3649                                'surface_forcing_surface_pressure',            &
3650                                nest_offl%surface_pressure )
3651          ENDIF
3652!
3653!--       Set control flag to indicate that initialization is already done
3654          nest_offl%init = .TRUE.
3655
3656       ENDIF
3657
3658!
3659!--    Obtain time index for current input starting at 0.
3660!--    @todo: At the moment INIFOR and simulated time correspond
3661!--           to each other. If required, adjust to daytime.
3662       nest_offl%tind = MINLOC( ABS( nest_offl%time -                          &
3663                                     time_since_reference_point ), DIM = 1 )   &
3664                        - 1
3665       nest_offl%tind_p = nest_offl%tind + 1       
3666!
3667!--    Read geostrophic wind components
3668       DO  t = nest_offl%tind, nest_offl%tind_p
3669          CALL get_variable_pr( id_dynamic, 'ls_forcing_ug', t+1,              &
3670                                nest_offl%ug(t-nest_offl%tind,nzb+1:nzt) )
3671          CALL get_variable_pr( id_dynamic, 'ls_forcing_vg', t+1,              &
3672                                nest_offl%vg(t-nest_offl%tind,nzb+1:nzt) )
3673       ENDDO
3674!
3675!--    Read data at lateral and top boundaries. Please note, at left and
3676!--    right domain boundary, yz-layers are read for u, v, w, pt and q.
3677!--    For the v-component, the data starts at nysv, while for the other
3678!--    quantities the data starts at nys. This is equivalent at the north
3679!--    and south domain boundary for the u-component.
3680!--    Further, lateral data is not accessed by parallel IO, indicated by the
3681!--    last passed flag in the subroutine get_variable(). This is because
3682!--    not every PE participates in this collective blocking read operation.
3683       IF ( bc_dirichlet_l )  THEN
3684          CALL get_variable( id_dynamic, 'ls_forcing_left_u',                  &
3685                           nest_offl%u_left(0:1,nzb+1:nzt,nys:nyn),            &
3686                           nys+1, nzb+1, nest_offl%tind+1,                     &
3687                           nyn-nys+1, nest_offl%nzu, 2, .FALSE. )
3688     
3689          CALL get_variable( id_dynamic, 'ls_forcing_left_v',                  &
3690                           nest_offl%v_left(0:1,nzb+1:nzt,nysv:nyn),           &
3691                           nysv, nzb+1, nest_offl%tind+1,                      &
3692                           nyn-nysv+1, nest_offl%nzu, 2, .FALSE. )
3693
3694          CALL get_variable( id_dynamic, 'ls_forcing_left_w',                  &
3695                           nest_offl%w_left(0:1,nzb+1:nzt-1,nys:nyn),          &
3696                           nys+1, nzb+1, nest_offl%tind+1,                     &
3697                           nyn-nys+1, nest_offl%nzw, 2, .FALSE. )
3698
3699          IF ( .NOT. neutral )  THEN
3700             CALL get_variable( id_dynamic, 'ls_forcing_left_pt',              &
3701                           nest_offl%pt_left(0:1,nzb+1:nzt,nys:nyn),           &
3702                           nys+1, nzb+1, nest_offl%tind+1,                     &
3703                           nyn-nys+1, nest_offl%nzu, 2, .FALSE. )
3704          ENDIF
3705
3706          IF ( humidity )  THEN
3707             CALL get_variable( id_dynamic, 'ls_forcing_left_qv',              &
3708                           nest_offl%q_left(0:1,nzb+1:nzt,nys:nyn),            &
3709                           nys+1, nzb+1, nest_offl%tind+1,                     &
3710                           nyn-nys+1, nest_offl%nzu, 2, .FALSE. )
3711          ENDIF
3712
3713       ENDIF
3714
3715       IF ( bc_dirichlet_r )  THEN
3716          CALL get_variable( id_dynamic, 'ls_forcing_right_u',                 &
3717                           nest_offl%u_right(0:1,nzb+1:nzt,nys:nyn),           &
3718                           nys+1, nzb+1, nest_offl%tind+1,                     &
3719                           nyn-nys+1, nest_offl%nzu, 2, .FALSE. )
3720                           
3721          CALL get_variable( id_dynamic, 'ls_forcing_right_v',                 &
3722                           nest_offl%v_right(0:1,nzb+1:nzt,nysv:nyn),          &
3723                           nysv, nzb+1, nest_offl%tind+1,                      &
3724                           nyn-nysv+1, nest_offl%nzu, 2, .FALSE. )
3725                           
3726          CALL get_variable( id_dynamic, 'ls_forcing_right_w',                 &
3727                           nest_offl%w_right(0:1,nzb+1:nzt-1,nys:nyn),         &
3728                           nys+1, nzb+1, nest_offl%tind+1,                     &
3729                           nyn-nys+1, nest_offl%nzw, 2, .FALSE. )
3730                           
3731          IF ( .NOT. neutral )  THEN
3732             CALL get_variable( id_dynamic, 'ls_forcing_right_pt',             &
3733                           nest_offl%pt_right(0:1,nzb+1:nzt,nys:nyn),          &
3734                           nys+1, nzb+1, nest_offl%tind+1,                     &
3735                           nyn-nys+1, nest_offl%nzu, 2, .FALSE. )
3736          ENDIF
3737          IF ( humidity )  THEN
3738             CALL get_variable( id_dynamic, 'ls_forcing_right_qv',             &
3739                           nest_offl%q_right(0:1,nzb+1:nzt,nys:nyn),           &
3740                           nys+1, nzb+1, nest_offl%tind+1,                     &
3741                           nyn-nys+1, nest_offl%nzu, 2, .FALSE. )
3742          ENDIF
3743       ENDIF
3744
3745       IF ( bc_dirichlet_n )  THEN
3746       
3747          CALL get_variable( id_dynamic, 'ls_forcing_north_u',                 &
3748                           nest_offl%u_north(0:1,nzb+1:nzt,nxlu:nxr),          &
3749                           nxlu, nzb+1, nest_offl%tind+1,                      &
3750                           nxr-nxlu+1, nest_offl%nzu, 2, .FALSE. )
3751                           
3752          CALL get_variable( id_dynamic, 'ls_forcing_north_v',                 &
3753                           nest_offl%v_north(0:1,nzb+1:nzt,nxl:nxr),           &
3754                           nxl+1, nzb+1, nest_offl%tind+1,                     &
3755                           nxr-nxl+1, nest_offl%nzu, 2, .FALSE. )
3756                           
3757          CALL get_variable( id_dynamic, 'ls_forcing_north_w',                 &
3758                           nest_offl%w_north(0:1,nzb+1:nzt-1,nxl:nxr),         &
3759                           nxl+1, nzb+1, nest_offl%tind+1,                     &
3760                           nxr-nxl+1, nest_offl%nzw, 2, .FALSE. )
3761                           
3762          IF ( .NOT. neutral )  THEN
3763             CALL get_variable( id_dynamic, 'ls_forcing_north_pt',             &
3764                           nest_offl%pt_north(0:1,nzb+1:nzt,nxl:nxr),          &
3765                           nxl+1, nzb+1, nest_offl%tind+1,                     &
3766                           nxr-nxl+1, nest_offl%nzu, 2, .FALSE. )
3767          ENDIF
3768          IF ( humidity )  THEN
3769             CALL get_variable( id_dynamic, 'ls_forcing_north_qv',             &
3770                           nest_offl%q_north(0:1,nzb+1:nzt,nxl:nxr),           &
3771                           nxl+1, nzb+1, nest_offl%tind+1,                     &
3772                           nxr-nxl+1, nest_offl%nzu, 2, .FALSE. )
3773          ENDIF
3774       ENDIF
3775
3776       IF ( bc_dirichlet_s )  THEN
3777          CALL get_variable( id_dynamic, 'ls_forcing_south_u',                 &
3778                           nest_offl%u_south(0:1,nzb+1:nzt,nxlu:nxr),          &
3779                           nxlu, nzb+1, nest_offl%tind+1,                      &
3780                           nxr-nxlu+1, nest_offl%nzu, 2, .FALSE. )
3781
3782          CALL get_variable( id_dynamic, 'ls_forcing_south_v',                 &
3783                           nest_offl%v_south(0:1,nzb+1:nzt,nxl:nxr),           &
3784                           nxl+1, nzb+1, nest_offl%tind+1,                     &
3785                           nxr-nxl+1, nest_offl%nzu, 2, .FALSE. )
3786                           
3787          CALL get_variable( id_dynamic, 'ls_forcing_south_w',                 &
3788                           nest_offl%w_south(0:1,nzb+1:nzt-1,nxl:nxr),         &
3789                           nxl+1, nzb+1, nest_offl%tind+1,                     &
3790                           nxr-nxl+1, nest_offl%nzw, 2, .FALSE. )
3791                           
3792          IF ( .NOT. neutral )  THEN
3793             CALL get_variable( id_dynamic, 'ls_forcing_south_pt',             &
3794                           nest_offl%pt_south(0:1,nzb+1:nzt,nxl:nxr),          &
3795                           nxl+1, nzb+1, nest_offl%tind+1,                     &
3796                           nxr-nxl+1, nest_offl%nzu, 2, .FALSE. )
3797          ENDIF
3798          IF ( humidity )  THEN
3799             CALL get_variable( id_dynamic, 'ls_forcing_south_qv',             &
3800                           nest_offl%q_south(0:1,nzb+1:nzt,nxl:nxr),           &
3801                           nxl+1, nzb+1, nest_offl%tind+1,                     &
3802                           nxr-nxl+1, nest_offl%nzu, 2, .FALSE. )
3803          ENDIF
3804       ENDIF
3805
3806!
3807!--    Top boundary
3808       CALL get_variable( id_dynamic, 'ls_forcing_top_u',                      &
3809                             nest_offl%u_top(0:1,nys:nyn,nxlu:nxr),            &
3810                             nxlu, nys+1, nest_offl%tind+1,                    &
3811                             nxr-nxlu+1, nyn-nys+1, 2, .TRUE. )
3812
3813       CALL get_variable( id_dynamic, 'ls_forcing_top_v',                      &
3814                             nest_offl%v_top(0:1,nysv:nyn,nxl:nxr),            &
3815                             nxl+1, nysv, nest_offl%tind+1,                    &
3816                             nxr-nxl+1, nyn-nysv+1, 2, .TRUE. )
3817                             
3818       CALL get_variable( id_dynamic, 'ls_forcing_top_w',                      &
3819                             nest_offl%w_top(0:1,nys:nyn,nxl:nxr),             &
3820                             nxl+1, nys+1, nest_offl%tind+1,                   &
3821                             nxr-nxl+1, nyn-nys+1, 2, .TRUE. )
3822                             
3823       IF ( .NOT. neutral )  THEN
3824          CALL get_variable( id_dynamic, 'ls_forcing_top_pt',                  &
3825                                nest_offl%pt_top(0:1,nys:nyn,nxl:nxr),         &
3826                                nxl+1, nys+1, nest_offl%tind+1,                &
3827                                nxr-nxl+1, nyn-nys+1, 2, .TRUE. )
3828       ENDIF
3829       IF ( humidity )  THEN
3830          CALL get_variable( id_dynamic, 'ls_forcing_top_qv',                  &
3831                                nest_offl%q_top(0:1,nys:nyn,nxl:nxr),          &
3832                                nxl+1, nys+1, nest_offl%tind+1,                &
3833                                nxr-nxl+1, nyn-nys+1, 2, .TRUE. )
3834       ENDIF
3835
3836!
3837!--    Close input file
3838       CALL close_input_file( id_dynamic )
3839#endif
3840!
3841!--    End of CPU measurement
3842       CALL cpu_log( log_point_s(86), 'NetCDF input forcing', 'stop' )
3843
3844    END SUBROUTINE netcdf_data_input_offline_nesting
3845
3846
3847!------------------------------------------------------------------------------!
3848! Description:
3849! ------------
3850!> Checks input file for consistency and minimum requirements.
3851!------------------------------------------------------------------------------!
3852    SUBROUTINE netcdf_data_input_check_dynamic
3853
3854       USE control_parameters,                                                 &
3855           ONLY:  initializing_actions, message_string, nesting_offline 
3856
3857       IMPLICIT NONE
3858
3859!
3860!--    In case of forcing, check whether dynamic input file is present
3861       IF ( .NOT. input_pids_dynamic  .AND.  nesting_offline  )  THEN
3862          message_string = 'nesting_offline = .TRUE. requires dynamic '  //    &
3863                            'input file ' //                                   &
3864                            TRIM( input_file_dynamic ) // TRIM( coupling_char )
3865          CALL message( 'netcdf_data_input_mod', 'PA0546', 1, 2, 0, 6, 0 )
3866       ENDIF
3867!
3868!--    Dynamic input file must also be present if initialization via inifor is
3869!--    prescribed.
3870       IF ( .NOT. input_pids_dynamic  .AND.                                    &
3871            TRIM( initializing_actions ) == 'inifor' )  THEN
3872          message_string = 'initializing_actions = inifor requires dynamic ' //&
3873                           'input file ' // TRIM( input_file_dynamic ) //      &
3874                           TRIM( coupling_char )
3875          CALL message( 'netcdf_data_input_mod', 'PA0547', 1, 2, 0, 6, 0 )
3876       ENDIF
3877
3878    END SUBROUTINE netcdf_data_input_check_dynamic
3879
3880!------------------------------------------------------------------------------!
3881! Description:
3882! ------------
3883!> Checks input file for consistency and minimum requirements.
3884!------------------------------------------------------------------------------!
3885    SUBROUTINE netcdf_data_input_check_static
3886
3887       USE arrays_3d,                                                          &
3888           ONLY:  zu
3889
3890       USE control_parameters,                                                 &
3891           ONLY:  land_surface, message_string, urban_surface
3892
3893       USE grid_variables,                                                     &
3894           ONLY:  dx, dy
3895
3896       USE indices,                                                            &
3897           ONLY:  nx, nxl, nxr, ny, nyn, nys
3898
3899       IMPLICIT NONE
3900
3901       INTEGER(iwp) ::  i      !< loop index along x-direction
3902       INTEGER(iwp) ::  j      !< loop index along y-direction
3903       INTEGER(iwp) ::  n_surf !< number of different surface types at given location
3904
3905       LOGICAL      ::  check_passed !< flag indicating if a check passed
3906
3907!
3908!--    Return if no static input file is available
3909       IF ( .NOT. input_pids_static )  RETURN
3910!
3911!--    Check whether dimension size in input file matches the model dimensions
3912       IF ( dim_static%nx-1 /= nx  .OR.  dim_static%ny-1 /= ny )  THEN
3913          message_string = 'Static input file: horizontal dimension in ' //    &
3914                           'x- and/or y-direction ' //                         &
3915                           'do not match the respective model dimension'
3916          CALL message( 'netcdf_data_input_mod', 'PA0548', 1, 2, 0, 6, 0 )
3917       ENDIF
3918!
3919!--    Check if grid spacing of provided input data matches the respective
3920!--    grid spacing in the model.
3921       IF ( ABS( dim_static%x(1) - dim_static%x(0) - dx ) > 10E-6_wp  .OR.     &
3922            ABS( dim_static%y(1) - dim_static%y(0) - dy ) > 10E-6_wp )  THEN
3923          message_string = 'Static input file: horizontal grid spacing ' //    &
3924                           'in x- and/or y-direction ' //                      &
3925                           'do not match the respective model grid spacing.'
3926          CALL message( 'netcdf_data_input_mod', 'PA0549', 1, 2, 0, 6, 0 )
3927       ENDIF
3928!
3929!--    Check for correct dimension of surface_fractions, should run from 0-2.
3930       IF ( surface_fraction_f%from_file )  THEN
3931          IF ( surface_fraction_f%nf-1 > 2 )  THEN
3932             message_string = 'nsurface_fraction must not be larger than 3.' 
3933             CALL message( 'netcdf_data_input_mod', 'PA0580', 1, 2, 0, 6, 0 )
3934          ENDIF
3935       ENDIF
3936!
3937!--    Check orography for fill-values. For the moment, give an error message.
3938!--    More advanced methods, e.g. a nearest neighbor algorithm as used in GIS
3939!--    systems might be implemented later.
3940!--    Please note, if no terrain height is provided, it is set to 0.
3941       IF ( ANY( terrain_height_f%var == terrain_height_f%fill ) )  THEN
3942          message_string = 'NetCDF variable zt is not ' //                     &
3943                           'allowed to have missing data'
3944          CALL message( 'netcdf_data_input_mod', 'PA0550', 2, 2, myid, 6, 0 )
3945       ENDIF
3946!
3947!--    Check for negative terrain heights
3948       IF ( ANY( terrain_height_f%var < 0.0_wp ) )  THEN
3949          message_string = 'NetCDF variable zt is not ' //                     &
3950                           'allowed to have negative values'
3951          CALL message( 'netcdf_data_input_mod', 'PA0551', 2, 2, myid, 6, 0 )
3952       ENDIF
3953!
3954!--    If 3D buildings are read, check if building information is consistent
3955!--    to numeric grid.
3956       IF ( buildings_f%from_file )  THEN
3957          IF ( buildings_f%lod == 2 )  THEN
3958             IF ( buildings_f%nz > SIZE( zu ) )  THEN
3959                message_string = 'Reading 3D building data - too much ' //     &
3960                                 'data points along the vertical coordinate.'
3961                CALL message( 'netcdf_data_input_mod', 'PA0552', 2, 2, 0, 6, 0 )
3962             ENDIF
3963
3964             IF ( ANY( ABS( buildings_f%z(0:buildings_f%nz-1) -                &
3965                       zu(0:buildings_f%nz-1) ) > 1E-6_wp ) )  THEN
3966                message_string = 'Reading 3D building data - vertical ' //     &
3967                                 'coordinate do not match numeric grid.'
3968                CALL message( 'netcdf_data_input_mod', 'PA0553', 2, 2, myid, 6, 0 )
3969             ENDIF
3970          ENDIF
3971       ENDIF
3972
3973!
3974!--    Skip further checks concerning buildings and natural surface properties
3975!--    if no urban surface and land surface model are applied.
3976       IF (  .NOT. land_surface  .AND.  .NOT. urban_surface )  RETURN
3977!
3978!--    Check for minimum requirement of surface-classification data in case
3979!--    static input file is used.
3980       IF ( ( .NOT. vegetation_type_f%from_file  .OR.                          &
3981              .NOT. pavement_type_f%from_file    .OR.                          &
3982              .NOT. water_type_f%from_file       .OR.                          &
3983              .NOT. soil_type_f%from_file             ) .OR.                   &
3984             ( urban_surface  .AND.  .NOT. building_type_f%from_file ) )  THEN
3985          message_string = 'Minimum requirement for surface classification ' //&
3986                           'is not fulfilled. At least ' //                    &
3987                           'vegetation_type, pavement_type, ' //               &
3988                           'soil_type and water_type are '//                   &
3989                           'required. If urban-surface model is applied, ' //  &
3990                           'also building_type ist required'
3991          CALL message( 'netcdf_data_input_mod', 'PA0554', 1, 2, 0, 6, 0 )
3992       ENDIF
3993!
3994!--    Check for general availability of input variables.
3995!--    If vegetation_type is 0 at any location, vegetation_pars as well as
3996!--    root_area_dens_s are required.
3997       IF ( vegetation_type_f%from_file )  THEN
3998          IF ( ANY( vegetation_type_f%var == 0 ) )  THEN
3999             IF ( .NOT. vegetation_pars_f%from_file )  THEN
4000                message_string = 'If vegetation_type = 0 at any location, ' // &
4001                                 'vegetation_pars is required'
4002                CALL message( 'netcdf_data_input_mod', 'PA0555', 2, 2, -1, 6, 0 )
4003             ENDIF
4004             IF ( .NOT. root_area_density_lsm_f%from_file )  THEN
4005                message_string = 'If vegetation_type = 0 at any location, ' // &
4006                                 'root_area_dens_s is required'
4007                CALL message( 'netcdf_data_input_mod', 'PA0556', 2, 2, myid, 6, 0 )
4008             ENDIF
4009          ENDIF
4010       ENDIF
4011!
4012!--    If soil_type is zero at any location, soil_pars is required.
4013       IF ( soil_type_f%from_file )  THEN
4014          check_passed = .TRUE.
4015          IF ( ALLOCATED( soil_type_f%var_2d ) )  THEN
4016             IF ( ANY( soil_type_f%var_2d == 0 ) )  THEN
4017                IF ( .NOT. soil_pars_f%from_file )  check_passed = .FALSE.
4018             ENDIF
4019          ELSE
4020             IF ( ANY( soil_type_f%var_3d == 0 ) )  THEN
4021                IF ( .NOT. soil_pars_f%from_file )  check_passed = .FALSE.
4022             ENDIF
4023          ENDIF
4024          IF ( .NOT. check_passed )  THEN
4025             message_string = 'If soil_type = 0 at any location, ' //          &
4026                              'soil_pars is required'
4027             CALL message( 'netcdf_data_input_mod', 'PA0557', 2, 2, myid, 6, 0 )
4028          ENDIF
4029       ENDIF
4030!
4031!--    Buildings require a type in case of urban-surface model.
4032       IF ( buildings_f%from_file  .AND.  .NOT. building_type_f%from_file  )  THEN
4033          message_string = 'If buildings are provided, also building_type ' // &
4034                           'is required'
4035          CALL message( 'netcdf_data_input_mod', 'PA0581', 2, 2, myid, 6, 0 )
4036       ENDIF
4037!
4038!--    Buildings require an ID.
4039       IF ( buildings_f%from_file  .AND.  .NOT. building_id_f%from_file  )  THEN
4040          message_string = 'If buildings are provided, also building_id ' //   &
4041                           'is required'
4042          CALL message( 'netcdf_data_input_mod', 'PA0582', 2, 2, myid, 6, 0 )
4043       ENDIF
4044!
4045!--    If building_type is zero at any location, building_pars is required.
4046       IF ( building_type_f%from_file )  THEN
4047          IF ( ANY( building_type_f%var == 0 ) )  THEN
4048             IF ( .NOT. building_pars_f%from_file )  THEN
4049                message_string = 'If building_type = 0 at any location, ' //   &
4050                                 'building_pars is required'
4051                CALL message( 'netcdf_data_input_mod', 'PA0558', 2, 2, myid, 6, 0 )
4052             ENDIF
4053          ENDIF
4054       ENDIF
4055!
4056!--    If building_type is provided, also building_id is needed (due to the
4057!--    filtering algorithm).
4058       IF ( building_type_f%from_file  .AND.  .NOT. building_id_f%from_file )  &
4059       THEN
4060          message_string = 'If building_type is provided, also building_id '// &
4061                           'is required'
4062          CALL message( 'netcdf_data_input_mod', 'PA0519', 2, 2, myid, 6, 0 )
4063       ENDIF       
4064!
4065!--    If albedo_type is zero at any location, albedo_pars is required.
4066       IF ( albedo_type_f%from_file )  THEN
4067          IF ( ANY( albedo_type_f%var == 0 ) )  THEN
4068             IF ( .NOT. albedo_pars_f%from_file )  THEN
4069                message_string = 'If albedo_type = 0 at any location, ' //     &
4070                                 'albedo_pars is required'
4071                CALL message( 'netcdf_data_input_mod', 'PA0559', 2, 2, myid, 6, 0 )
4072             ENDIF
4073          ENDIF
4074       ENDIF
4075!
4076!--    If pavement_type is zero at any location, pavement_pars is required.
4077       IF ( pavement_type_f%from_file )  THEN
4078          IF ( ANY( pavement_type_f%var == 0 ) )  THEN
4079             IF ( .NOT. pavement_pars_f%from_file )  THEN
4080                message_string = 'If pavement_type = 0 at any location, ' //   &
4081                                 'pavement_pars is required'
4082                CALL message( 'netcdf_data_input_mod', 'PA0560', 2, 2, myid, 6, 0 )
4083             ENDIF
4084          ENDIF
4085       ENDIF
4086!
4087!--    If pavement_type is zero at any location, also pavement_subsurface_pars
4088!--    is required.
4089       IF ( pavement_type_f%from_file )  THEN
4090          IF ( ANY( pavement_type_f%var == 0 ) )  THEN
4091             IF ( .NOT. pavement_subsurface_pars_f%from_file )  THEN
4092                message_string = 'If pavement_type = 0 at any location, ' //   &
4093                                 'pavement_subsurface_pars is required'
4094                CALL message( 'netcdf_data_input_mod', 'PA0561', 2, 2, myid, 6, 0 )
4095             ENDIF
4096          ENDIF
4097       ENDIF
4098!
4099!--    If water_type is zero at any location, water_pars is required.
4100       IF ( water_type_f%from_file )  THEN
4101          IF ( ANY( water_type_f%var == 0 ) )  THEN
4102             IF ( .NOT. water_pars_f%from_file )  THEN
4103                message_string = 'If water_type = 0 at any location, ' //      &
4104                                 'water_pars is required'
4105                CALL message( 'netcdf_data_input_mod', 'PA0562', 2, 2,myid, 6, 0 )
4106             ENDIF
4107          ENDIF
4108       ENDIF
4109!
4110!--    Check for local consistency of the input data.
4111       DO  i = nxl, nxr
4112          DO  j = nys, nyn
4113!
4114!--          For each (y,x)-location at least one of the parameters
4115!--          vegetation_type, pavement_type, building_type, or water_type
4116!--          must be set to a non­missing value.
4117             IF ( vegetation_type_f%var(j,i) == vegetation_type_f%fill  .AND.  &
4118                  pavement_type_f%var(j,i)   == pavement_type_f%fill    .AND.  &
4119                  building_type_f%var(j,i)   == building_type_f%fill    .AND.  &
4120                  water_type_f%var(j,i)      == water_type_f%fill )  THEN
4121                WRITE( message_string, * ) 'At least one of the parameters '// &
4122                                 'vegetation_type, pavement_type, '     //     &
4123                                 'building_type, or water_type must be set '// &
4124                                 'to a non-missing value. Grid point: ', j, i
4125                CALL message( 'netcdf_data_input_mod', 'PA0563', 2, 2, myid, 6, 0 )
4126             ENDIF
4127!
4128!--          Note that a soil_type is required for each location (y,x) where
4129!--          either vegetation_type or pavement_type is a non­missing value.
4130             IF ( ( vegetation_type_f%var(j,i) /= vegetation_type_f%fill  .OR. &
4131                    pavement_type_f%var(j,i)   /= pavement_type_f%fill ) )  THEN
4132                check_passed = .TRUE.
4133                IF ( ALLOCATED( soil_type_f%var_2d ) )  THEN
4134                   IF ( soil_type_f%var_2d(j,i) == soil_type_f%fill )          &
4135                      check_passed = .FALSE.
4136                ELSE
4137                   IF ( ANY( soil_type_f%var_3d(:,j,i) == soil_type_f%fill) )  &
4138                      check_passed = .FALSE.
4139                ENDIF
4140
4141                IF ( .NOT. check_passed )  THEN
4142                   message_string = 'soil_type is required for each '//        &
4143                                 'location (y,x) where vegetation_type or ' // &
4144                                 'pavement_type is a non-missing value.'
4145                   CALL message( 'netcdf_data_input_mod', 'PA0564',            &
4146                                  2, 2, myid, 6, 0 )
4147                ENDIF
4148             ENDIF
4149!
4150!--          Check for consistency of surface fraction. If more than one type
4151!--          is set, surface fraction need to be given and the sum must not
4152!--          be larger than 1.
4153             n_surf = 0
4154             IF ( vegetation_type_f%var(j,i) /= vegetation_type_f%fill )       &
4155                n_surf = n_surf + 1
4156             IF ( water_type_f%var(j,i)      /= water_type_f%fill )            &
4157                n_surf = n_surf + 1
4158             IF ( pavement_type_f%var(j,i)   /= pavement_type_f%fill )         &
4159                n_surf = n_surf + 1
4160
4161             IF ( n_surf > 1 )  THEN
4162                IF ( .NOT. surface_fraction_f%from_file )  THEN
4163                   message_string = 'If more than one surface type is ' //     &
4164                                 'given at a location, surface_fraction ' //   &
4165                                 'must be provided.'
4166                   CALL message( 'netcdf_data_input_mod', 'PA0565',            &
4167                                  2, 2, myid, 6, 0 )
4168                ELSEIF ( ANY ( surface_fraction_f%frac(:,j,i) ==               &
4169                               surface_fraction_f%fill ) )  THEN
4170                   message_string = 'If more than one surface type is ' //     &
4171                                 'given at a location, surface_fraction ' //   &
4172                                 'must be provided.'
4173                   CALL message( 'netcdf_data_input_mod', 'PA0565',            &
4174                                  2, 2, myid, 6, 0 )
4175                ENDIF
4176             ENDIF
4177!
4178!--          Check for further mismatches. e.g. relative fractions exceed 1 or
4179!--          vegetation_type is set but surface vegetation fraction is zero,
4180!--          etc..
4181             IF ( surface_fraction_f%from_file )  THEN
4182!
4183!--             Sum of relative fractions must not exceed 1.
4184                IF ( SUM ( surface_fraction_f%frac(0:2,j,i) ) > 1.0_wp )  THEN
4185                   message_string = 'surface_fraction must not exceed 1'
4186                   CALL message( 'netcdf_data_input_mod', 'PA0566',            &
4187                                  2, 2, myid, 6, 0 )
4188                ENDIF
4189!
4190!--             Relative fraction for a type must not be zero at locations where
4191!--             this type is set.
4192                IF (                                                           &
4193                  ( vegetation_type_f%var(j,i) /= vegetation_type_f%fill  .AND.&
4194                 ( surface_fraction_f%frac(ind_veg_wall,j,i) == 0.0_wp .OR.    &
4195                   surface_fraction_f%frac(ind_veg_wall,j,i) ==                &
4196                                                     surface_fraction_f%fill ) &
4197                  )  .OR.                                                      &
4198                  ( pavement_type_f%var(j,i) /= pavement_type_f%fill     .AND. &
4199                 ( surface_fraction_f%frac(ind_pav_green,j,i) == 0.0_wp .OR.   &
4200                   surface_fraction_f%frac(ind_pav_green,j,i) ==               &