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

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

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