source: palm/trunk/SOURCE/urban_surface_mod.f90 @ 2317

Last change on this file since 2317 was 2317, checked in by suehring, 4 years ago

get topograpyh top index via function call

  • Property svn:keywords set to Id
File size: 263.9 KB
Line 
1!> @file urban_surface_mod.f90
2!--------------------------------------------------------------------------------!
3! This file is part of PALM.
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 2015-2017 Czech Technical University in Prague
18! Copyright 1997-2017 Leibniz Universitaet Hannover
19!--------------------------------------------------------------------------------!
20!
21! Current revisions:
22! ------------------
23! Get topography top index via Function call
24!
25! Former revisions:
26! -----------------
27! $Id: urban_surface_mod.f90 2317 2017-07-20 17:27:19Z suehring $
28! Bugfix: adjust output of shf. Added support for spinups
29!
30! 2287 2017-06-15 16:46:30Z suehring
31! Bugfix in determination topography-top index
32!
33! 2269 2017-06-09 11:57:32Z suehring
34! Enable restart runs with different number of PEs
35! Bugfixes nopointer branch
36!
37! 2258 2017-06-08 07:55:13Z suehring
38! Bugfix, add pre-preprocessor directives to enable non-parrallel mode
39!
40! 2233 2017-05-30 18:08:54Z suehring
41!
42! 2232 2017-05-30 17:47:52Z suehring
43! Adjustments according to new surface-type structure. Remove usm_wall_heat_flux;
44! insteat, heat fluxes are directly applied in diffusion_s.
45!
46! 2213 2017-04-24 15:10:35Z kanani
47! Removal of output quantities usm_lad and usm_canopy_hr
48!
49! 2209 2017-04-19 09:34:46Z kanani
50! cpp switch __mpi3 removed,
51! minor formatting,
52! small bugfix for division by zero (Krc)
53!
54! 2113 2017-01-12 13:40:46Z kanani
55! cpp switch __mpi3 added for MPI-3 standard code (Ketelsen)
56!
57! 2071 2016-11-17 11:22:14Z maronga
58! Small bugfix (Resler)
59!
60! 2031 2016-10-21 15:11:58Z knoop
61! renamed variable rho to rho_ocean
62!
63! 2024 2016-10-12 16:42:37Z kanani
64! Bugfixes in deallocation of array plantt and reading of csf/csfsurf,
65! optimization of MPI-RMA operations,
66! declaration of pcbl as integer,
67! renamed usm_radnet -> usm_rad_net, usm_canopy_khf -> usm_canopy_hr,
68! splitted arrays svf -> svf & csf, svfsurf -> svfsurf & csfsurf,
69! use of new control parameter varnamelength,
70! added output variables usm_rad_ressw, usm_rad_reslw,
71! minor formatting changes,
72! minor optimizations.
73!
74! 2011 2016-09-19 17:29:57Z kanani
75! Major reformatting according to PALM coding standard (comments, blanks,
76! alphabetical ordering, etc.),
77! removed debug_prints,
78! removed auxiliary SUBROUTINE get_usm_info, instead, USM flag urban_surface is
79! defined in MODULE control_parameters (modules.f90) to avoid circular
80! dependencies,
81! renamed canopy_heat_flux to pc_heating_rate, as meaning of quantity changed.
82!
83! 2007 2016-08-24 15:47:17Z kanani
84! Initial revision
85!
86!
87! Description:
88! ------------
89! 2016/6/9 - Initial version of the USM (Urban Surface Model)
90!            authors: Jaroslav Resler, Pavel Krc
91!                     (Czech Technical University in Prague and Institute of
92!                      Computer Science of the Czech Academy of Sciences, Prague)
93!            with contributions: Michal Belda, Nina Benesova, Ondrej Vlcek
94!            partly inspired by PALM LSM (B. Maronga)
95!            parameterizations of Ra checked with TUF3D (E. S. Krayenhoff)
96!> Module for Urban Surface Model (USM)
97!> The module includes:
98!>    1. radiation model with direct/diffuse radiation, shading, reflections
99!>       and integration with plant canopy
100!>    2. wall and wall surface model
101!>    3. surface layer energy balance
102!>    4. anthropogenic heat (only from transportation so far)
103!>    5. necessary auxiliary subroutines (reading inputs, writing outputs,
104!>       restart simulations, ...)
105!> It also make use of standard radiation and integrates it into
106!> urban surface model.
107!>
108!> Further work:
109!> -------------
110!> 1. Reduce number of shape view factors by merging factors for distant surfaces
111!>    under shallow angles. Idea: Iteratively select the smallest shape view
112!>    factor by value (among all sources and targets) which has a similarly
113!>    oriented source neighbor (or near enough) SVF and merge them by adding
114!>    value of the smaller SVF to the larger one and deleting the smaller one.
115!>    This will allow for better scaling at higher resolutions.
116!>
117!> 2. Remove global arrays surfouts, surfoutl and only keep track of radiosity
118!>    from surfaces that are visible from local surfaces (i.e. there is a SVF
119!>    where target is local). To do that, radiosity will be exchanged after each
120!>    reflection step using MPI_Alltoall instead of current MPI_Allgather.
121!>
122!> 3. Temporarily large values of surface heat flux can be observed, up to
123!>    1.2 Km/s, which seem to be not realistic.
124!>
125!> @todo Revise flux conversion in energy-balance solver
126!> @todo Bugfixing in nopointer branch
127!> @todo Check optimizations for RMA operations
128!> @todo Alternatives for MPI_WIN_ALLOCATE? (causes problems with openmpi)
129!> @todo Check for load imbalances in CPU measures, e.g. for exchange_horiz_prog
130!>       factor 3 between min and max time
131!------------------------------------------------------------------------------!
132 MODULE urban_surface_mod
133
134    USE arrays_3d,                                                             &
135        ONLY:  zu, pt, pt_1, pt_2, p, u, v, w, hyp, tend
136
137    USE cloud_parameters,                                                      &
138        ONLY:  cp, r_d
139
140    USE constants,                                                             &
141        ONLY:  pi
142   
143    USE control_parameters,                                                    &
144        ONLY:  coupling_start_time, dz, topography, dt_3d,                     &
145               intermediate_timestep_count, initializing_actions,              &
146               intermediate_timestep_count_max, simulated_time, end_time,      &
147               timestep_scheme, tsc, coupling_char, io_blocks, io_group,       &
148               message_string, time_since_reference_point, surface_pressure,   &
149               g, pt_surface, large_scale_forcing, lsf_surf, spinup,           &
150               spinup_pt_mean, spinup_time, time_do3d, dt_do3d,                &
151               average_count_3d, varnamelength, urban_surface
152
153    USE cpulog,                                                                &
154        ONLY:  cpu_log, log_point, log_point_s
155     
156    USE grid_variables,                                                        &
157        ONLY:  dx, dy, ddx, ddy, ddx2, ddy2
158   
159    USE indices,                                                               &
160        ONLY:  nx, ny, nnx, nny, nnz, nxl, nxlg, nxr, nxrg, nyn, nyng, nys,    &
161               nysg, nzb, nzt, nbgp, wall_flags_0
162
163    USE, INTRINSIC :: iso_c_binding
164
165    USE kinds
166             
167    USE pegrid
168   
169    USE plant_canopy_model_mod,                                                &
170        ONLY:  plant_canopy, pch_index,                                        &
171               pc_heating_rate, lad_s
172   
173    USE radiation_model_mod,                                                   &
174        ONLY:  radiation, calc_zenith, zenith, day_init, time_utc_init,        &
175               rad_net, rad_sw_in, rad_lw_in, rad_sw_out, rad_lw_out,          &
176               sigma_sb, sun_direction, sun_dir_lat, sun_dir_lon,              &
177               force_radiation_call
178
179    USE statistics,                                                            &
180        ONLY:  hom, statistic_regions
181
182    USE surface_mod
183
184               
185
186    IMPLICIT NONE
187
188!-- configuration parameters (they can be setup in PALM config)
189    LOGICAL                                        ::  split_diffusion_radiation = .TRUE. !< split direct and diffusion dw radiation
190                                                                                          !< (.F. in case the radiation model already does it)   
191    LOGICAL                                        ::  usm_energy_balance_land = .TRUE.   !< flag parameter indicating wheather the energy balance is calculated for land and roofs
192    LOGICAL                                        ::  usm_energy_balance_wall = .TRUE.   !< flag parameter indicating wheather the energy balance is calculated for land and roofs
193    LOGICAL                                        ::  usm_material_model = .TRUE.        !< flag parameter indicating wheather the  model of heat in materials is used
194    LOGICAL                                        ::  usm_anthropogenic_heat = .FALSE.   !< flag parameter indicating wheather the anthropogenic heat sources (e.g.transportation) are used
195    LOGICAL                                        ::  force_radiation_call_l = .FALSE.   !< flag parameter for unscheduled radiation model calls
196    LOGICAL                                        ::  mrt_factors = .FALSE.              !< whether to generate MRT factor files during init
197    LOGICAL                                        ::  write_svf_on_init = .FALSE.
198    LOGICAL                                        ::  read_svf_on_init = .FALSE.
199    LOGICAL                                        ::  usm_lad_rma = .TRUE.               !< use MPI RMA to access LAD for raytracing (instead of global array)
200   
201    INTEGER(iwp)                                   ::  nrefsteps = 0                      !< number of reflection steps to perform
202   
203    INTEGER(iwp)                                   ::  land_category = 2                  !< default category for land surface
204    INTEGER(iwp)                                   ::  wall_category = 2                  !< default category for wall surface over pedestrian zone
205    INTEGER(iwp)                                   ::  pedestrant_category = 2            !< default category for wall surface in pedestrian zone
206    INTEGER(iwp)                                   ::  roof_category = 2                  !< default category for root surface
207    REAL(wp)                                       ::  roof_height_limit = 4._wp          !< height for distinguish between land surfaces and roofs
208
209    REAL(wp), PARAMETER                            ::  ext_coef = 0.6_wp                  !< extinction coefficient (a.k.a. alpha)
210    REAL(wp)                                       ::  ra_horiz_coef = 5.0_wp             !< mysterious coefficient for correction of overestimation
211                                                                                          !< of r_a for horizontal surfaces -> TODO
212   
213!-- parameters of urban surface model
214    INTEGER(iwp), PARAMETER                        ::  usm_version_len = 10               !< length of identification string of usm version
215    CHARACTER(usm_version_len), PARAMETER          ::  usm_version = 'USM v. 1.0'         !< identification of version of binary svf and restart files
216    INTEGER(iwp), PARAMETER                        ::  svf_code_len = 15                  !< length of code for verification of the end of svf file
217    CHARACTER(svf_code_len), PARAMETER             ::  svf_code = '*** end svf ***'       !< code for verification of the end of svf file
218    INTEGER(iwp)                                   ::  nzu                                !< number of layers of urban surface (will be calculated)
219    INTEGER(iwp)                                   ::  nzub,nzut                          !< bottom and top layer of urban surface (will be calculated)
220    INTEGER(iwp), PARAMETER                        ::  nzut_free = 3                      !< number of free layers in urban surface layer above top of buildings
221    INTEGER(iwp), PARAMETER                        ::  ndsvf = 2                          !< number of dimensions of real values in SVF
222    INTEGER(iwp), PARAMETER                        ::  idsvf = 2                          !< number of dimensions of integer values in SVF
223    INTEGER(iwp), PARAMETER                        ::  ndcsf = 2                          !< number of dimensions of real values in CSF
224    INTEGER(iwp), PARAMETER                        ::  idcsf = 2                          !< number of dimensions of integer values in CSF
225    INTEGER(iwp), PARAMETER                        ::  kdcsf = 4                          !< number of dimensions of integer values in CSF calculation array
226    INTEGER(iwp), PARAMETER                        ::  id = 1                             !< position of d-index in surfl and surf
227    INTEGER(iwp), PARAMETER                        ::  iz = 2                             !< position of k-index in surfl and surf
228    INTEGER(iwp), PARAMETER                        ::  iy = 3                             !< position of j-index in surfl and surf
229    INTEGER(iwp), PARAMETER                        ::  ix = 4                             !< position of i-index in surfl and surf
230    INTEGER(iwp), PARAMETER                        ::  iroof = 0                          !< 0 - index of ground or roof
231    INTEGER(iwp), PARAMETER                        ::  isouth = 1                         !< 1 - index of south facing wall
232    INTEGER(iwp), PARAMETER                        ::  inorth = 2                         !< 2 - index of north facing wall
233    INTEGER(iwp), PARAMETER                        ::  iwest  = 3                         !< 3 - index of west facing wall
234    INTEGER(iwp), PARAMETER                        ::  ieast  = 4                         !< 4 - index of east facing wall
235    INTEGER(iwp), PARAMETER                        ::  isky = 5                           !< 5 - index of top border of the urban surface layer ("urban sky")
236    INTEGER(iwp), PARAMETER                        ::  inorthb = 6                        !< 6 - index of free north border of the domain (south facing)
237    INTEGER(iwp), PARAMETER                        ::  isouthb = 7                        !< 7 - index of north south border of the domain (north facing)
238    INTEGER(iwp), PARAMETER                        ::  ieastb  = 8                        !< 8 - index of east border of the domain (west facing)
239    INTEGER(iwp), PARAMETER                        ::  iwestb  = 9                        !< 9 - index of wast border of the domain (east facing)
240    INTEGER(iwp), DIMENSION(0:9), PARAMETER        ::  idir = (/0,0,0,-1,1,0,0,0,-1,1/)   !< surface normal direction x indices
241    INTEGER(iwp), DIMENSION(0:9), PARAMETER        ::  jdir = (/0,-1,1,0,0,0,-1,1,0,0/)   !< surface normal direction y indices
242    INTEGER(iwp), DIMENSION(0:9), PARAMETER        ::  kdir = (/1,0,0,0,0,-1,0,0,0,0/)    !< surface normal direction z indices
243    REAL(wp), DIMENSION(1:4)                       ::  ddxy2                              !< 1/dx^2 or 1/dy^2 (in surface normal direction)
244    INTEGER(iwp), DIMENSION(1:4,6:9)               ::  ijdb                               !< start and end of the local domain border coordinates (set in code)
245    LOGICAL, DIMENSION(6:9)                        ::  isborder                           !< is PE on the border of the domain in four corresponding directions
246                                                                                          !< parameter but set in the code
247
248!-- indices and sizes of urban surface model
249    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE      ::  surfl            !< coordinates of i-th local surface in local grid - surfl[:,k] = [d, z, y, x]
250    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE      ::  surf             !< coordinates of i-th surface in grid - surf[:,k] = [d, z, y, x]
251    INTEGER(iwp)                                   ::  nsurfl           !< number of all surfaces in local processor
252    INTEGER(iwp), DIMENSION(:), ALLOCATABLE        ::  nsurfs           !< array of number of all surfaces in individual processors
253    INTEGER(iwp)                                   ::  startsky         !< start index of block of sky
254    INTEGER(iwp)                                   ::  endsky           !< end index of block of sky
255    INTEGER(iwp)                                   ::  nskys            !< number of sky surfaces in local processor
256    INTEGER(iwp)                                   ::  startland        !< start index of block of land and roof surfaces
257    INTEGER(iwp)                                   ::  endland          !< end index of block of land and roof surfaces
258    INTEGER(iwp)                                   ::  nlands           !< number of land and roof surfaces in local processor
259    INTEGER(iwp)                                   ::  startwall        !< start index of block of wall surfaces
260    INTEGER(iwp)                                   ::  endwall          !< end index of block of wall surfaces
261    INTEGER(iwp)                                   ::  nwalls           !< number of wall surfaces in local processor
262    INTEGER(iwp)                                   ::  startenergy      !< start index of block of real surfaces (land, walls and roofs)
263    INTEGER(iwp)                                   ::  endenergy        !< end index of block of real surfaces (land, walls and roofs)
264    INTEGER(iwp)                                   ::  nenergy          !< number of real surfaces in local processor
265    INTEGER(iwp)                                   ::  nsurf            !< global number of surfaces in index array of surfaces (nsurf = Σproc nsurfs)
266    INTEGER(iwp), DIMENSION(:), ALLOCATABLE        ::  surfstart        !< starts of blocks of surfaces for individual processors in array surf
267                                                                        !< respective block for particular processor is surfstart[iproc]+1 : surfstart[iproc+1]
268    INTEGER(iwp)                                   ::  nsvfl            !< number of svf for local processor
269    INTEGER(iwp)                                   ::  ncsfl            !< no. of csf in local processor
270                                                                        !< needed only during calc_svf but must be here because it is
271                                                                        !< shared between subroutines usm_calc_svf and usm_raytrace
272
273!-- type for calculation of svf
274    TYPE t_svf
275        INTEGER(iwp)                               :: isurflt           !<
276        INTEGER(iwp)                               :: isurfs            !<
277        REAL(wp)                                   :: rsvf              !<
278        REAL(wp)                                   :: rtransp           !<
279    END TYPE
280
281!-- type for calculation of csf
282    TYPE t_csf
283        INTEGER(iwp)                               :: ip                !<
284        INTEGER(iwp)                               :: itx               !<
285        INTEGER(iwp)                               :: ity               !<
286        INTEGER(iwp)                               :: itz               !<
287        INTEGER(iwp)                               :: isurfs            !<
288        REAL(wp)                                   :: rsvf              !<
289        REAL(wp)                                   :: rtransp           !<
290    END TYPE
291!
292!-- Type for surface temperatures at vertical walls. Is not necessary for horizontal walls.
293    TYPE t_surf_vertical
294       REAL(wp), DIMENSION(:), ALLOCATABLE         :: t
295    END TYPE t_surf_vertical
296!
297!-- Type for wall temperatures at vertical walls. Is not necessary for horizontal walls.
298    TYPE t_wall_vertical
299       REAL(wp), DIMENSION(:,:), ALLOCATABLE       :: t
300    END TYPE t_wall_vertical
301
302!-- arrays for calculation of svf and csf
303    TYPE(t_svf), DIMENSION(:), POINTER             ::  asvf             !< pointer to growing svc array
304    TYPE(t_csf), DIMENSION(:), POINTER             ::  acsf             !< pointer to growing csf array
305    TYPE(t_svf), DIMENSION(:), ALLOCATABLE, TARGET ::  asvf1, asvf2     !< realizations of svf array
306    TYPE(t_csf), DIMENSION(:), ALLOCATABLE, TARGET ::  acsf1, acsf2     !< realizations of csf array
307    INTEGER(iwp)                                   ::  nsvfla           !< dimmension of array allocated for storage of svf in local processor
308    INTEGER(iwp)                                   ::  ncsfla           !< dimmension of array allocated for storage of csf in local processor
309    INTEGER(iwp)                                   ::  msvf, mcsf       !< mod for swapping the growing array
310    INTEGER(iwp), PARAMETER                        ::  gasize = 10000   !< initial size of growing arrays
311!-- temporary arrays for calculation of csf in raytracing
312    INTEGER(iwp)                                   ::  maxboxesg        !< max number of boxes ray can cross in the domain
313    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE      ::  boxes            !< coordinates of gridboxes being crossed by ray
314    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  crlens           !< array of crossing lengths of ray for particular grid boxes
315    INTEGER(iwp), DIMENSION(:), ALLOCATABLE        ::  lad_ip           !< array of numbers of process where lad is stored
316#if defined( __parallel )
317    INTEGER(kind=MPI_ADDRESS_KIND), &
318                  DIMENSION(:), ALLOCATABLE        ::  lad_disp         !< array of displaycements of lad in local array of proc lad_ip
319#endif
320    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  lad_s_ray        !< array of received lad_s for appropriate gridboxes crossed by ray
321
322!-- arrays storing the values of USM
323    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE      ::  svfsurf          !< svfsurf[:,isvf] = index of source and target surface for svf[isvf]
324    REAL(wp), DIMENSION(:,:), ALLOCATABLE          ::  svf              !< array of shape view factors+direct irradiation factors for local surfaces
325    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfins          !< array of sw radiation falling to local surface after i-th reflection
326    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfinl          !< array of lw radiation for local surface after i-th reflection
327   
328                                                                        !< Inward radiation is also valid for virtual surfaces (radiation leaving domain)
329    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfinsw         !< array of sw radiation falling to local surface including radiation from reflections
330    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfinlw         !< array of lw radiation falling to local surface including radiation from reflections
331    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfinswdir      !< array of direct sw radiation falling to local surface
332    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfinswdif      !< array of diffuse sw radiation from sky and model boundary falling to local surface
333    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfinlwdif      !< array of diffuse lw radiation from sky and model boundary falling to local surface
334   
335                                                                        !< Outward radiation is only valid for nonvirtual surfaces
336    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfoutsl        !< array of reflected sw radiation for local surface in i-th reflection
337    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfoutll        !< array of reflected + emitted lw radiation for local surface in i-th reflection
338    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfouts         !< array of reflected sw radiation for all surfaces in i-th reflection
339    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfoutl         !< array of reflected + emitted lw radiation for all surfaces in i-th reflection
340    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfoutsw        !< array of total sw radiation outgoing from nonvirtual surfaces surfaces after all reflection
341    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfoutlw        !< array of total lw radiation outgoing from nonvirtual surfaces surfaces after all reflection
342    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfhf           !< array of total radiation flux incoming to minus outgoing from local surface
343    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  rad_net_l        !< local copy of rad_net (net radiation at surface)
344
345!-- arrays for time averages
346    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  rad_net_av       !< average of rad_net_l
347    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfinsw_av      !< average of sw radiation falling to local surface including radiation from reflections
348    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfinlw_av      !< average of lw radiation falling to local surface including radiation from reflections
349    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfinswdir_av   !< average of direct sw radiation falling to local surface
350    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfinswdif_av   !< average of diffuse sw radiation from sky and model boundary falling to local surface
351    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfinlwdif_av   !< average of diffuse lw radiation from sky and model boundary falling to local surface
352    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfinswref_av   !< average of sw radiation falling to surface from reflections
353    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfinlwref_av   !< average of lw radiation falling to surface from reflections
354    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfoutsw_av     !< average of total sw radiation outgoing from nonvirtual surfaces surfaces after all reflection
355    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfoutlw_av     !< average of total lw radiation outgoing from nonvirtual surfaces surfaces after all reflection
356    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfins_av       !< average of array of residua of sw radiation absorbed in surface after last reflection
357    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfinl_av       !< average of array of residua of lw radiation absorbed in surface after last reflection
358    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  surfhf_av        !< average of total radiation flux incoming to minus outgoing from local surface 
359   
360!-- block variables needed for calculation of the plant canopy model inside the urban surface model
361    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE      ::  csfsurf          !< csfsurf[:,icsf] = index of target surface and csf grid index for csf[icsf]
362    REAL(wp), DIMENSION(:,:), ALLOCATABLE          ::  csf              !< array of plant canopy sink fators + direct irradiation factors (transparency)
363                                                                        !< for local surfaces
364    INTEGER(wp), DIMENSION(:,:), ALLOCATABLE       ::  pcbl             !< k,j,i coordinates of l-th local plant canopy box pcbl[:,l] = [k, j, i]
365    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE    ::  gridpcbl         !< index of local pcb[k,j,i]
366    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  pcbinsw          !< array of absorbed sw radiation for local plant canopy box
367    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  pcbinlw          !< array of absorbed lw radiation for local plant canopy box
368    INTEGER(iwp)                                   ::  npcbl            !< number of the plant canopy gridboxes in local processor
369    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE      ::  pch              !< heights of the plant canopy
370    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE      ::  pct              !< top layer of the plant canopy
371    REAL(wp), DIMENSION(:,:,:), POINTER            ::  usm_lad          !< subset of lad_s within urban surface, transformed to plain Z coordinate
372    REAL(wp), DIMENSION(:), POINTER                ::  usm_lad_g        !< usm_lad globalized (used to avoid MPI RMA calls in raytracing)
373    REAL(wp)                                       ::  prototype_lad    !< prototype leaf area density for computing effective optical depth
374    INTEGER(iwp), DIMENSION(:), ALLOCATABLE        ::  nzterr, plantt   !< temporary global arrays for raytracing
375   
376!-- radiation related arrays (it should be better in interface of radiation module of PALM
377    REAL(wp), DIMENSION(:,:), ALLOCATABLE          ::  rad_sw_in_dir    !< direct sw radiation
378    REAL(wp), DIMENSION(:,:), ALLOCATABLE          ::  rad_sw_in_diff   !< diffusion sw radiation
379    REAL(wp), DIMENSION(:,:), ALLOCATABLE          ::  rad_lw_in_diff   !< diffusion lw radiation
380
381!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
382!-- anthropogenic heat sources
383!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
384    REAL(wp), DIMENSION(:,:), ALLOCATABLE          ::  aheat             !< daily average of anthropogenic heat (W/m2)
385    REAL(wp), DIMENSION(:), ALLOCATABLE            ::  aheatprof         !< diurnal profile of anthropogenic heat
386
387!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
388!-- wall surface model
389!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
390!-- wall surface model constants
391    INTEGER(iwp), PARAMETER                        :: nzb_wall = 0       !< inner side of the wall model (to be switched)
392    INTEGER(iwp), PARAMETER                        :: nzt_wall = 3       !< outer side of the wall model (to be switched)
393    INTEGER(iwp), PARAMETER                        :: nzw = 4            !< number of wall layers (fixed for now)
394
395    REAL(wp), DIMENSION(nzb_wall:nzt_wall)         :: zwn_default = (/0.0242_wp, 0.0969_wp, 0.346_wp, 1.0_wp /)
396                                                                         !< normalized soil, wall and roof layer depths (m/m)
397                                                                       
398    REAL(wp)                                       ::   wall_inner_temperature = 296.0_wp    !< temperature of the inner wall surface (~23 degrees C) (K)
399    REAL(wp)                                       ::   roof_inner_temperature = 296.0_wp    !< temperature of the inner roof surface (~23 degrees C) (K)
400    REAL(wp)                                       ::   soil_inner_temperature = 283.0_wp    !< temperature of the deep soil (~10 degrees C) (K)
401
402!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
403!-- surface and material model variables for walls, ground, roofs
404!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
405    REAL(wp), DIMENSION(:), ALLOCATABLE            :: zwn                !< normalized wall layer depths (m)
406
407#if defined( __nopointer )
408    REAL(wp), DIMENSION(:), ALLOCATABLE, TARGET    :: t_surf_h           !< wall surface temperature (K) at horizontal walls
409    REAL(wp), DIMENSION(:), ALLOCATABLE, TARGET    :: t_surf_h_p         !< progn. wall surface temperature (K) at horizontal walls
410
411    TYPE(t_surf_vertical), DIMENSION(0:3), TARGET  ::  t_surf_v
412    TYPE(t_surf_vertical), DIMENSION(0:3), TARGET  ::  t_surf_v_p
413#else
414    REAL(wp), DIMENSION(:), POINTER                :: t_surf_h
415    REAL(wp), DIMENSION(:), POINTER                :: t_surf_h_p
416
417    REAL(wp), DIMENSION(:), ALLOCATABLE, TARGET    :: t_surf_h_1
418    REAL(wp), DIMENSION(:), ALLOCATABLE, TARGET    :: t_surf_h_2
419
420    TYPE(t_surf_vertical), DIMENSION(:), POINTER ::  t_surf_v
421    TYPE(t_surf_vertical), DIMENSION(:), POINTER ::  t_surf_v_p
422
423    TYPE(t_surf_vertical), DIMENSION(0:3), TARGET  :: t_surf_v_1
424    TYPE(t_surf_vertical), DIMENSION(0:3), TARGET  :: t_surf_v_2
425#endif
426    REAL(wp), DIMENSION(:), ALLOCATABLE, TARGET    :: t_surf_av          !< average of wall surface temperature (K)
427
428!-- Temporal tendencies for time stepping           
429    REAL(wp), DIMENSION(:), ALLOCATABLE            :: tt_surface_m       !< surface temperature tendency (K)
430
431!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
432!-- Energy balance variables
433!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
434!-- parameters of the land, roof and wall surfaces
435    REAL(wp), DIMENSION(:), ALLOCATABLE            :: albedo_surf        !< albedo of the surface
436!-- parameters of the wall surfaces
437    REAL(wp), DIMENSION(:), ALLOCATABLE            :: emiss_surf         !< emissivity of the wall surface
438
439#if defined( __nopointer )
440    REAL(wp), DIMENSION(:), ALLOCATABLE, TARGET    :: t_wall_h             !< Wall temperature (K)
441    REAL(wp), DIMENSION(:), ALLOCATABLE, TARGET    :: t_wall_h_av          !< Average of t_wall
442    REAL(wp), DIMENSION(:), ALLOCATABLE, TARGET    :: t_wall_h_p           !< Prog. wall temperature (K)
443
444    TYPE(t_wall_vertical), DIMENSION(0:3), TARGET  :: t_wall_v             !< Wall temperature (K)
445    TYPE(t_wall_vertical), DIMENSION(0:3), TARGET  :: t_wall_v_av          !< Average of t_wall
446    TYPE(t_wall_vertical), DIMENSION(0:3), TARGET  :: t_wall_v_p           !< Prog. wall temperature (K)
447#else
448    REAL(wp), DIMENSION(:,:), POINTER                :: t_wall_h, t_wall_h_p
449    REAL(wp), DIMENSION(:,:), ALLOCATABLE, TARGET    :: t_wall_h_av, t_wall_h_1, t_wall_h_2
450
451    TYPE(t_wall_vertical), DIMENSION(:), POINTER   :: t_wall_v, t_wall_v_p
452    TYPE(t_wall_vertical), DIMENSION(0:3), TARGET  :: t_wall_v_av, t_wall_v_1, t_wall_v_2
453#endif
454
455!-- Wall temporal tendencies for time stepping
456    REAL(wp), DIMENSION(:,:), ALLOCATABLE          :: tt_wall_m          !< t_wall prognostic array
457
458!-- Surface and material parameters classes (surface_type)
459!-- albedo, emissivity, lambda_surf, roughness, thickness, volumetric heat capacity, thermal conductivity
460    INTEGER(iwp)                                   :: n_surface_types      !< number of the wall type categories
461    INTEGER(iwp), PARAMETER                        :: n_surface_params = 8 !< number of parameters for each type of the wall
462    INTEGER(iwp), PARAMETER                        :: ialbedo  = 1         !< albedo of the surface
463    INTEGER(iwp), PARAMETER                        :: iemiss   = 2         !< emissivity of the surface
464    INTEGER(iwp), PARAMETER                        :: ilambdas = 3         !< heat conductivity λS between air and surface ( W m−2 K−1 )
465    INTEGER(iwp), PARAMETER                        :: irough   = 4         !< roughness relative to concrete
466    INTEGER(iwp), PARAMETER                        :: icsurf   = 5         !< Surface skin layer heat capacity (J m−2 K−1 )
467    INTEGER(iwp), PARAMETER                        :: ithick   = 6         !< thickness of the surface (wall, roof, land)  ( m )
468    INTEGER(iwp), PARAMETER                        :: irhoC    = 7         !< volumetric heat capacity rho*C of the material ( J m−3 K−1 )
469    INTEGER(iwp), PARAMETER                        :: ilambdah = 8         !< thermal conductivity λH of the wall (W m−1 K−1 )
470    CHARACTER(12), DIMENSION(:), ALLOCATABLE       :: surface_type_names   !< names of wall types (used only for reports)
471    INTEGER(iwp), DIMENSION(:), ALLOCATABLE        :: surface_type_codes   !< codes of wall types
472    REAL(wp), DIMENSION(:,:), ALLOCATABLE          :: surface_params       !< parameters of wall types
473   
474    CHARACTER(len=*), PARAMETER                    :: svf_file_name='usm_svf'
475   
476!-- interfaces of subroutines accessed from outside of this module
477    INTERFACE usm_check_data_output
478       MODULE PROCEDURE usm_check_data_output
479    END INTERFACE usm_check_data_output
480   
481    INTERFACE usm_check_parameters
482       MODULE PROCEDURE usm_check_parameters
483    END INTERFACE usm_check_parameters
484   
485    INTERFACE usm_data_output_3d
486       MODULE PROCEDURE usm_data_output_3d
487    END INTERFACE usm_data_output_3d
488   
489    INTERFACE usm_define_netcdf_grid
490       MODULE PROCEDURE usm_define_netcdf_grid
491    END INTERFACE usm_define_netcdf_grid
492
493    INTERFACE usm_init_urban_surface
494       MODULE PROCEDURE usm_init_urban_surface
495    END INTERFACE usm_init_urban_surface
496
497    INTERFACE usm_material_heat_model
498       MODULE PROCEDURE usm_material_heat_model
499    END INTERFACE usm_material_heat_model
500   
501    INTERFACE usm_parin
502       MODULE PROCEDURE usm_parin
503    END INTERFACE usm_parin
504
505    INTERFACE usm_radiation
506       MODULE PROCEDURE usm_radiation
507    END INTERFACE usm_radiation
508   
509    INTERFACE usm_read_restart_data
510       MODULE PROCEDURE usm_read_restart_data
511    END INTERFACE usm_read_restart_data
512
513    INTERFACE usm_surface_energy_balance
514       MODULE PROCEDURE usm_surface_energy_balance
515    END INTERFACE usm_surface_energy_balance
516   
517    INTERFACE usm_swap_timelevel
518       MODULE PROCEDURE usm_swap_timelevel
519    END INTERFACE usm_swap_timelevel
520       
521    INTERFACE usm_write_restart_data
522       MODULE PROCEDURE usm_write_restart_data
523    END INTERFACE usm_write_restart_data
524   
525    SAVE
526
527    PRIVATE 
528   
529!-- Public parameters, constants and initial values
530    PUBLIC split_diffusion_radiation,                                          &
531           usm_anthropogenic_heat, usm_material_model, mrt_factors,            &
532           usm_check_parameters,                                               &
533           usm_energy_balance_land, usm_energy_balance_wall, nrefsteps,        &
534           usm_init_urban_surface, usm_radiation, usm_read_restart_data,       &
535           usm_surface_energy_balance, usm_material_heat_model,                &
536           usm_swap_timelevel, usm_check_data_output, usm_average_3d_data,     &
537           usm_data_output_3d, usm_define_netcdf_grid, usm_parin,              &
538           usm_write_restart_data,                                             &
539           nzub, nzut, ra_horiz_coef, usm_lad_rma,                             &
540           land_category, pedestrant_category, wall_category, roof_category,   &
541           write_svf_on_init, read_svf_on_init
542
543
544 CONTAINS
545
546 
547!------------------------------------------------------------------------------!
548! Description:
549! ------------
550!> This subroutine creates the necessary indices of the urban surfaces
551!> and plant canopy and it allocates the needed arrays for USM
552!------------------------------------------------------------------------------!
553    SUBROUTINE usm_allocate_urban_surface
554   
555        IMPLICIT NONE
556       
557        INTEGER(iwp) :: i, j, k, d, l, ir, jr, ids, m
558        INTEGER(iwp) :: k_topo     !< vertical index indicating topography top for given (j,i)
559        INTEGER(iwp) :: k_topo2    !< vertical index indicating topography top for given (j,i)
560        INTEGER(iwp) :: nzubl, nzutl, isurf, ipcgb
561        INTEGER(iwp) :: procid
562
563       
564
565       
566!--     auxiliary vars
567        ddxy2 = (/ddy2,ddy2,ddx2,ddx2/)      !< 1/dx^2 or 1/dy^2 (in surface normal direction)
568       
569        CALL location_message( '', .TRUE. )
570        CALL location_message( '    allocation of needed arrays', .TRUE. )
571!
572!--     Find nzub, nzut, nzu via wall_flag_0 array (nzb_s_inner will be
573!--     removed later). The following contruct finds the lowest / largest index
574!--     for any upward-facing wall (see bit 12).
575        nzubl = MINVAL(                                                        &
576                    MAXLOC(                                                    &
577                          MERGE( 1, 0,                                         &
578                                 BTEST( wall_flags_0(:,nys:nyn,nxl:nxr), 12 )  &
579                               ), DIM = 1                                      &
580                          ) - 1                                                & 
581                            )
582        nzutl = MAXVAL(                                                        &
583                   MAXLOC(                                                     &
584                          MERGE( 1, 0,                                         &
585                                 BTEST( wall_flags_0(:,nys:nyn,nxl:nxr), 12 )  &
586                               ), DIM = 1                                      &
587                          ) - 1                                                &
588                            )
589        nzubl = max(nzubl,nzb)
590
591       
592        IF ( plant_canopy )  THEN
593!--         allocate needed arrays
594            ALLOCATE( pct(nys:nyn,nxl:nxr) )
595            ALLOCATE( pch(nys:nyn,nxl:nxr) )
596
597!--         calculate plant canopy height
598            npcbl = 0
599            pct = 0.0_wp
600            pch = 0.0_wp
601            DO i = nxl, nxr
602                DO j = nys, nyn
603!
604!--                 Find topography top index
605                    k_topo = get_topography_top_index( j, i, 's' )
606
607                    DO k = nzt+1, 0, -1
608                        IF ( lad_s(k,j,i) /= 0.0_wp )  THEN
609!--                         we are at the top of the pcs
610                            pct(j,i) = k + k_topo
611                            pch(j,i) = k
612                            npcbl = npcbl + pch(j,i)
613                            EXIT
614                        ENDIF
615                    ENDDO
616                ENDDO
617            ENDDO
618           
619            nzutl = max(nzutl, maxval(pct))
620!--         code of plant canopy model uses parameter pch_index
621!--         we need to setup it here to right value
622!--         (pch_index, lad_s and other arrays in PCM are defined flat)
623            pch_index = maxval(pch)
624
625            prototype_lad = maxval(lad_s) * .9_wp  !< better be *1.0 if lad is either 0 or maxval(lad) everywhere
626            IF ( prototype_lad <= 0._wp ) prototype_lad = .3_wp
627            !WRITE(message_string, '(a,f6.3)') 'Precomputing effective box optical ' &
628            !    // 'depth using prototype leaf area density = ', prototype_lad
629            !CALL message('usm_init_urban_surface', 'PA0520', 0, 0, -1, 6, 0)
630        ENDIF
631       
632        nzutl = min(nzutl+nzut_free, nzt)
633                 
634#if defined( __parallel )
635        CALL MPI_AllReduce(nzubl,nzub,1,MPI_INTEGER,MPI_MIN,comm2d,ierr);
636        CALL MPI_AllReduce(nzutl,nzut,1,MPI_INTEGER,MPI_MAX,comm2d,ierr);
637#else
638        nzub = nzubl
639        nzut = nzutl
640#endif
641
642!--     global number of urban layers
643        nzu = nzut - nzub + 1
644       
645!--     allocate urban surfaces grid
646!--     calc number of surfaces in local proc
647        CALL location_message( '    calculation of indices for surfaces', .TRUE. )
648        nsurfl = 0
649!
650!--     Number of land- and roof surfaces. Note, since horizontal surface elements
651!--     are already counted in surface_mod, in case be simply reused here.
652        startland = 1
653        nsurfl    = surf_usm_h%ns
654        endland   = nsurfl
655        nlands    = endland-startland+1
656
657!
658!--     Number of vertical surfaces. As vertical surfaces are already
659!--     counted in surface mod, it can be reused here.
660        startwall = nsurfl+1
661        nsurfl = nsurfl + surf_usm_v(0)%ns + surf_usm_v(1)%ns +        &
662                          surf_usm_v(2)%ns + surf_usm_v(3)%ns
663        endwall = nsurfl
664        nwalls = endwall-startwall+1
665
666       
667!--     range of energy balance surfaces  ! will be treated separately by surf_usm_h and surf_usm_v
668        nenergy = 0
669        IF ( usm_energy_balance_land )  THEN
670            startenergy = startland
671            nenergy = nenergy + nlands
672        ELSE
673            startenergy = startwall
674        ENDIF
675        IF ( usm_energy_balance_wall )  THEN
676            endenergy = endwall
677            nenergy = nenergy + nwalls
678        ELSE
679            endenergy = endland
680        ENDIF
681
682!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
683!--     block of virtual surfaces
684!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
685!--     calculate sky surfaces  ! not used so far!
686        startsky = nsurfl+1
687        nsurfl = nsurfl+(nxr-nxl+1)*(nyn-nys+1)
688        endsky = nsurfl
689        nskys = endsky-startsky+1
690       
691!--     border flags
692#if defined( __parallel )
693        isborder = (/ north_border_pe, south_border_pe, right_border_pe, left_border_pe /)
694#else
695        isborder = (/.TRUE.,.TRUE.,.TRUE.,.TRUE./)
696#endif
697!--     fill array of the limits of the local domain borders
698        ijdb = RESHAPE( (/ nxl,nxr,nyn,nyn,nxl,nxr,nys,nys,nxr,nxr,nys,nyn,nxl,nxl,nys,nyn /), (/4, 4/) )
699!--     calulation of the free borders of the domain
700        DO  ids = 6,9
701           IF ( isborder(ids) )  THEN
702!--           free border of the domain in direction ids
703              DO  i = ijdb(1,ids), ijdb(2,ids)
704                 DO  j = ijdb(3,ids), ijdb(4,ids)
705
706                    k_topo  = get_topography_top_index( j, i, 's' )
707                    k_topo2 = get_topography_top_index( j-jdir(ids), i-idir(ids), 's' )
708
709                    k = nzut - MAX( k_topo, k_topo2 )
710                    nsurfl = nsurfl + k
711                 ENDDO
712              ENDDO
713           ENDIF
714        ENDDO
715       
716!--     fill gridpcbl and pcbl
717        IF ( plant_canopy )  THEN
718            ALLOCATE( pcbl(iz:ix, 1:npcbl) )
719            ALLOCATE( gridpcbl(nzub:nzut,nys:nyn,nxl:nxr) )
720            gridpcbl(:,:,:) = 0
721            ipcgb = 0
722            DO i = nxl, nxr
723                DO j = nys, nyn
724!
725!--                 Find topography top index
726                    k_topo = get_topography_top_index( j, i, 's' )
727
728                    DO k = k_topo + 1, pct(j,i)
729                        ipcgb = ipcgb + 1
730                        gridpcbl(k,j,i) = ipcgb
731                        pcbl(:,ipcgb) = (/ k, j, i /)
732                    ENDDO
733                ENDDO
734            ENDDO
735
736            ALLOCATE( pcbinsw( 1:npcbl ) )
737            ALLOCATE( pcbinlw( 1:npcbl ) )
738        ENDIF
739
740!--     fill surfl
741        ALLOCATE(surfl(5,nsurfl))
742        isurf = 0
743       
744!--     add land surfaces or roofs
745        DO i = nxl, nxr
746            DO j = nys, nyn
747               DO  m = surf_usm_h%start_index(j,i), surf_usm_h%end_index(j,i)
748                  k = surf_usm_h%k(m)
749
750                  isurf = isurf + 1
751                  surfl(:,isurf) = (/iroof,k,j,i,m/)
752               ENDDO
753            ENDDO
754        ENDDO
755
756!--     add walls
757        DO i = nxl, nxr
758            DO j = nys, nyn
759               l = 0
760               DO  m = surf_usm_v(l)%start_index(j,i), surf_usm_v(l)%end_index(j,i)
761                  k = surf_usm_v(l)%k(m)
762
763                  isurf          = isurf + 1
764                  surfl(:,isurf) = (/2,k,j,i,m/)
765               ENDDO
766               l = 1
767               DO  m = surf_usm_v(l)%start_index(j,i), surf_usm_v(l)%end_index(j,i)
768                  k = surf_usm_v(l)%k(m)
769
770                  isurf          = isurf + 1
771                  surfl(:,isurf) = (/1,k,j,i,m/)
772               ENDDO
773               l = 2
774               DO  m = surf_usm_v(l)%start_index(j,i), surf_usm_v(l)%end_index(j,i)
775                  k = surf_usm_v(l)%k(m)
776
777                  isurf          = isurf + 1
778                  surfl(:,isurf) = (/4,k,j,i,m/)
779               ENDDO
780               l = 3
781               DO  m = surf_usm_v(l)%start_index(j,i), surf_usm_v(l)%end_index(j,i)
782                  k = surf_usm_v(l)%k(m)
783
784                  isurf          = isurf + 1
785                  surfl(:,isurf) = (/3,k,j,i,m/)
786               ENDDO
787            ENDDO
788        ENDDO
789
790!--     add sky
791        DO i = nxl, nxr
792            DO j = nys, nyn
793                isurf = isurf + 1
794                k = nzut
795                surfl(:,isurf) = (/isky,k,j,i,-1/)
796            ENDDO
797        ENDDO
798       
799!--     calulation of the free borders of the domain
800        DO ids = 6,9
801            IF ( isborder(ids) )  THEN
802!--             free border of the domain in direction ids
803                DO i = ijdb(1,ids), ijdb(2,ids)
804                    DO j = ijdb(3,ids), ijdb(4,ids)
805                        k_topo  = get_topography_top_index( j, i, 's' )
806                        k_topo2 = get_topography_top_index( j-jdir(ids), i-idir(ids), 's' )
807
808                        DO k = MAX(k_topo,k_topo2)+1, nzut
809                            isurf = isurf + 1
810                            surfl(:,isurf) = (/ids,k,j,i,-1/)
811                        ENDDO
812                    ENDDO
813                ENDDO
814            ENDIF
815        ENDDO
816       
817!--     global array surf of indices of surfaces and displacement index array surfstart
818        ALLOCATE(nsurfs(0:numprocs-1))
819       
820#if defined( __parallel )
821        CALL MPI_Allgather(nsurfl,1,MPI_INTEGER,nsurfs,1,MPI_INTEGER,comm2d,ierr)
822#else
823        nsurfs(0) = nsurfl
824#endif
825        ALLOCATE(surfstart(0:numprocs))
826        k = 0
827        DO i=0,numprocs-1
828            surfstart(i) = k
829            k = k+nsurfs(i)
830        ENDDO
831        surfstart(numprocs) = k
832        nsurf = k
833        ALLOCATE(surf(5,nsurf))
834       
835#if defined( __parallel )
836        CALL MPI_AllGatherv(surfl, nsurfl*5, MPI_INTEGER, surf, nsurfs*5, surfstart*5, MPI_INTEGER, comm2d, ierr)
837#else
838        surf = surfl
839#endif
840       
841!--
842!--     allocation of the arrays for direct and diffusion radiation
843        CALL location_message( '    allocation of radiation arrays', .TRUE. )
844!--     rad_sw_in, rad_lw_in are computed in radiation model,
845!--     splitting of direct and diffusion part is done
846!--     in usm_calc_diffusion_radiation for now
847        ALLOCATE( rad_sw_in_dir(nysg:nyng,nxlg:nxrg) )
848        ALLOCATE( rad_sw_in_diff(nysg:nyng,nxlg:nxrg) )
849        ALLOCATE( rad_lw_in_diff(nysg:nyng,nxlg:nxrg) )
850       
851!--     allocate radiation arrays
852        ALLOCATE( surfins(nsurfl) )
853        ALLOCATE( surfinl(nsurfl) )
854        ALLOCATE( surfinsw(nsurfl) )
855        ALLOCATE( surfinlw(nsurfl) )
856        ALLOCATE( surfinswdir(nsurfl) )
857        ALLOCATE( surfinswdif(nsurfl) )
858        ALLOCATE( surfinlwdif(nsurfl) )
859        ALLOCATE( surfoutsl(startenergy:endenergy) )
860        ALLOCATE( surfoutll(startenergy:endenergy) )
861        ALLOCATE( surfoutsw(startenergy:endenergy) )
862        ALLOCATE( surfoutlw(startenergy:endenergy) )
863        ALLOCATE( surfouts(nsurf) ) !TODO: global surfaces without virtual
864        ALLOCATE( surfoutl(nsurf) ) !TODO: global surfaces without virtual
865
866
867
868!
869!--     Allocate radiation arrays which are part of the new data type.
870!--     For horizontal surfaces.
871        ALLOCATE( surf_usm_h%surfhf(1:surf_usm_h%ns)    )
872        ALLOCATE( surf_usm_h%rad_net_l(1:surf_usm_h%ns) )
873!
874!--  New
875        ALLOCATE( surf_usm_h%rad_in_sw(1:surf_usm_h%ns)  )
876        ALLOCATE( surf_usm_h%rad_out_sw(1:surf_usm_h%ns) )
877        ALLOCATE( surf_usm_h%rad_in_lw(1:surf_usm_h%ns)  )
878        ALLOCATE( surf_usm_h%rad_out_lw(1:surf_usm_h%ns) )
879!
880!--     For vertical surfaces
881        DO  l = 0, 3
882           ALLOCATE( surf_usm_v(l)%surfhf(1:surf_usm_v(l)%ns)    )
883           ALLOCATE( surf_usm_v(l)%rad_net_l(1:surf_usm_v(l)%ns) )
884           ALLOCATE( surf_usm_v(l)%rad_in_sw(1:surf_usm_v(l)%ns)  )
885           ALLOCATE( surf_usm_v(l)%rad_out_sw(1:surf_usm_v(l)%ns) )
886           ALLOCATE( surf_usm_v(l)%rad_in_lw(1:surf_usm_v(l)%ns)  )
887           ALLOCATE( surf_usm_v(l)%rad_out_lw(1:surf_usm_v(l)%ns) )
888        ENDDO
889
890!--     Wall surface model
891!--     allocate arrays for wall surface model and define pointers
892       
893!--     allocate array of wall types and wall parameters
894        ALLOCATE ( surf_usm_h%surface_types(1:surf_usm_h%ns) )
895        DO  l = 0, 3
896           ALLOCATE( surf_usm_v(l)%surface_types(1:surf_usm_v(l)%ns) )
897        ENDDO
898       
899!--     broadband albedo of the land, roof and wall surface
900!--     for domain border and sky set artifically to 1.0
901!--     what allows us to calculate heat flux leaving over
902!--     side and top borders of the domain
903        ALLOCATE ( albedo_surf(nsurfl) )
904        albedo_surf = 1.0_wp
905        ALLOCATE ( surf_usm_h%albedo_surf(1:surf_usm_h%ns) )
906        DO  l = 0, 3
907           ALLOCATE( surf_usm_v(l)%albedo_surf(1:surf_usm_v(l)%ns) )
908        ENDDO
909       
910!--     wall and roof surface parameters. First for horizontal surfaces
911        ALLOCATE ( emiss_surf(startenergy:endenergy) )
912
913        ALLOCATE ( surf_usm_h%isroof_surf(1:surf_usm_h%ns)    )
914        ALLOCATE ( surf_usm_h%emiss_surf(1:surf_usm_h%ns)     )
915        ALLOCATE ( surf_usm_h%lambda_surf(1:surf_usm_h%ns)    )
916        ALLOCATE ( surf_usm_h%c_surface(1:surf_usm_h%ns)      )
917        ALLOCATE ( surf_usm_h%roughness_wall(1:surf_usm_h%ns) )
918!
919!--     For vertical surfaces.
920        DO  l = 0, 3
921           ALLOCATE ( surf_usm_v(l)%emiss_surf(1:surf_usm_v(l)%ns)     )
922           ALLOCATE ( surf_usm_v(l)%lambda_surf(1:surf_usm_v(l)%ns)    )
923           ALLOCATE ( surf_usm_v(l)%c_surface(1:surf_usm_v(l)%ns)      )
924           ALLOCATE ( surf_usm_v(l)%roughness_wall(1:surf_usm_v(l)%ns) )
925        ENDDO
926       
927!--     allocate wall and roof material parameters. First for horizontal surfaces
928        ALLOCATE ( surf_usm_h%thickness_wall(1:surf_usm_h%ns)               )
929        ALLOCATE ( surf_usm_h%lambda_h(nzb_wall:nzt_wall,1:surf_usm_h%ns)   )
930        ALLOCATE ( surf_usm_h%rho_c_wall(nzb_wall:nzt_wall,1:surf_usm_h%ns) )
931!
932!--     For vertical surfaces.
933        DO  l = 0, 3
934           ALLOCATE ( surf_usm_v(l)%thickness_wall(1:surf_usm_v(l)%ns)               )
935           ALLOCATE ( surf_usm_v(l)%lambda_h(nzb_wall:nzt_wall,1:surf_usm_v(l)%ns)   )
936           ALLOCATE ( surf_usm_v(l)%rho_c_wall(nzb_wall:nzt_wall,1:surf_usm_v(l)%ns) )
937        ENDDO
938
939!--     allocate wall and roof layers sizes. For horizontal surfaces.
940        ALLOCATE ( zwn(nzb_wall:nzt_wall) )
941        ALLOCATE ( surf_usm_h%dz_wall(nzb_wall:nzt_wall+1,1:surf_usm_h%ns)     )
942        ALLOCATE ( surf_usm_h%ddz_wall(nzb_wall:nzt_wall+1,1:surf_usm_h%ns)    )
943        ALLOCATE ( surf_usm_h%dz_wall_stag(nzb_wall:nzt_wall,1:surf_usm_h%ns)  )
944        ALLOCATE ( surf_usm_h%ddz_wall_stag(nzb_wall:nzt_wall,1:surf_usm_h%ns) )
945        ALLOCATE ( surf_usm_h%zw(nzb_wall:nzt_wall,1:surf_usm_h%ns)            )
946!
947!--     For vertical surfaces.
948        DO  l = 0, 3
949           ALLOCATE ( surf_usm_v(l)%dz_wall(nzb_wall:nzt_wall+1,1:surf_usm_v(l)%ns)     )
950           ALLOCATE ( surf_usm_v(l)%ddz_wall(nzb_wall:nzt_wall+1,1:surf_usm_v(l)%ns)    )
951           ALLOCATE ( surf_usm_v(l)%dz_wall_stag(nzb_wall:nzt_wall,1:surf_usm_v(l)%ns)  )
952           ALLOCATE ( surf_usm_v(l)%ddz_wall_stag(nzb_wall:nzt_wall,1:surf_usm_v(l)%ns) )
953           ALLOCATE ( surf_usm_v(l)%zw(nzb_wall:nzt_wall,1:surf_usm_v(l)%ns)            )
954        ENDDO
955
956!--     allocate wall and roof temperature arrays, for horizontal walls
957#if defined( __nopointer )
958        IF ( .NOT. ALLOCATED( t_surf_h ) )                                     &
959           ALLOCATE ( t_surf_h(1:surf_usm_h%ns) )
960        IF ( .NOT. ALLOCATED( t_surf_h_p ) )                                   &
961           ALLOCATE ( t_surf_h_p(1:surf_usm_h%ns) )
962        IF ( .NOT. ALLOCATED( t_wall_h ) )                                     &           
963           ALLOCATE ( t_wall_h(nzb_wall:nzt_wall+1,1:surf_usm_h%ns) ) 
964        IF ( .NOT. ALLOCATED( t_wall_h_p ) )                                   &           
965           ALLOCATE ( t_wall_h_p(nzb_wall:nzt_wall+1,1:surf_usm_h%ns) ) 
966#else
967!
968!--     Allocate if required. Note, in case of restarts, some of these arrays
969!--     might be already allocated.
970        IF ( .NOT. ALLOCATED( t_surf_h_1 ) )                                   &
971           ALLOCATE ( t_surf_h_1(1:surf_usm_h%ns) )
972        IF ( .NOT. ALLOCATED( t_surf_h_2 ) )                                   &
973           ALLOCATE ( t_surf_h_2(1:surf_usm_h%ns) )
974        IF ( .NOT. ALLOCATED( t_wall_h_1 ) )                                   &           
975           ALLOCATE ( t_wall_h_1(nzb_wall:nzt_wall+1,1:surf_usm_h%ns) ) 
976        IF ( .NOT. ALLOCATED( t_wall_h_2 ) )                                   &           
977           ALLOCATE ( t_wall_h_2(nzb_wall:nzt_wall+1,1:surf_usm_h%ns) )         
978!           
979!--     initial assignment of the pointers
980        t_wall_h    => t_wall_h_1;    t_wall_h_p    => t_wall_h_2
981        t_surf_h => t_surf_h_1; t_surf_h_p => t_surf_h_2           
982#endif
983
984!--     allocate wall and roof temperature arrays, for vertical walls if required
985#if defined( __nopointer )
986        DO  l = 0, 3
987           IF ( .NOT. ALLOCATED( t_surf_v(l)%t ) )                             &
988              ALLOCATE ( t_surf_v(l)%t(1:surf_usm_v(l)%ns) )
989           IF ( .NOT. ALLOCATED( t_surf_v_p(l)%t ) )                           &
990              ALLOCATE ( t_surf_v_p(l)%t(1:surf_usm_v(l)%ns) )
991           IF ( .NOT. ALLOCATED( t_wall_v(l)%t ) )                             &
992              ALLOCATE ( t_wall_v(l)%t(nzb_wall:nzt_wall+1,1:surf_usm_v(l)%ns) )
993           IF ( .NOT. ALLOCATED( t_wall_v_p(l)%t ) )                           &                 
994              ALLOCATE ( t_wall_v_p(l)%t(nzb_wall:nzt_wall+1,1:surf_usm_v(l)%ns) )
995        ENDDO
996#else
997!
998!--     Allocate if required. Note, in case of restarts, some of these arrays
999!--     might be already allocated.
1000        DO  l = 0, 3
1001           IF ( .NOT. ALLOCATED( t_surf_v_1(l)%t ) )                           &
1002              ALLOCATE ( t_surf_v_1(l)%t(1:surf_usm_v(l)%ns) )
1003           IF ( .NOT. ALLOCATED( t_surf_v_2(l)%t ) )                           &
1004              ALLOCATE ( t_surf_v_2(l)%t(1:surf_usm_v(l)%ns) )
1005           IF ( .NOT. ALLOCATED( t_wall_v_1(l)%t ) )                           &           
1006              ALLOCATE ( t_wall_v_1(l)%t(nzb_wall:nzt_wall+1,1:surf_usm_v(l)%ns) ) 
1007           IF ( .NOT. ALLOCATED( t_wall_v_2(l)%t ) )                           &           
1008              ALLOCATE ( t_wall_v_2(l)%t(nzb_wall:nzt_wall+1,1:surf_usm_v(l)%ns) ) 
1009        ENDDO
1010!
1011!--     initial assignment of the pointers
1012        t_wall_v    => t_wall_v_1;    t_wall_v_p    => t_wall_v_2
1013        t_surf_v => t_surf_v_1; t_surf_v_p => t_surf_v_2
1014#endif
1015!
1016!--     Allocate intermediate timestep arrays. For horizontal surfaces.
1017        ALLOCATE ( surf_usm_h%tt_surface_m(1:surf_usm_h%ns)                  )
1018        ALLOCATE ( surf_usm_h%tt_wall_m(nzb_wall:nzt_wall+1,1:surf_usm_h%ns) )
1019!
1020!--     Set inital values for prognostic quantities
1021        IF ( ALLOCATED( surf_usm_h%tt_surface_m ) )  surf_usm_h%tt_surface_m = 0.0_wp
1022        IF ( ALLOCATED( surf_usm_h%tt_wall_m    ) )  surf_usm_h%tt_wall_m    = 0.0_wp
1023!
1024!--     Now, for vertical surfaces
1025        DO  l = 0, 3
1026           ALLOCATE ( surf_usm_v(l)%tt_surface_m(1:surf_usm_v(l)%ns)                  )
1027           ALLOCATE ( surf_usm_v(l)%tt_wall_m(nzb_wall:nzt_wall+1,1:surf_usm_v(l)%ns) )
1028           IF ( ALLOCATED( surf_usm_v(l)%tt_surface_m ) )  surf_usm_v(l)%tt_surface_m = 0.0_wp
1029           IF ( ALLOCATED( surf_usm_v(l)%tt_wall_m    ) )  surf_usm_v(l)%tt_wall_m    = 0.0_wp
1030        ENDDO
1031
1032!--     allocate wall heat flux output array and set initial values. For horizontal surfaces
1033!         ALLOCATE ( surf_usm_h%wshf(1:surf_usm_h%ns)    )  !can be removed
1034        ALLOCATE ( surf_usm_h%wshf_eb(1:surf_usm_h%ns) )
1035        ALLOCATE ( surf_usm_h%wghf_eb(1:surf_usm_h%ns) )
1036        IF ( ALLOCATED( surf_usm_h%wshf    ) )  surf_usm_h%wshf    = 0.0_wp
1037        IF ( ALLOCATED( surf_usm_h%wshf_eb ) )  surf_usm_h%wshf_eb = 0.0_wp
1038        IF ( ALLOCATED( surf_usm_h%wghf_eb ) )  surf_usm_h%wghf_eb = 0.0_wp
1039!
1040!--     Now, for vertical surfaces
1041        DO  l = 0, 3
1042!            ALLOCATE ( surf_usm_v(l)%wshf(1:surf_usm_v(l)%ns)    )    ! can be removed
1043           ALLOCATE ( surf_usm_v(l)%wshf_eb(1:surf_usm_v(l)%ns) )
1044           ALLOCATE ( surf_usm_v(l)%wghf_eb(1:surf_usm_v(l)%ns) )
1045           IF ( ALLOCATED( surf_usm_v(l)%wshf    ) )  surf_usm_v(l)%wshf    = 0.0_wp
1046           IF ( ALLOCATED( surf_usm_v(l)%wshf_eb ) )  surf_usm_v(l)%wshf_eb = 0.0_wp
1047           IF ( ALLOCATED( surf_usm_v(l)%wghf_eb ) )  surf_usm_v(l)%wghf_eb = 0.0_wp
1048        ENDDO
1049       
1050    END SUBROUTINE usm_allocate_urban_surface
1051
1052
1053
1054!------------------------------------------------------------------------------!
1055! Description:
1056! ------------
1057!> Sum up and time-average urban surface output quantities as well as allocate
1058!> the array necessary for storing the average.
1059!------------------------------------------------------------------------------!
1060    SUBROUTINE usm_average_3d_data( mode, variable )
1061
1062        IMPLICIT NONE
1063
1064        CHARACTER (len=*), INTENT(IN) ::  mode
1065        CHARACTER (len=*), INTENT(IN) :: variable
1066 
1067        INTEGER(iwp)                                       :: i, j, k, l, m, ids, iwl,istat
1068        CHARACTER (len=varnamelength)                      :: var, surfid
1069        INTEGER(iwp), PARAMETER                            :: nd = 5
1070        CHARACTER(len=6), DIMENSION(0:nd-1), PARAMETER     :: dirname = (/ '_roof ', '_south', '_north', '_west ', '_east ' /)
1071
1072!--     find the real name of the variable
1073        var = TRIM(variable)
1074        DO i = 0, nd-1
1075            k = len(TRIM(var))
1076            j = len(TRIM(dirname(i)))
1077            IF ( var(k-j+1:k) == dirname(i) )  THEN
1078                ids = i
1079                var = var(:k-j)
1080                EXIT
1081            ENDIF
1082        ENDDO
1083        IF ( ids == -1 )  THEN
1084            var = TRIM(variable)
1085        ENDIF
1086        IF ( var(1:11) == 'usm_t_wall_'  .AND.  len(TRIM(var)) >= 12 )  THEN
1087!--          wall layers
1088            READ(var(12:12), '(I1)', iostat=istat ) iwl
1089            IF ( istat == 0  .AND.  iwl >= nzb_wall  .AND.  iwl <= nzt_wall )  THEN
1090                var = var(1:10)
1091            ELSE
1092!--             wrong wall layer index
1093                RETURN
1094            ENDIF
1095        ENDIF
1096
1097        IF ( mode == 'allocate' )  THEN
1098           
1099           SELECT CASE ( TRIM( var ) )
1100               
1101                CASE ( 'usm_rad_net' )
1102!--                 array of complete radiation balance
1103                    IF ( .NOT.  ALLOCATED(surf_usm_h%rad_net_av) )  THEN
1104                        ALLOCATE( surf_usm_h%rad_net_av(1:surf_usm_h%ns) )
1105                        surf_usm_h%rad_net_av = 0.0_wp
1106                    ENDIF
1107                    DO  l = 0, 3
1108                       IF ( .NOT.  ALLOCATED(surf_usm_v(l)%rad_net_av) )  THEN
1109                           ALLOCATE( surf_usm_v(l)%rad_net_av(1:surf_usm_v(l)%ns) )
1110                           surf_usm_v(l)%rad_net_av = 0.0_wp
1111                       ENDIF
1112                    ENDDO
1113                   
1114                CASE ( 'usm_rad_insw' )
1115!--                 array of sw radiation falling to surface after i-th reflection
1116                    IF ( .NOT.  ALLOCATED(surf_usm_h%surfinsw_av) )  THEN
1117                        ALLOCATE( surf_usm_h%surfinsw_av(1:surf_usm_h%ns) )
1118                        surf_usm_h%surfinsw_av = 0.0_wp
1119                    ENDIF
1120                    DO  l = 0, 3
1121                       IF ( .NOT.  ALLOCATED(surf_usm_v(l)%surfinsw_av) )  THEN
1122                           ALLOCATE( surf_usm_v(l)%surfinsw_av(1:surf_usm_v(l)%ns) )
1123                           surf_usm_v(l)%surfinsw_av = 0.0_wp
1124                       ENDIF
1125                    ENDDO
1126                                   
1127                CASE ( 'usm_rad_inlw' )
1128!--                 array of lw radiation falling to surface after i-th reflection
1129                    IF ( .NOT.  ALLOCATED(surf_usm_h%surfinlw_av) )  THEN
1130                        ALLOCATE( surf_usm_h%surfinlw_av(1:surf_usm_h%ns) )
1131                        surf_usm_h%surfinlw_av = 0.0_wp
1132                    ENDIF
1133                    DO  l = 0, 3
1134                       IF ( .NOT.  ALLOCATED(surf_usm_v(l)%surfinlw_av) )  THEN
1135                           ALLOCATE( surf_usm_v(l)%surfinlw_av(1:surf_usm_v(l)%ns) )
1136                           surf_usm_v(l)%surfinlw_av = 0.0_wp
1137                       ENDIF
1138                    ENDDO
1139
1140                CASE ( 'usm_rad_inswdir' )
1141!--                 array of direct sw radiation falling to surface from sun
1142                    IF ( .NOT.  ALLOCATED(surfinswdir_av) )  THEN
1143                        ALLOCATE( surfinswdir_av(startenergy:endenergy) )
1144                        surfinswdir_av = 0.0_wp
1145                    ENDIF
1146
1147                CASE ( 'usm_rad_inswdif' )
1148!--                 array of difusion sw radiation falling to surface from sky and borders of the domain
1149                    IF ( .NOT.  ALLOCATED(surfinswdif_av) )  THEN
1150                        ALLOCATE( surfinswdif_av(startenergy:endenergy) )
1151                        surfinswdif_av = 0.0_wp
1152                    ENDIF
1153
1154                CASE ( 'usm_rad_inswref' )
1155!--                 array of sw radiation falling to surface from reflections
1156                    IF ( .NOT.  ALLOCATED(surfinswref_av) )  THEN
1157                        ALLOCATE( surfinswref_av(startenergy:endenergy) )
1158                        surfinswref_av = 0.0_wp
1159                    ENDIF
1160
1161                CASE ( 'usm_rad_inlwdif' )
1162!--                 array of sw radiation falling to surface after i-th reflection
1163                   IF ( .NOT.  ALLOCATED(surfinlwdif_av) )  THEN
1164                        ALLOCATE( surfinlwdif_av(startenergy:endenergy) )
1165                        surfinlwdif_av = 0.0_wp
1166                    ENDIF
1167
1168                CASE ( 'usm_rad_inlwref' )
1169!--                 array of lw radiation falling to surface from reflections
1170                    IF ( .NOT.  ALLOCATED(surfinlwref_av) )  THEN
1171                        ALLOCATE( surfinlwref_av(startenergy:endenergy) )
1172                        surfinlwref_av = 0.0_wp
1173                    ENDIF
1174
1175                CASE ( 'usm_rad_outsw' )
1176!--                 array of sw radiation emitted from surface after i-th reflection
1177                    IF ( .NOT.  ALLOCATED(surfoutsw_av) )  THEN
1178                        ALLOCATE( surfoutsw_av(startenergy:endenergy) )
1179                        surfoutsw_av = 0.0_wp
1180                    ENDIF
1181
1182                CASE ( 'usm_rad_outlw' )
1183!--                 array of lw radiation emitted from surface after i-th reflection
1184                    IF ( .NOT.  ALLOCATED(surfoutlw_av) )  THEN
1185                        ALLOCATE( surfoutlw_av(startenergy:endenergy) )
1186                        surfoutlw_av = 0.0_wp
1187                    ENDIF
1188                CASE ( 'usm_rad_ressw' )
1189!--                 array of residua of sw radiation absorbed in surface after last reflection
1190                    IF ( .NOT.  ALLOCATED(surfins_av) )  THEN
1191                        ALLOCATE( surfins_av(startenergy:endenergy) )
1192                        surfins_av = 0.0_wp
1193                    ENDIF
1194                                   
1195                CASE ( 'usm_rad_reslw' )
1196!--                 array of residua of lw radiation absorbed in surface after last reflection
1197                    IF ( .NOT.  ALLOCATED(surfinl_av) )  THEN
1198                        ALLOCATE( surfinl_av(startenergy:endenergy) )
1199                        surfinl_av = 0.0_wp
1200                    ENDIF
1201                                   
1202                CASE ( 'usm_rad_hf' )
1203!--                 array of heat flux from radiation for surfaces after i-th reflection
1204                    IF ( .NOT.  ALLOCATED(surf_usm_h%surfhf_av) )  THEN
1205                        ALLOCATE( surf_usm_h%surfhf_av(1:surf_usm_h%ns) )
1206                        surf_usm_h%surfhf_av = 0.0_wp
1207                    ENDIF
1208                    DO  l = 0, 3
1209                       IF ( .NOT.  ALLOCATED(surf_usm_v(l)%surfhf_av) )  THEN
1210                           ALLOCATE( surf_usm_v(l)%surfhf_av(1:surf_usm_v(l)%ns) )
1211                           surf_usm_v(l)%surfhf_av = 0.0_wp
1212                       ENDIF
1213                    ENDDO
1214
1215                CASE ( 'usm_wshf' )
1216!--                 array of sensible heat flux from surfaces
1217!--                 land surfaces
1218                    IF ( .NOT.  ALLOCATED(surf_usm_h%wshf_eb_av) )  THEN
1219                        ALLOCATE( surf_usm_h%wshf_eb_av(1:surf_usm_h%ns) )
1220                        surf_usm_h%wshf_eb_av = 0.0_wp
1221                    ENDIF
1222                    DO  l = 0, 3
1223                       IF ( .NOT.  ALLOCATED(surf_usm_v(l)%wshf_eb_av) )  THEN
1224                           ALLOCATE( surf_usm_v(l)%wshf_eb_av(1:surf_usm_v(l)%ns) )
1225                           surf_usm_v(l)%wshf_eb_av = 0.0_wp
1226                       ENDIF
1227                    ENDDO
1228
1229                CASE ( 'usm_wghf' )
1230!--                 array of heat flux from ground (wall, roof, land)
1231                    IF ( .NOT.  ALLOCATED(surf_usm_h%wghf_eb_av) )  THEN
1232                        ALLOCATE( surf_usm_h%wghf_eb_av(1:surf_usm_h%ns) )
1233                        surf_usm_h%wghf_eb_av = 0.0_wp
1234                    ENDIF
1235                    DO  l = 0, 3
1236                       IF ( .NOT.  ALLOCATED(surf_usm_v(l)%wghf_eb_av) )  THEN
1237                           ALLOCATE( surf_usm_v(l)%wghf_eb_av(1:surf_usm_v(l)%ns) )
1238                           surf_usm_v(l)%wghf_eb_av = 0.0_wp
1239                       ENDIF
1240                    ENDDO
1241
1242                CASE ( 'usm_t_surf' )
1243!--                 surface temperature for surfaces
1244                    IF ( .NOT.  ALLOCATED(surf_usm_h%t_surf_av) )  THEN
1245                        ALLOCATE( surf_usm_h%t_surf_av(1:surf_usm_h%ns) )
1246                        surf_usm_h%t_surf_av = 0.0_wp
1247                    ENDIF
1248                    DO  l = 0, 3
1249                       IF ( .NOT.  ALLOCATED(surf_usm_v(l)%t_surf_av) )  THEN
1250                           ALLOCATE( surf_usm_v(l)%t_surf_av(1:surf_usm_v(l)%ns) )
1251                           surf_usm_v(l)%t_surf_av = 0.0_wp
1252                       ENDIF
1253                    ENDDO
1254
1255                CASE ( 'usm_t_wall' )
1256!--                 wall temperature for iwl layer of walls and land
1257                    IF ( .NOT.  ALLOCATED(surf_usm_h%t_wall_av) )  THEN
1258                        ALLOCATE( surf_usm_h%t_wall_av(nzb_wall:nzt_wall,1:surf_usm_h%ns) )
1259                        surf_usm_h%t_wall_av = 0.0_wp
1260                    ENDIF
1261                    DO  l = 0, 3
1262                       IF ( .NOT.  ALLOCATED(surf_usm_v(l)%t_wall_av) )  THEN
1263                           ALLOCATE( surf_usm_v(l)%t_wall_av(nzb_wall:nzt_wall,1:surf_usm_v(l)%ns) )
1264                           surf_usm_v(l)%t_wall_av = 0.0_wp
1265                       ENDIF
1266                    ENDDO
1267
1268               CASE DEFAULT
1269                   CONTINUE
1270
1271           END SELECT
1272
1273        ELSEIF ( mode == 'sum' )  THEN
1274           
1275           SELECT CASE ( TRIM( var ) )
1276               
1277                CASE ( 'usm_rad_net' )
1278!--                 array of complete radiation balance
1279                    DO  m = 1, surf_usm_h%ns
1280                       surf_usm_h%rad_net_av(m) =                              &
1281                                          surf_usm_h%rad_net_av(m) +           &
1282                                          surf_usm_h%rad_net_l(m)
1283                    ENDDO
1284                    DO  l = 0, 3
1285                       DO  m = 1, surf_usm_v(l)%ns
1286                          surf_usm_v(l)%rad_net_av(m) =                        &
1287                                          surf_usm_v(l)%rad_net_av(m) +        &
1288                                          surf_usm_v(l)%rad_net_l(m)
1289                       ENDDO
1290                    ENDDO
1291                   
1292                CASE ( 'usm_rad_insw' )
1293!--                 array of sw radiation falling to surface after i-th reflection
1294                    DO l = startenergy, endenergy
1295                        IF ( surfl(id,l) == ids )  THEN
1296                            surfinsw_av(l) = surfinsw_av(l) + surfinsw(l)
1297                        ENDIF
1298                    ENDDO
1299                             
1300                CASE ( 'usm_rad_inlw' )
1301!--                 array of lw radiation falling to surface after i-th reflection
1302                    DO l = startenergy, endenergy
1303                        IF ( surfl(id,l) == ids )  THEN
1304                            surfinlw_av(l) = surfinlw_av(l) + surfinlw(l)
1305                        ENDIF
1306                    ENDDO
1307                   
1308                CASE ( 'usm_rad_inswdir' )
1309!--                 array of direct sw radiation falling to surface from sun
1310                    DO l = startenergy, endenergy
1311                        IF ( surfl(id,l) == ids )  THEN
1312                            surfinswdir_av(l) = surfinswdir_av(l) + surfinswdir(l)
1313                        ENDIF
1314                    ENDDO
1315                   
1316                CASE ( 'usm_rad_inswdif' )
1317!--                 array of difusion sw radiation falling to surface from sky and borders of the domain
1318                    DO l = startenergy, endenergy
1319                        IF ( surfl(id,l) == ids )  THEN
1320                            surfinswdif_av(l) = surfinswdif_av(l) + surfinswdif(l)
1321                        ENDIF
1322                    ENDDO
1323                   
1324                CASE ( 'usm_rad_inswref' )
1325!--                 array of sw radiation falling to surface from reflections
1326                    DO l = startenergy, endenergy
1327                        IF ( surfl(id,l) == ids )  THEN
1328                            surfinswref_av(l) = surfinswref_av(l) + surfinsw(l) - &
1329                                                surfinswdir(l) - surfinswdif(l)
1330                        ENDIF
1331                    ENDDO
1332
1333                   
1334                CASE ( 'usm_rad_inlwdif' )
1335!--                 array of sw radiation falling to surface after i-th reflection
1336                    DO l = startenergy, endenergy
1337                        IF ( surfl(id,l) == ids )  THEN
1338                            surfinswref_av(l) = surfinswref_av(l) + surfinsw(l) - &
1339                                                surfinswdir(l) - surfinswdif(l)
1340                        ENDIF
1341                    ENDDO
1342!                     
1343                CASE ( 'usm_rad_inlwref' )
1344!--                 array of lw radiation falling to surface from reflections
1345                    DO l = startenergy, endenergy
1346                        IF ( surfl(id,l) == ids )  THEN
1347                            surfinlwdif_av(l) = surfinlwdif_av(l) + surfinlwdif(l)
1348                        ENDIF
1349                    ENDDO
1350                   
1351                CASE ( 'usm_rad_outsw' )
1352!--                 array of sw radiation emitted from surface after i-th reflection
1353                    DO l = startenergy, endenergy
1354                        IF ( surfl(id,l) == ids )  THEN
1355                            surfinlwref_av(l) = surfinlwref_av(l) + &
1356                                                surfinlw(l) - surfinlwdif(l)
1357                        ENDIF
1358                    ENDDO
1359                   
1360                CASE ( 'usm_rad_outlw' )
1361!--                 array of lw radiation emitted from surface after i-th reflection
1362                    DO l = startenergy, endenergy
1363                        IF ( surfl(id,l) == ids )  THEN
1364                            surfoutsw_av(l) = surfoutsw_av(l) + surfoutsw(l)
1365                        ENDIF
1366                    ENDDO
1367                   
1368                CASE ( 'usm_rad_ressw' )
1369!--                 array of residua of sw radiation absorbed in surface after last reflection
1370                    DO l = startenergy, endenergy
1371                        IF ( surfl(id,l) == ids )  THEN
1372                            surfoutlw_av(l) = surfoutlw_av(l) + surfoutlw(l)
1373                        ENDIF
1374                    ENDDO
1375                                   
1376                CASE ( 'usm_rad_reslw' )
1377!--                 array of residua of lw radiation absorbed in surface after last reflection
1378                    DO l = startenergy, endenergy
1379                        IF ( surfl(id,l) == ids )  THEN
1380                            surfins_av(l) = surfins_av(l) + surfins(l)
1381                        ENDIF
1382                    ENDDO
1383                   
1384                CASE ( 'usm_rad_hf' )
1385!--                 array of heat flux from radiation for surfaces after i-th reflection
1386                    DO  m = 1, surf_usm_h%ns
1387                       surf_usm_h%surfhf_av(m) =                               &
1388                                          surf_usm_h%surfhf_av(m) +            &
1389                                          surf_usm_h%surfhf(m)
1390                    ENDDO
1391                    DO  l = 0, 3
1392                       DO  m = 1, surf_usm_v(l)%ns
1393                          surf_usm_v(l)%surfhf_av(m) =                         &
1394                                          surf_usm_v(l)%surfhf_av(m) +         &
1395                                          surf_usm_v(l)%surfhf(m)
1396                       ENDDO
1397                    ENDDO
1398                   
1399                CASE ( 'usm_wshf' )
1400!--                 array of sensible heat flux from surfaces (land, roof, wall)
1401                    DO  m = 1, surf_usm_h%ns
1402                       surf_usm_h%wshf_eb_av(m) =                              &
1403                                          surf_usm_h%wshf_eb_av(m) +           &
1404                                          surf_usm_h%wshf_eb(m)
1405                    ENDDO
1406                    DO  l = 0, 3
1407                       DO  m = 1, surf_usm_v(l)%ns
1408                          surf_usm_v(l)%wshf_eb_av(m) =                        &
1409                                          surf_usm_v(l)%wshf_eb_av(m) +        &
1410                                          surf_usm_v(l)%wshf_eb(m)
1411                       ENDDO
1412                    ENDDO
1413                   
1414                CASE ( 'usm_wghf' )
1415!--                 array of heat flux from ground (wall, roof, land)
1416                    DO  m = 1, surf_usm_h%ns
1417                       surf_usm_h%wghf_eb_av(m) =                              &
1418                                          surf_usm_h%wghf_eb_av(m) +           &
1419                                          surf_usm_h%wghf_eb(m)
1420                    ENDDO
1421                    DO  l = 0, 3
1422                       DO  m = 1, surf_usm_v(l)%ns
1423                          surf_usm_v(l)%wghf_eb_av(m) =                        &
1424                                          surf_usm_v(l)%wghf_eb_av(m) +        &
1425                                          surf_usm_v(l)%wghf_eb(m)
1426                       ENDDO
1427                    ENDDO
1428                   
1429                CASE ( 'usm_t_surf' )
1430!--                 surface temperature for surfaces
1431                    DO  m = 1, surf_usm_h%ns
1432                       surf_usm_h%t_surf_av(m) =                               & 
1433                                          surf_usm_h%t_surf_av(m) +            &
1434                                          t_surf_h(m)
1435                    ENDDO
1436                    DO  l = 0, 3
1437                       DO  m = 1, surf_usm_v(l)%ns
1438                          surf_usm_v(l)%t_surf_av(m) =                         &
1439                                          surf_usm_v(l)%t_surf_av(m) +         &
1440                                          t_surf_v(l)%t(m)
1441                       ENDDO
1442                    ENDDO
1443                   
1444                CASE ( 'usm_t_wall' )
1445!--                 wall temperature for  iwl layer of walls and land
1446                    DO  m = 1, surf_usm_h%ns
1447                       surf_usm_h%t_wall_av(iwl,m) =                           &
1448                                          surf_usm_h%t_wall_av(iwl,m) +        &
1449                                          t_wall_h(iwl,m)
1450                    ENDDO
1451                    DO  l = 0, 3
1452                       DO  m = 1, surf_usm_v(l)%ns
1453                          surf_usm_v(l)%t_wall_av(iwl,m) =                     &
1454                                          surf_usm_v(l)%t_wall_av(iwl,m) +     &
1455                                          t_wall_v(l)%t(iwl,m)
1456                       ENDDO
1457                    ENDDO
1458                   
1459                CASE DEFAULT
1460                    CONTINUE
1461
1462           END SELECT
1463
1464        ELSEIF ( mode == 'average' )  THEN
1465           
1466           SELECT CASE ( TRIM( var ) )
1467               
1468                CASE ( 'usm_rad_net' )
1469!--                 array of complete radiation balance
1470                    DO  m = 1, surf_usm_h%ns
1471                       surf_usm_h%rad_net_av(m) =                              &
1472                                          surf_usm_h%rad_net_av(m) /           &
1473                                          REAL( average_count_3d, kind=wp )
1474                    ENDDO
1475                    DO  l = 0, 3
1476                       DO  m = 1, surf_usm_v(l)%ns
1477                          surf_usm_v(l)%rad_net_av(m) =                        &
1478                                          surf_usm_v(l)%rad_net_av(m) /        &
1479                                          REAL( average_count_3d, kind=wp )
1480                       ENDDO
1481                    ENDDO
1482                   
1483                CASE ( 'usm_rad_insw' )
1484!--                 array of sw radiation falling to surface after i-th reflection
1485                    DO l = startenergy, endenergy
1486                        IF ( surfl(id,l) == ids )  THEN
1487                            surfinsw_av(l) = surfinsw_av(l) / REAL( average_count_3d, kind=wp )
1488                        ENDIF
1489                    ENDDO
1490                             
1491                CASE ( 'usm_rad_inlw' )
1492!--                 array of lw radiation falling to surface after i-th reflection
1493                    DO l = startenergy, endenergy
1494                        IF ( surfl(id,l) == ids )  THEN
1495                            surfinlw_av(l) = surfinlw_av(l) / REAL( average_count_3d, kind=wp )
1496                        ENDIF
1497                    ENDDO
1498                   
1499                CASE ( 'usm_rad_inswdir' )
1500!--                 array of direct sw radiation falling to surface from sun
1501                    DO l = startenergy, endenergy
1502                        IF ( surfl(id,l) == ids )  THEN
1503                            surfinswdir_av(l) = surfinswdir_av(l) / REAL( average_count_3d, kind=wp )
1504                        ENDIF
1505                    ENDDO
1506                   
1507                CASE ( 'usm_rad_inswdif' )
1508!--                 array of difusion sw radiation falling to surface from sky and borders of the domain
1509                    DO l = startenergy, endenergy
1510                        IF ( surfl(id,l) == ids )  THEN
1511                            surfinswdif_av(l) = surfinswdif_av(l) / REAL( average_count_3d, kind=wp )
1512                        ENDIF
1513                    ENDDO
1514                   
1515                CASE ( 'usm_rad_inswref' )
1516!--                 array of sw radiation falling to surface from reflections
1517                    DO l = startenergy, endenergy
1518                        IF ( surfl(id,l) == ids )  THEN
1519                            surfinswref_av(l) = surfinswref_av(l) / REAL( average_count_3d, kind=wp )
1520                        ENDIF
1521                    ENDDO
1522                   
1523                CASE ( 'usm_rad_inlwdif' )
1524!--                 array of sw radiation falling to surface after i-th reflection
1525                    DO l = startenergy, endenergy
1526                        IF ( surfl(id,l) == ids )  THEN
1527                            surfinlwdif_av(l) = surfinlwdif_av(l) / REAL( average_count_3d, kind=wp )
1528                        ENDIF
1529                    ENDDO
1530                   
1531                CASE ( 'usm_rad_inlwref' )
1532!--                 array of lw radiation falling to surface from reflections
1533                    DO l = startenergy, endenergy
1534                        IF ( surfl(id,l) == ids )  THEN
1535                            surfinlwref_av(l) = surfinlwref_av(l) / REAL( average_count_3d, kind=wp )
1536                        ENDIF
1537                    ENDDO
1538                   
1539                CASE ( 'usm_rad_outsw' )
1540!--                 array of sw radiation emitted from surface after i-th reflection
1541                    DO l = startenergy, endenergy
1542                        IF ( surfl(id,l) == ids )  THEN
1543                            surfoutsw_av(l) = surfoutsw_av(l) / REAL( average_count_3d, kind=wp )
1544                        ENDIF
1545                    ENDDO
1546                   
1547                CASE ( 'usm_rad_outlw' )
1548!--                 array of lw radiation emitted from surface after i-th reflection
1549                    DO l = startenergy, endenergy
1550                        IF ( surfl(id,l) == ids )  THEN
1551                            surfoutlw_av(l) = surfoutlw_av(l) / REAL( average_count_3d, kind=wp )
1552                        ENDIF
1553                    ENDDO
1554                   
1555                CASE ( 'usm_rad_ressw' )
1556!--                 array of residua of sw radiation absorbed in surface after last reflection
1557                    DO l = startenergy, endenergy
1558                        IF ( surfl(id,l) == ids )  THEN
1559                            surfins_av(l) = surfins_av(l) / REAL( average_count_3d, kind=wp )
1560                        ENDIF
1561                    ENDDO
1562                                   
1563                CASE ( 'usm_rad_reslw' )
1564!--                 array of residua of lw radiation absorbed in surface after last reflection
1565                    DO l = startenergy, endenergy
1566                        IF ( surfl(id,l) == ids )  THEN
1567                            surfinl_av(l) = surfinl_av(l) / REAL( average_count_3d, kind=wp )
1568                        ENDIF
1569                    ENDDO
1570                   
1571                CASE ( 'usm_rad_hf' )
1572!--                 array of heat flux from radiation for surfaces after i-th reflection
1573                    DO  m = 1, surf_usm_h%ns
1574                       surf_usm_h%surfhf_av(m) =                               &
1575                                          surf_usm_h%surfhf_av(m) /            &
1576                                          REAL( average_count_3d, kind=wp )
1577                    ENDDO
1578                    DO  l = 0, 3
1579                       DO  m = 1, surf_usm_v(l)%ns
1580                          surf_usm_v(l)%surfhf_av(m) =                         &
1581                                          surf_usm_v(l)%surfhf_av(m) /         &
1582                                          REAL( average_count_3d, kind=wp )
1583                       ENDDO
1584                    ENDDO
1585                   
1586                CASE ( 'usm_wshf' )
1587!--                 array of sensible heat flux from surfaces (land, roof, wall)
1588                    DO  m = 1, surf_usm_h%ns
1589                       surf_usm_h%wshf_eb_av(m) =                              &
1590                                          surf_usm_h%wshf_eb_av(m) /           &
1591                                          REAL( average_count_3d, kind=wp )
1592                    ENDDO
1593                    DO  l = 0, 3
1594                       DO  m = 1, surf_usm_v(l)%ns
1595                          surf_usm_v(l)%wshf_eb_av(m) =                        &
1596                                          surf_usm_v(l)%wshf_eb_av(m) /        &
1597                                          REAL( average_count_3d, kind=wp )
1598                       ENDDO
1599                    ENDDO
1600                   
1601                CASE ( 'usm_wghf' )
1602!--                 array of heat flux from ground (wall, roof, land)
1603                    DO  m = 1, surf_usm_h%ns
1604                       surf_usm_h%wghf_eb_av(m) =                              &
1605                                          surf_usm_h%wghf_eb_av(m) /           &
1606                                          REAL( average_count_3d, kind=wp )
1607                    ENDDO
1608                    DO  l = 0, 3
1609                       DO  m = 1, surf_usm_v(l)%ns
1610                          surf_usm_v(l)%wghf_eb_av(m) =                        &
1611                                          surf_usm_v(l)%wghf_eb_av(m) /        &
1612                                          REAL( average_count_3d, kind=wp )
1613                       ENDDO
1614                    ENDDO
1615                   
1616                CASE ( 'usm_t_surf' )
1617!--                 surface temperature for surfaces
1618                    DO  m = 1, surf_usm_h%ns
1619                       surf_usm_h%t_surf_av(m) =                               & 
1620                                          surf_usm_h%t_surf_av(m) /            &
1621                                          REAL( average_count_3d, kind=wp )
1622                    ENDDO
1623                    DO  l = 0, 3
1624                       DO  m = 1, surf_usm_v(l)%ns
1625                          surf_usm_v(l)%t_surf_av(m) =                         &
1626                                          surf_usm_v(l)%t_surf_av(m) /         &
1627                                          REAL( average_count_3d, kind=wp )
1628                       ENDDO
1629                    ENDDO
1630                   
1631                CASE ( 'usm_t_wall' )
1632!--                 wall temperature for  iwl layer of walls and land
1633                    DO  m = 1, surf_usm_h%ns
1634                       surf_usm_h%t_wall_av(iwl,m) =                           &
1635                                          surf_usm_h%t_wall_av(iwl,m) /        &
1636                                          REAL( average_count_3d, kind=wp )
1637                    ENDDO
1638                    DO  l = 0, 3
1639                       DO  m = 1, surf_usm_v(l)%ns
1640                          surf_usm_v(l)%t_wall_av(iwl,m) =                     &
1641                                          surf_usm_v(l)%t_wall_av(iwl,m) /     &
1642                                          REAL( average_count_3d, kind=wp )
1643                       ENDDO
1644                    ENDDO
1645
1646           END SELECT
1647
1648        ENDIF
1649
1650    END SUBROUTINE usm_average_3d_data
1651
1652
1653!------------------------------------------------------------------------------!
1654!> Calculates radiation absorbed by box with given size and LAD.
1655!>
1656!> Simulates resol**2 rays (by equally spacing a bounding horizontal square
1657!> conatining all possible rays that would cross the box) and calculates
1658!> average transparency per ray. Returns fraction of absorbed radiation flux
1659!> and area for which this fraction is effective.
1660!------------------------------------------------------------------------------!
1661    PURE SUBROUTINE usm_box_absorb(boxsize, resol, dens, uvec, area, absorb)
1662        IMPLICIT NONE
1663
1664        REAL(wp), DIMENSION(3), INTENT(in) :: &
1665            boxsize, &      !< z, y, x size of box in m
1666            uvec            !< z, y, x unit vector of incoming flux
1667        INTEGER(iwp), INTENT(in) :: &
1668            resol           !< No. of rays in x and y dimensions
1669        REAL(wp), INTENT(in) :: &
1670            dens            !< box density (e.g. Leaf Area Density)
1671        REAL(wp), INTENT(out) :: &
1672            area, &         !< horizontal area for flux absorbtion
1673            absorb          !< fraction of absorbed flux
1674        REAL(wp) :: &
1675            xshift, yshift, &
1676            xmin, xmax, ymin, ymax, &
1677            xorig, yorig, &
1678            dx1, dy1, dz1, dx2, dy2, dz2, &
1679            crdist, &
1680            transp
1681        INTEGER(iwp) :: &
1682            i, j
1683
1684        xshift = uvec(3) / uvec(1) * boxsize(1)
1685        xmin = min(0._wp, -xshift)
1686        xmax = boxsize(3) + max(0._wp, -xshift)
1687        yshift = uvec(2) / uvec(1) * boxsize(1)
1688        ymin = min(0._wp, -yshift)
1689        ymax = boxsize(2) + max(0._wp, -yshift)
1690
1691        transp = 0._wp
1692        DO i = 1, resol
1693            xorig = xmin + (xmax-xmin) * (i-.5_wp) / resol
1694            DO j = 1, resol
1695                yorig = ymin + (ymax-ymin) * (j-.5_wp) / resol
1696
1697                dz1 = 0._wp
1698                dz2 = boxsize(1)/uvec(1)
1699
1700                IF ( uvec(2) > 0._wp )  THEN
1701                    dy1 = -yorig             / uvec(2) !< crossing with y=0
1702                    dy2 = (boxsize(2)-yorig) / uvec(2) !< crossing with y=boxsize(2)
1703                ELSE IF ( uvec(2) < 0._wp )  THEN
1704                    dy1 = (boxsize(2)-yorig) / uvec(2) !< crossing with y=boxsize(2)
1705                    dy2 = -yorig             / uvec(2) !< crossing with y=0
1706                ELSE !uvec(2)==0
1707                    dy1 = -huge(1._wp)
1708                    dy2 = huge(1._wp)
1709                ENDIF
1710
1711                IF ( uvec(3) > 0._wp )  THEN
1712                    dx1 = -xorig             / uvec(3) !< crossing with x=0
1713                    dx2 = (boxsize(3)-xorig) / uvec(3) !< crossing with x=boxsize(3)
1714                ELSE IF ( uvec(3) < 0._wp )  THEN
1715                    dx1 = (boxsize(3)-xorig) / uvec(3) !< crossing with x=boxsize(3)
1716                    dx2 = -xorig             / uvec(3) !< crossing with x=0
1717                ELSE !uvec(1)==0
1718                    dx1 = -huge(1._wp)
1719                    dx2 = huge(1._wp)
1720                ENDIF
1721
1722                crdist = max(0._wp, (min(dz2, dy2, dx2) - max(dz1, dy1, dx1)))
1723                transp = transp + exp(-ext_coef * dens * crdist)
1724            ENDDO
1725        ENDDO
1726        transp = transp / resol**2
1727        area = (boxsize(3)+xshift)*(boxsize(2)+yshift)
1728        absorb = 1._wp - transp
1729       
1730    END SUBROUTINE usm_box_absorb
1731   
1732   
1733!------------------------------------------------------------------------------!
1734! Description:
1735! ------------
1736!> This subroutine splits direct and diffusion dw radiation
1737!> It sould not be called in case the radiation model already does it
1738!> It follows <CITATION>
1739!------------------------------------------------------------------------------!
1740    SUBROUTINE usm_calc_diffusion_radiation
1741   
1742        REAL(wp), PARAMETER                          ::  sol_const = 1367.0_wp   !< solar conbstant
1743        REAL(wp), PARAMETER                          :: lowest_solarUp = 0.1_wp  !< limit the sun elevation to protect stability of the calculation
1744        INTEGER(iwp)                                 :: i, j
1745        REAL(wp), PARAMETER                          ::  year_seconds = 86400._wp * 365._wp
1746        REAL(wp)                                     ::  year_angle              !< angle
1747        REAL(wp)                                     ::  etr                     !< extraterestrial radiation
1748        REAL(wp)                                     ::  corrected_solarUp       !< corrected solar up radiation
1749        REAL(wp)                                     ::  horizontalETR           !< horizontal extraterestrial radiation
1750        REAL(wp)                                     ::  clearnessIndex          !< clearness index
1751        REAL(wp)                                     ::  diff_frac               !< diffusion fraction of the radiation
1752
1753       
1754!--     Calculate current day and time based on the initial values and simulation time
1755        year_angle = ((day_init*86400) + time_utc_init+time_since_reference_point) &
1756                       / year_seconds * 2.0_wp * pi
1757       
1758        etr = sol_const * (1.00011_wp +                                            &
1759                          0.034221_wp * cos(year_angle) +                          &
1760                          0.001280_wp * sin(year_angle) +                          &
1761                          0.000719_wp * cos(2.0_wp * year_angle) +                 &
1762                          0.000077_wp * sin(2.0_wp * year_angle))
1763       
1764!--   
1765!--     Under a very low angle, we keep extraterestrial radiation at
1766!--     the last small value, therefore the clearness index will be pushed
1767!--     towards 0 while keeping full continuity.
1768!--   
1769        IF ( zenith(0) <= lowest_solarUp )  THEN
1770            corrected_solarUp = lowest_solarUp
1771        ELSE
1772            corrected_solarUp = zenith(0)
1773        ENDIF
1774       
1775        horizontalETR = etr * corrected_solarUp
1776       
1777        DO i = nxlg, nxrg
1778            DO j = nysg, nyng
1779                clearnessIndex = rad_sw_in(0,j,i) / horizontalETR
1780                diff_frac = 1.0_wp / (1.0_wp + exp(-5.0033_wp + 8.6025_wp * clearnessIndex))
1781                rad_sw_in_diff(j,i) = rad_sw_in(0,j,i) * diff_frac
1782                rad_sw_in_dir(j,i)  = rad_sw_in(0,j,i) * (1.0_wp - diff_frac)
1783                rad_lw_in_diff(j,i) = rad_lw_in(0,j,i)
1784            ENDDO
1785        ENDDO
1786       
1787    END SUBROUTINE usm_calc_diffusion_radiation
1788   
1789
1790!------------------------------------------------------------------------------!
1791! Description:
1792! ------------
1793!> Calculates shape view factors SVF and plant sink canopy factors PSCF
1794!> !!!!!DESCRIPTION!!!!!!!!!!
1795!------------------------------------------------------------------------------!
1796    SUBROUTINE usm_calc_svf
1797   
1798        IMPLICIT NONE
1799       
1800        INTEGER(iwp)                                :: i, j, k, l, d, ip, jp
1801        INTEGER(iwp)                                :: isvf, ksvf, icsf, kcsf, npcsfl, isvf_surflt, imrtt, imrtf
1802        INTEGER(iwp)                                :: sd, td, ioln, iproc
1803        REAL(wp),     DIMENSION(0:9)                :: facearea
1804        INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE   :: nzterrl, planthl
1805        REAL(wp),     DIMENSION(:,:), ALLOCATABLE   :: csflt, pcsflt
1806        INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE   :: kcsflt,kpcsflt
1807        INTEGER(iwp), DIMENSION(:), ALLOCATABLE     :: icsflt,dcsflt,ipcsflt,dpcsflt
1808        REAL(wp), DIMENSION(3)                      :: uv
1809        LOGICAL                                     :: visible
1810        REAL(wp), DIMENSION(3)                      :: sa, ta          !< real coordinates z,y,x of source and target
1811        REAL(wp)                                    :: transparency, rirrf, sqdist, svfsum
1812        INTEGER(iwp)                                :: isurflt, isurfs, isurflt_prev
1813        INTEGER(iwp)                                :: itx, ity, itz
1814        CHARACTER(len=7)                            :: pid_char = ''
1815        INTEGER(iwp)                                :: win_lad, minfo
1816        REAL(wp), DIMENSION(:,:,:), POINTER         :: lad_s_rma       !< fortran pointer, but lower bounds are 1
1817        TYPE(c_ptr)                                 :: lad_s_rma_p     !< allocated c pointer
1818#if defined( __parallel )
1819        INTEGER(kind=MPI_ADDRESS_KIND)              :: size_lad_rma
1820#endif
1821!   
1822!--     calculation of the SVF
1823        CALL location_message( '    calculation of SVF and CSF', .TRUE. )
1824!
1825!--     precalculate face areas for different face directions using normal vector
1826        DO d = 0, 9
1827            facearea(d) = 1._wp
1828            IF ( idir(d) == 0 ) facearea(d) = facearea(d) * dx
1829            IF ( jdir(d) == 0 ) facearea(d) = facearea(d) * dy
1830            IF ( kdir(d) == 0 ) facearea(d) = facearea(d) * dz
1831        ENDDO
1832
1833!--     initialize variables and temporary arrays for calculation of svf and csf
1834        nsvfl  = 0
1835        ncsfl  = 0
1836        nsvfla = gasize
1837        msvf   = 1
1838        ALLOCATE( asvf1(nsvfla) )
1839        asvf => asvf1
1840        IF ( plant_canopy )  THEN
1841            ncsfla = gasize
1842            mcsf   = 1
1843            ALLOCATE( acsf1(ncsfla) )
1844            acsf => acsf1
1845        ENDIF
1846       
1847!--     initialize temporary terrain and plant canopy height arrays (global 2D array!)
1848        ALLOCATE( nzterr(0:(nx+1)*(ny+1)-1) )
1849#if defined( __parallel )
1850        ALLOCATE( nzterrl(nys:nyn,nxl:nxr) )
1851        nzterrl = MAXLOC(                                                      &
1852                          MERGE( 1, 0,                                         &
1853                                 BTEST( wall_flags_0(:,nys:nyn,nxl:nxr), 12 )  &
1854                               ), DIM = 1                                      &
1855                        ) - 1  ! = nzb_s_inner(nys:nyn,nxl:nxr)
1856        CALL MPI_AllGather( nzterrl, nnx*nny, MPI_INTEGER, &
1857                            nzterr, nnx*nny, MPI_INTEGER, comm2d, ierr )
1858        DEALLOCATE(nzterrl)
1859#else
1860        nzterr = RESHAPE( MAXLOC(                                              &
1861                          MERGE( 1, 0,                                         &
1862                                 BTEST( wall_flags_0(:,nys:nyn,nxl:nxr), 12 )  &
1863                               ), DIM = 1                                      &
1864                                ) - 1,                                         &
1865                          (/(nx+1)*(ny+1)/)                                    &
1866                        )
1867#endif
1868        IF ( plant_canopy )  THEN
1869            ALLOCATE( plantt(0:(nx+1)*(ny+1)-1) )
1870            maxboxesg = nx + ny + nzu + 1
1871!--         temporary arrays storing values for csf calculation during raytracing
1872            ALLOCATE( boxes(3, maxboxesg) )
1873            ALLOCATE( crlens(maxboxesg) )
1874
1875#if defined( __parallel )
1876            ALLOCATE( planthl(nys:nyn,nxl:nxr) )
1877            planthl = pch(nys:nyn,nxl:nxr)
1878       
1879            CALL MPI_AllGather( planthl, nnx*nny, MPI_INTEGER, &
1880                                plantt, nnx*nny, MPI_INTEGER, comm2d, ierr )
1881            DEALLOCATE( planthl )
1882           
1883!--         temporary arrays storing values for csf calculation during raytracing
1884            ALLOCATE( lad_ip(maxboxesg) )
1885            ALLOCATE( lad_disp(maxboxesg) )
1886
1887            IF ( usm_lad_rma )  THEN
1888                ALLOCATE( lad_s_ray(maxboxesg) )
1889               
1890                ! set conditions for RMA communication
1891                CALL MPI_Info_create(minfo, ierr)
1892                CALL MPI_Info_set(minfo, 'accumulate_ordering', '', ierr)
1893                CALL MPI_Info_set(minfo, 'accumulate_ops', 'same_op', ierr)
1894                CALL MPI_Info_set(minfo, 'same_size', 'true', ierr)
1895                CALL MPI_Info_set(minfo, 'same_disp_unit', 'true', ierr)
1896
1897!--             Allocate and initialize the MPI RMA window
1898!--             must be in accordance with allocation of lad_s in plant_canopy_model
1899!--             optimization of memory should be done
1900!--             Argument X of function c_sizeof(X) needs arbitrary REAL(wp) value, set to 1.0_wp for now
1901                size_lad_rma = c_sizeof(1.0_wp)*nnx*nny*nzu
1902                CALL MPI_Win_allocate(size_lad_rma, c_sizeof(1.0_wp), minfo, comm2d, &
1903                                        lad_s_rma_p, win_lad, ierr)
1904                CALL c_f_pointer(lad_s_rma_p, lad_s_rma, (/ nzu, nny, nnx /))
1905                usm_lad(nzub:, nys:, nxl:) => lad_s_rma(:,:,:)
1906            ELSE
1907                ALLOCATE(usm_lad(nzub:nzut, nys:nyn, nxl:nxr))
1908            ENDIF
1909#else
1910            plantt = RESHAPE( pct(nys:nyn,nxl:nxr), (/(nx+1)*(ny+1)/) )
1911            ALLOCATE(usm_lad(nzub:nzut, nys:nyn, nxl:nxr))
1912#endif
1913            usm_lad(:,:,:) = 0._wp
1914            DO i = nxl, nxr
1915                DO j = nys, nyn
1916                    k = get_topography_top_index( j, i, 's' )
1917
1918                    usm_lad(k:nzut, j, i) = lad_s(0:nzut-k, j, i)
1919                ENDDO
1920            ENDDO
1921
1922#if defined( __parallel )
1923            IF ( usm_lad_rma )  THEN
1924                CALL MPI_Info_free(minfo, ierr)
1925                CALL MPI_Win_lock_all(0, win_lad, ierr)
1926            ELSE
1927                ALLOCATE( usm_lad_g(0:(nx+1)*(ny+1)*nzu-1) )
1928                CALL MPI_AllGather( usm_lad, nnx*nny*nzu, MPI_REAL, &
1929                                    usm_lad_g, nnx*nny*nzu, MPI_REAL, comm2d, ierr )
1930            ENDIF
1931#endif
1932        ENDIF
1933
1934        IF ( mrt_factors )  THEN
1935            OPEN(153, file='MRT_TARGETS', access='SEQUENTIAL', &
1936                    action='READ', status='OLD', form='FORMATTED', err=524)
1937            OPEN(154, file='MRT_FACTORS'//myid_char, access='DIRECT', recl=(5*4+2*8), &
1938                    action='WRITE', status='REPLACE', form='UNFORMATTED', err=525)
1939            imrtf = 1
1940            DO
1941                READ(153, *, end=526, err=524) imrtt, i, j, k
1942                IF ( i < nxl  .OR.  i > nxr &
1943                     .OR.  j < nys  .OR.  j > nyn ) CYCLE
1944                ta = (/ REAL(k), REAL(j), REAL(i) /)
1945
1946                DO isurfs = 1, nsurf
1947                    IF ( .NOT.  usm_facing(i, j, k, -1, &
1948                        surf(ix, isurfs), surf(iy, isurfs), &
1949                        surf(iz, isurfs), surf(id, isurfs)) )  THEN
1950                        CYCLE
1951                    ENDIF
1952                     
1953                    sd = surf(id, isurfs)
1954                    sa = (/ REAL(surf(iz, isurfs), wp) - 0.5_wp * kdir(sd), &
1955                            REAL(surf(iy, isurfs), wp) - 0.5_wp * jdir(sd), &
1956                            REAL(surf(ix, isurfs), wp) - 0.5_wp * idir(sd) /)
1957
1958!--                 unit vector source -> target
1959                    uv = (/ (ta(1)-sa(1))*dz, (ta(2)-sa(2))*dy, (ta(3)-sa(3))*dx /)
1960                    sqdist = SUM(uv(:)**2)
1961                    uv = uv / SQRT(sqdist)
1962
1963!--                 irradiance factor - see svf. Here we consider that target face is always normal,
1964!--                 i.e. the second dot product equals 1
1965                    rirrf = dot_product((/ kdir(sd), jdir(sd), idir(sd) /), uv) &
1966                        / (pi * sqdist) * facearea(sd)
1967
1968!--                 raytrace while not creating any canopy sink factors
1969                    CALL usm_raytrace(sa, ta, isurfs, rirrf, 1._wp, .FALSE., &
1970                            visible, transparency, win_lad)
1971                    IF ( .NOT.  visible ) CYCLE
1972
1973                    !rsvf = rirrf * transparency
1974                    WRITE(154, rec=imrtf, err=525) INT(imrtt, kind=4), &
1975                        INT(surf(id, isurfs), kind=4), &
1976                        INT(surf(iz, isurfs), kind=4), &
1977                        INT(surf(iy, isurfs), kind=4), &
1978                        INT(surf(ix, isurfs), kind=4), &
1979                        REAL(rirrf, kind=8), REAL(transparency, kind=8)
1980                    imrtf = imrtf + 1
1981
1982                ENDDO !< isurfs
1983            ENDDO !< MRT_TARGETS record
1984
1985524         message_string = 'error reading file MRT_TARGETS'
1986            CALL message( 'usm_calc_svf', 'PA0524', 1, 2, 0, 6, 0 )
1987
1988525         message_string = 'error writing file MRT_FACTORS'//myid_char
1989            CALL message( 'usm_calc_svf', 'PA0525', 1, 2, 0, 6, 0 )
1990
1991526         CLOSE(153)
1992            CLOSE(154)
1993        ENDIF  !< mrt_factors
1994
1995       
1996        DO isurflt = 1, nsurfl
1997!--         determine face centers
1998            td = surfl(id, isurflt)
1999            IF ( td >= isky  .AND.  .NOT.  plant_canopy ) CYCLE
2000            ta = (/ REAL(surfl(iz, isurflt), wp) - 0.5_wp * kdir(td),  &
2001                      REAL(surfl(iy, isurflt), wp) - 0.5_wp * jdir(td),  &
2002                      REAL(surfl(ix, isurflt), wp) - 0.5_wp * idir(td)  /)
2003            DO isurfs = 1, nsurf
2004                IF ( .NOT.  usm_facing(surfl(ix, isurflt), surfl(iy, isurflt), &
2005                    surfl(iz, isurflt), surfl(id, isurflt), &
2006                    surf(ix, isurfs), surf(iy, isurfs), &
2007                    surf(iz, isurfs), surf(id, isurfs)) )  THEN
2008                    CYCLE
2009                ENDIF
2010                 
2011                sd = surf(id, isurfs)
2012                sa = (/ REAL(surf(iz, isurfs), wp) - 0.5_wp * kdir(sd),  &
2013                        REAL(surf(iy, isurfs), wp) - 0.5_wp * jdir(sd),  &
2014                        REAL(surf(ix, isurfs), wp) - 0.5_wp * idir(sd)  /)
2015
2016!--             unit vector source -> target
2017                uv = (/ (ta(1)-sa(1))*dz, (ta(2)-sa(2))*dy, (ta(3)-sa(3))*dx /)
2018                sqdist = SUM(uv(:)**2)
2019                uv = uv / SQRT(sqdist)
2020               
2021!--             irradiance factor (our unshaded shape view factor) = view factor per differential target area * source area
2022                rirrf = dot_product((/ kdir(sd), jdir(sd), idir(sd) /), uv) & ! cosine of source normal and direction
2023                    * dot_product((/ kdir(td), jdir(td), idir(td) /), -uv) &  ! cosine of target normal and reverse direction
2024                    / (pi * sqdist) & ! square of distance between centers
2025                    * facearea(sd)
2026
2027!--             raytrace + process plant canopy sinks within
2028                CALL usm_raytrace(sa, ta, isurfs, rirrf, facearea(td), .TRUE., &
2029                        visible, transparency, win_lad)
2030               
2031                IF ( .NOT.  visible ) CYCLE
2032                IF ( td >= isky ) CYCLE !< we calculated these only for raytracing
2033                                        !< to find plant canopy sinks, we don't need svf for them
2034                ! rsvf = rirrf * transparency
2035
2036!--             write to the svf array
2037                nsvfl = nsvfl + 1
2038!--             check dimmension of asvf array and enlarge it if needed
2039                IF ( nsvfla < nsvfl )  THEN
2040                    k = nsvfla * 2
2041                    IF ( msvf == 0 )  THEN
2042                        msvf = 1
2043                        ALLOCATE( asvf1(k) )
2044                        asvf => asvf1
2045                        asvf1(1:nsvfla) = asvf2
2046                        DEALLOCATE( asvf2 )
2047                    ELSE
2048                        msvf = 0
2049                        ALLOCATE( asvf2(k) )
2050                        asvf => asvf2
2051                        asvf2(1:nsvfla) = asvf1
2052                        DEALLOCATE( asvf1 )
2053                    ENDIF
2054                    nsvfla = k
2055                ENDIF
2056!--             write svf values into the array
2057                asvf(nsvfl)%isurflt = isurflt
2058                asvf(nsvfl)%isurfs = isurfs
2059                asvf(nsvfl)%rsvf = rirrf !we postopne multiplication by transparency
2060                asvf(nsvfl)%rtransp = transparency !a.k.a. Direct Irradiance Factor
2061            ENDDO
2062        ENDDO
2063
2064        CALL location_message( '    waiting for completion of SVF and CSF calculation in all processes', .TRUE. )
2065!--     deallocate temporary global arrays
2066        DEALLOCATE(nzterr)
2067       
2068        IF ( plant_canopy )  THEN
2069!--         finalize mpi_rma communication and deallocate temporary arrays
2070#if defined( __parallel )
2071            IF ( usm_lad_rma )  THEN
2072                CALL MPI_Win_flush_all(win_lad, ierr)
2073!--             unlock MPI window
2074                CALL MPI_Win_unlock_all(win_lad, ierr)
2075!--             free MPI window
2076                CALL MPI_Win_free(win_lad, ierr)
2077               
2078!--             deallocate temporary arrays storing values for csf calculation during raytracing
2079                DEALLOCATE( lad_s_ray )
2080!--             usm_lad is the pointer to lad_s_rma in case of usm_lad_rma
2081!--             and must not be deallocated here
2082            ELSE
2083                DEALLOCATE(usm_lad)
2084                DEALLOCATE(usm_lad_g)
2085            ENDIF
2086#else
2087            DEALLOCATE(usm_lad)
2088#endif
2089            DEALLOCATE( boxes )
2090            DEALLOCATE( crlens )
2091            DEALLOCATE( plantt )
2092        ENDIF
2093
2094        CALL location_message( '    calculation of the complete SVF array', .TRUE. )
2095
2096!--     sort svf ( a version of quicksort )
2097        CALL quicksort_svf(asvf,1,nsvfl)
2098
2099        ALLOCATE( svf(ndsvf,nsvfl) )
2100        ALLOCATE( svfsurf(idsvf,nsvfl) )
2101
2102        !< load svf from the structure array to plain arrays
2103        isurflt_prev = -1
2104        ksvf = 1
2105        svfsum = 0._wp
2106        DO isvf = 1, nsvfl
2107!--         normalize svf per target face
2108            IF ( asvf(ksvf)%isurflt /= isurflt_prev )  THEN
2109                IF ( isurflt_prev /= -1  .AND.  svfsum /= 0._wp )  THEN
2110!--                 TODO detect and log when normalization differs too much from 1
2111                    svf(1, isvf_surflt:isvf-1) = svf(1, isvf_surflt:isvf-1) / svfsum
2112                ENDIF
2113                isurflt_prev = asvf(ksvf)%isurflt
2114                isvf_surflt = isvf
2115                svfsum = asvf(ksvf)%rsvf !?? / asvf(ksvf)%rtransp
2116            ELSE
2117                svfsum = svfsum + asvf(ksvf)%rsvf !?? / asvf(ksvf)%rtransp
2118            ENDIF
2119
2120            svf(:, isvf) = (/ asvf(ksvf)%rsvf, asvf(ksvf)%rtransp /)
2121            svfsurf(:, isvf) = (/ asvf(ksvf)%isurflt, asvf(ksvf)%isurfs /)
2122
2123!--         next element
2124            ksvf = ksvf + 1
2125        ENDDO
2126
2127        IF ( isurflt_prev /= -1  .AND.  svfsum /= 0._wp )  THEN
2128!--         TODO detect and log when normalization differs too much from 1
2129            svf(1, isvf_surflt:nsvfl) = svf(1, isvf_surflt:nsvfl) / svfsum
2130        ENDIF
2131
2132!--     deallocate temporary asvf array
2133!--     DEALLOCATE(asvf) - ifort has a problem with deallocation of allocatable target
2134!--     via pointing pointer - we need to test original targets
2135        IF ( ALLOCATED(asvf1) )  THEN
2136            DEALLOCATE(asvf1)
2137        ENDIF
2138        IF ( ALLOCATED(asvf2) )  THEN
2139            DEALLOCATE(asvf2)
2140        ENDIF
2141
2142        npcsfl = 0
2143        IF ( plant_canopy )  THEN
2144
2145            CALL location_message( '    calculation of the complete CSF array', .TRUE. )
2146
2147!--         sort and merge csf for the last time, keeping the array size to minimum
2148            CALL usm_merge_and_grow_csf(-1)
2149           
2150!--         aggregate csb among processors
2151!--         allocate necessary arrays
2152            ALLOCATE( csflt(ndcsf,max(ncsfl,ndcsf)) )
2153            ALLOCATE( kcsflt(kdcsf,max(ncsfl,kdcsf)) )
2154            ALLOCATE( icsflt(0:numprocs-1) )
2155            ALLOCATE( dcsflt(0:numprocs-1) )
2156            ALLOCATE( ipcsflt(0:numprocs-1) )
2157            ALLOCATE( dpcsflt(0:numprocs-1) )
2158           
2159!--         fill out arrays of csf values and
2160!--         arrays of number of elements and displacements
2161!--         for particular precessors
2162            icsflt = 0
2163            dcsflt = 0
2164            ip = -1
2165            j = -1
2166            d = 0
2167            DO kcsf = 1, ncsfl
2168                j = j+1
2169                IF ( acsf(kcsf)%ip /= ip )  THEN
2170!--                 new block of the processor
2171!--                 number of elements of previous block
2172                    IF ( ip>=0) icsflt(ip) = j
2173                    d = d+j
2174!--                 blank blocks
2175                    DO jp = ip+1, acsf(kcsf)%ip-1
2176!--                     number of elements is zero, displacement is equal to previous
2177                        icsflt(jp) = 0
2178                        dcsflt(jp) = d
2179                    ENDDO
2180!--                 the actual block
2181                    ip = acsf(kcsf)%ip
2182                    dcsflt(ip) = d
2183                    j = 0
2184                ENDIF
2185!--             fill out real values of rsvf, rtransp
2186                csflt(1,kcsf) = acsf(kcsf)%rsvf
2187                csflt(2,kcsf) = acsf(kcsf)%rtransp
2188!--             fill out integer values of itz,ity,itx,isurfs
2189                kcsflt(1,kcsf) = acsf(kcsf)%itz
2190                kcsflt(2,kcsf) = acsf(kcsf)%ity
2191                kcsflt(3,kcsf) = acsf(kcsf)%itx
2192                kcsflt(4,kcsf) = acsf(kcsf)%isurfs
2193            ENDDO
2194!--         last blank blocks at the end of array
2195            j = j+1
2196            IF ( ip>=0 ) icsflt(ip) = j
2197            d = d+j
2198            DO jp = ip+1, numprocs-1
2199!--             number of elements is zero, displacement is equal to previous
2200                icsflt(jp) = 0
2201                dcsflt(jp) = d
2202            ENDDO
2203           
2204!--         deallocate temporary acsf array
2205!--         DEALLOCATE(acsf) - ifort has a problem with deallocation of allocatable target
2206!--         via pointing pointer - we need to test original targets
2207            IF ( ALLOCATED(acsf1) )  THEN
2208                DEALLOCATE(acsf1)
2209            ENDIF
2210            IF ( ALLOCATED(acsf2) )  THEN
2211                DEALLOCATE(acsf2)
2212            ENDIF
2213                   
2214#if defined( __parallel )
2215!--         scatter and gather the number of elements to and from all processor
2216!--         and calculate displacements
2217            CALL MPI_AlltoAll(icsflt,1,MPI_INTEGER,ipcsflt,1,MPI_INTEGER,comm2d, ierr)
2218           
2219            npcsfl = SUM(ipcsflt)
2220            d = 0
2221            DO i = 0, numprocs-1
2222                dpcsflt(i) = d
2223                d = d + ipcsflt(i)
2224            ENDDO
2225       
2226!--         exchange csf fields between processors
2227            ALLOCATE( pcsflt(ndcsf,max(npcsfl,ndcsf)) )
2228            ALLOCATE( kpcsflt(kdcsf,max(npcsfl,kdcsf)) )
2229            CALL MPI_AlltoAllv(csflt, ndcsf*icsflt, ndcsf*dcsflt, MPI_REAL, &
2230                pcsflt, ndcsf*ipcsflt, ndcsf*dpcsflt, MPI_REAL, comm2d, ierr)
2231            CALL MPI_AlltoAllv(kcsflt, kdcsf*icsflt, kdcsf*dcsflt, MPI_INTEGER, &
2232                kpcsflt, kdcsf*ipcsflt, kdcsf*dpcsflt, MPI_INTEGER, comm2d, ierr)
2233           
2234#else
2235            npcsfl = ncsfl
2236            ALLOCATE( pcsflt(ndcsf,max(npcsfl,ndcsf)) )
2237            ALLOCATE( kpcsflt(kdcsf,max(npcsfl,kdcsf)) )
2238            pcsflt = csflt
2239            kpcsflt = kcsflt
2240#endif
2241
2242!--         deallocate temporary arrays
2243            DEALLOCATE( csflt )
2244            DEALLOCATE( kcsflt )
2245            DEALLOCATE( icsflt )
2246            DEALLOCATE( dcsflt )
2247            DEALLOCATE( ipcsflt )
2248            DEALLOCATE( dpcsflt )
2249
2250!--         sort csf ( a version of quicksort )
2251            CALL quicksort_csf2(kpcsflt, pcsflt, 1, npcsfl)
2252
2253!--         aggregate canopy sink factor records with identical box & source
2254!--         againg across all values from all processors
2255            IF ( npcsfl > 0 )  THEN
2256                icsf = 1 !< reading index
2257                kcsf = 1 !< writing index
2258                DO while (icsf < npcsfl)
2259!--                 here kpcsf(kcsf) already has values from kpcsf(icsf)
2260                    IF ( kpcsflt(3,icsf) == kpcsflt(3,icsf+1)  .AND.  &
2261                         kpcsflt(2,icsf) == kpcsflt(2,icsf+1)  .AND.  &
2262                         kpcsflt(1,icsf) == kpcsflt(1,icsf+1)  .AND.  &
2263                         kpcsflt(4,icsf) == kpcsflt(4,icsf+1) )  THEN
2264!--                     We could simply take either first or second rtransp, both are valid. As a very simple heuristic about which ray
2265!--                     probably passes nearer the center of the target box, we choose DIF from the entry with greater CSF, since that
2266!--                     might mean that the traced beam passes longer through the canopy box.
2267                        IF ( pcsflt(1,kcsf) < pcsflt(1,icsf+1) )  THEN
2268                            pcsflt(2,kcsf) = pcsflt(2,icsf+1)
2269                        ENDIF
2270                        pcsflt(1,kcsf) = pcsflt(1,kcsf) + pcsflt(1,icsf+1)
2271
2272!--                     advance reading index, keep writing index
2273                        icsf = icsf + 1
2274                    ELSE
2275!--                     not identical, just advance and copy
2276                        icsf = icsf + 1
2277                        kcsf = kcsf + 1
2278                        kpcsflt(:,kcsf) = kpcsflt(:,icsf)
2279                        pcsflt(:,kcsf) = pcsflt(:,icsf)
2280                    ENDIF
2281                ENDDO
2282!--             last written item is now also the last item in valid part of array
2283                npcsfl = kcsf
2284            ENDIF
2285
2286            ncsfl = npcsfl
2287            IF ( ncsfl > 0 )  THEN
2288                ALLOCATE( csf(ndcsf,ncsfl) )
2289                ALLOCATE( csfsurf(idcsf,ncsfl) )
2290                DO icsf = 1, ncsfl
2291                    csf(:,icsf) = pcsflt(:,icsf)
2292                    csfsurf(1,icsf) =  gridpcbl(kpcsflt(1,icsf),kpcsflt(2,icsf),kpcsflt(3,icsf))
2293                    csfsurf(2,icsf) =  kpcsflt(4,icsf)
2294                ENDDO
2295            ENDIF
2296           
2297!--         deallocation of temporary arrays
2298            DEALLOCATE( pcsflt )
2299            DEALLOCATE( kpcsflt )
2300           
2301        ENDIF
2302       
2303        RETURN
2304       
2305301     WRITE( message_string, * )  &
2306            'I/O error when processing shape view factors / ',  &
2307            'plant canopy sink factors / direct irradiance factors.'
2308        CALL message( 'init_urban_surface', 'PA0502', 2, 2, 0, 6, 0 )
2309       
2310    END SUBROUTINE usm_calc_svf
2311
2312
2313!------------------------------------------------------------------------------!
2314!
2315! Description:
2316! ------------
2317!> Subroutine checks variables and assigns units.
2318!> It is caaled out from subroutine check_parameters.
2319!------------------------------------------------------------------------------!
2320    SUBROUTINE usm_check_data_output( variable, unit )
2321       
2322        IMPLICIT NONE
2323 
2324        CHARACTER (len=*),INTENT(IN)    ::  variable !:
2325        CHARACTER (len=*),INTENT(OUT)   ::  unit     !:
2326       
2327        CHARACTER (len=varnamelength)   :: var
2328
2329        var = TRIM(variable)
2330        IF ( var(1:12) == 'usm_rad_net_'  .OR.  var(1:13) == 'usm_rad_insw_'  .OR.        &
2331             var(1:13) == 'usm_rad_inlw_'  .OR.  var(1:16) == 'usm_rad_inswdir_'  .OR.    &
2332             var(1:16) == 'usm_rad_inswdif_'  .OR.  var(1:16) == 'usm_rad_inswref_'  .OR. &
2333             var(1:16) == 'usm_rad_inlwdif_'  .OR.  var(1:16) == 'usm_rad_inlwref_'  .OR. &
2334             var(1:14) == 'usm_rad_outsw_'  .OR.  var(1:14) == 'usm_rad_outlw_'  .OR.     &
2335             var(1:14) == 'usm_rad_ressw_'  .OR.  var(1:14) == 'usm_rad_reslw_'  .OR.     &
2336             var(1:11) == 'usm_rad_hf_'  .OR.                                             &
2337             var(1:9)  == 'usm_wshf_'  .OR.  var(1:9) == 'usm_wghf_' )  THEN
2338            unit = 'W/m2'
2339        ELSE IF ( var(1:10) == 'usm_t_surf'  .OR.  var(1:10) == 'usm_t_wall' )  THEN
2340            unit = 'K'
2341        ELSE IF ( var(1:9) == 'usm_surfz'  .OR.  var(1:7) == 'usm_svf'  .OR.              & 
2342                  var(1:7) == 'usm_dif'  .OR.  var(1:11) == 'usm_surfcat'  .OR.           &
2343                  var(1:11) == 'usm_surfalb'  .OR.  var(1:12) == 'usm_surfemis')  THEN
2344            unit = '1'
2345        ELSE
2346            unit = 'illegal'
2347        ENDIF
2348
2349    END SUBROUTINE usm_check_data_output
2350
2351
2352!------------------------------------------------------------------------------!
2353! Description:
2354! ------------
2355!> Check parameters routine for urban surface model
2356!------------------------------------------------------------------------------!
2357    SUBROUTINE usm_check_parameters
2358   
2359       USE control_parameters,                                                 &
2360           ONLY:  bc_pt_b, bc_q_b, constant_flux_layer, large_scale_forcing,   &
2361                  lsf_surf, topography
2362
2363!
2364!--    Dirichlet boundary conditions are required as the surface fluxes are
2365!--    calculated from the temperature/humidity gradients in the urban surface
2366!--    model
2367       IF ( bc_pt_b == 'neumann'   .OR.   bc_q_b == 'neumann' )  THEN
2368          message_string = 'urban surface model requires setting of '//        &
2369                           'bc_pt_b = "dirichlet" and '//                      &
2370                           'bc_q_b  = "dirichlet"'
2371          CALL message( 'check_parameters', 'PA0590', 1, 2, 0, 6, 0 )
2372       ENDIF
2373
2374       IF ( .NOT.  constant_flux_layer )  THEN
2375          message_string = 'urban surface model requires '//                   &
2376                           'constant_flux_layer = .T.'
2377          CALL message( 'check_parameters', 'PA0591', 1, 2, 0, 6, 0 )
2378       ENDIF
2379!       
2380!--    Surface forcing has to be disabled for LSF in case of enabled
2381!--    urban surface module
2382       IF ( large_scale_forcing )  THEN
2383          lsf_surf = .FALSE.
2384       ENDIF
2385!
2386!--    Topography
2387       IF ( topography == 'flat' )  THEN
2388          message_string = 'topography /= "flat" is required '//               &
2389                           'when using the urban surface model'
2390          CALL message( 'check_parameters', 'PA0592', 1, 2, 0, 6, 0 )
2391       ENDIF
2392
2393
2394    END SUBROUTINE usm_check_parameters
2395
2396
2397!------------------------------------------------------------------------------!
2398!
2399! Description:
2400! ------------
2401!> Output of the 3D-arrays in netCDF and/or AVS format
2402!> for variables of urban_surface model.
2403!> It resorts the urban surface module output quantities from surf style
2404!> indexing into temporary 3D array with indices (i,j,k).
2405!> It is called from subroutine data_output_3d.
2406!------------------------------------------------------------------------------!
2407    SUBROUTINE usm_data_output_3d( av, variable, found, local_pf, nzb_do, nzt_do )
2408       
2409        IMPLICIT NONE
2410
2411        INTEGER(iwp), INTENT(IN)       ::  av        !<
2412        CHARACTER (len=*), INTENT(IN)  ::  variable  !<
2413        INTEGER(iwp), INTENT(IN)       ::  nzb_do    !< lower limit of the data output (usually 0)
2414        INTEGER(iwp), INTENT(IN)       ::  nzt_do    !< vertical upper limit of the data output (usually nz_do3d)
2415        LOGICAL, INTENT(OUT)           ::  found     !<
2416        REAL(sp), DIMENSION(nxlg:nxrg,nysg:nyng,nzb_do:nzt_do) ::  local_pf   !< sp - it has to correspond to module data_output_3d
2417        REAL(wp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg)     ::  temp_pf    !< temp array for urban surface output procedure
2418       
2419        CHARACTER (len=varnamelength)                          :: var, surfid
2420        INTEGER(iwp), PARAMETER                                :: nd = 5
2421        CHARACTER(len=6), DIMENSION(0:nd-1), PARAMETER         :: dirname = (/ '_roof ', '_south', '_north', '_west ', '_east ' /)
2422        INTEGER(iwp), DIMENSION(0:nd-1), PARAMETER             :: dirint = (/ iroof, isouth, inorth, iwest, ieast /)
2423        INTEGER(iwp), DIMENSION(0:nd-1)                        :: dirstart
2424        INTEGER(iwp), DIMENSION(0:nd-1)                        :: dirend
2425        INTEGER(iwp)                                           :: ids,isurf,isvf,isurfs,isurflt
2426        INTEGER(iwp)                                           :: is,js,ks,i,j,k,iwl,istat, l, m
2427        INTEGER(iwp)                                           ::  k_topo    !< topography top index
2428
2429        dirstart = (/ startland, startwall, startwall, startwall, startwall /)
2430        dirend = (/ endland, endwall, endwall, endwall, endwall /)
2431
2432        found = .TRUE.
2433        temp_pf = -1._wp
2434       
2435        ids = -1
2436        var = TRIM(variable)
2437        DO i = 0, nd-1
2438            k = len(TRIM(var))
2439            j = len(TRIM(dirname(i)))
2440            IF ( var(k-j+1:k) == dirname(i) )  THEN
2441                ids = i
2442                var = var(:k-j)
2443                EXIT
2444            ENDIF
2445        ENDDO
2446        IF ( ids == -1 )  THEN
2447            var = TRIM(variable)
2448        ENDIF
2449        IF ( var(1:11) == 'usm_t_wall_'  .AND.  len(TRIM(var)) >= 12 )  THEN
2450!--         wall layers
2451            READ(var(12:12), '(I1)', iostat=istat ) iwl
2452            IF ( istat == 0  .AND.  iwl >= nzb_wall  .AND.  iwl <= nzt_wall )  THEN
2453                var = var(1:10)
2454            ENDIF
2455        ENDIF
2456        IF ( (var(1:8) == 'usm_svf_'  .OR.  var(1:8) == 'usm_dif_')  .AND.  len(TRIM(var)) >= 13 )  THEN
2457!--         svf values to particular surface
2458            surfid = var(9:)
2459            i = index(surfid,'_')
2460            j = index(surfid(i+1:),'_')
2461            READ(surfid(1:i-1),*, iostat=istat ) is
2462            IF ( istat == 0 )  THEN
2463                READ(surfid(i+1:i+j-1),*, iostat=istat ) js
2464            ENDIF
2465            IF ( istat == 0 )  THEN
2466                READ(surfid(i+j+1:),*, iostat=istat ) ks
2467            ENDIF
2468            IF ( istat == 0 )  THEN
2469                var = var(1:7)
2470            ENDIF
2471        ENDIF
2472       
2473        SELECT CASE ( TRIM(var) )
2474
2475          CASE ( 'usm_surfz' )
2476!--           array of lw radiation falling to local surface after i-th reflection
2477              DO  m = 1, surf_usm_h%ns
2478                 i = surf_usm_h%i(m)
2479                 j = surf_usm_h%j(m)
2480                 k = surf_usm_h%k(m)
2481                 temp_pf(0,j,i) = MAX( temp_pf(0,j,i), REAL( k, kind=wp) )
2482              ENDDO
2483              DO  l = 0, 3
2484                 DO  m = 1, surf_usm_v(l)%ns
2485                    i = surf_usm_v(l)%i(m)
2486                    j = surf_usm_v(l)%j(m)
2487                    k = surf_usm_v(l)%k(m)
2488                    temp_pf(0,j,i) = MAX( temp_pf(0,j,i), REAL( k, kind=wp) + 1.0_wp )
2489                 ENDDO
2490              ENDDO
2491
2492          CASE ( 'usm_surfcat' )
2493!--           surface category
2494              DO  m = 1, surf_usm_h%ns
2495                 i = surf_usm_h%i(m)
2496                 j = surf_usm_h%j(m)
2497                 k = surf_usm_h%k(m)
2498                 temp_pf(k,j,i) = surf_usm_h%surface_types(m)
2499              ENDDO
2500              DO  l = 0, 3
2501                 DO  m = 1, surf_usm_v(l)%ns
2502                    i = surf_usm_v(l)%i(m)
2503                    j = surf_usm_v(l)%j(m)
2504                    k = surf_usm_v(l)%k(m)
2505                    temp_pf(k,j,i) = surf_usm_v(l)%surface_types(m)
2506                 ENDDO
2507              ENDDO
2508             
2509          CASE ( 'usm_surfalb' )
2510!--           surface albedo
2511              DO  m = 1, surf_usm_h%ns
2512                 i = surf_usm_h%i(m)
2513                 j = surf_usm_h%j(m)
2514                 k = surf_usm_h%k(m)
2515                 temp_pf(k,j,i) = surf_usm_h%albedo_surf(m)
2516              ENDDO
2517              DO  l = 0, 3
2518                 DO  m = 1, surf_usm_v(l)%ns
2519                    i = surf_usm_v(l)%i(m)
2520                    j = surf_usm_v(l)%j(m)
2521                    k = surf_usm_v(l)%k(m)
2522                    temp_pf(k,j,i) = surf_usm_v(l)%albedo_surf(m)
2523                 ENDDO
2524              ENDDO
2525             
2526          CASE ( 'usm_surfemis' )
2527!--           surface albedo
2528              DO  m = 1, surf_usm_h%ns
2529                 i = surf_usm_h%i(m)
2530                 j = surf_usm_h%j(m)
2531                 k = surf_usm_h%k(m)
2532                 temp_pf(k,j,i) = surf_usm_h%emiss_surf(m)
2533              ENDDO
2534              DO  l = 0, 3
2535                 DO  m = 1, surf_usm_v(l)%ns
2536                    i = surf_usm_v(l)%i(m)
2537                    j = surf_usm_v(l)%j(m)
2538                    k = surf_usm_v(l)%k(m)
2539                    temp_pf(k,j,i) = surf_usm_v(l)%emiss_surf(m)
2540                 ENDDO
2541              ENDDO
2542!
2543!-- Not adjusted so far             
2544          CASE ( 'usm_svf', 'usm_dif' )
2545!--           shape view factors or iradiance factors to selected surface
2546              IF ( TRIM(var)=='usm_svf' )  THEN
2547                  k = 1
2548              ELSE
2549                  k = 2
2550              ENDIF
2551              DO isvf = 1, nsvfl
2552                  isurflt = svfsurf(1, isvf)
2553                  isurfs = svfsurf(2, isvf)
2554                             
2555                  IF ( surf(ix,isurfs) == is  .AND.  surf(iy,isurfs) == js  .AND.       &
2556                       surf(iz,isurfs) == ks  .AND.  surf(id,isurfs) == ids )  THEN
2557  !--                 correct source surface
2558                      temp_pf(surfl(iz,isurflt),surfl(iy,isurflt),surfl(ix,isurflt)) = svf(k,isvf)
2559                  ENDIF
2560              ENDDO
2561
2562          CASE ( 'usm_rad_net' )
2563!--           array of complete radiation balance
2564              IF ( av == 0 )  THEN
2565                 DO  m = 1, surf_usm_h%ns
2566                    i = surf_usm_h%i(m)
2567                    j = surf_usm_h%j(m)
2568                    k = surf_usm_h%k(m)
2569                    temp_pf(k,j,i) = surf_usm_h%rad_net_l(m)
2570                 ENDDO
2571                 DO  l = 0, 3
2572                    DO  m = 1, surf_usm_v(l)%ns
2573                       i = surf_usm_v(l)%i(m)
2574                       j = surf_usm_v(l)%j(m)
2575                       k = surf_usm_v(l)%k(m)
2576                       temp_pf(k,j,i) = surf_usm_v(l)%rad_net_l(m)
2577                    ENDDO
2578                 ENDDO
2579              ELSE
2580                 DO  m = 1, surf_usm_h%ns
2581                    i = surf_usm_h%i(m)
2582                    j = surf_usm_h%j(m)
2583                    k = surf_usm_h%k(m)
2584                    temp_pf(k,j,i) = surf_usm_h%rad_net_av(m)
2585                 ENDDO
2586                 DO  l = 0, 3
2587                    DO  m = 1, surf_usm_v(l)%ns
2588                       i = surf_usm_v(l)%i(m)
2589                       j = surf_usm_v(l)%j(m)
2590                       k = surf_usm_v(l)%k(m)
2591                       temp_pf(k,j,i) = surf_usm_v(l)%rad_net_av(m)
2592                    ENDDO
2593                 ENDDO
2594              ENDIF
2595
2596          CASE ( 'usm_rad_insw' )
2597!--           array of sw radiation falling to surface after i-th reflection
2598              DO isurf = dirstart(ids), dirend(ids)
2599                 IF ( surfl(id,isurf) == ids )  THEN
2600                   IF ( av == 0 )  THEN
2601                     temp_pf(surfl(iz,isurf),surfl(iy,isurf),surfl(ix,isurf)) = surfinsw(isurf)
2602                   ELSE
2603                     temp_pf(surfl(iz,isurf),surfl(iy,isurf),surfl(ix,isurf)) = surfinsw_av(isurf)
2604                   ENDIF
2605                 ENDIF
2606              ENDDO
2607
2608          CASE ( 'usm_rad_inlw' )
2609!--           array of lw radiation falling to surface after i-th reflection
2610              DO isurf = dirstart(ids), dirend(ids)
2611                 IF ( surfl(id,isurf) == ids )  THEN
2612                   IF ( av == 0 )  THEN
2613                     temp_pf(surfl(iz,isurf),surfl(iy,isurf),surfl(ix,isurf)) = surfinlw(isurf)
2614                   ELSE
2615                     temp_pf(surfl(iz,isurf),surfl(iy,isurf),surfl(ix,isurf)) = surfinlw_av(isurf)
2616                   ENDIF
2617                 ENDIF
2618              ENDDO
2619
2620          CASE ( 'usm_rad_inswdir' )
2621!--           array of direct sw radiation falling to surface from sun
2622              DO isurf = dirstart(ids), dirend(ids)
2623                 IF ( surfl(id,isurf) == ids )  THEN
2624                   IF ( av == 0 )  THEN
2625                     temp_pf(surfl(iz,isurf),surfl(iy,isurf),surfl(ix,isurf)) = surfinswdir(isurf)
2626                   ELSE
2627                     temp_pf(surfl(iz,isurf),surfl(iy,isurf),surfl(ix,isurf)) = surfinswdir_av(isurf)
2628                   ENDIF
2629                 ENDIF
2630              ENDDO
2631
2632          CASE ( 'usm_rad_inswdif' )
2633!--           array of difusion sw radiation falling to surface from sky and borders of the domain
2634              DO isurf = dirstart(ids), dirend(ids)
2635                 IF ( surfl(id,isurf) == ids )  THEN
2636                   IF ( av == 0 )  THEN
2637                     temp_pf(surfl(iz,isurf),surfl(iy,isurf),surfl(ix,isurf)) = surfinswdif(isurf)
2638                   ELSE
2639                     temp_pf(surfl(iz,isurf),surfl(iy,isurf),surfl(ix,isurf)) = surfinswdif_av(isurf)
2640                   ENDIF
2641                 ENDIF
2642              ENDDO
2643
2644          CASE ( 'usm_rad_inswref' )
2645!--           array of sw radiation falling to surface from reflections
2646              DO isurf = dirstart(ids), dirend(ids)
2647                 IF ( surfl(id,isurf) == ids )  THEN
2648                   IF ( av == 0 )  THEN
2649                     temp_pf(surfl(iz,isurf),surfl(iy,isurf),surfl(ix,isurf)) = &
2650                       surfinsw(isurf) - surfinswdir(isurf) - surfinswdif(isurf)
2651                   ELSE
2652                     temp_pf(surfl(iz,isurf),surfl(iy,isurf),surfl(ix,isurf)) = surfinswref_av(isurf)
2653                   ENDIF
2654                 ENDIF
2655              ENDDO
2656
2657          CASE ( 'usm_rad_inlwref' )
2658!--           array of lw radiation falling to surface from reflections
2659              DO isurf = dirstart(ids), dirend(ids)
2660                 IF ( surfl(id,isurf) == ids )  THEN
2661                   IF ( av == 0 )  THEN
2662                     temp_pf(surfl(iz,isurf),surfl(iy,isurf),surfl(ix,isurf)) = surfinlw(isurf) - surfinlwdif(isurf)
2663                   ELSE
2664                     temp_pf(surfl(iz,isurf),surfl(iy,isurf),surfl(ix,isurf)) = surfinlwref_av(isurf)
2665                   ENDIF
2666                 ENDIF
2667              ENDDO
2668
2669          CASE ( 'usm_rad_outsw' )
2670!--           array of sw radiation emitted from surface after i-th reflection
2671              DO isurf = dirstart(ids), dirend(ids)
2672                 IF ( surfl(id,isurf) == ids )  THEN
2673                   IF ( av == 0 )  THEN
2674                     temp_pf(surfl(iz,isurf),surfl(iy,isurf),surfl(ix,isurf)) = surfoutsw(isurf)
2675                   ELSE
2676                     temp_pf(surfl(iz,isurf),surfl(iy,isurf),surfl(ix,isurf)) = surfoutsw_av(isurf)
2677                   ENDIF
2678                 ENDIF
2679              ENDDO
2680
2681          CASE ( 'usm_rad_outlw' )
2682!--           array of lw radiation emitted from surface after i-th reflection
2683              DO isurf = dirstart(ids), dirend(ids)
2684                 IF ( surfl(id,isurf) == ids )  THEN
2685                   IF ( av == 0 )  THEN
2686                     temp_pf(surfl(iz,isurf),surfl(iy,isurf),surfl(ix,isurf)) = surfoutlw(isurf)
2687                   ELSE
2688                     temp_pf(surfl(iz,isurf),surfl(iy,isurf),surfl(ix,isurf)) = surfoutlw_av(isurf)
2689                   ENDIF
2690                 ENDIF
2691              ENDDO
2692
2693          CASE ( 'usm_rad_ressw' )
2694!--           average of array of residua of sw radiation absorbed in surface after last reflection
2695              DO isurf = dirstart(ids), dirend(ids)
2696                 IF ( surfl(id,isurf) == ids )  THEN
2697                   IF ( av == 0 )  THEN
2698                     temp_pf(surfl(iz,isurf),surfl(iy,isurf),surfl(ix,isurf)) = surfins(isurf)
2699                   ELSE
2700                     temp_pf(surfl(iz,isurf),surfl(iy,isurf),surfl(ix,isurf)) = surfins_av(isurf)
2701                   ENDIF
2702                 ENDIF
2703              ENDDO
2704
2705          CASE ( 'usm_rad_reslw' )
2706!--           average of array of residua of lw radiation absorbed in surface after last reflection
2707              DO isurf = dirstart(ids), dirend(ids)
2708                 IF ( surfl(id,isurf) == ids )  THEN
2709                   IF ( av == 0 )  THEN
2710                     temp_pf(surfl(iz,isurf),surfl(iy,isurf),surfl(ix,isurf)) = surfinl(isurf)
2711                   ELSE
2712                     temp_pf(surfl(iz,isurf),surfl(iy,isurf),surfl(ix,isurf)) = surfinl_av(isurf)
2713                   ENDIF
2714                 ENDIF
2715              ENDDO
2716 
2717          CASE ( 'usm_rad_hf' )
2718!--           array of heat flux from radiation for surfaces after all reflections
2719              IF ( av == 0 )  THEN
2720                 DO  m = 1, surf_usm_h%ns
2721                    i = surf_usm_h%i(m)
2722                    j = surf_usm_h%j(m)
2723                    k = surf_usm_h%k(m)
2724                    temp_pf(k,j,i) = surf_usm_h%surfhf(m)
2725                 ENDDO
2726                 DO  l = 0, 3
2727                    DO  m = 1, surf_usm_v(l)%ns
2728                       i = surf_usm_v(l)%i(m)
2729                       j = surf_usm_v(l)%j(m)
2730                       k = surf_usm_v(l)%k(m)
2731                       temp_pf(k,j,i) = surf_usm_v(l)%surfhf(m)
2732                    ENDDO
2733                 ENDDO
2734              ELSE
2735                 DO  m = 1, surf_usm_h%ns
2736                    i = surf_usm_h%i(m)
2737                    j = surf_usm_h%j(m)
2738                    k = surf_usm_h%k(m)
2739                    temp_pf(k,j,i) = surf_usm_h%surfhf_av(m)
2740                 ENDDO
2741                 DO  l = 0, 3
2742                    DO  m = 1, surf_usm_v(l)%ns
2743                       i = surf_usm_v(l)%i(m)
2744                       j = surf_usm_v(l)%j(m)
2745                       k = surf_usm_v(l)%k(m)
2746                       temp_pf(k,j,i) = surf_usm_v(l)%surfhf_av(m)
2747                    ENDDO
2748                 ENDDO
2749              ENDIF
2750 
2751          CASE ( 'usm_wshf' )
2752!--           array of sensible heat flux from surfaces
2753              IF ( av == 0 )  THEN
2754                 DO  m = 1, surf_usm_h%ns
2755                    i = surf_usm_h%i(m)
2756                    j = surf_usm_h%j(m)
2757                    k = surf_usm_h%k(m)
2758                    temp_pf(k,j,i) = surf_usm_h%wshf_eb(m)
2759                 ENDDO
2760                 DO  l = 0, 3
2761                    DO  m = 1, surf_usm_v(l)%ns
2762                       i = surf_usm_v(l)%i(m)
2763                       j = surf_usm_v(l)%j(m)
2764                       k = surf_usm_v(l)%k(m)
2765                       temp_pf(k,j,i) = surf_usm_v(l)%wshf_eb(m)
2766                    ENDDO
2767                 ENDDO
2768              ELSE
2769                 DO  m = 1, surf_usm_h%ns
2770                    i = surf_usm_h%i(m)
2771                    j = surf_usm_h%j(m)
2772                    k = surf_usm_h%k(m)
2773                    temp_pf(k,j,i) = surf_usm_h%wshf_eb_av(m)
2774                 ENDDO
2775                 DO  l = 0, 3
2776                    DO  m = 1, surf_usm_v(l)%ns
2777                       i = surf_usm_v(l)%i(m)
2778                       j = surf_usm_v(l)%j(m)
2779                       k = surf_usm_v(l)%k(m)
2780                       temp_pf(k,j,i) = surf_usm_v(l)%wshf_eb_av(m)
2781                    ENDDO
2782                 ENDDO
2783              ENDIF
2784
2785
2786          CASE ( 'usm_wghf' )
2787!--           array of heat flux from ground (land, wall, roof)
2788              IF ( av == 0 )  THEN
2789                 DO  m = 1, surf_usm_h%ns
2790                    i = surf_usm_h%i(m)
2791                    j = surf_usm_h%j(m)
2792                    k = surf_usm_h%k(m)
2793                    temp_pf(k,j,i) = surf_usm_h%wghf_eb(m)
2794                 ENDDO
2795                 DO  l = 0, 3
2796                    DO  m = 1, surf_usm_v(l)%ns
2797                       i = surf_usm_v(l)%i(m)
2798                       j = surf_usm_v(l)%j(m)
2799                       k = surf_usm_v(l)%k(m)
2800                       temp_pf(k,j,i) = surf_usm_v(l)%wghf_eb(m)
2801                    ENDDO
2802                 ENDDO
2803              ELSE
2804                 DO  m = 1, surf_usm_h%ns
2805                    i = surf_usm_h%i(m)
2806                    j = surf_usm_h%j(m)
2807                    k = surf_usm_h%k(m)
2808                    temp_pf(k,j,i) = surf_usm_h%wghf_eb_av(m)
2809                 ENDDO
2810                 DO  l = 0, 3
2811                    DO  m = 1, surf_usm_v(l)%ns
2812                       i = surf_usm_v(l)%i(m)
2813                       j = surf_usm_v(l)%j(m)
2814                       k = surf_usm_v(l)%k(m)
2815                       temp_pf(k,j,i) = surf_usm_v(l)%wghf_eb_av(m)
2816                    ENDDO
2817                 ENDDO
2818              ENDIF
2819
2820          CASE ( 'usm_t_surf' )
2821!--           surface temperature for surfaces
2822              IF ( av == 0 )  THEN
2823                 DO  m = 1, surf_usm_h%ns
2824                    i = surf_usm_h%i(m)
2825                    j = surf_usm_h%j(m)
2826                    k = surf_usm_h%k(m)
2827                    temp_pf(k,j,i) = t_surf_h(m)
2828                 ENDDO
2829                 DO  l = 0, 3
2830                    DO  m = 1, surf_usm_v(l)%ns
2831                       i = surf_usm_v(l)%i(m)
2832                       j = surf_usm_v(l)%j(m)
2833                       k = surf_usm_v(l)%k(m)
2834                       temp_pf(k,j,i) = t_surf_v(l)%t(m)
2835                    ENDDO
2836                 ENDDO
2837              ELSE
2838                 DO  m = 1, surf_usm_h%ns
2839                    i = surf_usm_h%i(m)
2840                    j = surf_usm_h%j(m)
2841                    k = surf_usm_h%k(m)
2842                    temp_pf(k,j,i) = surf_usm_h%t_surf_av(m)
2843                 ENDDO
2844                 DO  l = 0, 3
2845                    DO  m = 1, surf_usm_v(l)%ns
2846                       i = surf_usm_v(l)%i(m)
2847                       j = surf_usm_v(l)%j(m)
2848                       k = surf_usm_v(l)%k(m)
2849                       temp_pf(k,j,i) = surf_usm_v(l)%t_surf_av(m)
2850                    ENDDO
2851                 ENDDO
2852              ENDIF
2853             
2854          CASE ( 'usm_t_wall' )
2855!--           wall temperature for  iwl layer of walls and land
2856              IF ( av == 0 )  THEN
2857                 DO  m = 1, surf_usm_h%ns
2858                    i = surf_usm_h%i(m)
2859                    j = surf_usm_h%j(m)
2860                    k = surf_usm_h%k(m)
2861                    temp_pf(k,j,i) = t_wall_h(iwl,m)
2862                 ENDDO
2863                 DO  l = 0, 3
2864                    DO  m = 1, surf_usm_v(l)%ns
2865                       i = surf_usm_v(l)%i(m)
2866                       j = surf_usm_v(l)%j(m)
2867                       k = surf_usm_v(l)%k(m)
2868                       temp_pf(k,j,i) = t_wall_v(l)%t(iwl,m)
2869                    ENDDO
2870                 ENDDO
2871              ELSE
2872                 DO  m = 1, surf_usm_h%ns
2873                    i = surf_usm_h%i(m)
2874                    j = surf_usm_h%j(m)
2875                    k = surf_usm_h%k(m)
2876                    temp_pf(k,j,i) = surf_usm_h%t_wall_av(iwl,m)
2877                 ENDDO
2878                 DO  l = 0, 3
2879                    DO  m = 1, surf_usm_v(l)%ns
2880                       i = surf_usm_v(l)%i(m)
2881                       j = surf_usm_v(l)%j(m)
2882                       k = surf_usm_v(l)%k(m)
2883                       temp_pf(k,j,i) = surf_usm_v(l)%t_wall_av(iwl,m)
2884                    ENDDO
2885                 ENDDO
2886              ENDIF
2887             
2888          CASE DEFAULT
2889              found = .FALSE.
2890             
2891        END SELECT
2892       
2893!--     fill out array local_pf which is subsequently treated by data_output_3d
2894        CALL exchange_horiz( temp_pf, nbgp )
2895!
2896!--  To Do: why reversed loop order
2897        DO j = nysg,nyng
2898            DO i = nxlg,nxrg
2899                DO k = nzb_do, nzt_do
2900                    local_pf(i,j,k) = temp_pf(k,j,i)
2901                ENDDO
2902            ENDDO
2903        ENDDO
2904       
2905    END SUBROUTINE usm_data_output_3d
2906   
2907
2908!------------------------------------------------------------------------------!
2909!
2910! Description:
2911! ------------
2912!> Soubroutine defines appropriate grid for netcdf variables.
2913!> It is called out from subroutine netcdf.
2914!------------------------------------------------------------------------------!
2915    SUBROUTINE usm_define_netcdf_grid( variable, found, grid_x, grid_y, grid_z )
2916   
2917        IMPLICIT NONE
2918
2919        CHARACTER (len=*), INTENT(IN)  ::  variable    !<
2920        LOGICAL, INTENT(OUT)           ::  found       !<
2921        CHARACTER (len=*), INTENT(OUT) ::  grid_x      !<
2922        CHARACTER (len=*), INTENT(OUT) ::  grid_y      !<
2923        CHARACTER (len=*), INTENT(OUT) ::  grid_z      !<
2924
2925        CHARACTER (len=varnamelength)  :: var
2926
2927        var = TRIM(variable)
2928        IF ( var(1:12) == 'usm_rad_net_'  .OR.  var(1:13) == 'usm_rad_insw_'  .OR.          &
2929             var(1:13) == 'usm_rad_inlw_'  .OR.  var(1:16) == 'usm_rad_inswdir_'  .OR.      &
2930             var(1:16) == 'usm_rad_inswdif_'  .OR.  var(1:16) == 'usm_rad_inswref_'  .OR.   &
2931             var(1:16) == 'usm_rad_inlwdif_'  .OR.  var(1:16) == 'usm_rad_inlwref_'  .OR.   &
2932             var(1:14) == 'usm_rad_outsw_'  .OR.  var(1:14) == 'usm_rad_outlw_'  .OR.       &
2933             var(1:14) == 'usm_rad_ressw_'  .OR.  var(1:14) == 'usm_rad_reslw_'  .OR.       &
2934             var(1:11) == 'usm_rad_hf_'  .OR.                                               &
2935             var(1:9) == 'usm_wshf_'  .OR.  var(1:9) == 'usm_wghf_'  .OR.                   &
2936             var(1:10) == 'usm_t_surf'  .OR.  var(1:10) == 'usm_t_wall'  .OR.               &
2937             var(1:9) == 'usm_surfz'  .OR.  var(1:7) == 'usm_svf'  .OR.                     & 
2938             var(1:7) == 'usm_dif'  .OR.  var(1:11) == 'usm_surfcat'  .OR.                  &
2939             var(1:11) == 'usm_surfalb'  .OR.  var(1:12) == 'usm_surfemis' )  THEN
2940
2941            found = .TRUE.
2942            grid_x = 'x'
2943            grid_y = 'y'
2944            grid_z = 'zu'
2945        ELSE
2946            found  = .FALSE.
2947            grid_x = 'none'
2948            grid_y = 'none'
2949            grid_z = 'none'
2950        ENDIF
2951
2952    END SUBROUTINE usm_define_netcdf_grid
2953   
2954   
2955!------------------------------------------------------------------------------!
2956!> Finds first model boundary crossed by a ray
2957!------------------------------------------------------------------------------!
2958    PURE SUBROUTINE usm_find_boundary_face(origin, uvect, bdycross)
2959   
2960       IMPLICIT NONE
2961       
2962       INTEGER(iwp) ::  d       !<
2963       INTEGER(iwp) ::  seldim  !< found fist crossing index
2964
2965       INTEGER(iwp), DIMENSION(3)              ::  bdyd      !< boundary direction       
2966       INTEGER(iwp), DIMENSION(4), INTENT(out) ::  bdycross  !< found boundary crossing (d, z, y, x)
2967       
2968       REAL(wp)                                ::  bdydim  !<
2969       REAL(wp)                                ::  dist    !<
2970       
2971       REAL(wp), DIMENSION(3)             ::  crossdist  !< crossing distance
2972       REAL(wp), DIMENSION(3), INTENT(in) ::  origin     !< ray origin
2973       REAL(wp), DIMENSION(3), INTENT(in) ::  uvect      !< ray unit vector
2974 
2975
2976       bdydim       = nzut + .5_wp  !< top boundary
2977       bdyd(1)      = isky
2978       crossdist(1) = ( bdydim - origin(1) ) / uvect(1)  !< subroutine called only when uvect(1)>0
2979
2980       IF ( uvect(2) == 0._wp )  THEN
2981          crossdist(2) = huge(1._wp)
2982       ELSE
2983          IF ( uvect(2) >= 0._wp )  THEN
2984             bdydim  = ny + .5_wp  !< north global boundary
2985             bdyd(2) = inorthb
2986          ELSE
2987             bdydim  = -.5_wp  !< south global boundary
2988             bdyd(2) = isouthb
2989          ENDIF
2990          crossdist(2) = ( bdydim - origin(2) ) / uvect(2)
2991       ENDIF
2992
2993       IF ( uvect(3) == 0._wp )  THEN
2994          crossdist(3) = huge(1._wp)
2995       ELSE
2996          IF ( uvect(3) >= 0._wp )  THEN
2997             bdydim  = nx + .5_wp  !< east global boundary
2998             bdyd(3) = ieastb
2999          ELSE
3000             bdydim  = -.5_wp  !< west global boundary
3001             bdyd(3) = iwestb
3002          ENDIF
3003          crossdist(3) = ( bdydim - origin(3) ) / uvect(3)
3004       ENDIF
3005
3006       seldim = minloc(crossdist, 1)
3007       dist   = crossdist(seldim)
3008       d      = bdyd(seldim)
3009
3010       bdycross(1)   = d
3011       bdycross(2:4) = NINT( origin(:) + uvect(:) * dist &
3012                                       + .5_wp * (/ kdir(d), jdir(d), idir(d) /) )
3013                       
3014    END SUBROUTINE
3015
3016
3017!------------------------------------------------------------------------------!
3018!> Determines whether two faces are oriented towards each other
3019!------------------------------------------------------------------------------!
3020    PURE LOGICAL FUNCTION usm_facing(x, y, z, d, x2, y2, z2, d2)
3021        IMPLICIT NONE
3022        INTEGER(iwp),   INTENT(in)  :: x, y, z, d, x2, y2, z2, d2
3023     
3024        usm_facing = .FALSE.
3025        IF ( d==iroof  .AND.  d2==iroof ) RETURN
3026        IF ( d==isky  .AND.  d2==isky ) RETURN
3027        IF ( (d==isouth  .OR.  d==inorthb)  .AND.  (d2==isouth.OR.d2==inorthb) ) RETURN
3028        IF ( (d==inorth  .OR.  d==isouthb)  .AND.  (d2==inorth.OR.d2==isouthb) ) RETURN
3029        IF ( (d==iwest  .OR.  d==ieastb)  .AND.  (d2==iwest.OR.d2==ieastb) ) RETURN
3030        IF ( (d==ieast  .OR.  d==iwestb)  .AND.  (d2==ieast.OR.d2==iwestb) ) RETURN
3031
3032        SELECT CASE (d)
3033            CASE (iroof)                   !< ground, roof
3034                IF ( z2 < z ) RETURN
3035            CASE (isky)                    !< sky
3036                IF ( z2 > z ) RETURN
3037            CASE (isouth, inorthb)         !< south facing
3038                IF ( y2 > y ) RETURN
3039            CASE (inorth, isouthb)         !< north facing
3040                IF ( y2 < y ) RETURN
3041            CASE (iwest, ieastb)           !< west facing
3042                IF ( x2 > x ) RETURN
3043            CASE (ieast, iwestb)           !< east facing
3044                IF ( x2 < x ) RETURN
3045        END SELECT
3046
3047        SELECT CASE (d2)
3048            CASE (iroof)                   !< ground, roof
3049                IF ( z < z2 ) RETURN
3050            CASE (isky)                    !< sky
3051                IF ( z > z2 ) RETURN
3052            CASE (isouth, inorthb)         !< south facing
3053                IF ( y > y2 ) RETURN
3054            CASE (inorth, isouthb)         !< north facing
3055                IF ( y < y2 ) RETURN
3056            CASE (iwest, ieastb)           !< west facing
3057                IF ( x > x2 ) RETURN
3058            CASE (ieast, iwestb)           !< east facing
3059                IF ( x < x2 ) RETURN
3060            CASE (-1)
3061                CONTINUE
3062        END SELECT
3063
3064        usm_facing = .TRUE.
3065       
3066    END FUNCTION usm_facing
3067   
3068
3069!------------------------------------------------------------------------------!
3070! Description:
3071! ------------
3072!> Initialization of the wall surface model
3073!------------------------------------------------------------------------------!
3074    SUBROUTINE usm_init_material_model
3075
3076        IMPLICIT NONE
3077
3078        INTEGER(iwp) ::  k, l, m            !< running indices
3079       
3080        CALL location_message( '    initialization of wall surface model', .TRUE. )
3081       
3082!--     Calculate wall grid spacings.
3083!--     Temperature is defined at the center of the wall layers,
3084!--     whereas gradients/fluxes are defined at the edges (_stag)
3085        DO k = nzb_wall, nzt_wall
3086           zwn(k) = zwn_default(k)
3087        ENDDO
3088!       
3089!--     apply for all particular surface grids. First for horizontal surfaces
3090        DO  m = 1, surf_usm_h%ns
3091           surf_usm_h%zw(:,m)             = zwn(:) *                           &
3092                                            surf_usm_h%thickness_wall(m)
3093           surf_usm_h%dz_wall(nzb_wall,m) = surf_usm_h%zw(nzb_wall,m)
3094           DO k = nzb_wall+1, nzt_wall
3095               surf_usm_h%dz_wall(k,m) = surf_usm_h%zw(k,m) -                  &
3096                                         surf_usm_h%zw(k-1,m)
3097           ENDDO
3098           
3099           surf_usm_h%dz_wall(nzt_wall+1,m) = surf_usm_h%dz_wall(nzt_wall,m)
3100
3101           DO k = nzb_wall, nzt_wall-1
3102               surf_usm_h%dz_wall_stag(k,m) = 0.5 * (                          &
3103                           surf_usm_h%dz_wall(k+1,m) + surf_usm_h%dz_wall(k,m) )
3104           ENDDO
3105           surf_usm_h%dz_wall_stag(nzt_wall,m) = surf_usm_h%dz_wall(nzt_wall,m)
3106        ENDDO
3107        surf_usm_h%ddz_wall      = 1.0_wp / surf_usm_h%dz_wall
3108        surf_usm_h%ddz_wall_stag = 1.0_wp / surf_usm_h%dz_wall_stag
3109!       
3110!--     For vertical surfaces
3111        DO  l = 0, 3
3112           DO  m = 1, surf_usm_v(l)%ns
3113              surf_usm_v(l)%zw(:,m)             = zwn(:) *                     &
3114                                                  surf_usm_v(l)%thickness_wall(m)
3115              surf_usm_v(l)%dz_wall(nzb_wall,m) = surf_usm_v(l)%zw(nzb_wall,m)
3116              DO k = nzb_wall+1, nzt_wall
3117                  surf_usm_v(l)%dz_wall(k,m) = surf_usm_v(l)%zw(k,m) -         &
3118                                               surf_usm_v(l)%zw(k-1,m)
3119              ENDDO
3120           
3121              surf_usm_v(l)%dz_wall(nzt_wall+1,m) =                            &
3122                                              surf_usm_v(l)%dz_wall(nzt_wall,m)
3123
3124              DO k = nzb_wall, nzt_wall-1
3125                  surf_usm_v(l)%dz_wall_stag(k,m) = 0.5 * (                    &
3126                                                surf_usm_v(l)%dz_wall(k+1,m) + &
3127                                                surf_usm_v(l)%dz_wall(k,m) )
3128              ENDDO
3129              surf_usm_v(l)%dz_wall_stag(nzt_wall,m) =                         &
3130                                              surf_usm_v(l)%dz_wall(nzt_wall,m)
3131           ENDDO
3132           surf_usm_v(l)%ddz_wall      = 1.0_wp / surf_usm_v(l)%dz_wall
3133           surf_usm_v(l)%ddz_wall_stag = 1.0_wp / surf_usm_v(l)%dz_wall_stag
3134        ENDDO     
3135
3136       
3137        CALL location_message( '    wall structures filed out', .TRUE. )
3138
3139        CALL location_message( '    initialization of wall surface model finished', .TRUE. )
3140
3141    END SUBROUTINE usm_init_material_model
3142
3143 
3144!------------------------------------------------------------------------------!
3145! Description:
3146! ------------
3147!> Initialization of the urban surface model
3148!------------------------------------------------------------------------------!
3149    SUBROUTINE usm_init_urban_surface
3150   
3151        IMPLICIT NONE
3152
3153        INTEGER(iwp) ::  i, j, k, l, m            !< running indices
3154        REAL(wp)     ::  c, d, tin, exn
3155       
3156
3157        CALL cpu_log( log_point_s(78), 'usm_init', 'start' )
3158!--     surface forcing have to be disabled for LSF
3159!--     in case of enabled urban surface module
3160        IF ( large_scale_forcing )  THEN
3161            lsf_surf = .FALSE.
3162        ENDIF
3163       
3164!--     init anthropogenic sources of heat
3165        CALL usm_allocate_urban_surface()
3166       
3167!--     read the surface_types array somewhere
3168        CALL usm_read_urban_surface_types()
3169       
3170!--     init material heat model
3171        CALL usm_init_material_model()
3172       
3173        IF ( usm_anthropogenic_heat )  THEN
3174!--         init anthropogenic sources of heat (from transportation for now)
3175            CALL usm_read_anthropogenic_heat()
3176        ENDIF
3177       
3178        IF ( read_svf_on_init )  THEN
3179!--         read svf, csf, svfsurf and csfsurf data from file
3180            CALL location_message( '    Start reading SVF from file', .TRUE. )
3181            CALL usm_read_svf_from_file()
3182            CALL location_message( '    Reading SVF from file has finished', .TRUE. )
3183        ELSE
3184!--         calculate SFV and CSF
3185            CALL location_message( '    Start calculation of SVF', .TRUE. )
3186            CALL cpu_log( log_point_s(79), 'usm_calc_svf', 'start' )
3187            CALL usm_calc_svf()
3188            CALL cpu_log( log_point_s(79), 'usm_calc_svf', 'stop' )
3189            CALL location_message( '    Calculation of SVF has finished', .TRUE. )
3190        ENDIF
3191
3192        IF ( write_svf_on_init )  THEN
3193!--         write svf, csf svfsurf and csfsurf data to file
3194            CALL location_message( '    Store SVF and CSF to file', .TRUE. )
3195            CALL usm_write_svf_to_file()
3196        ENDIF
3197       
3198        IF ( plant_canopy )  THEN
3199!--         gridpcbl was only necessary for initialization
3200            DEALLOCATE( gridpcbl )
3201            IF ( .NOT.  ALLOCATED(pc_heating_rate) )  THEN
3202!--             then pc_heating_rate is allocated in init_plant_canopy
3203!--             in case of cthf /= 0 => we need to allocate it for our use here
3204                ALLOCATE( pc_heating_rate(nzb:nzt+1,nysg:nyng,nxlg:nxrg) )
3205            ENDIF
3206        ENDIF
3207
3208!--     Intitialization of the surface and wall/ground/roof temperature
3209
3210!--     Initialization for restart runs
3211        IF ( TRIM( initializing_actions ) /= 'read_restart_data'  .AND.        &
3212             TRIM( initializing_actions ) /= 'cyclic_fill' )  THEN
3213       
3214!--         Calculate initial surface temperature from pt of adjacent gridbox
3215            exn = ( surface_pressure / 1000.0_wp )**0.286_wp
3216
3217!
3218!--         At horizontal surfaces. Please note, t_surf_h is defined on a
3219!--         different data type, but with the same dimension.
3220            DO  m = 1, surf_usm_h%ns
3221               i = surf_usm_h%i(m)           
3222               j = surf_usm_h%j(m)
3223               k = surf_usm_h%k(m)
3224
3225               t_surf_h(m) = pt(k,j,i) * exn
3226            ENDDO
3227!
3228!--         At vertical surfaces.
3229            DO  l = 0, 3
3230               DO  m = 1, surf_usm_v(l)%ns
3231                  i = surf_usm_v(l)%i(m)           
3232                  j = surf_usm_v(l)%j(m)
3233                  k = surf_usm_v(l)%k(m)
3234
3235                  t_surf_v(l)%t(m) = pt(k,j,i) * exn
3236               ENDDO
3237            ENDDO
3238
3239     
3240!--         initial values for t_wall
3241!--         outer value is set to surface temperature
3242!--         inner value is set to wall_inner_temperature
3243!--         and profile is logaritmic (linear in nz).
3244!--         Horizontal surfaces
3245            DO  m = 1, surf_usm_h%ns
3246!
3247!--            Roof
3248               IF ( surf_usm_h%isroof_surf(m) )  THEN
3249                   tin = roof_inner_temperature
3250!
3251!--            Normal land surface
3252               ELSE
3253                   tin = soil_inner_temperature
3254               ENDIF
3255
3256               DO k = nzb_wall, nzt_wall+1
3257                   c = REAL( k - nzb_wall, wp ) /                              &
3258                       REAL( nzt_wall + 1 - nzb_wall , wp )
3259
3260                   t_wall_h(k,m) = ( 1.0_wp - c ) * t_surf_h(m) + c * tin
3261               ENDDO
3262            ENDDO
3263!
3264!--         Vertical surfaces
3265            DO  l = 0, 3
3266               DO  m = 1, surf_usm_v(l)%ns
3267!
3268!--               Inner wall
3269                  tin = wall_inner_temperature
3270
3271                  DO k = nzb_wall, nzt_wall+1
3272                     c = REAL( k - nzb_wall, wp ) /                            &
3273                         REAL( nzt_wall + 1 - nzb_wall , wp )
3274
3275                     t_wall_v(l)%t(k,m) = ( 1.0_wp - c ) * t_surf_v(l)%t(m) +  &
3276                                          c * tin
3277                  ENDDO
3278               ENDDO
3279            ENDDO
3280
3281        ENDIF
3282       
3283!--   
3284!--     Possibly DO user-defined actions (e.g. define heterogeneous wall surface)
3285        CALL user_init_urban_surface
3286
3287!--     initialize prognostic values for the first timestep
3288        t_surf_h_p = t_surf_h
3289        t_surf_v_p = t_surf_v
3290
3291        t_wall_h_p = t_wall_h
3292        t_wall_v_p = t_wall_v
3293       
3294!--     Adjust radiative fluxes for urban surface at model start
3295        CALL usm_radiation
3296       
3297        CALL cpu_log( log_point_s(78), 'usm_init', 'stop' )
3298
3299       
3300    END SUBROUTINE usm_init_urban_surface
3301
3302
3303!------------------------------------------------------------------------------!
3304! Description:
3305! ------------
3306!
3307!> Wall model as part of the urban surface model. The model predicts wall
3308!> temperature.
3309!------------------------------------------------------------------------------!
3310    SUBROUTINE usm_material_heat_model
3311
3312
3313        IMPLICIT NONE
3314
3315        INTEGER(iwp) ::  i,j,k,l,kw, m                      !< running indices
3316
3317        REAL(wp), DIMENSION(nzb_wall:nzt_wall) :: wtend  !< tendency
3318
3319!
3320!--     For horizontal surfaces                                   
3321        DO  m = 1, surf_usm_h%ns
3322!
3323!--        Obtain indices
3324           i = surf_usm_h%i(m)           
3325           j = surf_usm_h%j(m)
3326           k = surf_usm_h%k(m)
3327!
3328!--        prognostic equation for ground/roof temperature t_wall_h
3329           wtend(:) = 0.0_wp
3330           wtend(nzb_wall) = (1.0_wp / surf_usm_h%rho_c_wall(nzb_wall,m)) *    &
3331                                      ( surf_usm_h%lambda_h(nzb_wall,m) *      &
3332                                        ( t_wall_h(nzb_wall+1,m)               &
3333                                        - t_wall_h(nzb_wall,m) ) *             &
3334                                        surf_usm_h%ddz_wall(nzb_wall+1,m)      &
3335                                      + surf_usm_h%wghf_eb(m) ) *              &
3336                                        surf_usm_h%ddz_wall_stag(nzb_wall,m)
3337           
3338           DO  kw = nzb_wall+1, nzt_wall
3339               wtend(kw) = (1.0_wp / surf_usm_h%rho_c_wall(kw,m))              &
3340                              * (   surf_usm_h%lambda_h(kw,m)                  &
3341                                 * ( t_wall_h(kw+1,m) - t_wall_h(kw,m) )       &
3342                                 * surf_usm_h%ddz_wall(kw+1,m)                 &
3343                              - surf_usm_h%lambda_h(kw-1,m)                    &
3344                                 * ( t_wall_h(kw,m) - t_wall_h(kw-1,m) )       &
3345                                 * surf_usm_h%ddz_wall(kw,m)                   &
3346                              ) * surf_usm_h%ddz_wall_stag(kw,m)
3347            ENDDO
3348
3349           t_wall_h_p(nzb_wall:nzt_wall,m) = t_wall_h(nzb_wall:nzt_wall,m)     &
3350                                 + dt_3d * ( tsc(2)                            &
3351                                 * wtend(nzb_wall:nzt_wall) + tsc(3)           &
3352                                 * surf_usm_h%tt_wall_m(nzb_wall:nzt_wall,m) )   
3353           
3354!
3355!--        calculate t_wall tendencies for the next Runge-Kutta step
3356           IF ( timestep_scheme(1:5) == 'runge' )  THEN
3357               IF ( intermediate_timestep_count == 1 )  THEN
3358                  DO  kw = nzb_wall, nzt_wall
3359                     surf_usm_h%tt_wall_m(kw,m) = wtend(kw)
3360                  ENDDO
3361               ELSEIF ( intermediate_timestep_count <                          &
3362                        intermediate_timestep_count_max )  THEN
3363                   DO  kw = nzb_wall, nzt_wall
3364                      surf_usm_h%tt_wall_m(kw,m) = -9.5625_wp * wtend(kw) +    &
3365                                         5.3125_wp * surf_usm_h%tt_wall_m(kw,m)
3366                   ENDDO
3367               ENDIF
3368           ENDIF
3369        ENDDO
3370!
3371!--     For vertical surfaces     
3372        DO  l = 0, 3                             
3373           DO  m = 1, surf_usm_v(l)%ns
3374!
3375!--           Obtain indices
3376              i = surf_usm_v(l)%i(m)           
3377              j = surf_usm_v(l)%j(m)
3378              k = surf_usm_v(l)%k(m)
3379!
3380!--           prognostic equation for wall temperature t_wall_v
3381              wtend(:) = 0.0_wp
3382              wtend(nzb_wall) = (1.0_wp / surf_usm_v(l)%rho_c_wall(nzb_wall,m)) * &
3383                                      ( surf_usm_v(l)%lambda_h(nzb_wall,m) *   &
3384                                        ( t_wall_v(l)%t(nzb_wall+1,m)          &
3385                                        - t_wall_v(l)%t(nzb_wall,m) ) *        &
3386                                        surf_usm_v(l)%ddz_wall(nzb_wall+1,m)   &
3387                                      + surf_usm_v(l)%wghf_eb(m) ) *           &
3388                                        surf_usm_v(l)%ddz_wall_stag(nzb_wall,m)
3389           
3390              DO  kw = nzb_wall+1, nzt_wall
3391                  wtend(kw) = (1.0_wp / surf_usm_v(l)%rho_c_wall(kw,m))        &
3392                           * (   surf_usm_v(l)%lambda_h(kw,m)                  &
3393                              * ( t_wall_v(l)%t(kw+1,m) - t_wall_v(l)%t(kw,m) )&
3394                              * surf_usm_v(l)%ddz_wall(kw+1,m)                 &
3395                           - surf_usm_v(l)%lambda_h(kw-1,m)                    &
3396                              * ( t_wall_v(l)%t(kw,m) - t_wall_v(l)%t(kw-1,m) )&
3397                              * surf_usm_v(l)%ddz_wall(kw,m)                   &
3398                              ) * surf_usm_v(l)%ddz_wall_stag(kw,m)
3399               ENDDO
3400
3401              t_wall_v_p(l)%t(nzb_wall:nzt_wall,m) =                           &
3402                                   t_wall_v(l)%t(nzb_wall:nzt_wall,m)          &
3403                                 + dt_3d * ( tsc(2)                            &
3404                                 * wtend(nzb_wall:nzt_wall) + tsc(3)           &
3405                                 * surf_usm_v(l)%tt_wall_m(nzb_wall:nzt_wall,m) )   
3406           
3407!
3408!--           calculate t_wall tendencies for the next Runge-Kutta step
3409              IF ( timestep_scheme(1:5) == 'runge' )  THEN
3410                  IF ( intermediate_timestep_count == 1 )  THEN
3411                     DO  kw = nzb_wall, nzt_wall
3412                        surf_usm_v(l)%tt_wall_m(kw,m) = wtend(kw)
3413                     ENDDO
3414                  ELSEIF ( intermediate_timestep_count <                       &
3415                           intermediate_timestep_count_max )  THEN
3416                      DO  kw = nzb_wall, nzt_wall
3417                         surf_usm_v(l)%tt_wall_m(kw,m) =                       &
3418                                     - 9.5625_wp * wtend(kw) +                 &
3419                                       5.3125_wp * surf_usm_v(l)%tt_wall_m(kw,m)
3420                      ENDDO
3421                  ENDIF
3422              ENDIF
3423           ENDDO
3424        ENDDO
3425
3426    END SUBROUTINE usm_material_heat_model
3427
3428
3429!------------------------------------------------------------------------------!
3430! Description:
3431! ------------
3432!> Parin for &usm_par for urban surface model
3433!------------------------------------------------------------------------------!
3434    SUBROUTINE usm_parin
3435
3436       IMPLICIT NONE
3437
3438       CHARACTER (LEN=80) ::  line  !< string containing current line of file PARIN
3439
3440       NAMELIST /urban_surface_par/                                            &
3441                           land_category,                                      &
3442                           mrt_factors,                                        &
3443                           nrefsteps,                                          &
3444                           pedestrant_category,                                &
3445                           ra_horiz_coef,                                      &
3446                           read_svf_on_init,                                   &
3447                           roof_category,                                      &
3448                           split_diffusion_radiation,                          &
3449                           urban_surface,                                      &
3450                           usm_anthropogenic_heat,                             &
3451                           usm_energy_balance_land,                            &
3452                           usm_energy_balance_wall,                            &
3453                           usm_material_model,                                 &
3454                           usm_lad_rma,                                        &
3455                           wall_category,                                      &
3456                           write_svf_on_init
3457
3458       line = ' '
3459
3460!
3461!--    Try to find urban surface model package
3462       REWIND ( 11 )
3463       line = ' '
3464       DO   WHILE ( INDEX( line, '&urban_surface_par' ) == 0 )
3465          READ ( 11, '(A)', END=10 )  line
3466       ENDDO
3467       BACKSPACE ( 11 )
3468
3469!
3470!--    Read user-defined namelist
3471       READ ( 11, urban_surface_par )
3472!
3473!--    Set flag that indicates that the land surface model is switched on
3474       urban_surface = .TRUE.
3475
3476!
3477!--    Activate spinup
3478       IF ( spinup_time > 0.0_wp )  THEN
3479          coupling_start_time = spinup_time
3480          end_time = end_time + spinup_time
3481          IF ( spinup_pt_mean == 9999999.9_wp )  THEN
3482             spinup_pt_mean = pt_surface
3483          ENDIF
3484          spinup = .TRUE.
3485       ENDIF
3486
3487 10    CONTINUE
3488
3489    END SUBROUTINE usm_parin
3490
3491
3492!------------------------------------------------------------------------------!
3493! Description:
3494! ------------
3495!> This subroutine calculates interaction of the solar radiation
3496!> with urban surface and updates surface, roofs and walls heatfluxes.
3497!> It also updates rad_sw_out and rad_lw_out.
3498!------------------------------------------------------------------------------!
3499    SUBROUTINE usm_radiation
3500   
3501        IMPLICIT NONE
3502       
3503        INTEGER(iwp)               :: i, j, k, kk, is, js, d, ku, refstep, m, mm, l, ll
3504        INTEGER(iwp)               :: nzubl, nzutl, isurf, isurfsrc, isurf1, isvf, icsf, ipcgb
3505        INTEGER(iwp), DIMENSION(4) :: bdycross
3506        REAL(wp), DIMENSION(3,3)   :: mrot            !< grid rotation matrix (xyz)
3507        REAL(wp), DIMENSION(3,0:9) :: vnorm           !< face direction normal vectors (xyz)
3508        REAL(wp), DIMENSION(3)     :: sunorig         !< grid rotated solar direction unit vector (xyz)
3509        REAL(wp), DIMENSION(3)     :: sunorig_grid    !< grid squashed solar direction unit vector (zyx)
3510        REAL(wp), DIMENSION(0:9)   :: costheta        !< direct irradiance factor of solar angle
3511        REAL(wp), DIMENSION(nzub:nzut) :: pchf_prep   !< precalculated factor for canopy temp tendency
3512        REAL(wp), PARAMETER        :: alpha = 0._wp   !< grid rotation (TODO: add to namelist or remove)
3513        REAL(wp)                   :: rx, ry, rz
3514        REAL(wp)                   :: pc_box_area, pc_abs_frac, pc_abs_eff
3515        INTEGER(iwp)               :: pc_box_dimshift !< transform for best accuracy
3516        INTEGER(iwp), DIMENSION(0:3) :: reorder = (/ 1, 0, 3, 2 /)
3517       
3518       
3519        IF ( plant_canopy )  THEN
3520            pchf_prep(:) = r_d * (hyp(nzub:nzut) / 100000.0_wp)**0.286_wp &
3521                        / (cp * hyp(nzub:nzut) * dx*dy*dz) !< equals to 1 / (rho * c_p * Vbox * T)
3522        ENDIF
3523
3524        sun_direction = .TRUE.
3525        CALL calc_zenith  !< required also for diffusion radiation
3526
3527!--     prepare rotated normal vectors and irradiance factor
3528        vnorm(1,:) = idir(:)
3529        vnorm(2,:) = jdir(:)
3530        vnorm(3,:) = kdir(:)
3531        mrot(1, :) = (/ cos(alpha), -sin(alpha), 0._wp /)
3532        mrot(2, :) = (/ sin(alpha),  cos(alpha), 0._wp /)
3533        mrot(3, :) = (/ 0._wp,       0._wp,      1._wp /)
3534        sunorig = (/ sun_dir_lon, sun_dir_lat, zenith(0) /)
3535        sunorig = matmul(mrot, sunorig)
3536        DO d = 0, 9
3537            costheta(d) = dot_product(sunorig, vnorm(:,d))
3538        ENDDO
3539       
3540        IF ( zenith(0) > 0 )  THEN
3541!--         now we will "squash" the sunorig vector by grid box size in
3542!--         each dimension, so that this new direction vector will allow us
3543!--         to traverse the ray path within grid coordinates directly
3544            sunorig_grid = (/ sunorig(3)/dz, sunorig(2)/dy, sunorig(1)/dx /)
3545!--         sunorig_grid = sunorig_grid / norm2(sunorig_grid)
3546            sunorig_grid = sunorig_grid / SQRT(SUM(sunorig_grid**2))
3547
3548            IF ( plant_canopy )  THEN
3549!--            precompute effective box depth with prototype Leaf Area Density
3550               pc_box_dimshift = maxloc(sunorig, 1) - 1
3551               CALL usm_box_absorb(cshift((/dx,dy,dz/), pc_box_dimshift),      &
3552                                   60, prototype_lad,                          &
3553                                   cshift(sunorig, pc_box_dimshift),           &
3554                                   pc_box_area, pc_abs_frac)
3555               pc_box_area = pc_box_area * sunorig(pc_box_dimshift+1) / sunorig(3)
3556               pc_abs_eff = log(1._wp - pc_abs_frac) / prototype_lad
3557            ENDIF
3558        ENDIF
3559       
3560!--     split diffusion and direct part of the solar downward radiation
3561!--     comming from radiation model and store it in 2D arrays
3562!--     rad_sw_in_diff, rad_sw_in_dir and rad_lw_in_diff
3563        IF ( split_diffusion_radiation )  THEN
3564            CALL usm_calc_diffusion_radiation
3565        ELSE
3566            rad_sw_in_diff = 0.0_wp
3567            rad_sw_in_dir(:,:)  = rad_sw_in(0,:,:)
3568            rad_lw_in_diff(:,:) = rad_lw_in(0,:,:)
3569        ENDIF
3570
3571!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
3572!--     First pass: direct + diffuse irradiance
3573!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
3574        surfinswdir   = 0._wp !nsurfl
3575        surfinswdif   = 0._wp !nsurfl
3576        surfinlwdif   = 0._wp !nsurfl
3577        surfins       = 0._wp !nsurfl
3578        surfinl       = 0._wp !nsurfl
3579        surfoutsl(:)  = 0.0_wp !start-end
3580        surfoutll(:)  = 0.0_wp !start-end
3581       
3582!--     Set up thermal radiation from surfaces
3583!--     emiss_surf is defined only for surfaces for which energy balance is calculated
3584!--     Workaround: reorder surface data type back on 1D array including all surfaces,
3585!--     which implies to reorder horizontal and vertical surfaces
3586!
3587!--     Horizontal walls
3588        mm = 1
3589        DO  i = nxl, nxr
3590           DO  j = nys, nyn
3591
3592              DO  m = surf_usm_h%start_index(j,i), surf_usm_h%end_index(j,i)
3593                 surfoutll(mm) = surf_usm_h%emiss_surf(m) * sigma_sb   &
3594                                     * t_surf_h(m)**4
3595                 albedo_surf(mm) = surf_usm_h%albedo_surf(m)
3596                 emiss_surf(mm)  = surf_usm_h%emiss_surf(m)
3597                 mm = mm + 1
3598              ENDDO
3599           ENDDO
3600        ENDDO
3601!
3602!--     Vertical walls
3603        DO  i = nxl, nxr
3604           DO  j = nys, nyn
3605              DO  ll = 0, 3
3606                 l = reorder(ll)
3607                 DO  m = surf_usm_v(l)%start_index(j,i), surf_usm_v(l)%end_index(j,i)
3608                    surfoutll(mm) = surf_usm_v(l)%emiss_surf(m) * sigma_sb   &
3609                                     * t_surf_v(l)%t(m)**4
3610                    albedo_surf(mm) = surf_usm_v(l)%albedo_surf(m)
3611                    emiss_surf(mm) = surf_usm_v(l)%emiss_surf(m)
3612                    mm = mm + 1
3613                 ENDDO
3614              ENDDO
3615           ENDDO
3616        ENDDO
3617       
3618#if defined( __parallel )
3619!--     might be optimized and gather only values relevant for current processor
3620       
3621        CALL MPI_AllGatherv(surfoutll, nenergy, MPI_REAL, &
3622                            surfoutl, nsurfs, surfstart, MPI_REAL, comm2d, ierr) !nsurf global
3623#else
3624        surfoutl(:) = surfoutll(:) !nsurf global
3625#endif
3626       
3627        isurf1 = -1   !< previous processed surface
3628        DO isvf = 1, nsvfl
3629            isurf = svfsurf(1, isvf)
3630            k = surfl(iz, isurf)
3631            j = surfl(iy, isurf)
3632            i = surfl(ix, isurf)
3633            isurfsrc = svfsurf(2, isvf)
3634            IF ( zenith(0) > 0  .AND.  isurf /= isurf1 )  THEN
3635!--             locate the virtual surface where the direct solar ray crosses domain boundary
3636!--             (once per target surface)
3637                d = surfl(id, isurf)
3638                rz = REAL(k, wp) - 0.5_wp * kdir(d)
3639                ry = REAL(j, wp) - 0.5_wp * jdir(d)
3640                rx = REAL(i, wp) - 0.5_wp * idir(d)
3641               
3642                CALL usm_find_boundary_face( (/ rz, ry, rx /), sunorig_grid, bdycross)
3643               
3644                isurf1 = isurf
3645            ENDIF
3646
3647            IF ( surf(id, isurfsrc) >= isky )  THEN
3648!--             diffuse rad from boundary surfaces. Since it is a simply
3649!--             calculated value, it is not assigned to surfref(s/l),
3650!--             instead it is used directly here
3651!--             we consider the radiation from the radiation model falling on surface
3652!--             as the radiation falling on the top of urban layer into the place of the source surface
3653!--             we consider it as a very reasonable simplification which allow as avoid
3654!--             necessity of other global range arrays and some all to all mpi communication
3655                surfinswdif(isurf) = surfinswdif(isurf) + rad_sw_in_diff(j,i) * svf(1,isvf) * svf(2,isvf)
3656                                                                !< canopy shading is applied only to shortwave
3657                surfinlwdif(isurf) = surfinlwdif(isurf) + rad_lw_in_diff(j,i) * svf(1,isvf)
3658            ELSE
3659!--             for surface-to-surface factors we calculate thermal radiation in 1st pass
3660                surfinl(isurf) = surfinl(isurf) + svf(1,isvf) * surfoutl(isurfsrc)
3661            ENDIF
3662
3663            IF ( zenith(0) > 0  .AND.  all( surf(1:4,isurfsrc) == bdycross ) )  THEN
3664!--             found svf between model boundary and the face => face isn't shaded
3665                surfinswdir(isurf) = rad_sw_in_dir(j,i) &
3666                    * costheta(surfl(id, isurf)) * svf(2,isvf) / zenith(0)
3667
3668            ENDIF
3669        ENDDO
3670
3671        IF ( plant_canopy )  THEN
3672       
3673            pcbinsw(:) = 0._wp
3674            pcbinlw(:) = 0._wp  !< will stay always 0 since we don't absorb lw anymore
3675            !
3676!--         pcsf first pass
3677            isurf1 = -1  !< previous processed pcgb
3678            DO icsf = 1, ncsfl
3679                ipcgb = csfsurf(1, icsf)
3680                i = pcbl(ix,ipcgb)
3681                j = pcbl(iy,ipcgb)
3682                k = pcbl(iz,ipcgb)
3683                isurfsrc = csfsurf(2, icsf)
3684
3685                IF ( zenith(0) > 0  .AND.  ipcgb /= isurf1 )  THEN
3686!--                 locate the virtual surface where the direct solar ray crosses domain boundary
3687!--                 (once per target PC gridbox)
3688                    rz = REAL(k, wp)
3689                    ry = REAL(j, wp)
3690                    rx = REAL(i, wp)
3691                    CALL usm_find_boundary_face( (/ rz, ry, rx /), &
3692                        sunorig_grid, bdycross)
3693
3694                    isurf1 = ipcgb
3695                ENDIF
3696
3697                IF ( surf(id, isurfsrc) >= isky )  THEN
3698!--                 Diffuse rad from boundary surfaces. See comments for svf above.
3699                    pcbinsw(ipcgb) = pcbinsw(ipcgb) + csf(1,icsf) * csf(2,icsf) * rad_sw_in_diff(j,i)
3700!--                 canopy shading is applied only to shortwave, therefore no absorbtion for lw
3701!--                 pcbinlw(ipcgb) = pcbinlw(ipcgb) + svf(1,isvf) * rad_lw_in_diff(j,i)
3702                !ELSE
3703!--                 Thermal radiation in 1st pass
3704!--                 pcbinlw(ipcgb) = pcbinlw(ipcgb) + svf(1,isvf) * surfoutl(isurfsrc)
3705                ENDIF
3706
3707                IF ( zenith(0) > 0  .AND.  all( surf(1:4,isurfsrc) == bdycross ) )  THEN
3708!--                 found svf between model boundary and the pcgb => pcgb isn't shaded
3709                    pc_abs_frac = 1._wp - exp(pc_abs_eff * lad_s(k,j,i))
3710                    pcbinsw(ipcgb) = pcbinsw(ipcgb) &
3711                        + rad_sw_in_dir(j, i) * pc_box_area * csf(2,icsf) * pc_abs_frac
3712                ENDIF
3713            ENDDO
3714        ENDIF
3715
3716        surfins(startenergy:endenergy) = surfinswdir(startenergy:endenergy) + surfinswdif(startenergy:endenergy)
3717        surfinl(startenergy:endenergy) = surfinl(startenergy:endenergy) + surfinlwdif(startenergy:endenergy)
3718        surfinsw(:) = surfins(:)
3719        surfinlw(:) = surfinl(:)
3720        surfoutsw(:) = 0.0_wp
3721        surfoutlw(:) = surfoutll(:)
3722!         surfhf(startenergy:endenergy) = surfinsw(startenergy:endenergy) + surfinlw(startenergy:endenergy) &
3723!                                       - surfoutsw(startenergy:endenergy) - surfoutlw(startenergy:endenergy)
3724       
3725!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
3726!--     Next passes - reflections
3727!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
3728        DO refstep = 1, nrefsteps
3729       
3730            surfoutsl(startenergy:endenergy) = albedo_surf(startenergy:endenergy) * surfins(startenergy:endenergy)
3731!--         for non-transparent surfaces, longwave albedo is 1 - emissivity
3732            surfoutll(startenergy:endenergy) = (1._wp - emiss_surf(startenergy:endenergy)) * surfinl(startenergy:endenergy)
3733
3734#if defined( __parallel )
3735            CALL MPI_AllGatherv(surfoutsl, nsurfl, MPI_REAL, &
3736                surfouts, nsurfs, surfstart, MPI_REAL, comm2d, ierr)
3737            CALL MPI_AllGatherv(surfoutll, nsurfl, MPI_REAL, &
3738                surfoutl, nsurfs, surfstart, MPI_REAL, comm2d, ierr)
3739#else
3740            surfouts(:) = surfoutsl(:)
3741            surfoutl(:) = surfoutll(:)
3742#endif
3743
3744!--         reset for next pass input
3745            surfins(:) = 0._wp
3746            surfinl(:) = 0._wp
3747           
3748!--         reflected radiation
3749            DO isvf = 1, nsvfl
3750                isurf = svfsurf(1, isvf)
3751                isurfsrc = svfsurf(2, isvf)
3752
3753!--             TODO: to remove if, use start+end for isvf
3754                IF ( surf(id, isurfsrc) < isky )  THEN
3755                    surfins(isurf) = surfins(isurf) + svf(1,isvf) * svf(2,isvf) * surfouts(isurfsrc)
3756                    surfinl(isurf) = surfinl(isurf) + svf(1,isvf) * surfoutl(isurfsrc)
3757                ENDIF
3758            ENDDO
3759
3760!--         radiation absorbed by plant canopy
3761            DO icsf = 1, ncsfl
3762                ipcgb = csfsurf(1, icsf)
3763                isurfsrc = csfsurf(2, icsf)
3764
3765                IF ( surf(id, isurfsrc) < isky )  THEN
3766                    pcbinsw(ipcgb) = pcbinsw(ipcgb) + csf(1,icsf) * csf(2,icsf) * surfouts(isurfsrc)
3767!--                 pcbinlw(ipcgb) = pcbinlw(ipcgb) + csf(1,icsf) * surfoutl(isurfsrc)
3768                ENDIF
3769            ENDDO
3770           
3771            surfinsw(:) = surfinsw(:)  + surfins(:)
3772            surfinlw(:) = surfinlw(:)  + surfinl(:)
3773            surfoutsw(startenergy:endenergy) = surfoutsw(startenergy:endenergy) + surfoutsl(startenergy:endenergy)
3774            surfoutlw(startenergy:endenergy) = surfoutlw(startenergy:endenergy) + surfoutll(startenergy:endenergy)
3775!             surfhf(startenergy:endenergy) = surfinsw(startenergy:endenergy) + surfinlw(startenergy:endenergy) &
3776!                                           - surfoutsw(startenergy:endenergy) - surfoutlw(startenergy:endenergy)
3777       
3778        ENDDO
3779
3780!--     push heat flux absorbed by plant canopy to respective 3D arrays
3781        IF ( plant_canopy )  THEN
3782            pc_heating_rate(:,:,:) = 0._wp
3783            DO ipcgb = 1, npcbl
3784                j = pcbl(iy, ipcgb)
3785                i = pcbl(ix, ipcgb)
3786                k = pcbl(iz, ipcgb)
3787!
3788!--             Following expression equals former kk = k - nzb_s_inner(j,i)
3789                kk = k - ( get_topography_top_index( j, i, 's' ) )  !- lad arrays are defined flat
3790                pc_heating_rate(kk, j, i) = (pcbinsw(ipcgb) + pcbinlw(ipcgb)) &
3791                    * pchf_prep(k) * pt(k, j, i) !-- = dT/dt
3792            ENDDO
3793        ENDIF
3794!
3795!--     Transfer radiation arrays required for energy balance to the respective data types
3796        DO  i = startenergy, endenergy
3797           m  = surfl(5,i)         
3798!
3799!--        upward-facing
3800           IF ( surfl(1,i) == 0 )  THEN
3801              surf_usm_h%rad_in_sw(m)  = surfinsw(i) 
3802              surf_usm_h%rad_out_sw(m) = surfoutsw(i) 
3803              surf_usm_h%rad_in_lw(m)  = surfinlw(i)
3804              surf_usm_h%rad_out_lw(m) = surfoutlw(i)
3805!
3806!--        southward-facding
3807           ELSEIF ( surfl(1,i) == 1 )  THEN
3808              surf_usm_v(1)%rad_in_sw(m)  = surfinsw(i) 
3809              surf_usm_v(1)%rad_out_sw(m) = surfoutsw(i) 
3810              surf_usm_v(1)%rad_in_lw(m)  = surfinlw(i)
3811              surf_usm_v(1)%rad_out_lw(m) = surfoutlw(i)
3812!
3813!--        northward-facding
3814           ELSEIF ( surfl(1,i) == 2 )  THEN
3815              surf_usm_v(0)%rad_in_sw(m)  = surfinsw(i) 
3816              surf_usm_v(0)%rad_out_sw(m) = surfoutsw(i) 
3817              surf_usm_v(0)%rad_in_lw(m)  = surfinlw(i)
3818              surf_usm_v(0)%rad_out_lw(m) = surfoutlw(i)
3819!
3820!--        westward-facding
3821           ELSEIF ( surfl(1,i) == 3 )  THEN
3822              surf_usm_v(3)%rad_in_sw(m)  = surfinsw(i) 
3823              surf_usm_v(3)%rad_out_sw(m) = surfoutsw(i) 
3824              surf_usm_v(3)%rad_in_lw(m)  = surfinlw(i)
3825              surf_usm_v(3)%rad_out_lw(m) = surfoutlw(i)
3826!
3827!--        eastward-facing
3828           ELSEIF ( surfl(1,i) == 4 )  THEN
3829              surf_usm_v(2)%rad_in_sw(m)  = surfinsw(i) 
3830              surf_usm_v(2)%rad_out_sw(m) = surfoutsw(i) 
3831              surf_usm_v(2)%rad_in_lw(m)  = surfinlw(i)
3832              surf_usm_v(2)%rad_out_lw(m) = surfoutlw(i)
3833           ENDIF
3834
3835        ENDDO
3836
3837
3838        DO  m = 1, surf_usm_h%ns
3839           surf_usm_h%surfhf(m) = surf_usm_h%rad_in_sw(m)  +                   &
3840                                  surf_usm_h%rad_in_lw(m)  -                   &
3841                                  surf_usm_h%rad_out_sw(m) -                   &
3842                                  surf_usm_h%rad_out_lw(m)
3843        ENDDO
3844
3845        DO  l = 0, 3
3846           DO  m = 1, surf_usm_v(l)%ns
3847              surf_usm_v(l)%surfhf(m) = surf_usm_v(l)%rad_in_sw(m)  +          &
3848                                        surf_usm_v(l)%rad_in_lw(m)  -          &
3849                                        surf_usm_v(l)%rad_out_sw(m) -          &
3850                                        surf_usm_v(l)%rad_out_lw(m)
3851           ENDDO
3852        ENDDO
3853
3854!--     return surface radiation to horizontal surfaces
3855!--     to rad_sw_in, rad_lw_in and rad_net for outputs
3856        !!!!!!!!!!
3857!--     we need the original radiation on urban top layer
3858!--     for calculation of MRT so we can't do adjustment here for now
3859        !!!!!!!!!!
3860        !!!DO isurf = 1, nsurfl
3861        !!!    i = surfl(ix,isurf)
3862        !!!    j = surfl(iy,isurf)
3863        !!!    k = surfl(iz,isurf)
3864        !!!    d = surfl(id,isurf)
3865        !!!    IF ( d==iroof )  THEN
3866        !!!        rad_sw_in(:,j,i) = surfinsw(isurf)
3867        !!!        rad_lw_in(:,j,i) = surfinlw(isurf)
3868        !!!        rad_net(j,i) = rad_sw_in(k,j,i) - rad_sw_out(k,j,i) + rad_lw_in(k,j,i) - rad_lw_out(k,j,i)
3869        !!!    ENDIF
3870        !!!ENDDO
3871
3872    END SUBROUTINE usm_radiation
3873
3874   
3875!------------------------------------------------------------------------------!
3876! Description:
3877! ------------
3878!> Raytracing for detecting obstacles and calculating compound canopy sink
3879!> factors. (A simple obstacle detection would only need to process faces in
3880!> 3 dimensions without any ordering.)
3881!> Assumtions:
3882!> -----------
3883!> 1. The ray always originates from a face midpoint (only one coordinate equals
3884!>    *.5, i.e. wall) and doesn't travel parallel to the surface (that would mean
3885!>    shape factor=0). Therefore, the ray may never travel exactly along a face
3886!>    or an edge.
3887!> 2. From grid bottom to urban surface top the grid has to be *equidistant*
3888!>    within each of the dimensions, including vertical (but the resolution
3889!>    doesn't need to be the same in all three dimensions).
3890!------------------------------------------------------------------------------!
3891    SUBROUTINE usm_raytrace(src, targ, isrc, rirrf, atarg, create_csf, visible, transparency, win_lad)
3892        IMPLICIT NONE
3893
3894        REAL(wp), DIMENSION(3), INTENT(in)     :: src, targ    !< real coordinates z,y,x
3895        INTEGER(iwp), INTENT(in)               :: isrc         !< index of source face for csf
3896        REAL(wp), INTENT(in)                   :: rirrf        !< irradiance factor for csf
3897        REAL(wp), INTENT(in)                   :: atarg        !< target surface area for csf
3898        LOGICAL, INTENT(in)                    :: create_csf   !< whether to generate new CSFs during raytracing
3899        LOGICAL, INTENT(out)                   :: visible
3900        REAL(wp), INTENT(out)                  :: transparency !< along whole path
3901        INTEGER(iwp), INTENT(in)               :: win_lad
3902        INTEGER(iwp)                           :: i, j, k, d
3903        INTEGER(iwp)                           :: seldim       !< dimension to be incremented
3904        INTEGER(iwp)                           :: ncsb         !< no of written plant canopy sinkboxes
3905        INTEGER(iwp)                           :: maxboxes     !< max no of gridboxes visited
3906        REAL(wp)                               :: distance     !< euclidean along path
3907        REAL(wp)                               :: crlen        !< length of gridbox crossing
3908        REAL(wp)                               :: lastdist     !< beginning of current crossing
3909        REAL(wp)                               :: nextdist     !< end of current crossing
3910        REAL(wp)                               :: realdist     !< distance in meters per unit distance
3911        REAL(wp)                               :: crmid        !< midpoint of crossing
3912        REAL(wp)                               :: cursink      !< sink factor for current canopy box
3913        REAL(wp), DIMENSION(3)                 :: delta        !< path vector
3914        REAL(wp), DIMENSION(3)                 :: uvect        !< unit vector
3915        REAL(wp), DIMENSION(3)                 :: dimnextdist  !< distance for each dimension increments
3916        INTEGER(iwp), DIMENSION(3)             :: box          !< gridbox being crossed
3917        INTEGER(iwp), DIMENSION(3)             :: dimnext      !< next dimension increments along path
3918        INTEGER(iwp), DIMENSION(3)             :: dimdelta     !< dimension direction = +- 1
3919        INTEGER(iwp)                           :: px, py       !< number of processors in x and y dir before
3920                                                               !< the processor in the question
3921        INTEGER(iwp)                           :: ip           !< number of processor where gridbox reside
3922        INTEGER(iwp)                           :: ig           !< 1D index of gridbox in global 2D array
3923        REAL(wp)                               :: lad_s_target !< recieved lad_s of particular grid box
3924        REAL(wp), PARAMETER                    :: grow_factor = 1.5_wp !< factor of expansion of grow arrays
3925
3926!
3927!--     Maximum number of gridboxes visited equals to maximum number of boundaries crossed in each dimension plus one. That's also
3928!--     the maximum number of plant canopy boxes written. We grow the acsf array accordingly using exponential factor.
3929        maxboxes = SUM(ABS(NINT(targ) - NINT(src))) + 1
3930        IF ( plant_canopy  .AND.  ncsfl + maxboxes > ncsfla )  THEN
3931!--         use this code for growing by fixed exponential increments (equivalent to case where ncsfl always increases by 1)
3932!--         k = CEILING(grow_factor ** real(CEILING(log(real(ncsfl + maxboxes, kind=wp)) &
3933!--                                                / log(grow_factor)), kind=wp))
3934!--         or use this code to simply always keep some extra space after growing
3935            k = CEILING(REAL(ncsfl + maxboxes, kind=wp) * grow_factor)
3936
3937            CALL usm_merge_and_grow_csf(k)
3938        ENDIF
3939       
3940        transparency = 1._wp
3941        ncsb = 0
3942
3943        delta(:) = targ(:) - src(:)
3944        distance = SQRT(SUM(delta(:)**2))
3945        IF ( distance == 0._wp )  THEN
3946            visible = .TRUE.
3947            RETURN
3948        ENDIF
3949        uvect(:) = delta(:) / distance
3950        realdist = SQRT(SUM( (uvect(:)*(/dz,dy,dx/))**2 ))
3951
3952        lastdist = 0._wp
3953
3954!--     Since all face coordinates have values *.5 and we'd like to use
3955!--     integers, all these have .5 added
3956        DO d = 1, 3
3957            IF ( uvect(d) == 0._wp )  THEN
3958                dimnext(d) = 999999999
3959                dimdelta(d) = 999999999
3960                dimnextdist(d) = 1.0E20_wp
3961            ELSE IF ( uvect(d) > 0._wp )  THEN
3962                dimnext(d) = CEILING(src(d) + .5_wp)
3963                dimdelta(d) = 1
3964                dimnextdist(d) = (dimnext(d) - .5_wp - src(d)) / uvect(d)
3965            ELSE
3966                dimnext(d) = FLOOR(src(d) + .5_wp)
3967                dimdelta(d) = -1
3968                dimnextdist(d) = (dimnext(d) - .5_wp - src(d)) / uvect(d)
3969            ENDIF
3970        ENDDO
3971
3972        DO
3973!--         along what dimension will the next wall crossing be?
3974            seldim = minloc(dimnextdist, 1)
3975            nextdist = dimnextdist(seldim)
3976            IF ( nextdist > distance ) nextdist = distance
3977
3978            crlen = nextdist - lastdist
3979            IF ( crlen > .001_wp )  THEN
3980                crmid = (lastdist + nextdist) * .5_wp
3981                box = NINT(src(:) + uvect(:) * crmid)
3982
3983!--             calculate index of the grid with global indices (box(2),box(3))
3984!--             in the array nzterr and plantt and id of the coresponding processor
3985                px = box(3)/nnx
3986                py = box(2)/nny
3987                ip = px*pdims(2)+py
3988                ig = ip*nnx*nny + (box(3)-px*nnx)*nny + box(2)-py*nny
3989                IF ( box(1) <= nzterr(ig) )  THEN
3990                    visible = .FALSE.
3991                    RETURN
3992                ENDIF
3993
3994                IF ( plant_canopy )  THEN
3995                    IF ( box(1) <= plantt(ig) )  THEN
3996                        ncsb = ncsb + 1
3997                        boxes(:,ncsb) = box
3998                        crlens(ncsb) = crlen
3999#if defined( __parallel )
4000                        lad_ip(ncsb) = ip
4001                        lad_disp(ncsb) = (box(3)-px*nnx)*(nny*nzu) + (box(2)-py*nny)*nzu + box(1)-nzub
4002#endif
4003                    ENDIF
4004                ENDIF
4005            ENDIF
4006
4007            IF ( nextdist >= distance ) EXIT
4008            lastdist = nextdist
4009            dimnext(seldim) = dimnext(seldim) + dimdelta(seldim)
4010            dimnextdist(seldim) = (dimnext(seldim) - .5_wp - src(seldim)) / uvect(seldim)
4011        ENDDO
4012       
4013        IF ( plant_canopy )  THEN
4014#if defined( __parallel )
4015            IF ( usm_lad_rma )  THEN
4016!--             send requests for lad_s to appropriate processor
4017                CALL cpu_log( log_point_s(77), 'usm_init_rma', 'start' )
4018                DO i = 1, ncsb
4019                    CALL MPI_Get(lad_s_ray(i), 1, MPI_REAL, lad_ip(i), lad_disp(i), &
4020                                 1, MPI_REAL, win_lad, ierr)
4021                    IF ( ierr /= 0 )  THEN
4022                        WRITE(message_string, *) 'MPI error ', ierr, ' at MPI_Get'
4023                        CALL message( 'usm_raytrace', 'PA0519', 1, 2, 0, 6, 0 )
4024                    ENDIF
4025                ENDDO
4026               
4027!--             wait for all pending local requests complete
4028                CALL MPI_Win_flush_local_all(win_lad, ierr)
4029                IF ( ierr /= 0 )  THEN
4030                    WRITE(message_string, *) 'MPI error ', ierr, ' at MPI_Win_flush_local_all'
4031                    CALL message( 'usm_raytrace', 'PA0519', 1, 2, 0, 6, 0 )
4032                ENDIF
4033                CALL cpu_log( log_point_s(77), 'usm_init_rma', 'stop' )
4034               
4035            ENDIF
4036#endif
4037
4038!--         calculate csf and transparency
4039            DO i = 1, ncsb
4040#if defined( __parallel )
4041                IF ( usm_lad_rma )  THEN
4042                    lad_s_target = lad_s_ray(i)
4043                ELSE
4044                    lad_s_target = usm_lad_g(lad_ip(i)*nnx*nny*nzu + lad_disp(i))
4045                ENDIF
4046#else
4047                lad_s_target = usm_lad(boxes(1,i),boxes(2,i),boxes(3,i))
4048#endif
4049                cursink = 1._wp - exp(-ext_coef * lad_s_target * crlens(i)*realdist)
4050
4051                IF ( create_csf )  THEN
4052!--                 write svf values into the array
4053                    ncsfl = ncsfl + 1
4054                    acsf(ncsfl)%ip = lad_ip(i)
4055                    acsf(ncsfl)%itx = boxes(3,i)
4056                    acsf(ncsfl)%ity = boxes(2,i)
4057                    acsf(ncsfl)%itz = boxes(1,i)
4058                    acsf(ncsfl)%isurfs = isrc
4059                    acsf(ncsfl)%rsvf = REAL(cursink*rirrf*atarg, wp) !-- we postpone multiplication by transparency
4060                    acsf(ncsfl)%rtransp = REAL(transparency, wp)
4061                ENDIF  !< create_csf
4062
4063                transparency = transparency * (1._wp - cursink)
4064               
4065            ENDDO
4066        ENDIF
4067       
4068        visible = .TRUE.
4069
4070    END SUBROUTINE usm_raytrace
4071   
4072 
4073!------------------------------------------------------------------------------!
4074! Description:
4075! ------------
4076!
4077!> This subroutine is part of the urban surface model.
4078!> It reads daily heat produced by anthropogenic sources
4079!> and the diurnal cycle of the heat.
4080!------------------------------------------------------------------------------!
4081    SUBROUTINE usm_read_anthropogenic_heat
4082   
4083        INTEGER(iwp)                  :: i,j,ii
4084        REAL(wp)                      :: heat
4085       
4086!--     allocation of array of sources of anthropogenic heat and their diural profile
4087        ALLOCATE( aheat(nys:nyn,nxl:nxr) )
4088        ALLOCATE( aheatprof(0:24) )
4089
4090!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
4091!--     read daily amount of heat and its daily cycle
4092!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
4093        aheat = 0.0_wp
4094        DO  ii = 0, io_blocks-1
4095            IF ( ii == io_group )  THEN
4096
4097!--             open anthropogenic heat file
4098                OPEN( 151, file='ANTHROPOGENIC_HEAT'//TRIM(coupling_char), action='read', &
4099                           status='old', form='formatted', err=11 )
4100                i = 0
4101                j = 0
4102                DO
4103                    READ( 151, *, err=12, end=13 )  i, j, heat
4104                    IF ( i >= nxl  .AND.  i <= nxr  .AND.  j >= nys  .AND.  j <= nyn )  THEN
4105!--                     write heat into the array
4106                        aheat(j,i) = heat
4107                    ENDIF
4108                    CYCLE
4109 12                 WRITE(message_string,'(a,2i4)') 'error in file ANTHROPOGENIC_HEAT'//TRIM(coupling_char)//' after line ',i,j
4110                    CALL message( 'usm_read_anthropogenic_heat', 'PA0515', 0, 1, 0, 6, 0 )
4111                ENDDO
4112 13             CLOSE(151)
4113                CYCLE
4114 11             message_string = 'file ANTHROPOGENIC_HEAT'//TRIM(coupling_char)//' does not exist'
4115                CALL message( 'usm_read_anthropogenic_heat', 'PA0516', 1, 2, 0, 6, 0 )
4116            ENDIF
4117           
4118#if defined( __parallel ) && ! defined ( __check )
4119            CALL MPI_BARRIER( comm2d, ierr )
4120#endif
4121        ENDDO
4122       
4123!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
4124!--     read diurnal profiles of heat sources
4125!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
4126        aheatprof = 0.0_wp
4127        DO  ii = 0, io_blocks-1
4128            IF ( ii == io_group )  THEN
4129
4130!--             open anthropogenic heat profile file
4131                OPEN( 151, file='ANTHROPOGENIC_HEAT_PROFILE'//TRIM(coupling_char), action='read', &
4132                           status='old', form='formatted', err=21 )
4133                i = 0
4134                DO
4135                    READ( 151, *, err=22, end=23 )  i, heat
4136                    IF ( i >= 0  .AND.  i <= 24 )  THEN
4137!--                     write heat into the array
4138                        aheatprof(i) = heat
4139                    ENDIF
4140                    CYCLE
4141 22                 WRITE(message_string,'(a,i4)') 'error in file ANTHROPOGENIC_HEAT_PROFILE'// &
4142                                                     TRIM(coupling_char)//' after line ',i
4143                    CALL message( 'usm_read_anthropogenic_heat', 'PA0517', 0, 1, 0, 6, 0 )
4144                ENDDO
4145                aheatprof(24) = aheatprof(0)
4146 23             CLOSE(151)
4147                CYCLE
4148 21             message_string = 'file ANTHROPOGENIC_HEAT_PROFILE'//TRIM(coupling_char)//' does not exist'
4149                CALL message( 'usm_read_anthropogenic_heat', 'PA0518', 1, 2, 0, 6, 0 )
4150            ENDIF
4151           
4152#if defined( __parallel ) && ! defined ( __check )
4153            CALL MPI_BARRIER( comm2d, ierr )
4154#endif
4155        ENDDO
4156       
4157    END SUBROUTINE usm_read_anthropogenic_heat
4158   
4159
4160!------------------------------------------------------------------------------!
4161!
4162! Description:
4163! ------------
4164!> Soubroutine reads t_surf and t_wall data from restart files
4165!kanani: Renamed this routine according to corresponging routines in PALM
4166!kanani: Modified the routine to match read_var_list, from where usm_read_restart_data
4167!        shall be called in the future. This part has not been tested yet. (see virtual_flight_mod)
4168!        Also, I had some trouble with the allocation of t_surf, since this is a pointer.
4169!        So, I added some directives here.
4170!------------------------------------------------------------------------------!
4171    SUBROUTINE usm_read_restart_data( ii,                                      &
4172                                      nxlfa, nxl_on_file, nxrfa, nxr_on_file,  &
4173                                      nynfa, nyn_on_file, nysfa, nys_on_file,  &
4174                                      offset_xa, offset_ya, overlap_count )
4175
4176
4177       USE pegrid,                                                             &
4178           ONLY: numprocs_previous_run
4179           
4180       IMPLICIT NONE
4181
4182       CHARACTER (LEN=1)  ::  dum              !< dummy to create correct string for reading input variable
4183       CHARACTER (LEN=30) ::  field_chr        !< input variable
4184
4185       INTEGER(iwp)       ::  l                !< index variable for surface type
4186       INTEGER(iwp)       ::  ii               !< running index over input files
4187       INTEGER(iwp)       ::  kk               !< running index over previous input files covering current local domain
4188       INTEGER(iwp)       ::  ns_h_on_file_usm !< number of horizontal surface elements (urban type) on file
4189       INTEGER(iwp)       ::  nxlc             !< index of left boundary on current subdomain
4190       INTEGER(iwp)       ::  nxlf             !< index of left boundary on former subdomain
4191       INTEGER(iwp)       ::  nxl_on_file      !< index of left boundary on former local domain
4192       INTEGER(iwp)       ::  nxrc             !< index of right boundary on current subdomain
4193       INTEGER(iwp)       ::  nxrf             !< index of right boundary on former subdomain
4194       INTEGER(iwp)       ::  nxr_on_file      !< index of right boundary on former local domain 
4195       INTEGER(iwp)       ::  nync             !< index of north boundary on current subdomain
4196       INTEGER(iwp)       ::  nynf             !< index of north boundary on former subdomain
4197       INTEGER(iwp)       ::  nyn_on_file      !< index of norht boundary on former local domain 
4198       INTEGER(iwp)       ::  nysc             !< index of south boundary on current subdomain
4199       INTEGER(iwp)       ::  nysf             !< index of south boundary on former subdomain
4200       INTEGER(iwp)       ::  nys_on_file      !< index of south boundary on former local domain 
4201       INTEGER(iwp)       ::  overlap_count    !< number of overlaps
4202       
4203       INTEGER(iwp)       ::  ns_v_on_file_usm(0:3) !< number of vertical surface elements (urban type) on file
4204 
4205       INTEGER(iwp), DIMENSION(numprocs_previous_run,1000) ::  nxlfa       !<
4206       INTEGER(iwp), DIMENSION(numprocs_previous_run,1000) ::  nxrfa       !<
4207       INTEGER(iwp), DIMENSION(numprocs_previous_run,1000) ::  nynfa       !<
4208       INTEGER(iwp), DIMENSION(numprocs_previous_run,1000) ::  nysfa       !<
4209       INTEGER(iwp), DIMENSION(numprocs_previous_run,1000) ::  offset_xa   !<
4210       INTEGER(iwp), DIMENSION(numprocs_previous_run,1000) ::  offset_ya   !<
4211       
4212       INTEGER(iwp), DIMENSION(nys_on_file:nyn_on_file,nxl_on_file:nxr_on_file) ::  start_index_on_file
4213       INTEGER(iwp), DIMENSION(nys_on_file:nyn_on_file,nxl_on_file:nxr_on_file) ::  end_index_on_file
4214       
4215       REAL(wp), DIMENSION(:), ALLOCATABLE   ::  tmp_surf_h
4216       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  tmp_wall_h
4217       
4218       TYPE( t_surf_vertical ), DIMENSION(0:3) ::  tmp_surf_v
4219       TYPE( t_wall_vertical ), DIMENSION(0:3) ::  tmp_wall_v
4220
4221       
4222       IF ( initializing_actions == 'read_restart_data'  .OR.                  &
4223            initializing_actions == 'cyclic_fill' )  THEN
4224         
4225!
4226!--       Read number of respective surface elements on file
4227          READ ( 13 ) field_chr
4228          IF ( TRIM( field_chr ) /= 'ns_h_on_file_usm' )  THEN
4229!
4230!--          Add a proper error message
4231          ENDIF
4232          READ ( 13 ) ns_h_on_file_usm
4233
4234          READ ( 13 )  field_chr
4235          IF ( TRIM( field_chr ) /= 'ns_v_on_file_usm' )  THEN
4236!
4237!--          Add a proper error message
4238          ENDIF
4239          READ ( 13 ) ns_v_on_file_usm
4240!
4241!--       Allocate temporary arrays for reading data on file. Note, the
4242!--       size of allocated surface elements do not necessarily need to match
4243!--       the size of present surface elements on current processor, as the
4244!--       number of processors between restarts can change.
4245          ALLOCATE( tmp_surf_h(1:ns_h_on_file_usm) )
4246          ALLOCATE( tmp_wall_h(nzb_wall:nzt_wall+1,1:ns_h_on_file_usm) )
4247         
4248          DO  l = 0, 3
4249             ALLOCATE( tmp_surf_v(l)%t(1:ns_v_on_file_usm(l)) )
4250             ALLOCATE( tmp_wall_v(l)%t(nzb_wall:nzt_wall+1,1:ns_v_on_file_usm(l) ) )
4251          ENDDO
4252         
4253       
4254          READ ( 13 )  field_chr
4255
4256          DO  WHILE ( TRIM( field_chr ) /= '*** end usm ***' )
4257!
4258!--          Map data on file as often as needed (data are read only for k=1)
4259             DO  kk = 1, overlap_count
4260!
4261!--             Get the index range of the subdomain on file which overlap with the
4262!--             current subdomain
4263                nxlf = nxlfa(ii,kk)
4264                nxlc = nxlfa(ii,kk) + offset_xa(ii,kk)
4265                nxrf = nxrfa(ii,kk)
4266                nxrc = nxrfa(ii,kk) + offset_xa(ii,kk)
4267                nysf = nysfa(ii,kk)
4268                nysc = nysfa(ii,kk) + offset_ya(ii,kk)
4269                nynf = nynfa(ii,kk)
4270                nync = nynfa(ii,kk) + offset_ya(ii,kk)
4271
4272                SELECT CASE ( TRIM( field_chr ) )     
4273               
4274                   CASE ( 'usm_start_index_h', 'usm_start_index_v'  )   
4275                      IF ( kk == 1 )                                           &
4276                         READ ( 13 )  start_index_on_file
4277                     
4278                   CASE ( 'usm_end_index_h', 'usm_end_index_v' )   
4279                      IF ( kk == 1 )                                           &
4280                         READ ( 13 )  end_index_on_file
4281               
4282                   CASE ( 't_surf_h' )
4283#if defined( __nopointer )                   
4284                      IF ( kk == 1 )  THEN
4285                         IF ( .NOT.  ALLOCATED( t_surf_h ) )                   &
4286                            ALLOCATE( t_surf_h(1:surf_usm_h%ns) )
4287                         READ ( 13 )  tmp_surf_h
4288                      ENDIF
4289                      CALL restore_surface_elements_usm_1d(                    &
4290                                              t_surf_h, tmp_surf_h,            &
4291                                              surf_usm_h%start_index )
4292                      ENDIF
4293#else                     
4294                      IF ( kk == 1 )  THEN
4295                         IF ( .NOT.  ALLOCATED( t_surf_h_1 ) )                 &
4296                            ALLOCATE( t_surf_h_1(1:surf_usm_h%ns) )
4297                         READ ( 13 )  tmp_surf_h
4298                      ENDIF
4299                      CALL restore_surface_elements_usm_1d(                    &
4300                                              t_surf_h_1, tmp_surf_h,          &
4301                                              surf_usm_h%start_index )
4302#endif
4303
4304                   CASE ( 't_surf_v(0)' )
4305#if defined( __nopointer )           
4306                      IF ( kk == 1 )  THEN
4307                         IF ( .NOT.  ALLOCATED( t_surf_v(0)%t ) )              &
4308                            ALLOCATE( t_surf_v(0)%t(1:surf_usm_v(0)%ns) )
4309                         READ ( 13 )  tmp_surf_v(0)%t
4310                      ENDIF
4311                      CALL restore_surface_elements_usm_1d(                    &
4312                                              t_surf_v(0)%t, tmp_surf_v(0)%t,  &
4313                                              surf_usm_v(0)%start_index )
4314                      ENDIF
4315#else                     
4316                      IF ( kk == 1 )  THEN
4317                         IF ( .NOT.  ALLOCATED( t_surf_v_1(0)%t ) )            &
4318                            ALLOCATE( t_surf_v_1(0)%t(1:surf_usm_v(0)%ns) )
4319                         READ ( 13 )  tmp_surf_v(0)%t
4320                      ENDIF
4321                      CALL restore_surface_elements_usm_1d(                    &
4322                                              t_surf_v_1(0)%t, tmp_surf_v(0)%t,&
4323                                              surf_usm_v(0)%start_index )
4324#endif
4325                         
4326                   CASE ( 't_surf_v(1)' )
4327#if defined( __nopointer )       
4328                      IF ( kk == 1 )  THEN
4329                         IF ( .NOT.  ALLOCATED( t_surf_v(1)%t ) )              &
4330                            ALLOCATE( t_surf_v(1)%t(1:surf_usm_v(1)%ns) )
4331                         READ ( 13 )  tmp_surf_v(1)%t
4332                      ENDIF
4333                      CALL restore_surface_elements_usm_1d(                    &
4334                                              t_surf_v(1)%t, tmp_surf_v(1)%t,  &
4335                                              surf_usm_v(1)%start_index )                       
4336#else                     
4337                      IF ( kk == 1 )  THEN
4338                         IF ( .NOT.  ALLOCATED( t_surf_v_1(1)%t ) )            &
4339                            ALLOCATE( t_surf_v_1(1)%t(1:surf_usm_v(1)%ns) )
4340                         READ ( 13 )  tmp_surf_v(1)%t
4341                      ENDIF
4342                      CALL restore_surface_elements_usm_1d(                    &
4343                                              t_surf_v_1(1)%t, tmp_surf_v(1)%t,&
4344                                              surf_usm_v(1)%start_index )
4345#endif
4346
4347                   CASE ( 't_surf_v(2)' )
4348#if defined( __nopointer )         
4349                      IF ( kk == 1 )  THEN
4350                         IF ( .NOT.  ALLOCATED( t_surf_v(2)%t ) )              &
4351                            ALLOCATE( t_surf_v(2)%t(1:surf_usm_v(2)%ns) )
4352                         READ ( 13 )  tmp_surf_v(2)%t
4353                      ENDIF
4354                      CALL restore_surface_elements_usm_1d(                    &
4355                                              t_surf_v(2)%t, tmp_surf_v(2)%t,  &
4356                                              surf_usm_v(2)%start_index )
4357#else                     
4358                      IF ( kk == 1 )  THEN
4359                         IF ( .NOT.  ALLOCATED( t_surf_v_1(2)%t ) )            &
4360                            ALLOCATE( t_surf_v_1(2)%t(1:surf_usm_v(2)%ns) )
4361                         READ ( 13 )  tmp_surf_v(2)%t
4362                      ENDIF
4363                      CALL restore_surface_elements_usm_1d(                    &
4364                                              t_surf_v_1(2)%t, tmp_surf_v(2)%t,&
4365                                              surf_usm_v(2)%start_index ) 
4366#endif
4367                         
4368                   CASE ( 't_surf_v(3)' )
4369#if defined( __nopointer )   
4370                      IF ( kk == 1 )  THEN
4371                         IF ( .NOT.  ALLOCATED( t_surf_v(3)%t ) )              &
4372                            ALLOCATE( t_surf_v(3)%t(1:surf_usm_v(3)%ns) )
4373                         READ ( 13 )  tmp_surf_v(3)%t
4374                      ENDIF
4375                      CALL restore_surface_elements_usm_1d(                    &
4376                                              t_surf_v(3)%t, tmp_surf_v(3)%t,  &
4377                                              surf_usm_v(3)%start_index ) 
4378#else                     
4379                      IF ( kk == 1 )  THEN
4380                         IF ( .NOT.  ALLOCATED( t_surf_v_1(3)%t ) )            &
4381                            ALLOCATE( t_surf_v_1(3)%t(1:surf_usm_v(3)%ns) )
4382                         READ ( 13 )  tmp_surf_v(3)%t
4383                      ENDIF
4384                      CALL restore_surface_elements_usm_1d(                    &
4385                                              t_surf_v_1(3)%t, tmp_surf_v(3)%t,&
4386                                              surf_usm_v(3)%start_index )
4387#endif
4388                   CASE ( 't_wall_h' )
4389#if defined( __nopointer )
4390                      IF ( kk == 1 )  THEN
4391                         IF ( .NOT.  ALLOCATED( t_wall_h ) )                   &
4392                            ALLOCATE( t_wall_h(nzb_wall:nzt_wall+1,1:surf_usm_h%ns) )
4393                         READ ( 13 )  tmp_wall_h
4394                      ENDIF
4395                      CALL restore_surface_elements_usm_2d(                    &
4396                                              t_wall_h, tmp_wall_h,            &
4397                                              surf_usm_h%start_index )
4398#else
4399                      IF ( kk == 1 )  THEN
4400                         IF ( .NOT.  ALLOCATED( t_wall_h_1 ) )                 &
4401                            ALLOCATE( t_wall_h_1(nzb_wall:nzt_wall+1,1:surf_usm_h%ns) )
4402                         READ ( 13 )  tmp_wall_h
4403                      ENDIF
4404                      CALL restore_surface_elements_usm_2d(                    &
4405                                              t_wall_h_1, tmp_wall_h,          &
4406                                              surf_usm_h%start_index )
4407#endif
4408                   CASE ( 't_wall_v(0)' )
4409#if defined( __nopointer )
4410                      IF ( kk == 1 )  THEN
4411                         IF ( .NOT.  ALLOCATED( t_wall_v(0)%t ) )              &
4412                            ALLOCATE( t_wall_v(0)%t(nzb_wall:nzt_wall+1,1:surf_usm_v(0)%ns) )
4413                         READ ( 13 )  tmp_wall_v(0)%t
4414                      ENDIF
4415                      CALL restore_surface_elements_usm_2d(                    &
4416                                              t_wall_v(0)%t, tmp_wall_v(0)%t,  &
4417                                              surf_usm_v(0)%start_index )
4418#else
4419                      IF ( kk == 1 )  THEN
4420                         IF ( .NOT.  ALLOCATED( t_wall_v_1(0)%t ) )            &
4421                            ALLOCATE( t_wall_v_1(0)%t(nzb_wall:nzt_wall+1,1:surf_usm_v(0)%ns) )
4422                         READ ( 13 )  tmp_wall_v(0)%t
4423                      ENDIF
4424                      CALL restore_surface_elements_usm_2d(                    &
4425                                              t_wall_v_1(0)%t, tmp_wall_v(0)%t,&
4426                                              surf_usm_v(0)%start_index )
4427#endif
4428                   CASE ( 't_wall_v(1)' )
4429#if defined( __nopointer )
4430                      IF ( kk == 1 )  THEN
4431                         IF ( .NOT.  ALLOCATED( t_wall_v(1)%t ) )              &
4432                            ALLOCATE( t_wall_v(1)%t(nzb_wall:nzt_wall+1,1:surf_usm_v(1)%ns) )
4433                         READ ( 13 )  tmp_wall_v(1)%t
4434                      ENDIF
4435                      CALL restore_surface_elements_usm_2d(                    &
4436                                              t_wall_v(1)%t, tmp_wall_v(1)%t,  &
4437                                              surf_usm_v(1)%start_index )
4438#else
4439                      IF ( kk == 1 )  THEN
4440                         IF ( .NOT.  ALLOCATED( t_wall_v_1(1)%t ) )            &
4441                            ALLOCATE( t_wall_v_1(1)%t(nzb_wall:nzt_wall+1,1:surf_usm_v(1)%ns) )
4442                         READ ( 13 )  tmp_wall_v(1)%t
4443                      ENDIF
4444                      CALL restore_surface_elements_usm_2d(                    &
4445                                              t_wall_v_1(1)%t, tmp_wall_v(1)%t,&
4446                                              surf_usm_v(1)%start_index )
4447#endif
4448                   CASE ( 't_wall_v(2)' )
4449#if defined( __nopointer )
4450                      IF ( kk == 1 )  THEN
4451                         IF ( .NOT.  ALLOCATED( t_wall_v(2)%t ) )              &
4452                            ALLOCATE( t_wall_v(2)%t(nzb_wall:nzt_wall+1,1:surf_usm_v(2)%ns) )
4453                         READ ( 13 )  tmp_wall_v(2)%t
4454                      ENDIF
4455                      CALL restore_surface_elements_usm_2d(                    &
4456                                              t_wall_v(2)%t, tmp_wall_v(2)%t,  &
4457                                              surf_usm_v(2)%start_index )
4458                      ENDIF
4459#else
4460                      IF ( kk == 1 )  THEN
4461                         IF ( .NOT.  ALLOCATED( t_wall_v_1(2)%t ) )            &
4462                            ALLOCATE( t_wall_v_1(2)%t(nzb_wall:nzt_wall+1,1:surf_usm_v(2)%ns) )
4463                         READ ( 13 )  tmp_wall_v(2)%t
4464                      ENDIF
4465                      CALL restore_surface_elements_usm_2d(                    &
4466                                              t_wall_v_1(2)%t, tmp_wall_v(2)%t,&
4467                                              surf_usm_v(2)%start_index )
4468#endif
4469                   CASE ( 't_wall_v(3)' )
4470#if defined( __nopointer )
4471                      IF ( kk == 1 )  THEN
4472                         IF ( .NOT.  ALLOCATED( t_wall_v(3)%t ) )              &
4473                            ALLOCATE( t_wall_v(3)%t(nzb_wall:nzt_wall+1,1:surf_usm_v(3)%ns) )
4474                         READ ( 13 )  tmp_wall_v(3)%t
4475                      ENDIF
4476                      CALL restore_surface_elements_usm_2d(                    &
4477                                              t_wall_v(3)%t, tmp_wall_v(3)%t,  &
4478                                              surf_usm_v(3)%start_index )
4479#else
4480                      IF ( kk == 1 )  THEN
4481                         IF ( .NOT.  ALLOCATED( t_wall_v_1(3)%t ) )            &
4482                            ALLOCATE( t_wall_v_1(3)%t(nzb_wall:nzt_wall+1,1:surf_usm_v(3)%ns) )
4483                         READ ( 13 )  tmp_wall_v(3)%t
4484                      ENDIF
4485                      CALL restore_surface_elements_usm_2d(                    &
4486                                              t_wall_v_1(3)%t, tmp_wall_v(3)%t,&
4487                                              surf_usm_v(3)%start_index )
4488#endif
4489
4490                   CASE DEFAULT
4491                      WRITE ( message_string, * )  'unknown variable named "', &
4492                                        TRIM( field_chr ), '" found in',       &
4493                                        '&data from prior run on PE ', myid
4494                      CALL message( 'user_read_restart_data', 'UI0012', 1, 2, 0, 6, 0 )
4495
4496                END SELECT
4497
4498             ENDDO
4499
4500             READ ( 13 )  field_chr
4501
4502          ENDDO
4503
4504       ENDIF
4505       
4506       CONTAINS
4507       
4508          SUBROUTINE restore_surface_elements_usm_1d( surf_target, surf_file, start_index_c )
4509
4510             IMPLICIT NONE
4511       
4512             INTEGER(iwp) ::  i         !< running index along x-direction, refers to former domain size
4513             INTEGER(iwp) ::  ic        !< running index along x-direction, refers to current domain size
4514             INTEGER(iwp) ::  j         !< running index along y-direction, refers to former domain size
4515             INTEGER(iwp) ::  jc        !< running index along y-direction, refers to former domain size       
4516             INTEGER(iwp) ::  m         !< surface-element index on file
4517             INTEGER(iwp) ::  mm        !< surface-element index on current subdomain
4518
4519             INTEGER(iwp), DIMENSION(nys:nyn,nxl:nxr) ::  start_index_c             
4520             
4521             REAL(wp), DIMENSION(:) ::  surf_target !< target surface type
4522             REAL(wp), DIMENSION(:) ::  surf_file   !< surface type on file
4523             
4524             ic = nxlc
4525             DO  i = nxlf, nxrf
4526                jc = nysc
4527                DO  j = nysf, nynf
4528
4529                   mm = start_index_c(jc,ic)
4530                   DO  m = start_index_on_file(j,i), end_index_on_file(j,i)
4531                      surf_target(mm) = surf_file(m)
4532                      mm = mm + 1
4533                   ENDDO
4534
4535                   jc = jc + 1
4536                ENDDO
4537                ic = ic + 1
4538             ENDDO
4539
4540
4541          END SUBROUTINE restore_surface_elements_usm_1d
4542         
4543          SUBROUTINE restore_surface_elements_usm_2d( surf_target, surf_file, start_index_c )
4544
4545             IMPLICIT NONE
4546       
4547             INTEGER(iwp) ::  i         !< running index along x-direction, refers to former domain size
4548             INTEGER(iwp) ::  ic        !< running index along x-direction, refers to current domain size
4549             INTEGER(iwp) ::  j         !< running index along y-direction, refers to former domain size
4550             INTEGER(iwp) ::  jc        !< running index along y-direction, refers to former domain size       
4551             INTEGER(iwp) ::  m         !< surface-element index on file
4552             INTEGER(iwp) ::  mm        !< surface-element index on current subdomain
4553
4554             INTEGER(iwp), DIMENSION(nys:nyn,nxl:nxr) ::  start_index_c
4555             
4556             REAL(wp), DIMENSION(:,:) ::  surf_target !< target surface type
4557             REAL(wp), DIMENSION(:,:) ::  surf_file   !< surface type on file
4558             
4559             ic = nxlc
4560             DO  i = nxlf, nxrf
4561                jc = nysc
4562                DO  j = nysf, nynf
4563
4564                   mm = start_index_c(jc,ic)
4565                   DO  m = start_index_on_file(j,i), end_index_on_file(j,i)
4566                      surf_target(:,mm) = surf_file(:,m)
4567                      mm = mm + 1
4568                   ENDDO
4569
4570                   jc = jc + 1
4571                ENDDO
4572                ic = ic + 1
4573             ENDDO
4574
4575          END SUBROUTINE restore_surface_elements_usm_2d
4576
4577    END SUBROUTINE usm_read_restart_data
4578   
4579
4580
4581!------------------------------------------------------------------------------!
4582!
4583! Description:
4584! ------------
4585!> Soubroutine reads svf and svfsurf data from saved file
4586!------------------------------------------------------------------------------!
4587    SUBROUTINE usm_read_svf_from_file
4588
4589        IMPLICIT NONE
4590        INTEGER(iwp)                 :: fsvf = 89
4591        INTEGER(iwp)                 :: i
4592        CHARACTER(usm_version_len)   :: usm_version_field
4593        CHARACTER(svf_code_len)      :: svf_code_field
4594
4595        DO  i = 0, io_blocks-1
4596            IF ( i == io_group )  THEN
4597                OPEN ( fsvf, file=TRIM(svf_file_name)//TRIM(coupling_char)//myid_char,               &
4598                    form='unformatted', status='old' )
4599
4600!--             read and check version
4601                READ ( fsvf ) usm_version_field
4602                IF ( TRIM(usm_version_field) /= TRIM(usm_version) )  THEN
4603                    WRITE( message_string, * ) 'Version of binary SVF file "',           &
4604                                            TRIM(usm_version_field), '" does not match ',            &
4605                                            'the version of model "', TRIM(usm_version), '"'
4606                    CALL message( 'usm_read_svf_from_file', 'UI0012', 1, 2, 0, 6, 0 )
4607                ENDIF
4608               
4609!--             read nsvfl, ncsfl
4610                READ ( fsvf ) nsvfl, ncsfl
4611                IF ( nsvfl <= 0  .OR.  ncsfl < 0 )  THEN
4612                    WRITE( message_string, * ) 'Wrong number of SVF or CSF'
4613                    CALL message( 'usm_read_svf_from_file', 'UI0012', 1, 2, 0, 6, 0 )
4614                ELSE
4615                    WRITE(message_string,*) '    Number of SVF and CSF to read', nsvfl, ncsfl
4616                    CALL location_message( message_string, .TRUE. )
4617                ENDIF
4618               
4619                ALLOCATE(svf(ndsvf,nsvfl))
4620                ALLOCATE(svfsurf(idsvf,nsvfl))
4621                READ(fsvf) svf
4622                READ(fsvf) svfsurf
4623                IF ( plant_canopy )  THEN
4624                    ALLOCATE(csf(ndcsf,ncsfl))
4625                    ALLOCATE(csfsurf(idcsf,ncsfl))
4626                    READ(fsvf) csf
4627                    READ(fsvf) csfsurf
4628                ENDIF
4629                READ ( fsvf ) svf_code_field
4630               
4631                IF ( TRIM(svf_code_field) /= TRIM(svf_code) )  THEN
4632                    WRITE( message_string, * ) 'Wrong structure of binary svf file'
4633                    CALL message( 'usm_read_svf_from_file', 'UI0012', 1, 2, 0, 6, 0 )
4634                ENDIF
4635               
4636                CLOSE (fsvf)
4637               
4638            ENDIF
4639#if defined( __parallel )
4640            CALL MPI_BARRIER( comm2d, ierr )
4641#endif
4642        ENDDO
4643
4644    END SUBROUTINE usm_read_svf_from_file
4645
4646   
4647!------------------------------------------------------------------------------!
4648! Description:
4649! ------------
4650!
4651!> This subroutine reads walls, roofs and land categories and it parameters
4652!> from input files.
4653!------------------------------------------------------------------------------!
4654    SUBROUTINE usm_read_urban_surface_types
4655   
4656        CHARACTER(12)                                         :: wtn
4657        INTEGER(iwp)                                          :: wtc
4658        REAL(wp), DIMENSION(n_surface_params)                 :: wtp
4659   
4660        INTEGER(iwp), DIMENSION(0:17, nysg:nyng, nxlg:nxrg)   :: usm_par
4661        REAL(wp), DIMENSION(1:14, nysg:nyng, nxlg:nxrg)       :: usm_val
4662        INTEGER(iwp)                                          :: k, l, d, iw, jw, kw, it, ip, ii, ij, m
4663        INTEGER(iwp)                                          :: i, j
4664        INTEGER(iwp)                                          :: nz, roof, dirwe, dirsn
4665        INTEGER(iwp)                                          :: category
4666        INTEGER(iwp)                                          :: weheight1, wecat1, snheight1, sncat1
4667        INTEGER(iwp)                                          :: weheight2, wecat2, snheight2, sncat2
4668        INTEGER(iwp)                                          :: weheight3, wecat3, snheight3, sncat3
4669        REAL(wp)                                              :: height, albedo, thick
4670        REAL(wp)                                              :: wealbedo1, wethick1, snalbedo1, snthick1
4671        REAL(wp)                                              :: wealbedo2, wethick2, snalbedo2, snthick2
4672        REAL(wp)                                              :: wealbedo3, wethick3, snalbedo3, snthick3
4673       
4674!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
4675!--     read categories of walls and their parameters
4676!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
4677        DO  ii = 0, io_blocks-1
4678            IF ( ii == io_group )  THEN
4679
4680!--             open urban surface file
4681                OPEN( 151, file='SURFACE_PARAMETERS'//coupling_char, action='read', &
4682                           status='old', form='formatted', err=15 ) 
4683!--             first test and get n_surface_types
4684                k = 0
4685                l = 0
4686                DO
4687                    l = l+1
4688                    READ( 151, *, err=11, end=12 )  wtc, wtp, wtn
4689                    k = k+1
4690                    CYCLE
4691 11                 CONTINUE
4692                ENDDO
4693 12             n_surface_types = k
4694                ALLOCATE( surface_type_names(n_surface_types) )
4695                ALLOCATE( surface_type_codes(n_surface_types) )
4696                ALLOCATE( surface_params(n_surface_params, n_surface_types) )
4697!--             real reading
4698                rewind( 151 )
4699                k = 0
4700                DO
4701                    READ( 151, *, err=13, end=14 )  wtc, wtp, wtn
4702                    k = k+1
4703                    surface_type_codes(k) = wtc
4704                    surface_params(:,k) = wtp
4705                    surface_type_names(k) = wtn
4706                    CYCLE
470713                  WRITE(6,'(i3,a,2i5)') myid, 'readparams2 error k=', k
4708                    FLUSH(6)
4709                    CONTINUE
4710                ENDDO
4711 14             CLOSE(151)
4712                CYCLE
4713 15             message_string = 'file SURFACE_PARAMETERS'//TRIM(coupling_char)//' does not exist'
4714                CALL message( 'usm_read_urban_surface_types', 'PA0513', 1, 2, 0, 6, 0 )
4715            ENDIF
4716        ENDDO
4717   
4718!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
4719!--     read types of surfaces
4720!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
4721        usm_par = 0
4722        DO  ii = 0, io_blocks-1
4723            IF ( ii == io_group )  THEN
4724
4725                !
4726!--             open csv urban surface file
4727                OPEN( 151, file='URBAN_SURFACE'//TRIM(coupling_char), action='read', &
4728                      status='old', form='formatted', err=23 )
4729               
4730                l = 0
4731                DO
4732                    l = l+1
4733!--                 i, j, height, nz, roof, dirwe, dirsn, category, soilcat,
4734!--                 weheight1, wecat1, snheight1, sncat1, weheight2, wecat2, snheight2, sncat2,
4735!--                 weheight3, wecat3, snheight3, sncat3
4736                    READ( 151, *, err=21, end=25 )  i, j, height, nz, roof, dirwe, dirsn,            &
4737                                            category, albedo, thick,                                 &
4738                                            weheight1, wecat1, wealbedo1, wethick1,                  &
4739                                            weheight2,