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

Last change on this file since 4370 was 4370, checked in by raasch, 18 months ago

bugfixes for previous commit: unused variables removed, Temperton-fft usage on GPU, openacc porting of vector version of Obukhov length calculation, collective read switched off on NEC to avoid hanging; some vector directives added in prognostic equations to force vectorization on Intel19 compiler, configuration files for NEC Aurora added

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