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

Last change on this file since 4258 was 4258, checked in by suehring, 2 years ago

Land-surface model: Revise limitation for soil moisture in case it exceeds its saturation value; Revise initialization of soil moisture and temperature in a nested run in case dynamic input information is available. This case, the soil within the child domains can be initialized separately; As part of this revision, migrate the netcdf input of soil temperature / moisture to this module, as well as the routine to inter/extrapolate soil profiles between different grids.; Plant-canopy: Check if any LAD is prescribed when plant-canopy model is applied, in order to avoid crashes in the radiation transfer model; Surface-layer fluxes: Initialization of Obukhov length also at vertical surfaces (if allocated); Urban-surface model: Add checks to ensure that relative fractions of walls, windowns and green surfaces sum-u to one; Revise message calls dealing with local checks

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