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

Last change on this file since 3705 was 3705, checked in by suehring, 4 years ago

last commit documented

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