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

Last change on this file since 4387 was 4387, checked in by banzhafs, 17 months ago

Added subroutine get_variable_string_generic to netcdf_data_input_mod

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