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

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

document changes

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