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

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

Adjustments according new topography and surface-modelling concept implemented

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