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

Last change on this file since 2947 was 2947, checked in by suehring, 3 years ago

Checks for dynamic input further revised

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