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

Last change on this file since 2582 was 2582, checked in by hellstea, 4 years ago

pmc bugfix and gfortran workaround

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