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

Last change on this file since 4360 was 4360, checked in by suehring, 16 months ago

Bugfix in output of time-averaged plant-canopy quanities; Output of plant-canopy data only where tall canopy is defined; land-surface model: fix wrong location strings; tests: update urban test case; all source code files: copyright update

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