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

Last change on this file since 2113 was 2113, checked in by kanani, 5 years ago

cpp switch mpi3 added for MPI-3 standard code

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