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

Last change on this file since 4319 was 4319, checked in by suehring, 5 years ago

Further revise check for surface fractions

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