source: palm/trunk/SOURCE/modules.f90 @ 4502

Last change on this file since 4502 was 4502, checked in by schwenkel, 2 years ago

Implementation of ice microphysics

  • Property svn:keywords set to Id
File size: 122.4 KB
Line 
1!> @file modules.f90
2!------------------------------------------------------------------------------!
3! This file is part of the PALM model system.
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 1997-2020 Leibniz Universitaet Hannover
18!------------------------------------------------------------------------------!
19!
20! Current revisions:
21! ------------------
22!
23!
24! Former revisions:
25! -----------------
26! $Id: modules.f90 4502 2020-04-17 16:14:16Z schwenkel $
27! Implementation of ice microphysics
28!
29! 4495 2020-04-13 20:11:20Z raasch
30! +restart_data_format, restart_data_format_input|output, include_total_domain_boundaries
31!
32! 4476 2020-03-27 12:56:41Z maronga
33! Renamed variables for subgrids-scale model steering
34!
35! 4473 2020-03-25 21:04:07Z gronemeier
36! moved wall_adjustment_factor to turbulence_closure_mod
37!
38! 4472 2020-03-24 12:21:00Z Giersch
39! Additional switch added to activate calculations in flow_statistics for the
40! kolmogorov length scale
41!
42! 4461 2020-03-12 16:51:59Z raasch
43! +virtual_pe_grid, communicator_configurations
44!
45! 4414 2020-02-19 20:16:04Z suehring
46! - nzb_diff_s_inner, nzb_diff_s_outer, nzb_inner,nzb_outer, nzb_s_inner,
47!   nzb_s_outer, nzb_u_inner, nzb_u_outer, nzb_v_inner, nzb_v_outer,
48!   nzb_w_inner, nzb_w_outer
49!
50!
51! 4360 2020-01-07 11:25:50Z suehring
52! Introduction of wall_flags_total_0, which currently sets bits based on static
53! topography information used in wall_flags_static_0
54!
55! 4340 2019-12-16 08:17:03Z Giersch
56! Flag for topography closed channel flow with symmetric boundaries introduced
57!
58! 4331 2019-12-10 18:25:02Z suehring
59! - do_output_at_2m, pt_2m_av
60!
61! 4329 2019-12-10 15:46:36Z motisi
62! Renamed wall_flags_0 to wall_flags_static_0
63!
64! 4301 2019-11-22 12:09:09Z oliver.maas
65! removed recycling_yshift
66!
67! 4297 2019-11-21 10:37:50Z oliver.maas
68! changed variable type of recycling_yshift from LOGICAL to INTEGER
69!
70! 4293 2019-11-12 14:44:01Z Giersch
71! Add origin_date_time
72!
73! 4146 2019-08-07 07:47:36Z gronemeier
74! Added rotation_angle
75!
76! 4184 2019-08-23 08:07:40Z oliver.maas
77! changed allocated length of recycling_method_for_thermodynamic_quantities
78! from 20 to 80 characters
79!
80! 4183 2019-08-23 07:33:16Z oliver.maas
81! removed recycle_absolute_quantities and raq
82! added recycling_method_for_thermodynamic_quantities
83!
84! 4182 2019-08-22 15:20:23Z scharf
85! Corrected "Former revisions" section
86!
87! 4173 2019-08-20 12:04:06Z gronemeier
88! add vdi_internal_controls
89!
90! 4172 2019-08-20 11:55:33Z oliver.maas
91! added recycle_absolute_quantities and raq
92!
93! 4168 2019-08-16 13:50:17Z suehring
94! +topo_top_ind
95!
96! 4131 2019-08-02 11:06:18Z monakurppa
97! Add max_pr_salsa to control_parameters. Used in creating profile output for
98! salsa.
99!
100! 4110 2019-07-22 17:05:21Z suehring
101! -advc_flags_1, advc_flags_2
102! +advc_flags_m, advc_flags_s
103!
104! 4109 2019-07-22 17:00:34Z suehring
105! remove old_dt
106!
107! 4079 2019-07-09 18:04:41Z suehring
108! + monotonic_limiter_z
109!
110! 4069 2019-07-01 14:05:51Z Giersch
111! Masked output running index mid has been introduced as a local variable to
112! avoid runtime error (Loop variable has been modified) in time_integration
113!
114! 4017 2019-06-06 12:16:46Z schwenkel
115! increase maximum number of virtual flights
116!
117! 3987 2019-05-22 09:52:13Z kanani
118! Introduce alternative switch for debug output during timestepping
119!
120! 3885 2019-04-11 11:29:34Z kanani
121! Changes related to global restructuring of location messages and introduction
122! of additional debug messages
123!
124! 3871 2019-04-08 14:38:39Z knoop
125! Initialized parameter region
126!
127! 3746 2019-02-16 12:41:27Z gronemeier
128! Removed most_method
129!
130! 3648 2019-01-02 16:35:46Z suehring
131! -surface_data_output +surface_output
132!
133!------------------------------------------------------------------------------!
134! Description:
135! ------------
136!> Definition of global variables
137!------------------------------------------------------------------------------!
138
139
140!------------------------------------------------------------------------------!
141! Description:
142! ------------
143!> Definition of variables for special advection schemes.
144!------------------------------------------------------------------------------!
145 MODULE advection
146
147    USE kinds
148
149    REAL(wp), DIMENSION(:), ALLOCATABLE ::  aex  !< exponential coefficient for the Bott-Chlond advection scheme
150    REAL(wp), DIMENSION(:), ALLOCATABLE ::  bex  !< exponential coefficient for the Bott-Chlond advection scheme
151    REAL(wp), DIMENSION(:), ALLOCATABLE ::  dex  !< exponential coefficient for the Bott-Chlond advection scheme
152    REAL(wp), DIMENSION(:), ALLOCATABLE ::  eex  !< exponential coefficient for the Bott-Chlond advection scheme
153
154    SAVE
155
156 END MODULE advection
157
158
159
160!------------------------------------------------------------------------------!
161! Description:
162! ------------
163!> The variable in this module is used by multi_agent_system_mod AND
164!> netcdf_interface_mod. It must be here to avoid circular dependency.
165!> This is a workaround.
166!------------------------------------------------------------------------------!
167 MODULE mas_global_attributes
168
169    USE kinds
170
171    INTEGER(iwp) ::  dim_size_agtnum  !< size of agent number dimension for netCDF output
172
173    SAVE
174
175 END MODULE mas_global_attributes
176
177
178!------------------------------------------------------------------------------!
179! Description:
180! ------------
181!> Definition of all arrays defined on the computational grid.
182!------------------------------------------------------------------------------!
183 MODULE arrays_3d
184
185    USE kinds
186
187    REAL(wp), DIMENSION(:), ALLOCATABLE ::  c_u_m                  !< mean phase velocity at outflow for u-component used in radiation boundary condition
188    REAL(wp), DIMENSION(:), ALLOCATABLE ::  c_u_m_l                !< mean phase velocity at outflow for u-component used in radiation boundary condition (local subdomain value)
189    REAL(wp), DIMENSION(:), ALLOCATABLE ::  c_v_m                  !< mean phase velocity at outflow for v-component used in radiation boundary condition
190    REAL(wp), DIMENSION(:), ALLOCATABLE ::  c_v_m_l                !< mean phase velocity at outflow for v-component used in radiation boundary condition (local subdomain value)
191    REAL(wp), DIMENSION(:), ALLOCATABLE ::  c_w_m                  !< mean phase velocity at outflow for w-component used in radiation boundary condition
192    REAL(wp), DIMENSION(:), ALLOCATABLE ::  c_w_m_l                !< mean phase velocity at outflow for w-component used in radiation boundary condition (local subdomain value)
193    REAL(wp), DIMENSION(:), ALLOCATABLE ::  ddzu                   !< 1/dzu
194    REAL(wp), DIMENSION(:), ALLOCATABLE ::  ddzu_pres              !< modified ddzu for pressure solver
195    REAL(wp), DIMENSION(:), ALLOCATABLE ::  dd2zu                  !< 1/(dzu(k)+dzu(k+1))
196    REAL(wp), DIMENSION(:), ALLOCATABLE ::  dzu                    !< vertical grid size (u-grid)
197    REAL(wp), DIMENSION(:), ALLOCATABLE ::  ddzw                   !< 1/dzw
198    REAL(wp), DIMENSION(:), ALLOCATABLE ::  dzw                    !< vertical grid size (w-grid)
199    REAL(wp), DIMENSION(:), ALLOCATABLE ::  hyp                    !< hydrostatic pressure
200    REAL(wp), DIMENSION(:), ALLOCATABLE ::  inflow_damping_factor  !< used for turbulent inflow (non-cyclic boundary conditions)
201    REAL(wp), DIMENSION(:), ALLOCATABLE ::  ptdf_x                 !< damping factor for potential temperature in x-direction
202    REAL(wp), DIMENSION(:), ALLOCATABLE ::  ptdf_y                 !< damping factor for potential temperature in y-direction
203    REAL(wp), DIMENSION(:), ALLOCATABLE ::  pt_init                !< initial profile of potential temperature
204    REAL(wp), DIMENSION(:), ALLOCATABLE ::  q_init                 !< initial profile of total water mixing ratio
205                                                                   !< (or total water content with active cloud physics)
206    REAL(wp), DIMENSION(:), ALLOCATABLE ::  rdf                    !< rayleigh damping factor for velocity components
207    REAL(wp), DIMENSION(:), ALLOCATABLE ::  rdf_sc                 !< rayleigh damping factor for scalar quantities
208    REAL(wp), DIMENSION(:), ALLOCATABLE ::  ref_state              !< reference state of potential temperature
209                                                                   !< (and density in case of ocean simulation)
210    REAL(wp), DIMENSION(:), ALLOCATABLE ::  s_init                 !< initial profile of passive scalar concentration
211    REAL(wp), DIMENSION(:), ALLOCATABLE ::  sa_init                !< initial profile of salinity (ocean)
212    REAL(wp), DIMENSION(:), ALLOCATABLE ::  ug                     !< geostrophic wind component in x-direction
213    REAL(wp), DIMENSION(:), ALLOCATABLE ::  u_init                 !< initial profile of horizontal velocity component u
214    REAL(wp), DIMENSION(:), ALLOCATABLE ::  u_stokes_zu            !< u-component of Stokes drift velocity at zu levels
215    REAL(wp), DIMENSION(:), ALLOCATABLE ::  u_stokes_zw            !< u-component of Stokes drift velocity at zw levels
216    REAL(wp), DIMENSION(:), ALLOCATABLE ::  vg                     !< geostrophic wind component in y-direction
217    REAL(wp), DIMENSION(:), ALLOCATABLE ::  v_init                 !< initial profile of horizontal velocity component v
218    REAL(wp), DIMENSION(:), ALLOCATABLE ::  v_stokes_zu            !< v-component of Stokes drift velocity at zu levels
219    REAL(wp), DIMENSION(:), ALLOCATABLE ::  v_stokes_zw            !< v-component of Stokes drift velocity at zw levels
220    REAL(wp), DIMENSION(:), ALLOCATABLE ::  w_subs                 !< subsidence/ascent velocity
221    REAL(wp), DIMENSION(:), ALLOCATABLE ::  x                      !< horizontal grid coordinate of v-grid (in m)
222    REAL(wp), DIMENSION(:), ALLOCATABLE ::  xu                     !< horizontal grid coordinate of u-grid (in m)
223    REAL(wp), DIMENSION(:), ALLOCATABLE ::  y                      !< horizontal grid coordinate of u-grid (in m)
224    REAL(wp), DIMENSION(:), ALLOCATABLE ::  yv                     !< horizontal grid coordinate of v-grid (in m)
225    REAL(wp), DIMENSION(:), ALLOCATABLE ::  zu                     !< vertical grid coordinate of u-grid (in m)
226    REAL(wp), DIMENSION(:), ALLOCATABLE ::  zw                     !< vertical grid coordinate of w-grid (in m)
227
228    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  c_u                   !< phase speed of u-velocity component
229    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  c_v                   !< phase speed of v-velocity component
230    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  c_w                   !< phase speed of w-velocity component
231    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_diss           !< artificial numerical dissipation flux at south face of grid box - TKE dissipation
232    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_e              !< artificial numerical dissipation flux at south face of grid box - subgrid-scale TKE
233    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_nc             !< artificial numerical dissipation flux at south face of grid box - clouddrop-number concentration
234    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_ni             !< artificial numerical dissipation flux at south face of grid box - ice crystal-number concentration
235    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_nr             !< artificial numerical dissipation flux at south face of grid box - raindrop-number concentration
236    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_pt             !< artificial numerical dissipation flux at south face of grid box - potential temperature
237    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_q              !< artificial numerical dissipation flux at south face of grid box - mixing ratio
238    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_qc             !< artificial numerical dissipation flux at south face of grid box - cloudwater
239    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_qi             !< artificial numerical dissipation flux at south face of grid box - ice crystal mixing ratio
240    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_qr             !< artificial numerical dissipation flux at south face of grid box - rainwater
241    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_s              !< artificial numerical dissipation flux at south face of grid box - passive scalar
242    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_sa             !< artificial numerical dissipation flux at south face of grid box - salinity
243    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_u              !< artificial numerical dissipation flux at south face of grid box - u-component
244    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_v              !< artificial numerical dissipation flux at south face of grid box - v-component
245    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_w              !< artificial numerical dissipation flux at south face of grid box - w-component
246    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  dzu_mg                !< vertical grid size (u-grid) for multigrid pressure solver
247    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  dzw_mg                !< vertical grid size (w-grid) for multigrid pressure solver
248    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_diss           !< 6th-order advective flux at south face of grid box - TKE dissipation
249    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_e              !< 6th-order advective flux at south face of grid box - subgrid-scale TKE
250    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_nc             !< 6th-order advective flux at south face of grid box - clouddrop-number concentration
251    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_ni             !< 6th-order advective flux at south face of grid box - icecrystal-number concentration
252    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_nr             !< 6th-order advective flux at south face of grid box - raindrop-number concentration
253    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_pt             !< 6th-order advective flux at south face of grid box - potential temperature
254    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_q              !< 6th-order advective flux at south face of grid box - mixing ratio
255    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_qc             !< 6th-order advective flux at south face of grid box - cloudwater
256    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_qi             !< 6th-order advective flux at south face of grid box - ice crystal
257    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_qr             !< 6th-order advective flux at south face of grid box - rainwater
258    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_s              !< 6th-order advective flux at south face of grid box - passive scalar
259    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_sa             !< 6th-order advective flux at south face of grid box - salinity
260    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_u              !< 6th-order advective flux at south face of grid box - u-component
261    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_v              !< 6th-order advective flux at south face of grid box - v-component
262    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_w              !< 6th-order advective flux at south face of grid box - w-component
263    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  f1_mg                 !< grid factor used in right hand side of Gauss-Seidel equation (multigrid)
264    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  f2_mg                 !< grid factor used in right hand side of Gauss-Seidel equation (multigrid)
265    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  f3_mg                 !< grid factor used in right hand side of Gauss-Seidel equation (multigrid)
266    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  mean_inflow_profiles  !< used for turbulent inflow (non-cyclic boundary conditions)
267    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  precipitation_amount  !< precipitation amount due to gravitational settling (bulk microphysics)
268    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  pt_slope_ref          !< potential temperature in rotated coordinate system
269                                                                    !< (in case of sloped surface)
270    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  total_2d_a            !< horizontal array to store the total domain data, used for atmosphere-ocean coupling (atmosphere data)
271    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  total_2d_o            !< horizontal array to store the total domain data, used for atmosphere-ocean coupling (ocean data)
272
273    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  d           !< divergence
274    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  de_dx       !< gradient of sgs tke in x-direction (lpm)
275    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  de_dy       !< gradient of sgs tke in y-direction (lpm)
276    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  de_dz       !< gradient of sgs tke in z-direction (lpm)
277    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_diss !< artificial numerical dissipation flux at left face of grid box - TKE dissipation
278    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_e    !< artificial numerical dissipation flux at left face of grid box - subgrid-scale TKE
279    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_nc   !< artificial numerical dissipation flux at left face of grid box - clouddrop-number concentration
280    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_ni   !< artificial numerical dissipation flux at left face of grid box - ice crystal-number concentration
281    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_nr   !< artificial numerical dissipation flux at left face of grid box - raindrop-number concentration
282    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_pt   !< artificial numerical dissipation flux at left face of grid box - potential temperature
283    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_q    !< artificial numerical dissipation flux at left face of grid box - mixing ratio
284    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_qc   !< artificial numerical dissipation flux at left face of grid box - cloudwater
285    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_qi   !< artificial numerical dissipation flux at left face of grid box - ice crystal
286    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_qr   !< artificial numerical dissipation flux at left face of grid box - rainwater
287    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_s    !< artificial numerical dissipation flux at left face of grid box - passive scalar
288    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_sa   !< artificial numerical dissipation flux at left face of grid box - salinity
289    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_u    !< artificial numerical dissipation flux at left face of grid box - u-component
290    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_v    !< artificial numerical dissipation flux at left face of grid box - v-component
291    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_w    !< artificial numerical dissipation flux at left face of grid box - w-component
292    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_diss !< 6th-order advective flux at south face of grid box - TKE dissipation
293    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_e    !< 6th-order advective flux at south face of grid box - subgrid-scale TKE
294    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_nc   !< 6th-order advective flux at south face of grid box - clouddrop-number concentration
295    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_ni   !< 6th-order advective flux at south face of grid box - ice crystal-number concentration
296    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_nr   !< 6th-order advective flux at south face of grid box - raindrop-number concentration
297    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_pt   !< 6th-order advective flux at south face of grid box - potential temperature
298    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_q    !< 6th-order advective flux at south face of grid box - mixing ratio
299    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_qc   !< 6th-order advective flux at south face of grid box - cloudwater
300    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_qi   !< 6th-order advective flux at south face of grid box - ice crystal
301    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_qr   !< 6th-order advective flux at south face of grid box - rainwater
302    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_s    !< 6th-order advective flux at south face of grid box - passive scalar
303    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_sa   !< 6th-order advective flux at south face of grid box - salinity
304    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_u    !< 6th-order advective flux at south face of grid box - u-component
305    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_v    !< 6th-order advective flux at south face of grid box - v-component
306    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_w    !< 6th-order advective flux at south face of grid box - w-component
307    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  kh  !< eddy diffusivity for heat
308    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  km  !< eddy diffusivity for momentum
309    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  prr         !< rain rate
310    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  p_loc       !< local array in multigrid/sor solver containing the pressure which is iteratively advanced in each iteration step
311    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  tend        !< tendency field (time integration)
312    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  tric        !< coefficients of the tridiagonal matrix for solution of the Poisson equation in Fourier space
313    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  u_m_l       !< velocity data (u at left boundary) from time level t-dt required for radiation boundary condition
314    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  u_m_n       !< velocity data (u at north boundary) from time level t-dt required for radiation boundary condition
315    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  u_m_r       !< velocity data (u at right boundary) from time level t-dt required for radiation boundary condition
316    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  u_m_s       !< velocity data (u at south boundary) from time level t-dt required for radiation boundary condition
317    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  v_m_l       !< velocity data (v at left boundary) from time level t-dt required for radiation boundary condition
318    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  v_m_n       !< velocity data (v at north boundary) from time level t-dt required for radiation boundary condition
319    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  v_m_r       !< velocity data (v at right boundary) from time level t-dt required for radiation boundary condition
320    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  v_m_s       !< velocity data (v at south boundary) from time level t-dt required for radiation boundary condition
321    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  w_m_l       !< velocity data (w at left boundary) from time level t-dt required for radiation boundary condition
322    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  w_m_n       !< velocity data (w at north boundary) from time level t-dt required for radiation boundary condition
323    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  w_m_r       !< velocity data (w at right boundary) from time level t-dt required for radiation boundary condition
324    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  w_m_s       !< velocity data (w at south boundary) from time level t-dt required for radiation boundary condition
325
326    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  diss_1  !< pointer for swapping of timelevels for respective quantity
327    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  diss_2  !< pointer for swapping of timelevels for respective quantity
328    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  diss_3  !< pointer for swapping of timelevels for respective quantity
329    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  e_1     !< pointer for swapping of timelevels for respective quantity
330    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  e_2     !< pointer for swapping of timelevels for respective quantity
331    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  e_3     !< pointer for swapping of timelevels for respective quantity
332    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  p       !< pointer: perturbation pressure
333    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  prho_1  !< pointer for swapping of timelevels for respective quantity
334    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  nc_1    !< pointer for swapping of timelevels for respective quantity
335    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  nc_2    !< pointer for swapping of timelevels for respective quantity
336    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  nc_3    !< pointer for swapping of timelevels for respective quantity
337    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ni_1    !< pointer for swapping of timelevels for respective quantity
338    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ni_2    !< pointer for swapping of timelevels for respective quantity
339    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ni_3    !< pointer for swapping of timelevels for respective quantity
340    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  nr_1    !< pointer for swapping of timelevels for respective quantity
341    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  nr_2    !< pointer for swapping of timelevels for respective quantity
342    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  nr_3    !< pointer for swapping of timelevels for respective quantity
343    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  pt_1    !< pointer for swapping of timelevels for respective quantity
344    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  pt_2    !< pointer for swapping of timelevels for respective quantity
345    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  pt_3    !< pointer for swapping of timelevels for respective quantity
346    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  q_1     !< pointer for swapping of timelevels for respective quantity
347    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  q_2     !< pointer for swapping of timelevels for respective quantity
348    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  q_3     !< pointer for swapping of timelevels for respective quantity
349    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qc_1    !< pointer for swapping of timelevels for respective quantity
350    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qc_2    !< pointer for swapping of timelevels for respective quantity
351    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qc_3    !< pointer for swapping of timelevels for respective quantity
352    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qi_1    !< pointer for swapping of timelevels for respective quantity
353    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qi_2    !< pointer for swapping of timelevels for respective quantity
354    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qi_3    !< pointer for swapping of timelevels for respective quantity
355    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ql_v    !< pointer: volume of liquid water
356    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ql_vp   !< pointer: liquid water weighting factor
357    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ql_1    !< pointer for swapping of timelevels for respective quantity
358    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ql_2    !< pointer for swapping of timelevels for respective quantity
359    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qr_1    !< pointer for swapping of timelevels for respective quantity
360    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qr_2    !< pointer for swapping of timelevels for respective quantity
361    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qr_3    !< pointer for swapping of timelevels for respective quantity
362    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  rho_1   !< pointer for swapping of timelevels for respective quantity
363    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  s_1     !< pointer for swapping of timelevels for respective quantity
364    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  s_2     !< pointer for swapping of timelevels for respective quantity
365    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  s_3     !< pointer for swapping of timelevels for respective quantity
366    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  sa_1    !< pointer for swapping of timelevels for respective quantity
367    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  sa_2    !< pointer for swapping of timelevels for respective quantity
368    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  sa_3    !< pointer for swapping of timelevels for respective quantity
369    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  u_1     !< pointer for swapping of timelevels for respective quantity
370    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  u_2     !< pointer for swapping of timelevels for respective quantity
371    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  u_3     !< pointer for swapping of timelevels for respective quantity
372    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  v_1     !< pointer for swapping of timelevels for respective quantity
373    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  v_2     !< pointer for swapping of timelevels for respective quantity
374    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  v_3     !< pointer for swapping of timelevels for respective quantity
375    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  vpt_1   !< pointer for swapping of timelevels for respective quantity
376    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  w_1     !< pointer for swapping of timelevels for respective quantity
377    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  w_2     !< pointer for swapping of timelevels for respective quantity
378    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  w_3     !< pointer for swapping of timelevels for respective quantity
379
380    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  diss       !< pointer: TKE dissipation
381    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  diss_p     !< pointer: prognostic value of TKE dissipation
382    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  e          !< pointer: subgrid-scale turbulence kinetic energy (sgs tke)
383    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  e_p        !< pointer: prognostic value of sgs tke
384    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  nc         !< pointer: cloud drop number density
385    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  nc_p       !< pointer: prognostic value of cloud drop number density
386    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  ni         !< pointer: ice crystal number density
387    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  ni_p       !< pointer: prognostic value of ice crystal number density
388    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  nr         !< pointer: rain drop number density
389    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  nr_p       !< pointer: prognostic value of rain drop number density
390    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  prho       !< pointer: potential density
391    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  pt         !< pointer: potential temperature
392    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  pt_p       !< pointer: prognostic value of potential temperature
393    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  q          !< pointer: mixing ratio
394    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  q_p        !< pointer: prognostic value of mixing ratio
395    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  qc         !< pointer: cloud water content
396    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  qc_p       !< pointer: prognostic value cloud water content
397    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  qi         !< pointer: ice crystal content
398    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  qi_p       !< pointer: prognostic value ice crystal content
399    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  ql         !< pointer: liquid water content
400    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  ql_c       !< pointer: change in liquid water content due to
401                                                                   !< condensation/evaporation during last time step
402    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  qr         !< pointer: rain water content
403    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  qr_p       !< pointer: prognostic value of rain water content
404    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  rho_ocean  !< pointer: density of ocean
405    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  s          !< pointer: passive scalar
406    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  s_p        !< pointer: prognostic value of passive scalar
407    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  sa         !< pointer: ocean salinity
408    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  sa_p       !< pointer: prognostic value of ocean salinity
409    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tdiss_m    !< pointer: weighted tendency of diss for previous sub-timestep (Runge-Kutta)
410    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  te_m       !< pointer: weighted tendency of e for previous sub-timestep (Runge-Kutta)
411    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tnc_m      !< pointer: weighted tendency of nc for previous sub-timestep (Runge-Kutta)
412    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tni_m      !< pointer: weighted tendency of ni for previous sub-timestep (Runge-Kutta)
413    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tnr_m      !< pointer: weighted tendency of nr for previous sub-timestep (Runge-Kutta)
414    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tpt_m      !< pointer: weighted tendency of pt for previous sub-timestep (Runge-Kutta)
415    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tq_m       !< pointer: weighted tendency of q for previous sub-timestep (Runge-Kutta)
416    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tqc_m      !< pointer: weighted tendency of qc for previous sub-timestep (Runge-Kutta)
417    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tqi_m      !< pointer: weighted tendency of qi for previous sub-timestep (Runge-Kutta)
418    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tqr_m      !< pointer: weighted tendency of qr for previous sub-timestep (Runge-Kutta)
419    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  ts_m       !< pointer: weighted tendency of s for previous sub-timestep (Runge-Kutta)
420    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tsa_m      !< pointer: weighted tendency of sa for previous sub-timestep (Runge-Kutta)
421    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tu_m       !< pointer: weighted tendency of u for previous sub-timestep (Runge-Kutta)
422    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tv_m       !< pointer: weighted tendency of v for previous sub-timestep (Runge-Kutta)
423    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tw_m       !< pointer: weighted tendency of w for previous sub-timestep (Runge-Kutta)
424    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  u          !< pointer: horizontal velocity component u (x-direction)
425    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  u_p        !< pointer: prognostic value of u
426    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  v          !< pointer: horizontal velocity component v (y-direction)
427    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  v_p        !< pointer: prognostic value of v
428    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  vpt        !< pointer: virtual potential temperature
429    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  w          !< pointer: vertical velocity component w (z-direction)
430    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  w_p        !< pointer: prognostic value of w
431
432    REAL(wp), DIMENSION(:,:,:,:), ALLOCATABLE ::  tri    !<  array to hold the tridiagonal matrix for solution of the Poisson equation in Fourier space (4th dimension for threads)
433
434    REAL(wp), DIMENSION(:), ALLOCATABLE ::  rho_air      !< air density profile on the uv grid
435    REAL(wp), DIMENSION(:), ALLOCATABLE ::  rho_air_zw   !< air density profile on the w grid
436    REAL(wp), DIMENSION(:), ALLOCATABLE ::  drho_air     !< inverse air density profile on the uv grid
437    REAL(wp), DIMENSION(:), ALLOCATABLE ::  drho_air_zw  !< inverse air density profile on the w grid
438
439    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  rho_air_mg     !< air density profiles on the uv grid for multigrid
440    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  rho_air_zw_mg  !< air density profiles on the w grid for multigrid
441
442    REAL(wp), DIMENSION(:), ALLOCATABLE ::  heatflux_input_conversion       !< conversion factor array for heatflux input
443    REAL(wp), DIMENSION(:), ALLOCATABLE ::  waterflux_input_conversion      !< conversion factor array for waterflux input
444    REAL(wp), DIMENSION(:), ALLOCATABLE ::  momentumflux_input_conversion   !< conversion factor array for momentumflux input
445    REAL(wp), DIMENSION(:), ALLOCATABLE ::  heatflux_output_conversion      !< conversion factor array for heatflux output
446    REAL(wp), DIMENSION(:), ALLOCATABLE ::  waterflux_output_conversion     !< conversion factor array for waterflux output
447    REAL(wp), DIMENSION(:), ALLOCATABLE ::  momentumflux_output_conversion  !< conversion factor array for momentumflux output
448
449    REAL(wp), DIMENSION(:), ALLOCATABLE ::  hyrho   !< density of air calculated with hydrostatic pressure
450    REAL(wp), DIMENSION(:), ALLOCATABLE ::  exner   !< ratio of actual and potential temperature
451    REAL(wp), DIMENSION(:), ALLOCATABLE ::  d_exner !< ratio of potential and actual temperature
452
453    SAVE
454
455 END MODULE arrays_3d
456
457
458!------------------------------------------------------------------------------!
459! Description:
460! ------------
461!> Definition of variables needed for time-averaging of 2d/3d data.
462!------------------------------------------------------------------------------!
463 MODULE averaging
464
465    USE kinds
466
467    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  ghf_av                 !< avg. ground heat flux
468    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  lwp_av                 !< avg. liquid water path
469    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  ol_av                  !< avg. Obukhov length
470    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  qsws_av                !< avg. surface moisture flux
471    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  r_a_av                 !< avg. resistance
472    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  ssws_av                !< avg. surface scalar flux
473    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  shf_av                 !< avg. surface heat flux
474    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  tsurf_av               !< avg. surface temperature
475    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  ts_av                  !< avg. characteristic temperature scale
476    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  us_av                  !< avg. friction velocity
477    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  z0_av                  !< avg. roughness length for momentum
478    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  z0h_av                 !< avg. roughness length for heat
479    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  z0q_av                 !< avg. roughness length for moisture
480
481    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  diss_av       !< avg. tke dissipation rate
482    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  e_av          !< avg. subgrid-scale tke
483    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  kh_av         !< avg. eddy diffusivity for heat
484    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  km_av         !< avg. eddy diffusivity for momentum
485    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  lpt_av        !< avg. liquid water potential temperature
486    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  nc_av         !< avg. cloud drop number density
487    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ni_av         !< avg. ice crystal number density
488    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  nr_av         !< avg. rain drop number density
489    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  p_av          !< avg. perturbation pressure
490    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  pc_av         !< avg. particle/droplet concentration
491    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  pr_av         !< avg. particle/droplet radius
492    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  prr_av        !< avg. precipitation rate
493    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  pt_av         !< avg. potential temperature
494    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  q_av          !< avg. mixing ratio
495                                                                      !< (or total water content with active cloud physics)
496    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qc_av         !< avg. cloud water content
497    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qi_av         !< avg. ice crystal content
498    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ql_av         !< avg. liquid water content
499    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ql_c_av       !< avg. change in liquid water content due to
500                                                                      !< condensation/evaporation during last time step
501    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ql_v_av       !< avg. volume of liquid water
502    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ql_vp_av      !< avg. liquid water weighting factor
503    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qr_av         !< avg. rain water content
504    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qv_av         !< avg. water vapor content (mixing ratio)
505    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  rho_ocean_av  !< avg. ocean density
506    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  s_av          !< avg. passive scalar
507    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  sa_av         !< avg. salinity
508    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  u_av          !< avg. horizontal velocity component u
509    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  v_av          !< avg. horizontal velocity component v
510    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  vpt_av        !< avg. virtual potential temperature
511    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  w_av          !< avg. vertical velocity component
512
513 END MODULE averaging
514
515
516!------------------------------------------------------------------------------!
517! Description:
518! ------------
519!> Definition of parameters for program control
520!------------------------------------------------------------------------------!
521 MODULE control_parameters
522
523    USE kinds
524
525    TYPE file_status
526       LOGICAL ::  opened         !< file is currently open
527       LOGICAL ::  opened_before  !< file is currently closed, but has been openend before
528    END TYPE file_status
529
530    INTEGER, PARAMETER      ::  mask_xyz_dimension = 100  !< limit of mask dimensions (100 points in each direction)
531    INTEGER, PARAMETER      ::  max_masks = 50            !< maximum number of masks
532    INTEGER(iwp), PARAMETER ::  varnamelength = 30        !< length of output variable names
533
534    TYPE(file_status), DIMENSION(200+2*max_masks) ::                &  !< indicates if file is open or if it has been opened before
535                             openfile = file_status(.FALSE.,.FALSE.)
536
537    CHARACTER (LEN=1)    ::  cycle_mg = 'w'                               !< namelist parameter (see documentation)
538    CHARACTER (LEN=1)    ::  timestep_reason = ' '                        !< 'A'dvection or 'D'iffusion criterion, written to RUN_CONTROL file
539    CHARACTER (LEN=8)    ::  coupling_char = ''                           !< appended to filenames in coupled or nested runs ('_O': ocean PE,
540                                                                          !< '_NV': vertically nested atmosphere PE, '_N##': PE of nested domain ##
541    CHARACTER (LEN=23)   ::  origin_date_time = '2019-06-21 12:00:00 +00' !< date and time to be simulated
542    CHARACTER (LEN=10)   ::  run_date = ' '                               !< date of simulation run
543    CHARACTER (LEN=8)    ::  run_time = ' '                               !< time of simulation run
544    CHARACTER (LEN=5)    ::  run_zone = ' '                               !< time zone of simulation run
545    CHARACTER (LEN=9)    ::  simulated_time_chr                           !< simulated time, printed to RUN_CONTROL file
546    CHARACTER (LEN=11)   ::  topography_grid_convention = ' '             !< namelist parameter
547    CHARACTER (LEN=12)   ::  version = ' '                                !< PALM version number
548    CHARACTER (LEN=12)   ::  revision = ' '                               !< PALM revision number
549    CHARACTER (LEN=12)   ::  user_interface_current_revision = ' '        !< revision number of the currently used user-interface (must match user_interface_required_revision)
550    CHARACTER (LEN=12)   ::  user_interface_required_revision = ' '       !< required user-interface revision number
551    CHARACTER (LEN=16)   ::  conserve_volume_flow_mode = 'default'        !< namelist parameter
552    CHARACTER (LEN=16)   ::  loop_optimization = 'cache'                  !< namelist parameter
553    CHARACTER (LEN=16)   ::  momentum_advec = 'ws-scheme'                 !< namelist parameter
554    CHARACTER (LEN=16)   ::  psolver = 'poisfft'                          !< namelist parameter
555    CHARACTER (LEN=16)   ::  scalar_advec = 'ws-scheme'                   !< namelist parameter
556    CHARACTER (LEN=20)   ::  approximation = 'boussinesq'                 !< namelist parameter
557    CHARACTER (LEN=40)   ::  flux_input_mode = 'approximation-specific'   !< type of flux input: dynamic or kinematic
558    CHARACTER (LEN=40)   ::  flux_output_mode = 'approximation-specific'  !< type of flux output: dynamic or kinematic
559    CHARACTER (LEN=20)   ::  bc_e_b = 'neumann'                           !< namelist parameter
560    CHARACTER (LEN=20)   ::  bc_lr = 'cyclic'                             !< namelist parameter
561    CHARACTER (LEN=20)   ::  bc_ns = 'cyclic'                             !< namelist parameter
562    CHARACTER (LEN=20)   ::  bc_p_b = 'neumann'                           !< namelist parameter
563    CHARACTER (LEN=20)   ::  bc_p_t = 'dirichlet'                         !< namelist parameter
564    CHARACTER (LEN=20)   ::  bc_pt_b = 'dirichlet'                        !< namelist parameter
565    CHARACTER (LEN=20)   ::  bc_pt_t = 'initial_gradient'                 !< namelist parameter
566    CHARACTER (LEN=20)   ::  bc_q_b = 'dirichlet'                         !< namelist parameter
567    CHARACTER (LEN=20)   ::  bc_q_t = 'neumann'                           !< namelist parameter
568    CHARACTER (LEN=20)   ::  bc_s_b = 'dirichlet'                         !< namelist parameter
569    CHARACTER (LEN=20)   ::  bc_s_t = 'initial_gradient'                  !< namelist parameter
570    CHARACTER (LEN=20)   ::  bc_uv_b = 'dirichlet'                        !< namelist parameter
571    CHARACTER (LEN=20)   ::  bc_uv_t = 'dirichlet'                        !< namelist parameter
572    CHARACTER (LEN=20)   ::  coupling_mode = 'uncoupled'                  !< coupling mode for atmosphere-ocean coupling
573    CHARACTER (LEN=20)   ::  coupling_mode_remote = 'uncoupled'           !< coupling mode of the remote process in case of coupled atmosphere-ocean runs
574    CHARACTER (LEN=20)   ::  dissipation_1d = 'detering'                  !< namelist parameter
575    CHARACTER (LEN=20)   ::  fft_method = 'temperton-algorithm'           !< namelist parameter
576    CHARACTER (LEN=20)   ::  mixing_length_1d = 'blackadar'               !< namelist parameter
577    CHARACTER (LEN=20)   ::  random_generator = 'random-parallel'         !< namelist parameter
578    CHARACTER (LEN=80)   ::  recycling_method_for_thermodynamic_quantities = 'turbulent_fluctuation'        !< namelist parameter
579    CHARACTER (LEN=20)   ::  reference_state = 'initial_profile'          !< namelist parameter
580    CHARACTER (LEN=20)   ::  restart_data_format = 'fortran_binary'       !< namelist parameter
581    CHARACTER (LEN=20)   ::  restart_data_format_input = 'undefined'      !< namelist parameter
582    CHARACTER (LEN=20)   ::  restart_data_format_output = 'undefined'     !< namelist parameter
583    CHARACTER (LEN=20)   ::  timestep_scheme = 'runge-kutta-3'            !< namelist parameter
584    CHARACTER (LEN=20)   ::  turbulence_closure = '1.5-order'             !< namelist parameter
585    CHARACTER (LEN=40)   ::  topography = 'flat'                          !< namelist parameter
586    CHARACTER (LEN=64)   ::  host = '????'                                !< configuration identifier as given by palmrun option -c, ENVPAR namelist parameter provided by palmrun
587    CHARACTER (LEN=80)   ::  log_message                                  !< user-defined message for debugging (sse data_log.f90)
588    CHARACTER (LEN=80)   ::  run_identifier                               !< run identifier as given by palmrun option -r, ENVPAR namelist parameter provided by palmrun
589    CHARACTER (LEN=100)  ::  initializing_actions = ' '                   !< namelist parameter
590    CHARACTER (LEN=100)  ::  restart_string = ' '                         !< for storing strings in case of writing/reading restart data
591    CHARACTER (LEN=210)  ::  run_description_header                       !< string containing diverse run informations as run identifier, coupling mode, host, ensemble number, run date and time
592    CHARACTER (LEN=1000) ::  debug_string = ' '                           !<.....
593    CHARACTER (LEN=1000) ::  message_string = ' '                         !< dynamic string for error message output
594
595    CHARACTER (LEN=varnamelength), DIMENSION(500) ::  data_output = ' '       !< namelist parameter
596    CHARACTER (LEN=varnamelength), DIMENSION(500) ::  data_output_user = ' '  !< namelist parameter
597    CHARACTER (LEN=varnamelength), DIMENSION(500) ::  doav = ' '              !< label array for multi-dimensional,
598                                                                              !< averaged output quantities
599
600    CHARACTER (LEN=varnamelength), DIMENSION(max_masks,100) ::  data_output_masks = ' '       !< namelist parameter
601    CHARACTER (LEN=varnamelength), DIMENSION(max_masks,100) ::  data_output_masks_user = ' '  !< namelist parameter
602
603    CHARACTER (LEN=varnamelength), DIMENSION(300) ::  data_output_pr = ' '  !< namelist parameter
604
605    CHARACTER (LEN=varnamelength), DIMENSION(200) ::  data_output_pr_user = ' '  !< namelist parameter
606
607    CHARACTER (LEN=varnamelength), DIMENSION(max_masks,0:1,100) ::  domask = ' ' !< label array for multi-dimensional,
608                                                                                 !< masked output quantities
609
610    CHARACTER (LEN=varnamelength), DIMENSION(0:1,500) ::  do2d = ' '  !< label array for 2d output quantities
611    CHARACTER (LEN=varnamelength), DIMENSION(0:1,500) ::  do3d = ' '  !< label array for 3d output quantities
612
613    INTEGER(iwp), PARAMETER ::  fl_max = 500     !< maximum number of virtual-flight measurements
614    INTEGER(iwp), PARAMETER ::  var_fl_max = 20  !< maximum number of different sampling variables in virtual flight measurements
615
616    INTEGER(iwp) ::  abort_mode = 1                    !< abort condition (nested runs)
617    INTEGER(iwp) ::  agt_time_count = 0                !< number of output intervals for agent data output
618    INTEGER(iwp) ::  average_count_pr = 0              !< number of samples in vertical-profile output
619    INTEGER(iwp) ::  average_count_3d = 0              !< number of samples in 3d output
620    INTEGER(iwp) ::  current_timestep_number = 0       !< current timestep number, printed to RUN_CONTROL file
621    INTEGER(iwp) ::  coupling_topology = 0             !< switch for atmosphere-ocean-coupling: 0: same number of grid points and PEs along x and y in atmosphere and ocean, otherwise 1
622    INTEGER(iwp) ::  dist_range = 0                    !< switch for steering the horizontal disturbance range, 1: inflow disturbances in case of non-cyclic horizontal BC, 0: otherwise
623    INTEGER(iwp) ::  disturbance_level_ind_b           !< lowest grid index where flow disturbance is applied
624    INTEGER(iwp) ::  disturbance_level_ind_t           !< highest grid index where flow disturbance is applied
625    INTEGER(iwp) ::  doav_n = 0                        !< number of 2d/3d output quantities subject to time averaging
626    INTEGER(iwp) ::  dopr_n = 0                        !< number of profile output quantities subject to time averaging
627    INTEGER(iwp) ::  dopr_time_count = 0               !< number of output intervals for profile output
628    INTEGER(iwp) ::  dopts_time_count = 0              !< number of output intervals for particle data timeseries
629    INTEGER(iwp) ::  dots_time_count = 0               !< number of output intervals for timeseries output
630    INTEGER(iwp) ::  dp_level_ind_b = 0                !< lowest grid index for external pressure gradient forcing
631    INTEGER(iwp) ::  ensemble_member_nr = 0            !< namelist parameter
632    INTEGER(iwp) ::  gamma_mg                          !< switch for steering the multigrid cycle: 1: v-cycle, 2: w-cycle
633    INTEGER(iwp) ::  gathered_size                     !< number of total domain grid points of the grid level which is gathered on PE0 (multigrid solver)
634    INTEGER(iwp) ::  grid_level                        !< current grid level handled in the multigrid solver
635    INTEGER(iwp) ::  ibc_e_b                           !< integer flag for bc_e_b
636    INTEGER(iwp) ::  ibc_p_b                           !< integer flag for bc_p_b
637    INTEGER(iwp) ::  ibc_p_t                           !< integer flag for bc_p_t
638    INTEGER(iwp) ::  ibc_pt_b                          !< integer flag for bc_pt_b
639    INTEGER(iwp) ::  ibc_pt_t                          !< integer flag for bc_pt_t
640    INTEGER(iwp) ::  ibc_q_b                           !< integer flag for bc_q_b
641    INTEGER(iwp) ::  ibc_q_t                           !< integer flag for bc_q_t
642    INTEGER(iwp) ::  ibc_s_b                           !< integer flag for bc_s_b
643    INTEGER(iwp) ::  ibc_s_t                           !< integer flag for bc_s_t
644    INTEGER(iwp) ::  ibc_uv_b                          !< integer flag for bc_uv_b
645    INTEGER(iwp) ::  ibc_uv_t                          !< integer flag for bc_uv_t
646    INTEGER(iwp) ::  inflow_disturbance_begin = -1     !< namelist parameter
647    INTEGER(iwp) ::  inflow_disturbance_end = -1       !< namelist parameter
648    INTEGER(iwp) ::  intermediate_timestep_count       !< number of current Runge-Kutta substep
649    INTEGER(iwp) ::  intermediate_timestep_count_max   !< maximum number of Runge-Kutta substeps
650    INTEGER(iwp) ::  io_group = 0                      !< I/O group to which the PE belongs (= #PE / io_blocks)
651    INTEGER(iwp) ::  io_blocks = 1                     !< number of blocks for which I/O is done in sequence (total number of PEs / maximum_parallel_io_streams)
652    INTEGER(iwp) ::  iran = -1234567                   !< integer random number used for flow disturbances
653    INTEGER(iwp) ::  length = 0                        !< integer that specifies the length of a string in case of writing/reading restart data
654    INTEGER(iwp) ::  masks = 0                         !< counter for number of masked output quantities
655    INTEGER(iwp) ::  maximum_grid_level                !< number of grid levels that the multigrid solver is using
656    INTEGER(iwp) ::  maximum_parallel_io_streams = -1  !< maximum number of parallel io streams that the underlying parallel file system allows, set with palmrun option -w, ENVPAR namelist parameter, provided by palmrun
657    INTEGER(iwp) ::  max_pr_salsa = 0                  !< number of salsa profiles (must not change within a job chain)
658    INTEGER(iwp) ::  max_pr_user = 0                   !< number of user-defined profiles (must not change within a job chain)
659    INTEGER(iwp) ::  max_pr_user_tmp = 0               !< number of user-defined profiles that is temporary stored to check it against max_pr_user in case of restarts
660    INTEGER(iwp) ::  mgcycles = 0                      !< number of multigrid cycles that the multigrid solver has actually carried out
661    INTEGER(iwp) ::  mg_cycles = 4                     !< namelist parameter
662    INTEGER(iwp) ::  mg_switch_to_pe0_level = -1       !< namelist parameter
663    INTEGER(iwp) ::  ngsrb = 2                         !< namelist parameter
664    INTEGER(iwp) ::  nr_timesteps_this_run = 0         !< number of timesteps (cpu time measurements)
665    INTEGER(iwp) ::  nsor = 20                         !< namelist parameter
666    INTEGER(iwp) ::  nsor_ini = 100                    !< namelist parameter
667    INTEGER(iwp) ::  n_sor                             !< number of iterations to be used in SOR-scheme
668    INTEGER(iwp) ::  normalizing_region = 0            !< namelist parameter
669    INTEGER(iwp) ::  num_mean_inflow_profiles = 7      !< number of mean inflow profiles in case of turbulent inflow
670    INTEGER(iwp) ::  num_leg=0                         !< number of different legs in virtual flight measurements
671    INTEGER(iwp) ::  num_var_fl                        !< number of sampling/output variables in virtual flight measurements
672    INTEGER(iwp) ::  num_var_fl_user=0                 !< number of user-defined sampling/output variables in virtual flight measurements
673    INTEGER(iwp) ::  number_stretch_level_start        !< number of user-specified start levels for stretching
674    INTEGER(iwp) ::  number_stretch_level_end          !< number of user-specified end levels for stretching
675    INTEGER(iwp) ::  nz_do3d = -9999                   !< namelist parameter
676    INTEGER(iwp) ::  prt_time_count = 0                !< number of output intervals for particle data output
677    INTEGER(iwp) ::  recycling_plane                   !< position of recycling plane along x (in grid points) in case of turbulence recycling
678    INTEGER(iwp) ::  runnr = 0                         !< number of run in job chain
679    INTEGER(iwp) ::  subdomain_size                    !< number of grid points in (3d) subdomain including ghost points
680    INTEGER(iwp) ::  symmetry_flag = 0                 !< flag for sterring the symmetric behavior of the bottom and top boundary
681    INTEGER(iwp) ::  terminate_coupled = 0             !< switch for steering termination in case of coupled runs
682    INTEGER(iwp) ::  terminate_coupled_remote = 0      !< switch for steering termination in case of coupled runs (condition of the remote model)
683    INTEGER(iwp) ::  timestep_count = 0                !< number of timesteps carried out since the beginning of the initial run
684    INTEGER(iwp) ::  y_shift = 0                       !< namelist parameter
685
686    INTEGER(iwp) ::  dist_nxl(0:1)                               !< left boundary of disturbance region
687    INTEGER(iwp) ::  dist_nxr(0:1)                               !< right boundary of disturbance region
688    INTEGER(iwp) ::  dist_nyn(0:1)                               !< north boundary of disturbance region
689    INTEGER(iwp) ::  dist_nys(0:1)                               !< south boundary of disturbance region
690    INTEGER(iwp) ::  do2d_no(0:1) = 0                            !< number of 2d output quantities
691    INTEGER(iwp) ::  do2d_xy_time_count(0:1) = 0                 !< number of output intervals for 2d data (xy)
692    INTEGER(iwp) ::  do2d_xz_time_count(0:1) = 0                 !< number of output intervals for 2d data (xz)
693    INTEGER(iwp) ::  do2d_yz_time_count(0:1) = 0                 !< number of output intervals for 2d data (yz)
694    INTEGER(iwp) ::  do3d_no(0:1) = 0                            !< number of 3d output quantities
695    INTEGER(iwp) ::  do3d_time_count(0:1) = 0                    !< number of output intervals for 3d data
696    INTEGER(iwp) ::  domask_no(max_masks,0:1) = 0                !< number of masked output quantities
697    INTEGER(iwp) ::  domask_time_count(max_masks,0:1)            !< number of output intervals for masked data
698    INTEGER(iwp) ::  dz_stretch_level_end_index(9)               !< vertical grid level index until which the vertical grid spacing is stretched
699    INTEGER(iwp) ::  dz_stretch_level_start_index(9)             !< vertical grid level index above which the vertical grid spacing is stretched
700    INTEGER(iwp) ::  mask_size(max_masks,3) = -1                 !< size of mask array per mask and dimension (for netcdf output)
701    INTEGER(iwp) ::  mask_size_l(max_masks,3) = -1               !< subdomain size of mask array per mask and dimension (for netcdf output)
702    INTEGER(iwp) ::  mask_start_l(max_masks,3) = -1              !< subdomain start index of mask array (for netcdf output)
703    INTEGER(iwp) ::  pt_vertical_gradient_level_ind(10) = -9999  !< grid index values of pt_vertical_gradient_level(s)
704    INTEGER(iwp) ::  q_vertical_gradient_level_ind(10) = -9999   !< grid index values of q_vertical_gradient_level(s)
705    INTEGER(iwp) ::  s_vertical_gradient_level_ind(10) = -9999   !< grid index values of s_vertical_gradient_level(s)
706    INTEGER(iwp) ::  section(100,3)                              !< collective array for section_xy/xz/yz
707    INTEGER(iwp) ::  section_xy(100) = -9999                     !< namelist parameter
708    INTEGER(iwp) ::  section_xz(100) = -9999                     !< namelist parameter
709    INTEGER(iwp) ::  section_yz(100) = -9999                     !< namelist parameter
710    INTEGER(iwp) ::  ug_vertical_gradient_level_ind(10) = -9999  !< grid index values of ug_vertical_gradient_level(s)
711    INTEGER(iwp) ::  vg_vertical_gradient_level_ind(10) = -9999  !< grid index values of vg_vertical_gradient_level(s)
712    INTEGER(iwp) ::  subs_vertical_gradient_level_i(10) = -9999  !< grid index values of subs_vertical_gradient_level(s)
713    INTEGER(iwp), DIMENSION(0:1) ::  ntdim_2d_xy  !< number of output intervals for 2d data (xy)
714    INTEGER(iwp), DIMENSION(0:1) ::  ntdim_2d_xz  !< number of output intervals for 2d data (xz)
715    INTEGER(iwp), DIMENSION(0:1) ::  ntdim_2d_yz  !< number of output intervals for 2d data (yz)
716    INTEGER(iwp), DIMENSION(0:1) ::  ntdim_3d     !< number of output intervals for 3d data
717
718    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  grid_level_count  !< internal switch for steering the multigrid v- and w-cycles
719
720    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  mask_i         !< subdomain grid index of masked output point on x-dimension
721    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  mask_j         !< subdomain grid index of masked output point on y-dimension
722    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  mask_k         !< subdomain grid index of masked output point on z-dimension
723    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  mask_i_global  !< global grid index of masked output point on x-dimension
724    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  mask_j_global  !< global grid index of masked output point on y-dimension
725    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  mask_k_global  !< global grid index of masked output point on z-dimension
726
727    INTEGER(iwp), DIMENSION(max_masks,mask_xyz_dimension) ::  mask_k_over_surface = -1  !< namelist parameter, k index of height over surface
728
729    LOGICAL ::  agent_time_unlimited = .FALSE.                   !< namelist parameter
730    LOGICAL ::  air_chemistry = .FALSE.                          !< chemistry model switch
731    LOGICAL ::  bc_dirichlet_l = .FALSE.                         !< flag indicating dirichlet boundary condition on left model boundary
732    LOGICAL ::  bc_dirichlet_n = .FALSE.                         !< flag indicating dirichlet boundary condition on north model boundary
733    LOGICAL ::  bc_dirichlet_r = .FALSE.                         !< flag indicating dirichlet boundary condition on right model boundary
734    LOGICAL ::  bc_dirichlet_s = .FALSE.                         !< flag indicating dirichlet boundary condition on south model boundary
735    LOGICAL ::  bc_lr_cyc =.TRUE.                                !< left-right boundary condition cyclic?
736    LOGICAL ::  bc_lr_dirrad = .FALSE.                           !< left-right boundary condition dirichlet/radiation?
737    LOGICAL ::  bc_lr_raddir = .FALSE.                           !< left-right boundary condition radiation/dirichlet?
738    LOGICAL ::  bc_ns_cyc = .TRUE.                               !< north-south boundary condition cyclic?
739    LOGICAL ::  bc_ns_dirrad = .FALSE.                           !< north-south boundary condition dirichlet/radiation?
740    LOGICAL ::  bc_ns_raddir = .FALSE.                           !< north-south boundary condition radiation/dirichlet?
741    LOGICAL ::  bc_radiation_l = .FALSE.                         !< radiation boundary condition for outflow at left domain boundary
742    LOGICAL ::  bc_radiation_n = .FALSE.                         !< radiation boundary condition for outflow at north domain boundary
743    LOGICAL ::  bc_radiation_r = .FALSE.                         !< radiation boundary condition for outflow at right domain boundary
744    LOGICAL ::  bc_radiation_s = .FALSE.                         !< radiation boundary condition for outflow at south domain boundary
745    LOGICAL ::  biometeorology = .FALSE.                         !< biometeorology module switch
746    LOGICAL ::  calc_soil_moisture_during_spinup = .FALSE.       !< namelist parameter
747    LOGICAL ::  call_psolver_at_all_substeps = .TRUE.            !< namelist parameter
748    LOGICAL ::  child_domain  = .FALSE.                          !< flag indicating that model is nested in a parent domain
749    LOGICAL ::  cloud_droplets = .FALSE.                         !< namelist parameter
750    LOGICAL ::  complex_terrain = .FALSE.                        !< namelist parameter
751    LOGICAL ::  conserve_volume_flow = .FALSE.                   !< namelist parameter
752    LOGICAL ::  constant_diffusion = .FALSE.                     !< diffusion coefficient constant?
753    LOGICAL ::  constant_flux_layer = .TRUE.                     !< namelist parameter
754    LOGICAL ::  constant_heatflux = .TRUE.                       !< heat flux at all surfaces constant?
755    LOGICAL ::  constant_top_heatflux = .TRUE.                   !< heat flux at domain top constant?
756    LOGICAL ::  constant_top_momentumflux = .FALSE.              !< momentum flux at domain topconstant?
757    LOGICAL ::  constant_top_salinityflux = .TRUE.               !< constant salinity flux at ocean surface
758    LOGICAL ::  constant_top_scalarflux = .TRUE.                 !< passive-scalar flux at domain top constant?
759    LOGICAL ::  constant_scalarflux = .TRUE.                     !< passive-scalar flux at surfaces constant?
760    LOGICAL ::  constant_waterflux = .TRUE.                      !< water flux at all surfaces constant?
761    LOGICAL ::  create_disturbances = .TRUE.                     !< namelist parameter
762    LOGICAL ::  data_output_during_spinup = .FALSE.              !< namelist parameter
763    LOGICAL ::  data_output_2d_on_each_pe = .TRUE.               !< namelist parameter
764    LOGICAL ::  debug_output = .FALSE.                           !< namelist parameter
765    LOGICAL ::  debug_output_timestep = .FALSE.                  !< namelist parameter
766    LOGICAL ::  disturbance_created = .FALSE.                    !< flow disturbance imposed?
767    LOGICAL ::  do2d_at_begin = .FALSE.                          !< namelist parameter
768    LOGICAL ::  do3d_at_begin = .FALSE.                          !< namelist parameter
769    LOGICAL ::  do_sum = .FALSE.                                 !< contribute to time average of profile data?
770    LOGICAL ::  dp_external = .FALSE.                            !< namelist parameter
771    LOGICAL ::  dp_smooth = .FALSE.                              !< namelist parameter
772    LOGICAL ::  dt_fixed = .FALSE.                               !< fixed timestep (namelist parameter dt set)?
773    LOGICAL ::  dt_3d_reached                                    !< internal timestep for particle advection
774    LOGICAL ::  dt_3d_reached_l                                  !< internal timestep for particle advection
775    LOGICAL ::  first_call_lpm = .TRUE.                          !< call lpm only once per timestep?
776    LOGICAL ::  first_call_mas = .TRUE.                          !< call mas only once per timestep
777    LOGICAL ::  force_print_header = .FALSE.                     !< namelist parameter
778    LOGICAL ::  galilei_transformation = .FALSE.                 !< namelist parameter
779    LOGICAL ::  humidity = .FALSE.                               !< namelist parameter
780    LOGICAL ::  humidity_remote = .FALSE.                        !< switch for receiving near-surface humidity flux (atmosphere-ocean coupling)
781    LOGICAL ::  include_total_domain_boundaries = .FALSE.        !< store outer boundaries in restart file (MPI-IO)
782    LOGICAL ::  indoor_model = .FALSE.                           !< switch for indoor-climate and energy-demand model
783    LOGICAL ::  kolmogorov_length_scale = .FALSE.                !< switch to activate calculations in flow_statistics for the kolmogorov length scale
784    LOGICAL ::  large_scale_forcing = .FALSE.                    !< namelist parameter
785    LOGICAL ::  large_scale_subsidence = .FALSE.                 !< namelist parameter
786    LOGICAL ::  land_surface = .FALSE.                           !< use land surface model?
787    LOGICAL ::  les_dai = .FALSE.                                !< use Dai et al. turbulence closure (modified 1.5-order closure) for LES mode. Shall replace the default 1.5-order closure
788    LOGICAL ::  les_dynamic = .FALSE.                            !< use dynamic subgrid model as turbulence closure for LES mode
789    LOGICAL ::  les_default = .FALSE.                            !< use 1.5-order default turbulence closure for LES mode
790    LOGICAL ::  lsf_exception = .FALSE.                          !< use of lsf with buildings (temporary)?
791    LOGICAL ::  lsf_surf = .TRUE.                                !< use surface forcing (large scale forcing)?
792    LOGICAL ::  lsf_vert = .TRUE.                                !< use atmospheric forcing (large scale forcing)?
793    LOGICAL ::  masking_method = .FALSE.                         !< namelist parameter
794    LOGICAL ::  mg_switch_to_pe0 = .FALSE.                       !< internal multigrid switch for steering the ghost point exchange in case that data has been collected on PE0
795    LOGICAL ::  monotonic_limiter_z = .FALSE.                    !< use monotonic flux limiter for vertical scalar advection
796    LOGICAL ::  nesting_offline = .FALSE.                        !< flag controlling offline nesting in COSMO model
797    LOGICAL ::  neutral = .FALSE.                                !< namelist parameter
798    LOGICAL ::  nudging = .FALSE.                                !< namelist parameter
799    LOGICAL ::  ocean_mode = .FALSE.                             !< namelist parameter
800    LOGICAL ::  passive_scalar = .FALSE.                         !< namelist parameter
801    LOGICAL ::  plant_canopy = .FALSE.                           !< switch for use of plant canopy model
802    LOGICAL ::  random_heatflux = .FALSE.                        !< namelist parameter
803    LOGICAL ::  rans_mode = .FALSE.                              !< switch between RANS and LES mode
804    LOGICAL ::  rans_tke_e = .FALSE.                             !< use TKE-e turbulence closure for RANS mode
805    LOGICAL ::  rans_tke_l = .FALSE.                             !< use TKE-l turbulence closure for RANS mode
806    LOGICAL ::  read_svf = .FALSE.                               !< ENVPAR namelist parameter to steer input of svf (ENVPAR is provided by palmrun)
807    LOGICAL ::  run_control_header = .FALSE.                     !< onetime output of RUN_CONTROL header
808    LOGICAL ::  run_coupled = .TRUE.                             !< internal switch telling PALM to run in coupled mode (i.e. to exchange surface data) in case of atmosphere-ocean coupling
809    LOGICAL ::  salsa = .FALSE.                                  !< switch for the sectional aerosol module salsa
810    LOGICAL ::  scalar_rayleigh_damping = .TRUE.                 !< namelist parameter
811    LOGICAL ::  sloping_surface = .FALSE.                        !< use sloped surface? (namelist parameter alpha_surface)
812    LOGICAL ::  spinup = .FALSE.                                 !< perform model spinup without atmosphere code?
813    LOGICAL ::  surface_output = .FALSE.                         !< output of surface data
814    LOGICAL ::  stop_dt = .FALSE.                                !< internal switch to stop the time stepping
815    LOGICAL ::  synchronous_exchange = .FALSE.                   !< namelist parameter
816    LOGICAL ::  syn_turb_gen = .FALSE.                           !< flag for synthetic turbulence generator module
817    LOGICAL ::  terminate_run = .FALSE.                          !< terminate run (cpu-time limit, restarts)?
818    LOGICAL ::  topo_no_distinct = .FALSE.                       !< flag controlling classification of topography surfaces
819    LOGICAL ::  transpose_compute_overlap = .FALSE.              !< namelist parameter
820    LOGICAL ::  turbulent_inflow = .FALSE.                       !< namelist parameter
821    LOGICAL ::  turbulent_outflow = .FALSE.                      !< namelist parameter
822    LOGICAL ::  urban_surface = .FALSE.                          !< use urban surface model?
823    LOGICAL ::  use_cmax = .TRUE.                                !< namelist parameter
824    LOGICAL ::  use_free_convection_scaling = .FALSE.            !< namelist parameter to switch on free convection velocity scale in calculation of horizontal wind speed (surface_layer_fluxes)
825    LOGICAL ::  use_initial_profile_as_reference = .FALSE.       !< use of initial profiles as reference state?
826    LOGICAL ::  use_prescribed_profile_data = .FALSE.            !< use of prescribed wind profiles?
827                                                                 !< (namelist parameters u_profile, v_profile)
828    LOGICAL ::  use_single_reference_value = .FALSE.             !< use of single value as reference state?
829    LOGICAL ::  use_subsidence_tendencies = .FALSE.              !< namelist parameter
830    LOGICAL ::  use_surface_fluxes = .FALSE.                     !< namelist parameter
831    LOGICAL ::  use_top_fluxes = .FALSE.                         !< namelist parameter
832    LOGICAL ::  use_ug_for_galilei_tr = .TRUE.                   !< namelist parameter
833    LOGICAL ::  use_upstream_for_tke = .FALSE.                   !< namelist parameter
834    LOGICAL ::  vdi_checks = .FALSE.                             !< do internal controls after VDI 3783 Part 9
835    LOGICAL ::  virtual_flight = .FALSE.                         !< use virtual flight model
836    LOGICAL ::  virtual_measurement = .FALSE.                    !< control parameter to switch-on virtual measurements
837    LOGICAL ::  wall_adjustment = .TRUE.                         !< namelist parameter
838    LOGICAL ::  wind_turbine = .FALSE.                           !< flag for use of wind turbine model
839    LOGICAL ::  write_binary = .FALSE.                           !< ENVPAR namelist parameter to steer restart I/O (ENVPAR is provided by palmrun)
840    LOGICAL ::  write_svf = .FALSE.                              !< ENVPAR namelist parameter to steer output of svf (ENVPAR is provided by palmrun)
841    LOGICAL ::  ws_scheme_sca = .FALSE.                          !< use Wicker-Skamarock scheme (scalar advection)?
842    LOGICAL ::  ws_scheme_mom = .FALSE.                          !< use Wicker-Skamarock scheme (momentum advection)?
843
844    LOGICAL ::  data_output_xy(0:1) = .FALSE.                !< output of xy cross-section data?
845    LOGICAL ::  data_output_xz(0:1) = .FALSE.                !< output of xz cross-section data?
846    LOGICAL ::  data_output_yz(0:1) = .FALSE.                !< output of yz cross-section data?
847
848    LOGICAL, DIMENSION(max_masks) ::  mask_surface = .FALSE.   !< flag for surface-following masked output
849
850    REAL(wp) ::  advected_distance_x = 0.0_wp                  !< advected distance of model domain along x
851                                                               !< (galilei transformation)
852    REAL(wp) ::  advected_distance_y = 0.0_wp                  !< advected distance of model domain along y
853                                                               !< (galilei transformation)
854    REAL(wp) ::  alpha_surface = 0.0_wp                        !< namelist parameter
855    REAL(wp) ::  atmos_ocean_sign = 1.0_wp                     !< vertical-grid conversion factor
856                                                               !< (=1.0 in atmosphere, =-1.0 in ocean)
857    REAL(wp) ::  averaging_interval = 0.0_wp                   !< namelist parameter
858    REAL(wp) ::  averaging_interval_pr = 9999999.9_wp          !< namelist parameter
859    REAL(wp) ::  bc_pt_t_val                                   !< vertical gradient of pt near domain top
860    REAL(wp) ::  bc_q_t_val                                    !< vertical gradient of humidity near domain top
861    REAL(wp) ::  bc_s_t_val                                    !< vertical gradient of passive scalar near domain top
862    REAL(wp) ::  bottom_salinityflux = 0.0_wp                  !< namelist parameter
863    REAL(wp) ::  building_height = 50.0_wp                     !< namelist parameter
864    REAL(wp) ::  building_length_x = 50.0_wp                   !< namelist parameter
865    REAL(wp) ::  building_length_y = 50.0_wp                   !< namelist parameter
866    REAL(wp) ::  building_wall_left = 9999999.9_wp             !< namelist parameter
867    REAL(wp) ::  building_wall_south = 9999999.9_wp            !< namelist parameter
868    REAL(wp) ::  canyon_height = 50.0_wp                       !< namelist parameter
869    REAL(wp) ::  canyon_width_x = 9999999.9_wp                 !< namelist parameter
870    REAL(wp) ::  canyon_width_y = 9999999.9_wp                 !< namelist parameter
871    REAL(wp) ::  canyon_wall_left = 9999999.9_wp               !< namelist parameter
872    REAL(wp) ::  canyon_wall_south = 9999999.9_wp              !< namelist parameter
873    REAL(wp) ::  cfl_factor = -1.0_wp                          !< namelist parameter
874    REAL(wp) ::  cos_alpha_surface                             !< cosine of alpha_surface
875    REAL(wp) ::  coupling_start_time = 0.0_wp                  !< namelist parameter
876    REAL(wp) ::  days_since_reference_point = 0.0_wp           !< days after atmosphere-ocean coupling has been activated,
877                                                               !< or after spinup phase of LSM has been finished
878    REAL(wp) ::  disturbance_amplitude = 0.25_wp               !< namelist parameter
879    REAL(wp) ::  disturbance_energy_limit = 0.01_wp            !< namelist parameter
880    REAL(wp) ::  disturbance_level_b = -9999999.9_wp           !< namelist parameter
881    REAL(wp) ::  disturbance_level_t = -9999999.9_wp           !< namelist parameter
882    REAL(wp) ::  dp_level_b = 0.0_wp                           !< namelist parameter
883    REAL(wp) ::  dt = -1.0_wp                                  !< namelist parameter
884    REAL(wp) ::  dt_averaging_input = 0.0_wp                   !< namelist parameter
885    REAL(wp) ::  dt_averaging_input_pr = 9999999.9_wp          !< namelist parameter
886    REAL(wp) ::  dt_coupling = 9999999.9_wp                    !< namelist parameter
887    REAL(wp) ::  dt_data_output = 9999999.9_wp                 !< namelist parameter
888    REAL(wp) ::  dt_data_output_av = 9999999.9_wp              !< namelist parameter
889    REAL(wp) ::  dt_disturb = 9999999.9_wp                     !< namelist parameter
890    REAL(wp) ::  dt_dopr = 9999999.9_wp                        !< namelist parameter
891    REAL(wp) ::  dt_dopr_listing = 9999999.9_wp                !< namelist parameter
892    REAL(wp) ::  dt_dopts = 9999999.9_wp                       !< namelist parameter
893    REAL(wp) ::  dt_dots = 9999999.9_wp                        !< namelist parameter
894    REAL(wp) ::  dt_do2d_xy = 9999999.9_wp                     !< namelist parameter
895    REAL(wp) ::  dt_do2d_xz = 9999999.9_wp                     !< namelist parameter
896    REAL(wp) ::  dt_do2d_yz = 9999999.9_wp                     !< namelist parameter
897    REAL(wp) ::  dt_do3d = 9999999.9_wp                        !< namelist parameter
898    REAL(wp) ::  dt_max = 20.0_wp                              !< namelist parameter
899    REAL(wp) ::  dt_restart = 9999999.9_wp                     !< namelist parameter
900    REAL(wp) ::  dt_run_control = 60.0_wp                      !< namelist parameter
901    REAL(wp) ::  dt_spinup = 60.0_wp                           !< namelist parameter
902    REAL(wp) ::  dt_write_agent_data = 9999999.9_wp            !< namelist parameter
903    REAL(wp) ::  dt_3d = 0.01_wp                               !< time step
904    REAL(wp) ::  dz_max = 999.0_wp                             !< namelist parameter
905    REAL(wp) ::  dz_stretch_factor = 1.08_wp                   !< namelist parameter
906    REAL(wp) ::  dz_stretch_level = -9999999.9_wp              !< namelist parameter
907    REAL(wp) ::  e_init = 0.0_wp                               !< namelist parameter
908    REAL(wp) ::  e_min = 0.0_wp                                !< namelist parameter
909    REAL(wp) ::  end_time = 0.0_wp                             !< namelist parameter
910    REAL(wp) ::  f = 0.0_wp                                    !< Coriolis parameter
911    REAL(wp) ::  fs = 0.0_wp                                   !< Coriolis parameter
912    REAL(wp) ::  inflow_damping_height = 9999999.9_wp          !< namelist parameter
913    REAL(wp) ::  inflow_damping_width = 9999999.9_wp           !< namelist parameter
914    REAL(wp) ::  km_constant = -1.0_wp                         !< namelist parameter
915    REAL(wp) ::  latitude = 55.0_wp                            !< namelist parameter
916    REAL(wp) ::  longitude = 0.0_wp                            !< namelist parameter
917    REAL(wp) ::  mask_scale_x = 1.0_wp                         !< namelist parameter
918    REAL(wp) ::  mask_scale_y = 1.0_wp                         !< namelist parameter
919    REAL(wp) ::  mask_scale_z = 1.0_wp                         !< namelist parameter
920    REAL(wp) ::  maximum_cpu_time_allowed = 0.0_wp             !< given wall time for run
921    REAL(wp) ::  molecular_viscosity = 1.461E-5_wp             !< molecular viscosity (used in lsm and lpm)
922    REAL(wp) ::  multi_agent_system_end   = 9999999.9_wp       !< namelist parameter (see documentation)
923    REAL(wp) ::  multi_agent_system_start = 0.0_wp             !< namelist parameter (see documentation)
924    REAL(wp) ::  omega = 7.29212E-5_wp                         !< namelist parameter
925    REAL(wp) ::  omega_sor = 1.8_wp                            !< namelist parameter
926    REAL(wp) ::  outflow_source_plane = -9999999.9_wp          !< namelist parameter
927    REAL(wp) ::  particle_maximum_age = 9999999.9_wp           !< namelist parameter
928    REAL(wp) ::  prandtl_number = 1.0_wp                       !< namelist parameter
929    REAL(wp) ::  pt_damping_factor = 0.0_wp                    !< namelist parameter
930    REAL(wp) ::  pt_damping_width = 0.0_wp                     !< namelist parameter
931    REAL(wp) ::  pt_reference = 9999999.9_wp                   !< namelist parameter
932    REAL(wp) ::  pt_slope_offset = 0.0_wp                      !< temperature difference between left and right
933                                                               !< boundary of total domain
934    REAL(wp) ::  pt_surface = 300.0_wp                         !< namelist parameter
935    REAL(wp) ::  pt_surface_initial_change = 0.0_wp            !< namelist parameter
936    REAL(wp) ::  q_surface = 0.0_wp                            !< namelist parameter
937    REAL(wp) ::  q_surface_initial_change = 0.0_wp             !< namelist parameter
938    REAL(wp) ::  rayleigh_damping_factor = -1.0_wp             !< namelist parameter
939    REAL(wp) ::  rayleigh_damping_height = -1.0_wp             !< namelist parameter
940    REAL(wp) ::  recycling_width = 9999999.9_wp                !< namelist parameter
941    REAL(wp) ::  residual_limit = 1.0E-4_wp                    !< namelist parameter
942    REAL(wp) ::  restart_time = 9999999.9_wp                   !< namelist parameter
943    REAL(wp) ::  rho_reference                                 !< reference state of density
944    REAL(wp) ::  rho_surface                                   !< surface value of density
945    REAL(wp) ::  rotation_angle = 0.0_wp                       !< angle between real North and model North (clockwise)
946    REAL(wp) ::  roughness_length = 0.1_wp                     !< namelist parameter
947    REAL(wp) ::  simulated_time = 0.0_wp                       !< elapsed simulated time
948    REAL(wp) ::  simulated_time_at_begin                       !< elapsed simulated time of previous run (job chain)
949    REAL(wp) ::  sin_alpha_surface                             !< sine of alpha_surface (sloped surface)
950    REAL(wp) ::  skip_time_data_output = 0.0_wp                !< namelist parameter
951    REAL(wp) ::  skip_time_data_output_av = 9999999.9_wp       !< namelist parameter
952    REAL(wp) ::  skip_time_dopr = 9999999.9_wp                 !< namelist parameter
953    REAL(wp) ::  skip_time_do2d_xy = 9999999.9_wp              !< namelist parameter
954    REAL(wp) ::  skip_time_do2d_xz = 9999999.9_wp              !< namelist parameter
955    REAL(wp) ::  skip_time_do2d_yz = 9999999.9_wp              !< namelist parameter
956    REAL(wp) ::  skip_time_do3d = 9999999.9_wp                 !< namelist parameter
957    REAL(wp) ::  spinup_pt_amplitude = 9999999.9_wp            !< namelist parameter
958    REAL(wp) ::  spinup_pt_mean = 9999999.9_wp                 !< namelist parameter
959    REAL(wp) ::  spinup_time = 0.0_wp                          !< namelist parameter
960    REAL(wp) ::  surface_heatflux = 9999999.9_wp               !< namelist parameter
961    REAL(wp) ::  surface_pressure = 1013.25_wp                 !< namelist parameter
962    REAL(wp) ::  surface_scalarflux = 9999999.9_wp             !< namelist parameter
963    REAL(wp) ::  surface_waterflux = 9999999.9_wp              !< namelist parameter
964    REAL(wp) ::  s_surface = 0.0_wp                            !< namelist parameter
965    REAL(wp) ::  s_surface_initial_change = 0.0_wp             !< namelist parameter
966    REAL(wp) ::  termination_time_needed = 35.0_wp             !< namelist parameter
967    REAL(wp) ::  time_coupling = 0.0_wp                        !< time since last coupling (surface_coupler)
968    REAL(wp) ::  time_disturb = 0.0_wp                         !< time since last flow disturbance
969    REAL(wp) ::  time_dopr = 0.0_wp                            !< time since last profile output
970    REAL(wp) ::  time_dopr_av = 0.0_wp                         !< time since last averaged profile output
971    REAL(wp) ::  time_dopr_listing = 0.0_wp                    !< time since last profile output (ASCII) on file
972    REAL(wp) ::  time_dopts = 0.0_wp                           !< time since last particle timeseries output
973    REAL(wp) ::  time_dosp = 0.0_wp                            !< time since last spectra output
974    REAL(wp) ::  time_dosp_av = 0.0_wp                         !< time since last averaged spectra output
975    REAL(wp) ::  time_dots = 0.0_wp                            !< time since last timeseries output
976    REAL(wp) ::  time_do2d_xy = 0.0_wp                         !< time since last xy cross-section output
977    REAL(wp) ::  time_do2d_xz = 0.0_wp                         !< time since last xz cross-section output
978    REAL(wp) ::  time_do2d_yz = 0.0_wp                         !< time since last yz cross-section output
979    REAL(wp) ::  time_do3d = 0.0_wp                            !< time since last 3d output
980    REAL(wp) ::  time_do_av = 0.0_wp                           !< time since last averaged-data output
981    REAL(wp) ::  time_do_sla = 0.0_wp                          !< time since last
982    REAL(wp) ::  time_restart = 9999999.9_wp                   !< time at which run shall be terminated and restarted
983    REAL(wp) ::  time_run_control = 0.0_wp                     !< time since last RUN_CONTROL output
984    REAL(wp) ::  time_since_reference_point = 0.0_wp           !< time after atmosphere-ocean coupling has been activated, or time after spinup phase of LSM has been finished
985    REAL(wp) ::  top_heatflux = 9999999.9_wp                   !< namelist parameter
986    REAL(wp) ::  top_momentumflux_u = 9999999.9_wp             !< namelist parameter
987    REAL(wp) ::  top_momentumflux_v = 9999999.9_wp             !< namelist parameter
988    REAL(wp) ::  top_salinityflux = 9999999.9_wp               !< namelist parameter
989    REAL(wp) ::  top_scalarflux = 9999999.9_wp                 !< namelist parameter
990    REAL(wp) ::  tunnel_height = 9999999.9_wp                  !< namelist parameter
991    REAL(wp) ::  tunnel_length = 9999999.9_wp                  !< namelist parameter
992    REAL(wp) ::  tunnel_width_x = 9999999.9_wp                 !< namelist parameter
993    REAL(wp) ::  tunnel_width_y = 9999999.9_wp                 !< namelist parameter
994    REAL(wp) ::  tunnel_wall_depth = 9999999.9_wp              !< namelist parameter
995    REAL(wp) ::  ug_surface = 0.0_wp                           !< namelist parameter
996    REAL(wp) ::  u_bulk = 0.0_wp                               !< namelist parameter
997    REAL(wp) ::  u_gtrans = 0.0_wp                             !< transformed wind component (galilei transformation)
998    REAL(wp) ::  vg_surface = 0.0_wp                           !< namelist parameter
999    REAL(wp) ::  vpt_reference = 9999999.9_wp                  !< reference state of virtual potential temperature
1000    REAL(wp) ::  v_bulk = 0.0_wp                               !< namelist parameter
1001    REAL(wp) ::  v_gtrans = 0.0_wp                             !< transformed wind component (galilei transformation)
1002    REAL(wp) ::  zeta_max = 20.0_wp                            !< namelist parameter
1003    REAL(wp) ::  zeta_min = -20.0_wp                           !< namelist parameter
1004    REAL(wp) ::  z0h_factor = 1.0_wp                           !< namelist parameter
1005
1006    REAL(wp) ::  do2d_xy_last_time(0:1) = -1.0_wp                  !< time of previous xy output
1007    REAL(wp) ::  do2d_xz_last_time(0:1) = -1.0_wp                  !< time of previous xz output
1008    REAL(wp) ::  do2d_yz_last_time(0:1) = -1.0_wp                  !< time of previous yz output
1009    REAL(wp) ::  dpdxy(1:2) = 0.0_wp                               !< namelist parameter
1010    REAL(wp) ::  dt_domask(max_masks) = 9999999.9_wp               !< namelist parameter
1011    REAL(wp) ::  dz(10) = -1.0_wp                                  !< namelist parameter
1012    REAL(wp) ::  dz_stretch_level_start(9) = -9999999.9_wp         !< namelist parameter
1013    REAL(wp) ::  dz_stretch_level_end(9) = 9999999.9_wp            !< namelist parameter
1014    REAL(wp) ::  dz_stretch_factor_array(9) = 1.08_wp              !< namelist parameter
1015    REAL(wp) ::  mask_scale(3)                                     !< collective array for mask_scale_x/y/z
1016    REAL(wp) ::  pt_vertical_gradient(10) = 0.0_wp                 !< namelist parameter
1017    REAL(wp) ::  pt_vertical_gradient_level(10) = -999999.9_wp   !< namelist parameter
1018    REAL(wp) ::  q_vertical_gradient(10) = 0.0_wp                  !< namelist parameter
1019    REAL(wp) ::  q_vertical_gradient_level(10) = -999999.9_wp    !< namelist parameter
1020    REAL(wp) ::  s_vertical_gradient(10) = 0.0_wp                  !< namelist parameter
1021    REAL(wp) ::  s_vertical_gradient_level(10) = -999999.9_wp    !< namelist parameter
1022    REAL(wp) ::  skip_time_domask(max_masks) = 9999999.9_wp        !< namelist parameter
1023    REAL(wp) ::  threshold(20) = 0.0_wp                            !< namelist parameter
1024    REAL(wp) ::  time_domask(max_masks) = 0.0_wp                   !< namelist parameter
1025    REAL(wp) ::  tsc(10) = (/ 1.0_wp, 1.0_wp, 0.0_wp, 0.0_wp, &    !< array used for controlling time-integration at different substeps
1026                 0.0_wp, 0.0_wp, 0.0_wp, 0.0_wp, 0.0_wp, 0.0_wp /)
1027    REAL(wp) ::  u_profile(200) = 9999999.9_wp                     !< namelist parameter
1028    REAL(wp) ::  uv_heights(200) = 9999999.9_wp                    !< namelist parameter
1029    REAL(wp) ::  v_profile(200) = 9999999.9_wp                     !< namelist parameter
1030    REAL(wp) ::  ug_vertical_gradient(10) = 0.0_wp                 !< namelist parameter
1031    REAL(wp) ::  ug_vertical_gradient_level(10) = -9999999.9_wp    !< namelist parameter
1032    REAL(wp) ::  vg_vertical_gradient(10) = 0.0_wp                 !< namelist parameter
1033    REAL(wp) ::  vg_vertical_gradient_level(10) = -9999999.9_wp    !< namelist parameter
1034    REAL(wp) ::  volume_flow(1:3) = 0.0_wp                         !< volume flow through 1:yz-plane, 2: xz-plane, 3: xy-plane (nest childs only)
1035    REAL(wp) ::  volume_flow_area(1:3) = 0.0_wp                    !< area of the respective volume flow planes
1036    REAL(wp) ::  volume_flow_initial(1:3) = 0.0_wp                 !< initial volume flow (t=0) through the respective volume flow planes
1037    REAL(wp) ::  wall_heatflux(0:5) = 0.0_wp                       !< namelist parameter
1038    REAL(wp) ::  wall_humidityflux(0:5) = 0.0_wp                   !< namelist parameter
1039    REAL(wp) ::  wall_salinityflux(0:5) = 0.0_wp                   !< namelist parameter
1040    REAL(wp) ::  wall_scalarflux(0:5) = 0.0_wp                     !< namelist parameter
1041    REAL(wp) ::  subs_vertical_gradient(10) = 0.0_wp               !< namelist parameter
1042    REAL(wp) ::  subs_vertical_gradient_level(10) = -9999999.9_wp  !< namelist parameter
1043
1044    REAL(wp), DIMENSION(:), ALLOCATABLE ::  dp_smooth_factor  !< smoothing factor for external pressure gradient forcing
1045
1046    REAL(wp), DIMENSION(max_masks,mask_xyz_dimension) ::  mask_x = -1.0_wp  !< namelist parameter
1047    REAL(wp), DIMENSION(max_masks,mask_xyz_dimension) ::  mask_y = -1.0_wp  !< namelist parameter
1048    REAL(wp), DIMENSION(max_masks,mask_xyz_dimension) ::  mask_z = -1.0_wp  !< namelist parameter
1049
1050    REAL(wp), DIMENSION(max_masks,3) ::  mask_x_loop = -1.0_wp  !< namelist parameter
1051    REAL(wp), DIMENSION(max_masks,3) ::  mask_y_loop = -1.0_wp  !< namelist parameter
1052    REAL(wp), DIMENSION(max_masks,3) ::  mask_z_loop = -1.0_wp  !< namelist parameter
1053
1054!
1055!--    internal mask arrays ("mask,dimension,selection")
1056       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  mask       !< collective array for mask_x/y/z
1057       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  mask_loop  !< collective array for mask_x/y/z_loop
1058
1059    SAVE
1060
1061 END MODULE control_parameters
1062
1063
1064!------------------------------------------------------------------------------!
1065! Description:
1066! ------------
1067!> Definition of grid spacings.
1068!------------------------------------------------------------------------------!
1069 MODULE grid_variables
1070
1071    USE kinds
1072
1073    REAL(wp) ::  ddx          !< 1/dx
1074    REAL(wp) ::  ddx2         !< 1/dx2
1075    REAL(wp) ::  dx = 1.0_wp  !< horizontal grid size (along x-direction)
1076    REAL(wp) ::  dx2          !< dx*dx
1077    REAL(wp) ::  ddy          !< 1/dy
1078    REAL(wp) ::  ddy2         !< 1/dy2
1079    REAL(wp) ::  dy = 1.0_wp  !< horizontal grid size (along y-direction)
1080    REAL(wp) ::  dy2          !< dy*dy
1081
1082    REAL(wp), DIMENSION(:), ALLOCATABLE ::  ddx2_mg  !< 1/dx_l**2 (dx_l: grid spacing along x on different multigrid level)
1083    REAL(wp), DIMENSION(:), ALLOCATABLE ::  ddy2_mg  !< 1/dy_l**2 (dy_l: grid spacing along y on different multigrid level)
1084
1085    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  zu_s_inner  !< height of topography top on scalar grid
1086    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  zw_w_inner  !< height of topography top on w grid
1087
1088    SAVE
1089
1090 END MODULE grid_variables
1091
1092
1093!------------------------------------------------------------------------------!
1094! Description:
1095! ------------
1096!> Definition of array bounds, number of gridpoints, and wall flag arrays.
1097!------------------------------------------------------------------------------!
1098 MODULE indices
1099
1100    USE kinds
1101
1102    INTEGER(iwp) ::  nbgp = 3       !< number of boundary ghost points
1103    INTEGER(iwp) ::  ngp_sums       !< number of vertical profile grid points time number of output profiles - used for allreduce statements in MPI calls
1104    INTEGER(iwp) ::  ngp_sums_ls    !< number of vertical profile grid points time number of large-scale forcing profiles - used for allreduce statements in MPI calls
1105    INTEGER(iwp) ::  nnx            !< number of subdomain grid points in x-direction
1106    INTEGER(iwp) ::  nx = 0         !< nx+1 = total number of grid points in x-direction
1107    INTEGER(iwp) ::  nx_a           !< in coupled atmosphere-ocean runs: total number of grid points along x (atmosphere)
1108    INTEGER(iwp) ::  nx_o           !< in coupled atmosphere-ocean runs: total number of grid points along x (ocean)
1109    INTEGER(iwp) ::  nxl            !< left-most grid index of subdomain (excluding ghost points)
1110    INTEGER(iwp) ::  nxlg           !< left-most grid index of subdomain (including ghost points)
1111    INTEGER(iwp) ::  nxlu           !< =nxl+1 (at left domain boundary with inflow from left), else =nxl (used for u-velocity component)
1112    INTEGER(iwp) ::  nxr            !< right-most grid index of subdomain (excluding ghost points)
1113    INTEGER(iwp) ::  nxrg           !< right-most grid index of subdomain (including ghost points)
1114    INTEGER(iwp) ::  nx_on_file     !< nx of previous run in job chain
1115    INTEGER(iwp) ::  nny            !< number of subdomain grid points in y-direction
1116    INTEGER(iwp) ::  ny = 0         !< ny+1 = total number of grid points in y-direction
1117    INTEGER(iwp) ::  ny_a           !< in coupled atmosphere-ocean runs: total number of grid points along y (atmosphere)
1118    INTEGER(iwp) ::  ny_o           !< in coupled atmosphere-ocean runs: total number of grid points along y (ocean)
1119    INTEGER(iwp) ::  nyn            !< north-most grid index of subdomain (excluding ghost points)
1120    INTEGER(iwp) ::  nyng           !< north-most grid index of subdomain (including ghost points)
1121    INTEGER(iwp) ::  nys            !< south-most grid index of subdomain (excluding ghost points)
1122    INTEGER(iwp) ::  nysg           !< south-most grid index of subdomain (including ghost points)
1123    INTEGER(iwp) ::  nysv           !< =nys+1 (at south domain boundary with inflow from south), else =nys (used for v-velocity component)
1124    INTEGER(iwp) ::  ny_on_file     !< ny of previous run in job chain
1125    INTEGER(iwp) ::  nnz            !< number of subdomain grid points in z-direction
1126    INTEGER(iwp) ::  nz = 0         !< total number of grid points in z-direction
1127    INTEGER(iwp) ::  nzb            !< bottom grid index of computational domain
1128    INTEGER(iwp) ::  nzb_diff       !< will be removed
1129    INTEGER(iwp) ::  nzb_max        !< vertical index of topography top
1130    INTEGER(iwp) ::  nzt            !< nzt+1 = top grid index of computational domain
1131    INTEGER(iwp) ::  topo_min_level !< minimum topography-top index (usually equal to nzb)
1132
1133    INTEGER(idp), DIMENSION(:), ALLOCATABLE ::  ngp_3d        !< number of grid points of the total domain
1134    INTEGER(idp), DIMENSION(:), ALLOCATABLE ::  ngp_3d_inner  !< ! need to have 64 bit for grids > 2E9
1135
1136    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  ngp_2dh  !< number of grid points of a horizontal cross section through the total domain
1137    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  nxl_mg   !< left-most grid index of subdomain on different multigrid level
1138    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  nxr_mg   !< right-most grid index of subdomain on different multigrid level
1139    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  nyn_mg   !< north-most grid index of subdomain on different multigrid level
1140    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  nys_mg   !< south-most grid index of subdomain on different multigrid level
1141    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  nzt_mg   !< top-most grid index of subdomain on different multigrid level
1142
1143
1144    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  ngp_2dh_outer     !< number of horizontal grid points which are non-topography and non-surface-bounded
1145    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  ngp_2dh_s_inner   !< number of horizontal grid points which are non-topography
1146    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  mg_loc_ind        !< internal array to store index bounds of all PEs of that multigrid level where data is collected to PE0
1147
1148    INTEGER(iwp), DIMENSION(:,:,:), POINTER ::  flags  !< pointer to wall_flags_1-10
1149
1150    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE,  TARGET ::  wall_flags_1   !< topograpyh masking flag on multigrid level 1
1151    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE,  TARGET ::  wall_flags_2   !< topograpyh masking flag on multigrid level 2
1152    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE,  TARGET ::  wall_flags_3   !< topograpyh masking flag on multigrid level 3
1153    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE,  TARGET ::  wall_flags_4   !< topograpyh masking flag on multigrid level 4
1154    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE,  TARGET ::  wall_flags_5   !< topograpyh masking flag on multigrid level 5
1155    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE,  TARGET ::  wall_flags_6   !< topograpyh masking flag on multigrid level 6
1156    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE,  TARGET ::  wall_flags_7   !< topograpyh masking flag on multigrid level 7
1157    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE,  TARGET ::  wall_flags_8   !< topograpyh masking flag on multigrid level 8
1158    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE,  TARGET ::  wall_flags_9   !< topograpyh masking flag on multigrid level 9
1159    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE,  TARGET ::  wall_flags_10  !< topograpyh masking flag on multigrid level 10
1160
1161    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE ::  advc_flags_m            !< flags used to degrade order of advection scheme for momentum
1162    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE ::  advc_flags_s            !< flags used to degrade order of advection scheme for scalar quantities
1163    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE ::  topo_top_ind            !< precalculated topography top indices
1164    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE ::  wall_flags_static_0     !< flags to mask topography and surface-bounded grid points
1165    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE ::  wall_flags_total_0      !< merged array, which contains the static and dynamic flags
1166
1167    SAVE
1168
1169 END MODULE indices
1170
1171
1172!------------------------------------------------------------------------------!
1173! Description:
1174! ------------
1175!> Interfaces for special subroutines which use optional parameters.
1176!------------------------------------------------------------------------------!
1177 MODULE interfaces
1178
1179    INTERFACE
1180
1181!------------------------------------------------------------------------------!
1182! Description:
1183! ------------
1184!> @todo Missing subroutine description.
1185!------------------------------------------------------------------------------!
1186       SUBROUTINE global_min_max ( i1, i2, j1, j2, k1, k2, array, mode, offset, &
1187                                   result, result_ijk, result1, result1_ijk )
1188
1189          USE kinds
1190
1191          CHARACTER (LEN=*), INTENT(IN) ::  mode                      !< mode of global min/max function: can be 'min', 'max', 'minmax', 'abs', or 'absoff'
1192          INTEGER(iwp), INTENT(IN)      ::  i1                        !< internal index of min/max function
1193          INTEGER(iwp), INTENT(IN)      ::  i2                        !< internal index of min/max function
1194          INTEGER(iwp), INTENT(IN)      ::  j1                        !< internal index of min/max function
1195          INTEGER(iwp), INTENT(IN)      ::  j2                        !< internal index of min/max function
1196          INTEGER(iwp), INTENT(IN)      ::  k1                        !< internal index of min/max function
1197          INTEGER(iwp), INTENT(IN)      ::  k2                        !< internal index of min/max function
1198          INTEGER(iwp)                  ::  result_ijk(3)             !< grid index result of min/max function
1199          INTEGER(iwp), OPTIONAL        ::  result1_ijk(3)            !< optional grid index result of min/max function
1200          REAL(wp)                      ::  offset                    !< min/max function calculates absolute value with respect to an offset
1201          REAL(wp)                      ::  result                    !< result of min/max function
1202          REAL(wp), OPTIONAL            ::  result1                   !< optional result of min/max function
1203          REAL(wp), INTENT(IN)          ::  array(i1:i2,j1:j2,k1:k2)  !< input array of min/max function
1204
1205       END SUBROUTINE global_min_max
1206
1207    END INTERFACE
1208
1209    SAVE
1210
1211 END MODULE interfaces
1212
1213
1214!------------------------------------------------------------------------------!
1215! Description:
1216! ------------
1217!> Interfaces for subroutines with pointer arguments called in
1218!> prognostic_equations.
1219!------------------------------------------------------------------------------!
1220 MODULE pointer_interfaces
1221
1222    INTERFACE
1223
1224!------------------------------------------------------------------------------!
1225! Description:
1226! ------------
1227!> @todo Missing subroutine description.
1228!------------------------------------------------------------------------------!
1229       SUBROUTINE advec_s_bc( sk, sk_char )
1230
1231          USE kinds
1232
1233          CHARACTER (LEN=*), INTENT(IN) ::  sk_char  !< string for treated scalar in Bott-Chlond scheme
1234
1235          REAL(wp), DIMENSION(:,:,:), POINTER ::  sk  !< treated scalar array in Bott-Chlond scheme
1236
1237       END SUBROUTINE advec_s_bc
1238
1239    END INTERFACE
1240
1241    SAVE
1242
1243 END MODULE pointer_interfaces
1244
1245
1246!------------------------------------------------------------------------------!
1247! Description:
1248! ------------
1249!> Definition of variables which define processor topology and the exchange of
1250!> ghost point layers. This module must be placed in all routines containing
1251!> MPI-calls.
1252!------------------------------------------------------------------------------!
1253 MODULE pegrid
1254
1255    USE kinds
1256
1257#if defined( __parallel )
1258#if defined( __mpifh )
1259    INCLUDE "mpif.h"
1260#else
1261    USE MPI
1262#endif
1263#endif
1264    CHARACTER(LEN=2) ::  send_receive = 'al'     !<
1265    CHARACTER(LEN=7) ::  myid_char = ''          !< character string containing processor id number
1266
1267    INTEGER(iwp) ::  comm1dx                     !< communicator for domain decomposition along x
1268    INTEGER(iwp) ::  comm1dy                     !< communicator for domain decomposition along y
1269    INTEGER(iwp) ::  comm2d                      !< standard 2d (xy) communicator used in PALM for the process group the PE belongs to
1270    INTEGER(iwp) ::  comm_inter                  !< intercommunicator that connects atmosphere/ocean process groups
1271    INTEGER(iwp) ::  comm_palm                   !< internal communicator used during the MPI setup at the beginning of a run
1272    INTEGER(iwp) ::  id_inflow = 0               !< myidx of procs at inflow (turbulent inflow method)
1273    INTEGER(iwp) ::  id_outflow = 0              !< myidx of procs at outflow (turbulent outflow method)
1274    INTEGER(iwp) ::  id_outflow_source = 0       !< myidx of procs including ouflow source plane (turbulent outflow method)
1275    INTEGER(iwp) ::  id_recycling = 0            !< myidx of procs containing the recycling plane (turbulence recycling method)
1276    INTEGER(iwp) ::  ierr                        !< standard error parameter in MPI calls
1277    INTEGER(iwp) ::  myid = 0                    !< id number of processor element
1278    INTEGER(iwp) ::  myidx = 0                   !< id number of processor elements with same position along x-direction
1279    INTEGER(iwp) ::  myidy = 0                   !< id number of processor elements with same position along y-direction
1280    INTEGER(iwp) ::  ndim = 2                    !< dimension of the virtual PE grid
1281    INTEGER(iwp) ::  ngp_a                       !< used in atmosphere/ocean coupling: total number of horizontal grid points (atmosphere)
1282    INTEGER(iwp) ::  ngp_o                       !< used in atmosphere/ocean coupling: total number of horizontal grid points (ocean)
1283    INTEGER(iwp) ::  ngp_xy                      !< used in atmosphere/ocean coupling: number of grid points of the subdomain
1284    INTEGER(iwp) ::  ngp_y                       !< number of subdomain grid points along y including ghost points
1285    INTEGER(iwp) ::  npex = -1                   !< number of processor elements in x-direction
1286    INTEGER(iwp) ::  npey = -1                   !< number of processor elements in y-direction
1287    INTEGER(iwp) ::  numprocs = 1                !< total number of appointed processor elements
1288    INTEGER(iwp) ::  numprocs_previous_run = -1  !< total number of appointed processor elements in previous run (job chain)
1289    INTEGER(iwp) ::  pleft                       !< MPI id of left neigbour pe
1290    INTEGER(iwp) ::  pnorth                      !< MPI id of right neigbour pe
1291    INTEGER(iwp) ::  pright                      !< MPI id of south neigbour pe
1292    INTEGER(iwp) ::  psouth                      !< MPI id of north neigbour pe
1293    INTEGER(iwp) ::  req_count = 0               !< MPI return variable - checks if Send-Receive operation is already finished
1294    INTEGER(iwp) ::  sendrecvcount_xy            !< number of subdomain gridpoints to be exchanged in direct transpositions (y --> x, or x --> y) or second (2d) transposition x --> y
1295    INTEGER(iwp) ::  sendrecvcount_yz            !< number of subdomain gridpoints to be exchanged in third (2d) transposition y --> z
1296    INTEGER(iwp) ::  sendrecvcount_zx            !< number of subdomain gridpoints to be exchanged in first (2d) transposition z --> x
1297    INTEGER(iwp) ::  sendrecvcount_zyd           !< number of subdomain gridpoints to be exchanged in direct transpositions z --> y (used for calculating spectra)
1298    INTEGER(iwp) ::  target_id                   !< in atmosphere/ocean coupling: id of the ocean/atmosphere counterpart PE with whom the atmosphere/ocean PE exchanges data
1299    INTEGER(iwp) ::  tasks_per_node = -9999      !< MPI tasks per compute node
1300    INTEGER(iwp) ::  threads_per_task = 1        !< number of OPENMP threads per MPI task
1301    INTEGER(iwp) ::  type_x                      !< derived MPI datatype for 2-D ghost-point exchange - north / south
1302    INTEGER(iwp) ::  type_xy                     !< derived MPI datatype for 2-D ghost-point exchange - north / south
1303    INTEGER(iwp) ::  type_y                      !< derived MPI datatype for 2-D exchange in atmosphere-ocean coupler
1304
1305    INTEGER(iwp) ::  pdims(2) = 1  !< number of processors along x-y dimension
1306    INTEGER(iwp) ::  req(100)      !< MPI return variable indicating if send-receive operation is finished
1307
1308    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  hor_index_bounds               !< horizontal index bounds
1309    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  hor_index_bounds_previous_run  !< horizontal index bounds of previous run
1310
1311    LOGICAL ::  collective_wait = .FALSE.          !< switch to set an explicit MPI barrier in front of all collective MPI calls
1312
1313    TYPE virtual_pe_grid
1314       INTEGER(iwp) ::  mpi_communicator         !< MPI communicator id
1315       INTEGER(iwp) ::  pleft                    !< MPI id of left neigbour pe
1316       INTEGER(iwp) ::  pright                   !< MPI id of right neigbour pe
1317       INTEGER(iwp) ::  psouth                   !< MPI id of south neigbour pe
1318       INTEGER(iwp) ::  pnorth                   !< MPI id of north neigbour pe
1319    END TYPE virtual_pe_grid
1320
1321    TYPE(virtual_pe_grid) ::  communicator_configurations(4)  !< stores the four possible 2d virtual grids:
1322                                                              !< cyclic, cyclic along x, cyclic along y, non-cyclic
1323
1324#if defined( __parallel )
1325    INTEGER(iwp) ::  ibuf(12)                 !< internal buffer for calculating MPI settings
1326    INTEGER(iwp) ::  pcoord(2)                !< PE coordinates along x and y
1327    INTEGER(iwp) ::  status(MPI_STATUS_SIZE)  !< MPI status variable used in various MPI calls
1328
1329    INTEGER(iwp), DIMENSION(MPI_STATUS_SIZE,100) ::  wait_stat  !< MPI status variable used in various MPI calls
1330
1331    INTEGER(iwp) ::  type_x_byte !< derived MPI datatype for 2-D 8-bit integer ghost-point exchange - north / south
1332    INTEGER(iwp) ::  type_y_byte !< derived MPI datatype for 2-D integer ghost-point exchange - left / right
1333
1334    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  ngp_xz      !< number of ghost points in xz-plane on different multigrid level
1335    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  ngp_xz_int  !< number of ghost points in xz-plane on different multigrid level
1336    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  ngp_yz      !< number of ghost points in yz-plane on different multigrid level
1337    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  ngp_yz_int  !< number of ghost points in yz-plane on different multigrid level
1338    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  type_x_int  !< derived MPI datatype for 2-D integer ghost-point exchange - north / south
1339    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  type_xz     !< derived MPI datatype for 3-D integer ghost-point exchange - north / south
1340    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  type_xz_int !< derived MPI datatype for 3-D integer ghost-point exchange - north / south
1341    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  type_y_int  !< derived MPI datatype for 2-D integer ghost-point exchange - left / right
1342    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  type_yz     !< derived MPI datatype for 3-D integer ghost-point exchange - left / right
1343    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  type_yz_int !< derived MPI datatype for 3-D integer ghost-point exchange - left / right
1344
1345    LOGICAL ::  left_border_pe  = .FALSE.  !< = .TRUE. if PE is on left border of computational domain
1346    LOGICAL ::  north_border_pe = .FALSE.  !< = .TRUE. if PE is on north border of computational domain
1347    LOGICAL ::  reorder = .TRUE.           !< switch to allow MPI the reorder of ranking (e.g. row-major or column-major)
1348    LOGICAL ::  right_border_pe = .FALSE.  !< = .TRUE. if PE is on right border of computational domain
1349    LOGICAL ::  south_border_pe = .FALSE.  !< = .TRUE. if PE is on south border of computational domain
1350
1351    LOGICAL, DIMENSION(2) ::  cyclic = (/ .TRUE. , .TRUE. /)  !< boundary conditions of the virtual PE grid
1352    LOGICAL, DIMENSION(2) ::  remain_dims                     !< internal array used to determine sub-topologies for transpositions
1353#endif
1354
1355    SAVE
1356
1357 END MODULE pegrid
1358
1359
1360!------------------------------------------------------------------------------!
1361! Description:
1362! ------------
1363!> Definition of variables which control PROFIL-output.
1364!------------------------------------------------------------------------------!
1365 MODULE profil_parameter
1366
1367    USE kinds
1368
1369    INTEGER(iwp), PARAMETER ::  crmax = 100  !< maximum number of coordinate systems for profile output
1370
1371    CHARACTER (LEN=27), DIMENSION(20) ::  cross_ts_profiles = &  !< time series to be plotted into one coordinate system, respectively
1372                           (/ ' E E*                      ', &
1373                              ' dt                        ', &
1374                              ' u* w*                     ', &
1375                              ' th*                       ', &
1376                              ' umax vmax wmax            ', &
1377                              ' div_old div_new           ', &
1378                              ' zi_wtheta zi_theta        ', &
1379                              ' w"theta"0 w"theta" wtheta ', &
1380                              ' theta(0) theta(zp)        ', &
1381                              ' splux spluy spluz         ', &
1382                              ' L                         ', &
1383                            ( '                           ', i9 = 1, 9 ) /)
1384
1385    CHARACTER (LEN=100), DIMENSION(crmax) ::  cross_profiles = &  !< quantities to be plotted into one coordinate system, respectively
1386                          (/ ' u v                                          ', &
1387                             ' pt                                           ', &
1388                             ' w"theta" w*theta* w*theta*BC wtheta wthetaBC ', &
1389                             ' w"u" w*u* wu w"v" w*v* wv                    ', &
1390                             ' km kh                                        ', &
1391                             ' l                                            ', &
1392             ( '                                              ', i9 = 1, 94 ) /)
1393
1394    INTEGER(iwp) ::  profile_columns = 2  !< number of coordinate systems on a profile plot per column
1395    INTEGER(iwp) ::  profile_rows = 3     !< number of coordinate systems on a profile plot per row
1396
1397    INTEGER(iwp) ::  dopr_index(300) = 0                !< index number of respective profile quantity
1398    INTEGER(iwp) ::  dopr_initial_index(300) = 0        !< index number of initial profiles to be output
1399
1400    SAVE
1401
1402 END MODULE profil_parameter
1403
1404!------------------------------------------------------------------------------!
1405! Description:
1406! ------------
1407!> Definition of statistical quantities, e.g. global sums.
1408!------------------------------------------------------------------------------!
1409 MODULE statistics
1410
1411    USE kinds
1412
1413    CHARACTER (LEN=40) ::  region(0:9) =  &  !< label for statistic region
1414                           'total domain                            '
1415
1416    INTEGER(iwp) ::  pr_palm = 200          !< maximum number of output profiles
1417    INTEGER(iwp) ::  statistic_regions = 0  !< identifier for statistic regions
1418
1419    INTEGER(iwp) ::  u_max_ijk(3) = -1  !< index values (i,j,k) of location where u_max occurs
1420    INTEGER(iwp) ::  v_max_ijk(3) = -1  !< index values (i,j,k) of location where v_max occurs
1421    INTEGER(iwp) ::  w_max_ijk(3) = -1  !< index values (i,j,k) of location where w_max occurs
1422
1423    LOGICAL ::  flow_statistics_called = .FALSE.  !< flag that tells other routines if flow statistics was executed
1424                                                  !< (after each timestep)
1425
1426    REAL(wp) ::  u_max = 0.0_wp  !< maximum of absolute u-veloctiy in entire domain
1427    REAL(wp) ::  v_max = 0.0_wp  !< maximum of absolute v-veloctiy in entire domain
1428    REAL(wp) ::  w_max = 0.0_wp  !< maximum of absolute w-veloctiy in entire domain
1429
1430    REAL(wp), DIMENSION(2) ::  z_i  !< inversion height
1431
1432    REAL(wp), DIMENSION(:), ALLOCATABLE ::  mean_surface_level_height  !< mean surface level height for the different statistic regions
1433    REAL(wp), DIMENSION(:), ALLOCATABLE ::  sums_divnew_l              !< subdomain sum (_l) of divergence after pressure
1434                                                                       !< solver call (new)
1435    REAL(wp), DIMENSION(:), ALLOCATABLE ::  sums_divold_l              !< subdomain sum (_l) of divergence before pressure
1436                                                                       !< solver call (old)
1437    REAL(wp), DIMENSION(:), ALLOCATABLE ::  weight_substep             !< weighting factor for substeps in timestepping
1438    REAL(wp), DIMENSION(:), ALLOCATABLE ::  weight_pres                !< substep weighting factor for pressure solver
1439
1440    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums             !< global sum array for the various output quantities
1441    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_salsa_ws_l  !< subdomain sum of vertical salsa flux w's' (5th-order advection scheme only)
1442    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wsts_bc_l   !< subdomain sum of sensible heat flux in Bott-Chlond scheme
1443    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  ts_value         !< timeseries output array for the various output quantities
1444    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wsus_ws_l   !< subdomain sum of vertical momentum flux w'u' (5th-order advection scheme only)
1445    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wsvs_ws_l   !< subdomain sum of vertical momentum flux w'v' (5th-order advection scheme only)
1446    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_us2_ws_l    !< subdomain sum of horizontal momentum flux u'u' (5th-order advection scheme only)
1447    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_vs2_ws_l    !< subdomain sum of horizontal momentum flux v'v' (5th-order advection scheme only)
1448    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_ws2_ws_l    !< subdomain sum of vertical momentum flux w'w' (5th-order advection scheme only)
1449    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wsncs_ws_l  !< subdomain sum of vertical clouddrop-number concentration flux w'nc' (5th-order advection scheme only)
1450    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wsnis_ws_l  !< subdomain sum of vertical ice crystal concentration flux w'ni' (5th-order advection scheme only)
1451    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wsnrs_ws_l  !< subdomain sum of vertical raindrop-number concentration flux w'nr' (5th-order advection scheme only)
1452    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wspts_ws_l  !< subdomain sum of vertical sensible heat flux w'pt' (5th-order advection scheme only)
1453    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wsqs_ws_l   !< subdomain sum of vertical latent heat flux w'q' (5th-order advection scheme only)
1454    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wsqcs_ws_l  !< subdomain sum of vertical cloudwater flux w'qc' (5th-order advection scheme only)
1455    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wsqis_ws_l  !< subdomain sum of vertical ice crystal flux w'qi' (5th-order advection scheme only)
1456    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wsqrs_ws_l  !< subdomain sum of vertical rainwater flux w'qr' (5th-order advection scheme only)
1457    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wssas_ws_l  !< subdomain sum of vertical salinity flux w'sa' (5th-order advection scheme only)
1458    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wsss_ws_l   !< subdomain sum of vertical passive scalar flux w's' (5th-order advection scheme only)
1459    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_ls_l        !< subdomain sum of large scale forcing and nudging tendencies
1460
1461    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  hom_sum             !< sum array for horizontal mean
1462    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  rmask               !< REAL flag array (0.0 or 1.0) for statistic regions
1463    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  sums_l              !< subdomain sum (_l) gathered for various quantities
1464    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  sums_l_l            !< subdomain sum (_l) of mixing length from diffusivities
1465
1466    REAL(wp), DIMENSION(:,:,:,:), ALLOCATABLE ::  hom  !< horizontal mean of various quantities (profiles/timeseries)
1467
1468    SAVE
1469
1470 END MODULE statistics
1471
1472
1473
1474!------------------------------------------------------------------------------!
1475! Description:
1476! ------------
1477!> Definition of indices for transposed arrays.
1478!------------------------------------------------------------------------------!
1479 MODULE transpose_indices
1480
1481    USE kinds
1482
1483    INTEGER(iwp) ::  nxl_y   !< internal index bound for transpositions
1484    INTEGER(iwp) ::  nxl_yd  !< internal index bound for transpositions
1485    INTEGER(iwp) ::  nxl_z   !< internal index bound for transpositions
1486    INTEGER(iwp) ::  nxr_y   !< internal index bound for transpositions
1487    INTEGER(iwp) ::  nxr_yd  !< internal index bound for transpositions
1488    INTEGER(iwp) ::  nxr_z   !< internal index bound for transpositions
1489    INTEGER(iwp) ::  nyn_x   !< internal index bound for transpositions
1490    INTEGER(iwp) ::  nyn_z   !< internal index bound for transpositions
1491    INTEGER(iwp) ::  nys_x   !< internal index bound for transpositions
1492    INTEGER(iwp) ::  nys_z   !< internal index bound for transpositions
1493    INTEGER(iwp) ::  nzb_x   !< internal index bound for transpositions
1494    INTEGER(iwp) ::  nzb_y   !< internal index bound for transpositions
1495    INTEGER(iwp) ::  nzb_yd  !< internal index bound for transpositions
1496    INTEGER(iwp) ::  nzt_x   !< internal index bound for transpositions
1497    INTEGER(iwp) ::  nzt_y   !< internal index bound for transpositions
1498    INTEGER(iwp) ::  nzt_yd  !< internal index bound for transpositions
1499
1500    SAVE
1501
1502 END MODULE transpose_indices
Note: See TracBrowser for help on using the repository browser.