source: palm/tags/release-5.0/SOURCE/modules.f90 @ 4417

Last change on this file since 4417 was 2696, checked in by kanani, 6 years ago

Merge of branch palm4u into trunk

  • Property svn:keywords set to Id
File size: 145.3 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-2017 Leibniz Universitaet Hannover
18!------------------------------------------------------------------------------!
19!
20! Current revisions:
21! ------------------
22!
23!
24! Former revisions:
25! -----------------
26! $Id: modules.f90 2696 2017-12-14 17:12:51Z monakurppa $
27! Implementation of uv exposure model (FK)
28! + turbulence closure variables (control_parameters)
29! + arrays for prognostic equation of disspiation (arrays_3d)
30! + km_av, kh_av (TG)
31! Implementation of chemistry module (FK)
32! -lod
33! +topo_distinct (MS)
34!
35! 2669 2017-12-06 16:03:27Z raasch
36! CONTIGUOUS-attribut added to 3d pointer arrays,
37! coupling_char extended to LEN=8
38!
39! 2575 2017-10-24 09:57:58Z maronga
40! Renamed phi -> latitude, moved longitude from radiation model to modules
41!
42! 2563 2017-10-19 15:36:10Z Giersch
43! Variable wind_turbine was added to control_parameters
44!
45! 2550 2017-10-16 17:12:01Z boeske
46! complex_terrain namelist parameter added
47!
48! 2508 2017-10-02 08:57:09Z suehring
49! Change default value for pt/q/s/sa_vertical_gradient_level
50!
51! 2499 2017-09-22 16:47:58Z kanani
52! Default changed to fft_method = 'temperton-algorithm'
53!
54! 2408 2017-09-05 15:47:53Z gronemeier
55! Changed default value of mg_cycles from -1 to 4.
56!
57! 2375 2017-08-29 14:10:28Z schwenkel
58! Moved mass_of_solute, molecular_weight_of_solute, molecular_weight_of_water,
59! vanthoff back from particle attributes because they can now also be used in
60! bulk microphysics.
61! Added aerosol_bulk, aerosol_nacl, aerosol_c3h4o4, aerosol_nh4no3
62!
63! 2372 2017-08-25 12:37:32Z sward
64! y_shift namelist parameter added
65!
66! 2339 2017-08-07 13:55:26Z gronemeier
67! corrected timestamp in header
68!
69! 2338 2017-08-07 12:15:38Z gronemeier
70! moved 1d-model varaibles to own module model_1d_mod
71!
72! 2337 2017-08-07 08:59:53Z gronemeier
73! -old_dt_1d
74! +l1d_diss
75!
76! 2326 2017-08-01 07:23:24Z gronemeier
77! Updated variable descriptions
78!
79! 2320 2017-07-21 12:47:43Z suehring
80! -ptnudge, qnudge, tnudge, td_lsa_lpt, td_lsa_q, td_sub_lpt, td_sub_q, ug_vert,
81!  vg_vert, unudge, vnudge, wsubs_vert, shf_surf, p_surf, pt_surf, q_surt,
82!  qsws_surf, tmp_tnudge, timenudge, time_surf, time_vert
83!
84! 2300 2017-06-29 13:31:14Z raasch
85! default value for host changed to '????', default value for loop_optimization
86! changed to 'cache', default value for termination_time_needed set to 35.0
87!
88! 2298 2017-06-29 09:28:18Z raasch
89! missing variable descriptions have been added,
90! type of write_binary changed from CHARACTER to LOGICAL
91! -plot_precision, plot_3d_precision, return_addres, return_username,
92! avs_data_file, exchange_mg, sendrecvcound_yxd, sendrecv_in_background,
93! port_name, profile_number, cross_ts_numbers, cross_ts_number_count,
94! dots_crossindex, dots_index, cross_ts_uymax, cross_ts_uymax_computed,
95! cross_ts_uymin, cross_ts_uymin_computed
96!
97! 2296 2017-06-28 07:53:56Z maronga
98! Added parameters for model spinup
99!
100! 2292 2017-06-20 09:51:42Z schwenkel
101! Implementation of new microphysic scheme: cloud_scheme = 'morrison'
102! includes two more prognostic equations for cloud drop concentration (nc) 
103! and cloud water content (qc).
104!
105! 2277 2017-06-12 10:47:51Z kanani
106! Added doxygen comments for variables/parameters,
107! removed unused variables dissipation_control, do2d_xy_n, do2d_xz_n, do2d_yz_n,
108! do3d_avs_n, lptnudge, lqnudge, lunudge, lvnudge, lwnudge, skip_do_avs,
109! sums_up_fraction_l.
110!
111! 2259 2017-06-08 09:09:11Z gronemeier
112! Implemented synthetic turbulence generator
113!
114! 2256 2017-06-07 13:58:08Z suehring
115! Change default value of zeta_min to -20
116! Increase dimension for wall_heatflux, etc.
117!
118! 2233 2017-05-30 18:08:54Z suehring
119!
120! 2232 2017-05-30 17:47:52Z suehring
121! Renamed wall_flags_0 and wall_flags_00 into advc_flags_1 and advc_flags_2,
122! respectively. Moreover, introduced further flag array wall_flags_0.
123!
124! Adjustments for new topography concept:
125!   -fwxm, fwxp, fwym, fwyp, fxm, fxp, fym, fyp, rif_wall, wall_e_x, wall_e_y,
126!   -wall_v, wall_u, wall_w_x, wall_w_y, wall_qflux, wall_sflux, wall_nrflux,
127!   -wall_qrflux
128!
129! Adjustments for new surface concept:
130!   +land_surface
131!   -z0, z0h, z0q, us, ts, qs, qsws, nrs, nrsws, qrs, qrsws, ssws, ss, saswsb
132!   -nzb_diff_u, nzb_diff_v, nzt_diff
133!   -uswst, vswst, tswst, sswst, saswst, qswst, qrswst, nrswst, qswst_remote
134!
135! Generic tunnel setup:
136!   +tunnel_height, tunnel_length, tunnel_width_x, tunnel_width_y,
137!   +tunnel_wall_depth
138!
139! Topography input via netcdf
140!   +lod
141!
142! 2200 2017-04-11 11:37:51Z suehring
143! -monotonic_adjustment
144!
145! 2174 2017-03-13 08:18:57Z maronga
146! Changed default values for most_method to 'newton'
147!
148! 2118 2017-01-17 16:38:49Z raasch
149! -acc_rank, background_communication, i_left, i_right, j_south, j_north,
150!  num_acc_per_node, on_device
151!
152! 2107 2017-01-09 12:21:49Z kanani
153! Preparation for doxygen comments (Giersch)
154!
155! 2050 2016-11-08 15:00:55Z gronemeier
156! Implement turbulent outflow condition
157!
158! 2037 2016-10-26 11:15:40Z knoop
159! Anelastic approximation implemented
160!
161! 2031 2016-10-21 15:11:58Z knoop
162! renamed variable rho to rho_ocean and rho_av to rho_ocean_av
163!
164! 2011 2016-09-19 17:29:57Z kanani
165! +urban_surface, +lsf_exception, +varnamelength
166!
167! 2007 2016-08-24 15:47:17Z kanani
168! Increased DIMENSION of data_output, data_output_user, do2d, do3d
169!
170! 2000 2016-08-20 18:09:15Z knoop
171! Forced header and separation lines into 80 columns
172!
173! 1992 2016-08-12 15:14:59Z suehring
174! +constant_top_scalarflux, top_scalarflux
175! default of bc_s_t adjusted
176!
177! 1968 2016-07-18 12:01:49Z suehring
178! Changed dimension for MPI-datatypes type_x_int and type_y_int
179!
180! 1960 2016-07-12 16:34:24Z suehring
181! Separate humidity and passive scalar
182! +bc_s_t_val, diss_s_s, diss_l_s, flux_s_s, flux_l_s, s, sp, s1, s2, s3, ssws_av,
183!  s_init, s_surf, sums_wsss_ws_l, ss, ssws, sswst, ts_m, wall_sflux
184! +constant_scalarflux, ibc_s_b, ibc_s_t, s_vertical_gradient_level_ind
185!
186! Unused variables removed
187! -gamma_x, gamma_y, gamma_z, var_x, var_y, var_z
188!
189! Change initial values (in order to unify gradient calculation):
190! pt_vertical_gradient_level, sa_vertical_gradient_level
191!
192! 1957 2016-07-07 10:43:48Z suehring
193! +fl_max, num_leg, num_var_fl, num_var_fl_user, var_fl_max, virtual_flight
194!
195! 1918 2016-05-27 14:35:57Z raasch
196! default timestep switched from -1.0 to +1.0 in order to avoid wrong sign of
197! initially calculated divergence
198!
199! 1906 2016-05-24 14:38:08Z suehring
200! default value of mg_switch_to_pe0_level changed to -1
201!
202! 1849 2016-04-08 11:33:18Z hoffmann
203! bfactor, mass_of_solute, molecular_weight_of_solute, molecular_weight_of_water,
204! vanthoff moved to mod_particle_attributes.
205! dt_micro and several cloud_parameters moved to microphysics_mod.
206! 1d-microphysics profiles moved to microphysics_mod.
207!
208! 1845 2016-04-08 08:29:13Z raasch
209! -nzb_2d
210!
211! 1833 2016-04-07 14:23:03Z raasch
212! spectra parameter moved to spectra module
213!
214! 1831 2016-04-07 13:15:51Z hoffmann
215! curvature_solution_effects removed
216! turbulence renamed collision_turbulence, drizzle renamed
217! cloud_water_sedimentation
218!
219! 1822 2016-04-07 07:49:42Z hoffmann
220! icloud_scheme removed. microphysics_sat_adjust, microphysics_kessler,
221! microphysics_seifert added.
222!
223! 1815 2016-04-06 13:49:59Z raasch
224! cpp-directive for decalpha removed
225!
226! 1808 2016-04-05 19:44:00Z raasch
227! MPI module used by default on all machines
228!
229! 1804 2016-04-05 16:30:18Z maronga
230! Removed code for parameter file check (__check)
231!
232! 1788 2016-03-10 11:01:04Z maronga
233! Added roughness length for moisture (z0q)
234!
235! 1786 2016-03-08 05:49:27Z raasch
236! module spectrum moved to new separate module
237!
238! 1783 2016-03-06 18:36:17Z raasch
239! netcdf variables moved to the netcdf-interface module
240!
241! 1779 2016-03-03 08:01:28Z raasch
242! coupling_char extended to LEN=3
243!
244! 1764 2016-02-28 12:45:19Z raasch
245! some reformatting
246!
247! 1762 2016-02-25 12:31:13Z hellstea
248! +nest_* variables, size of volume_flow arrays increased by one element
249!
250! 1738 2015-12-18 13:56:05Z raasch
251! +mean_surface_level_height
252!
253! 1695 2015-10-27 10:03:11Z maronga
254! Removed rif (forgotten in last revision)
255!
256! 1693 2015-10-27 08:35:45Z maronga
257! Renamed zp -> z_mo
258!
259! 1691 2015-10-26 16:17:44Z maronga
260! Renamed Obukhov length. Added ol, removed rif. Increased number of profiles
261! (pr_palm). Changed default values for dissipation_1d to 'detering' and
262! (mixing_length_1d to 'blackadar'. Added most_method. rif_min and rif_max
263! renamed to zeta_min and zeta_max and new values assigned.
264!
265! 1682 2015-10-07 23:56:08Z knoop
266! Code annotations made doxygen readable
267!
268! 1677 2015-10-02 13:25:23Z boeske
269! +ngp_yz_int, type_xz_int, type_yz_int
270!
271! 1666 2015-09-23 07:31:10Z raasch
272! +user_interface_current_revision, user_interface_required_revision in
273! control_parameters
274!
275! 1639 2015-08-31 14:46:48Z knoop
276! Bugfix: string 'unknown' extended to match LEN=13
277!
278! 1575 2015-03-27 09:56:27Z raasch
279! +ngp_xz
280!
281! 1560 2015-03-06 10:48:54Z keck
282! +recycling_yshift
283!
284! 1557 2015-03-05 16:43:04Z suehring
285! +monotonic_adjustment
286!
287! 1551 2015-03-03 14:18:16Z maronga
288! Increased pr_palm to 120. Increased length of dots_unit and dots_label to 13
289! digits. Increased length of domask, do2d, and do3d to 20 digits.
290!
291! 1496 2014-12-02 17:25:50Z maronga
292! Renamed "radiation" -> "cloud_top_radiation"
293!
294! 1484 2014-10-21 10:53:05Z kanani
295! Changes due to new module structure of the plant canopy model:
296!   canopy-model related parameters/variables moved to module
297!   plant_canopy_model_mod
298!
299! 1468 2014-09-24 14:06:57Z maronga
300! Adapted for use on up to 6-digit processor cores.
301! Increased identifier string length for user-defined quantities to 20.
302!
303! 1450 2014-08-21 07:31:51Z heinze
304! ntnudge from 100 to 1000 increased to allow longer simulations
305!
306! 1431 2014-07-15 14:47:17Z suehring
307! +var_d
308!
309! 1429 2014-07-15 12:53:45Z knoop
310! +ensemble_member_nr to prepare the random_generator for ensemble runs
311!
312! 1382 2014-04-30 12:15:41Z boeske
313! Renamed variables which store large scale forcing tendencies
314! pt_lsa -> td_lsa_lpt, pt_subs -> td_sub_lpt,
315! q_lsa  -> td_lsa_q,   q_subs  -> td_sub_q
316!
317! 1365 2014-04-22 15:03:56Z boeske
318! Usage of large scale forcing enabled:
319! increase pr_palm from 90 to 100 to allow for more standard profiles
320! + ngp_sums_ls, pt_lsa, pt_subs, q_lsa, q_subs, tmp_tnudge, sums_ls_l,
321! use_subsidence_tendencies
322!
323! 1361 2014-04-16 15:17:48Z hoffmann
324! tend_* removed
325! call_microphysics_at_all_substeps added
326! default of drizzle set to true
327!
328! 1359 2014-04-11 17:15:14Z hoffmann
329! particle_attributes moved to mod_particle_attributes.f90
330!
331! 1353 2014-04-08 15:21:23Z heinze
332! REAL constants provided with KIND-attribute
333!
334! 1327 2014-03-21 11:00:16Z raasch
335! REAL constants defined as wp-kind
336! -avs_output, data_output_format, do3d_compress, iso2d_output, netcdf_output
337!
338! 1320 2014-03-20 08:40:49Z raasch
339! ONLY-attribute added to USE-statements,
340! kind-parameters added to all INTEGER and REAL declaration statements,
341! kinds are defined in new module kinds,
342! old module precision_kind is removed,
343! revision history before 2012 removed,
344! comment fields (!:) to be used for variable explanations added to
345! all variable declaration statements
346!
347! 1318 2014-03-17 13:35:16Z raasch
348! module cpulog moved to new separate module-file
349! interface for cpu_log removed
350!
351! 1314 2014-03-14 18:25:17Z suehring
352! + log_z_z0, number_of_sublayers, z0_av_global
353! 1308 2014-03-13 14:58:42Z fricke
354! +ntdim_2d_xy, ntdim_2d_xz, ntdim_2d_yz, ntdim_3d
355!
356! 1257 2013-11-08 15:18:40Z raasch
357! set default values for grid indices of maximum velocity components
358! u|v|w_max_ijk
359!
360! 1241 2013-10-30 11:36:58Z heinze
361! Usage of nudging enabled
362! +nudging, ntnudge, ptnudge, qnudge, tnudge, unudge, vnudge, wnudge
363! increase pr_palm from 80 to 90 to allow for more standard profiles
364!
365! Enable prescribed time depenend surface fluxes and geostrophic wind read in
366! from external file LSF_DATA
367! +large_scale_forcing, lsf_surf, lsf_vert, nlsf, time_surf, shf_surf, qsws_surf,
368!  pt_surf, q_surf, p_surf, time_vert, ug_vert, vg_vert, wsubs_vert
369!
370! 1221 2013-09-10 08:59:13Z raasch
371! wall_flags_0 changed to 32bit int, +wall_flags_00,
372! +rflags_s_inner, rflags_invers
373!
374! 1216 2013-08-26 09:31:42Z raasch
375! +transpose_compute_overlap,
376! several variables are now defined in the serial (non-parallel) case also
377!
378! 1212 2013-08-15 08:46:27Z raasch
379! +tri
380!
381! 1179 2013-06-14 05:57:58Z raasch
382! +reference_state, ref_state, use_initial_profile_as_reference, vpt_reference,
383! use_reference renamed use_single_reference_value
384!
385! 1159 2013-05-21 11:58:22Z fricke
386! -bc_lr_dirneu, bc_lr_neudir, bc_ns_dirneu, bc_ns_neudir
387! +use_cmax
388!
389! 1128 2013-04-12 06:19:32Z raasch
390! +background_communication, i_left, i_right, j_north, j_south, req, req_count,
391! send_receive, sendrecv_in_background, wait_stat
392!
393! 1115 2013-03-26 18:16:16Z hoffmann
394! unused variables removed
395!
396! 1113 2013-03-10 02:48:14Z raasch
397! +on_device
398!
399! 1111 2013-03-08 23:54:10Z raasch
400! +tric, nr_timesteps_this_run
401!
402! 1106 2013-03-04 05:31:38Z raasch
403! array_kind renamed precision_kind, pdims defined in serial code
404! bugfix: default value assigned to coupling_start_time
405!
406! 1095 2013-02-03 02:21:01Z raasch
407! FORTRAN error in r1092 removed
408!
409! 1092 2013-02-02 11:24:22Z raasch
410! character length in some derived type changed for better alignment
411!
412! 1065 2012-11-22 17:42:36Z hoffmann
413! + c_sedimentation, limiter_sedimentation, turbulence, a_1, a_2, a_3, b_1, b_2,
414! + b_3, c_1, c_2, c_3, beta_cc
415!
416! bottom boundary condition of qr, nr changed from Dirichlet to Neumann
417!
418! 1053 2012-11-13 17:11:03Z hoffmann
419! necessary expansions according to the two new prognostic equations (nr, qr)
420! of the two-moment cloud physics scheme:
421! +*_init, flux_l_*, diss_l_*, flux_s_*, diss_s_*, *sws, *swst, tend_*, *, *_p
422! +t*_m, *_1, *_2, *_3, *_av, bc_*_b, bc_*_t, ibc_*_b, ibc_*_t, bc_*_t_val,
423! +*_vertical_gradient, *_surface_initial_change, *_vertical_gradient_level,
424! +*_vertical_gradient_level_ind, *_surface, constant_waterflux_*, 
425! +cloud_scheme, icloud_scheme, surface_waterflux_*, sums_ws*s_ws_l, wall_*flux
426!
427! constants for the two-moment scheme:
428! +a_vent, a_term, b_vent, b_term, c_evap, c_term, cof, eps_sb, k_cc, k_cr, k_rr,
429! +k_br, kappa_rr, kin_vis_air, mu_constant_value, nc, pirho_l, dpirho_l, rho_1,
430! +schmidt, schmidt_p_1d3, stp, x0, xmin, xmax, dt_precipitation, w_precipitation
431!
432! steering parameters for the two_moment scheme:
433! +mu_constant, ventilation_effect
434!
435! 1036 2012-10-22 13:43:42Z raasch
436! code put under GPL (PALM 3.9)
437!
438! 1031 2012-10-19 14:35:30Z raasch
439! +output_format_netcdf
440!
441! 1015 2012-09-27 09:23:24Z raasch
442! +acc_rank, num_acc_per_node,
443! -adjust_mixing_length
444!
445! 1010 2012-09-20 07:59:54Z raasch
446! pointer free version can be generated with cpp switch __nopointer
447!
448! 1003 2012-09-14 14:35:53Z raasch
449! -grid_matching, nxa, nya, etc., nnx_pe, nny_pe, spl_*
450!
451! 1001 2012-09-13 14:08:46Z raasch
452! -asselin_filter_factor, cut_spline_overshoot, dt_changed, last_dt_change,
453! last_dt_change_1d, long_filter_factor, overshoot_limit_*, ups_limit_*
454! several pointer/target arrays converted to normal ones
455!
456! 996 2012-09-07 10:41:47Z raasch
457! -use_prior_plot1d_parameters
458!
459! 978 2012-08-09 08:28:32Z fricke
460! +c_u_m, c_u_m_l, c_v_m, c_v_m_l, c_w_m, c_w_m_l,
461! +bc_lr_dirneu, bc_lr_neudir, bc_ns_dirneu, bc_ns_neudir
462! -km_damp_x, km_damp_y, km_damp_max, outflow_damping_width
463! +z0h, z0h_av, z0h_factor, z0h1d
464! +ptdf_x, ptdf_y, pt_damping_width, pt_damping_factor
465!
466! 964 2012-07-26 09:14:24Z raasch
467! -cross_linecolors, cross_linestyles, cross_normalized_x, cross_normx_factor,
468! cross_normalized_y, cross_normy_factor, cross_pnc_local,
469! cross_profile_numbers, cross_profile_number_counter, cross_uxmax,
470! cross_uxmax_computed, cross_uxmax_normalized,
471! cross_uxmax_normalized_computed, cross_uxmin, cross_uxmin_computed,
472! cross_uxmin_normalized, cross_uxmin_normalized_computed, cross_uymax,
473! cross_uymin, cross_xtext, dopr_crossindex, dopr_label, linecolors, linestyles,
474! nz_do1d, profil_output, z_max_do1d, z_max_do1d_normalized
475!
476! 951 2012-07-19 14:22:52Z hoffmann
477! changing profile_columns and profile_rows
478!
479! 940 2012-07-09 14:31:00Z raasch
480! +neutral
481!
482! 927 2012-06-06 19:15:04Z raasch
483! +masking_method
484!
485! 880 2012-04-13 06:28:59Z raasch
486! gathered_size, subdomain_size moved to control_parameters
487!
488! 866 2012-03-28 06:44:41Z raasch
489! interface for global_min_max changed
490!
491! 861 2012-03-26 14:18:34Z suehring
492! +wall_flags_0
493! -boundary_flags
494! +nzb_max
495! +adv_sca_1, +adv_mom_1
496!
497! 849 2012-03-15 10:35:09Z raasch
498! +deleted_particles, deleted_tails, tr.._count_sum, tr.._count_recv_sum in
499! particle_attributes,
500! +de_dx, de_dy, de_dz in arrays_3d,
501! first_call_advec_particles renamed first_call_lpm
502!
503! 828 2012-02-21 12:00:36Z raasch
504! +dissipation_classes, radius_classes, use_kernel_tables,
505! particle feature color renamed class
506!
507! 825 2012-02-19 03:03:44Z raasch
508! +bfactor, curvature_solution_effects, eps_ros, molecular_weight_of_water,
509! vanthoff, -b_cond in cloud_parameters,
510! dopts_num increased to 29, particle attributes speed_x|y|z_sgs renamed
511! rvar1|2|3
512! wang_collision_kernel and turbulence_effects_on_collision replaced by
513! collision_kernel, hall_kernel, palm_kernel, wang_kernel
514!
515! 809 2012-01-30 13:32:58Z marongas
516! Bugfix: replaced .AND. and .NOT. with && and ! in the preprocessor directives
517!
518! 807 2012-01-25 11:53:51Z maronga
519! New cpp directive "__check" implemented which is used by check_namelist_files.
520! New parameter check_restart has been defined which is needed by
521! check_namelist_files only.
522!
523! 805 2012-01-17 15:53:28Z franke
524! Bugfix collective_wait must be out of parallel branch for runs in serial mode
525!
526! 801 2012-01-10 17:30:36Z suehring
527! Dimesion of sums_wsus_ws_l, ! sums_wsvs_ws_l, sums_us2_ws_l, sums_vs2_ws_l,
528! sums_ws2_ws_l, sums_wspts_ws_l, sums_wsqs_ws_l, sums_wssas_ws_l increased.
529! for thread-safe summation in advec_ws.
530!
531! RCS Log replace by Id keyword, revision history cleaned up
532!
533! Revision 1.95  2007/02/11 13:18:30  raasch
534! version 3.1b (last under RCS control)
535!
536! Revision 1.1  1997/07/24 11:21:26  raasch
537! Initial revision
538!
539!
540!------------------------------------------------------------------------------!
541! Description:
542! ------------
543!> Definition of global variables
544!------------------------------------------------------------------------------!
545
546
547!------------------------------------------------------------------------------!
548! Description:
549! ------------
550!> Definition of variables for special advection schemes.
551!------------------------------------------------------------------------------!
552 MODULE advection
553 
554    USE kinds
555
556    REAL(wp), DIMENSION(:), ALLOCATABLE ::  aex  !< exponential coefficient for the Bott-Chlond advection scheme
557    REAL(wp), DIMENSION(:), ALLOCATABLE ::  bex  !< exponential coefficient for the Bott-Chlond advection scheme
558    REAL(wp), DIMENSION(:), ALLOCATABLE ::  dex  !< exponential coefficient for the Bott-Chlond advection scheme
559    REAL(wp), DIMENSION(:), ALLOCATABLE ::  eex  !< exponential coefficient for the Bott-Chlond advection scheme
560   
561    SAVE
562
563 END MODULE advection
564
565
566!------------------------------------------------------------------------------!
567! Description:
568! ------------
569!> Definition of all arrays defined on the computational grid.
570!------------------------------------------------------------------------------!
571 MODULE arrays_3d
572
573    USE kinds
574
575    REAL(wp), DIMENSION(:), ALLOCATABLE ::  c_u_m                  !< mean phase velocity at outflow for u-component used in radiation boundary condition
576    REAL(wp), DIMENSION(:), ALLOCATABLE ::  c_u_m_l                !< mean phase velocity at outflow for u-component used in radiation boundary condition (local subdomain value)
577    REAL(wp), DIMENSION(:), ALLOCATABLE ::  c_v_m                  !< mean phase velocity at outflow for v-component used in radiation boundary condition
578    REAL(wp), DIMENSION(:), ALLOCATABLE ::  c_v_m_l                !< mean phase velocity at outflow for v-component used in radiation boundary condition (local subdomain value)
579    REAL(wp), DIMENSION(:), ALLOCATABLE ::  c_w_m                  !< mean phase velocity at outflow for w-component used in radiation boundary condition
580    REAL(wp), DIMENSION(:), ALLOCATABLE ::  c_w_m_l                !< mean phase velocity at outflow for w-component used in radiation boundary condition (local subdomain value)
581    REAL(wp), DIMENSION(:), ALLOCATABLE ::  ddzu                   !< 1/dzu
582    REAL(wp), DIMENSION(:), ALLOCATABLE ::  ddzu_pres              !< modified ddzu for pressure solver
583    REAL(wp), DIMENSION(:), ALLOCATABLE ::  dd2zu                  !< 1/(dzu(k)+dzu(k+1))
584    REAL(wp), DIMENSION(:), ALLOCATABLE ::  dzu                    !< vertical grid size (u-grid)
585    REAL(wp), DIMENSION(:), ALLOCATABLE ::  ddzw                   !< 1/dzw
586    REAL(wp), DIMENSION(:), ALLOCATABLE ::  dzw                    !< vertical grid size (w-grid)
587    REAL(wp), DIMENSION(:), ALLOCATABLE ::  hyp                    !< hydrostatic pressure
588    REAL(wp), DIMENSION(:), ALLOCATABLE ::  inflow_damping_factor  !< used for turbulent inflow (non-cyclic boundary conditions)
589    REAL(wp), DIMENSION(:), ALLOCATABLE ::  l_grid                 !< geometric mean of grid sizes dx, dy, dz
590    REAL(wp), DIMENSION(:), ALLOCATABLE ::  ptdf_x                 !< damping factor for potential temperature in x-direction
591    REAL(wp), DIMENSION(:), ALLOCATABLE ::  ptdf_y                 !< damping factor for potential temperature in y-direction
592    REAL(wp), DIMENSION(:), ALLOCATABLE ::  pt_init                !< initial profile of potential temperature
593    REAL(wp), DIMENSION(:), ALLOCATABLE ::  q_init                 !< initial profile of specific humidity
594                                                                   !< (or total water content with active cloud physics)
595    REAL(wp), DIMENSION(:), ALLOCATABLE ::  rdf                    !< rayleigh damping factor for velocity components
596    REAL(wp), DIMENSION(:), ALLOCATABLE ::  rdf_sc                 !< rayleigh damping factor for scalar quantities
597    REAL(wp), DIMENSION(:), ALLOCATABLE ::  ref_state              !< reference state of potential temperature
598                                                                   !< (and density in case of ocean simulation)
599    REAL(wp), DIMENSION(:), ALLOCATABLE ::  s_init                 !< initial profile of passive scalar concentration
600    REAL(wp), DIMENSION(:), ALLOCATABLE ::  sa_init                !< initial profile of salinity (ocean)
601    REAL(wp), DIMENSION(:), ALLOCATABLE ::  ug                     !< geostrophic wind component in x-direction
602    REAL(wp), DIMENSION(:), ALLOCATABLE ::  u_init                 !< initial profile of horizontal velocity component u
603    REAL(wp), DIMENSION(:), ALLOCATABLE ::  vg                     !< geostrophic wind component in y-direction
604    REAL(wp), DIMENSION(:), ALLOCATABLE ::  v_init                 !< initial profile of horizontal velocity component v
605    REAL(wp), DIMENSION(:), ALLOCATABLE ::  w_subs                 !< subsidence/ascent velocity
606    REAL(wp), DIMENSION(:), ALLOCATABLE ::  zu                     !< vertical grid coordinate of u-grid (in m)
607    REAL(wp), DIMENSION(:), ALLOCATABLE ::  zw                     !< vertical grid coordinate of w-grid (in m)
608
609    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  c_u                   !< phase speed of u-velocity component
610    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  c_v                   !< phase speed of v-velocity component
611    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  c_w                   !< phase speed of w-velocity component
612    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_diss           !< artificial numerical dissipation flux at south face of grid box - TKE dissipation
613    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_e              !< artificial numerical dissipation flux at south face of grid box - subgrid-scale TKE
614    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_nc             !< artificial numerical dissipation flux at south face of grid box - clouddrop-number concentration   
615    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_nr             !< artificial numerical dissipation flux at south face of grid box - raindrop-number concentration   
616    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_pt             !< artificial numerical dissipation flux at south face of grid box - potential temperature
617    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_q              !< artificial numerical dissipation flux at south face of grid box - mixing ratio
618    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_qc             !< artificial numerical dissipation flux at south face of grid box - cloudwater
619    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_qr             !< artificial numerical dissipation flux at south face of grid box - rainwater
620    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_s              !< artificial numerical dissipation flux at south face of grid box - passive scalar
621    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_sa             !< artificial numerical dissipation flux at south face of grid box - salinity
622    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_u              !< artificial numerical dissipation flux at south face of grid box - u-component
623    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_v              !< artificial numerical dissipation flux at south face of grid box - v-component
624    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  diss_s_w              !< artificial numerical dissipation flux at south face of grid box - w-component
625    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  dzu_mg                !< vertical grid size (u-grid) for multigrid pressure solver
626    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  dzw_mg                !< vertical grid size (w-grid) for multigrid pressure solver
627    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_diss           !< 6th-order advective flux at south face of grid box - TKE dissipation
628    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_e              !< 6th-order advective flux at south face of grid box - subgrid-scale TKE
629    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_nc             !< 6th-order advective flux at south face of grid box - clouddrop-number concentration
630    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_nr             !< 6th-order advective flux at south face of grid box - raindrop-number concentration
631    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_pt             !< 6th-order advective flux at south face of grid box - potential temperature
632    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_q              !< 6th-order advective flux at south face of grid box - mixing ratio
633    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_qc             !< 6th-order advective flux at south face of grid box - cloudwater
634    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_qr             !< 6th-order advective flux at south face of grid box - rainwater
635    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_s              !< 6th-order advective flux at south face of grid box - passive scalar
636    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_sa             !< 6th-order advective flux at south face of grid box - salinity
637    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_u              !< 6th-order advective flux at south face of grid box - u-component
638    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_v              !< 6th-order advective flux at south face of grid box - v-component
639    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  flux_s_w              !< 6th-order advective flux at south face of grid box - w-component
640    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  f1_mg                 !< grid factor used in right hand side of Gauss-Seidel equation (multigrid)
641    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  f2_mg                 !< grid factor used in right hand side of Gauss-Seidel equation (multigrid)
642    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  f3_mg                 !< grid factor used in right hand side of Gauss-Seidel equation (multigrid)
643    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  mean_inflow_profiles  !< used for turbulent inflow (non-cyclic boundary conditions)
644    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  precipitation_amount  !< precipitation amount due to gravitational settling (bulk microphysics)
645    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  precipitation_rate    !< precipitation rate (bulk microphysics)
646    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  pt_slope_ref          !< potential temperature in rotated coordinate system
647                                                                    !< (in case of sloped surface)
648    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  total_2d_a            !< horizontal array to store the total domain data, used for atmosphere-ocean coupling (atmosphere data)
649    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  total_2d_o            !< horizontal array to store the total domain data, used for atmosphere-ocean coupling (ocean data)
650   
651    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  d           !< divergence
652    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  de_dx       !< gradient of sgs tke in x-direction (lpm)
653    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  de_dy       !< gradient of sgs tke in y-direction (lpm)
654    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  de_dz       !< gradient of sgs tke in z-direction (lpm)
655    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_diss !< artificial numerical dissipation flux at left face of grid box - TKE dissipation
656    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_e    !< artificial numerical dissipation flux at left face of grid box - subgrid-scale TKE
657    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_nc   !< artificial numerical dissipation flux at left face of grid box - clouddrop-number concentration
658    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_nr   !< artificial numerical dissipation flux at left face of grid box - raindrop-number concentration
659    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_pt   !< artificial numerical dissipation flux at left face of grid box - potential temperature
660    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_q    !< artificial numerical dissipation flux at left face of grid box - mixing ratio
661    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_qc   !< artificial numerical dissipation flux at left face of grid box - cloudwater
662    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_qr   !< artificial numerical dissipation flux at left face of grid box - rainwater
663    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_s    !< artificial numerical dissipation flux at left face of grid box - passive scalar
664    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_sa   !< artificial numerical dissipation flux at left face of grid box - salinity
665    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_u    !< artificial numerical dissipation flux at left face of grid box - u-component
666    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_v    !< artificial numerical dissipation flux at left face of grid box - v-component
667    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  diss_l_w    !< artificial numerical dissipation flux at left face of grid box - w-component
668    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_diss !< 6th-order advective flux at south face of grid box - TKE dissipation
669    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_e    !< 6th-order advective flux at south face of grid box - subgrid-scale TKE
670    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_nc   !< 6th-order advective flux at south face of grid box - clouddrop-number concentration
671    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_nr   !< 6th-order advective flux at south face of grid box - raindrop-number concentration
672    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_pt   !< 6th-order advective flux at south face of grid box - potential temperature
673    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_q    !< 6th-order advective flux at south face of grid box - mixing ratio
674    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_qc   !< 6th-order advective flux at south face of grid box - cloudwater
675    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_qr   !< 6th-order advective flux at south face of grid box - rainwater
676    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_s    !< 6th-order advective flux at south face of grid box - passive scalar
677    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_sa   !< 6th-order advective flux at south face of grid box - salinity
678    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_u    !< 6th-order advective flux at south face of grid box - u-component
679    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_v    !< 6th-order advective flux at south face of grid box - v-component
680    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  flux_l_w    !< 6th-order advective flux at south face of grid box - w-component
681    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  kh          !< eddy diffusivity for heat
682    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  km          !< eddy diffusivity for momentum
683    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  l_wall      !< near-wall mixing length
684    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  prr         !< rain rate
685    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  p_loc       !< local array in multigrid/sor solver containing the pressure which is iteratively advanced in each iteration step
686    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  tend        !< tendency field (time integration)
687    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  tric        !< coefficients of the tridiagonal matrix for solution of the Poisson equation in Fourier space
688    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  u_m_l       !< velocity data (u at left boundary) from time level t-dt required for radiation boundary condition
689    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  u_m_n       !< velocity data (u at north boundary) from time level t-dt required for radiation boundary condition
690    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  u_m_r       !< velocity data (u at right boundary) from time level t-dt required for radiation boundary condition
691    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  u_m_s       !< velocity data (u at south boundary) from time level t-dt required for radiation boundary condition
692    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  v_m_l       !< velocity data (v at left boundary) from time level t-dt required for radiation boundary condition
693    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  v_m_n       !< velocity data (v at north boundary) from time level t-dt required for radiation boundary condition
694    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  v_m_r       !< velocity data (v at right boundary) from time level t-dt required for radiation boundary condition
695    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  v_m_s       !< velocity data (v at south boundary) from time level t-dt required for radiation boundary condition
696    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  w_m_l       !< velocity data (w at left boundary) from time level t-dt required for radiation boundary condition
697    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  w_m_n       !< velocity data (w at north boundary) from time level t-dt required for radiation boundary condition
698    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  w_m_r       !< velocity data (w at right boundary) from time level t-dt required for radiation boundary condition
699    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  w_m_s       !< velocity data (w at south boundary) from time level t-dt required for radiation boundary condition
700
701#if defined( __nopointer )
702    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  diss       !< TKE dissipation
703    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  diss_p     !< prognostic value TKE dissipation
704    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  e          !< subgrid-scale turbulence kinetic energy (sgs tke)
705    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  e_p        !< prognostic value of sgs tke
706    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  nc         !< cloud drop number density
707    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  nc_p       !< prognostic value of cloud drop number density
708    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  nr         !< rain drop number density
709    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  nr_p       !< prognostic value of rain drop number density
710    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  p          !< perturbation pressure
711    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  prho       !< potential density
712    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  pt         !< potential temperature
713    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  pt_p       !< prognostic value of potential temperature
714    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  q          !< specific humidity
715                                                                   !< (or total water content with active cloud physics)
716    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  q_p        !< prognostic value of specific humidity
717    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qc         !< cloud water content
718    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qc_p       !< cloud water content
719    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ql         !< liquid water content
720    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ql_c       !< change in liquid water content due to
721                                                                   !< condensation/evaporation during last time step
722    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ql_v       !< volume of liquid water
723    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ql_vp      !< liquid water weighting factor
724    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qr         !< rain water content
725    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qr_p       !< prognostic value of rain water content
726    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  rho_ocean  !< density of ocean
727    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  s          !< passive scalar
728    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  s_p        !< prognostic value of passive scalar
729    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  sa         !< ocean salinity
730    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  sa_p       !< prognostic value of ocean salinity
731    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  tdiss_m    !< weighted tendency of diss for previous sub-timestep (Runge-Kutta)
732    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  te_m       !< weighted tendency of e for previous sub-timestep (Runge-Kutta)
733    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  tnc_m      !< weighted tendency of nc for previous sub-timestep (Runge-Kutta)
734    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  tnr_m      !< weighted tendency of nr for previous sub-timestep (Runge-Kutta)
735    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  tpt_m      !< weighted tendency of pt for previous sub-timestep (Runge-Kutta)
736    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  tq_m       !< weighted tendency of q for previous sub-timestep (Runge-Kutta)
737    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  tqc_m      !< weighted tendency of qc for previous sub-timestep (Runge-Kutta)
738    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  tqr_m      !< weighted tendency of qr for previous sub-timestep (Runge-Kutta)
739    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ts_m       !< weighted tendency of s for previous sub-timestep (Runge-Kutta)
740    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  tsa_m      !< weighted tendency of sa for previous sub-timestep (Runge-Kutta)
741    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  tu_m       !< weighted tendency of u for previous sub-timestep (Runge-Kutta)
742    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  tv_m       !< weighted tendency of v for previous sub-timestep (Runge-Kutta)
743    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  tw_m       !< weighted tendency of w for previous sub-timestep (Runge-Kutta)
744    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  u          !< horizontal velocity component u (x-direction)
745    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  u_p        !< prognostic value of u
746    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  v          !< horizontal velocity component v (y-direction)
747    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  v_p        !< prognostic value of v
748    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  vpt        !< virtual potential temperature
749    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  w          !< vertical velocity component w (z-direction)
750    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  w_p        !< prognostic value of w
751#else
752    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  diss_1  !< pointer for swapping of timelevels for respective quantity
753    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  diss_2  !< pointer for swapping of timelevels for respective quantity
754    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  diss_3  !< pointer for swapping of timelevels for respective quantity
755    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  e_1     !< pointer for swapping of timelevels for respective quantity
756    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  e_2     !< pointer for swapping of timelevels for respective quantity
757    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  e_3     !< pointer for swapping of timelevels for respective quantity
758    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  p       !< pointer: perturbation pressure
759    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  prho_1  !< pointer for swapping of timelevels for respective quantity
760    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  nc_1    !< pointer for swapping of timelevels for respective quantity
761    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  nc_2    !< pointer for swapping of timelevels for respective quantity
762    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  nc_3    !< pointer for swapping of timelevels for respective quantity
763    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  nr_1    !< pointer for swapping of timelevels for respective quantity
764    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  nr_2    !< pointer for swapping of timelevels for respective quantity
765    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  nr_3    !< pointer for swapping of timelevels for respective quantity
766    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  pt_1    !< pointer for swapping of timelevels for respective quantity
767    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  pt_2    !< pointer for swapping of timelevels for respective quantity
768    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  pt_3    !< pointer for swapping of timelevels for respective quantity
769    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  q_1     !< pointer for swapping of timelevels for respective quantity
770    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  q_2     !< pointer for swapping of timelevels for respective quantity
771    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  q_3     !< pointer for swapping of timelevels for respective quantity
772    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qc_1    !< pointer for swapping of timelevels for respective quantity
773    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qc_2    !< pointer for swapping of timelevels for respective quantity
774    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qc_3    !< pointer for swapping of timelevels for respective quantity
775    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ql_v    !< pointer: volume of liquid water
776    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ql_vp   !< pointer: liquid water weighting factor
777    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ql_1    !< pointer for swapping of timelevels for respective quantity
778    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ql_2    !< pointer for swapping of timelevels for respective quantity
779    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qr_1    !< pointer for swapping of timelevels for respective quantity
780    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qr_2    !< pointer for swapping of timelevels for respective quantity
781    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qr_3    !< pointer for swapping of timelevels for respective quantity
782    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  rho_1   !< pointer for swapping of timelevels for respective quantity
783    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  s_1     !< pointer for swapping of timelevels for respective quantity
784    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  s_2     !< pointer for swapping of timelevels for respective quantity
785    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  s_3     !< pointer for swapping of timelevels for respective quantity
786    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  sa_1    !< pointer for swapping of timelevels for respective quantity
787    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  sa_2    !< pointer for swapping of timelevels for respective quantity
788    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  sa_3    !< pointer for swapping of timelevels for respective quantity
789    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  u_1     !< pointer for swapping of timelevels for respective quantity
790    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  u_2     !< pointer for swapping of timelevels for respective quantity
791    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  u_3     !< pointer for swapping of timelevels for respective quantity
792    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  v_1     !< pointer for swapping of timelevels for respective quantity
793    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  v_2     !< pointer for swapping of timelevels for respective quantity
794    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  v_3     !< pointer for swapping of timelevels for respective quantity
795    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  vpt_1   !< pointer for swapping of timelevels for respective quantity
796    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  w_1     !< pointer for swapping of timelevels for respective quantity
797    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  w_2     !< pointer for swapping of timelevels for respective quantity
798    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  w_3     !< pointer for swapping of timelevels for respective quantity
799
800    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  diss       !< pointer: TKE dissipation
801    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  diss_p     !< pointer: prognostic value of TKE dissipation
802    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  e          !< pointer: subgrid-scale turbulence kinetic energy (sgs tke)
803    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  e_p        !< pointer: prognostic value of sgs tke
804    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  nc         !< pointer: cloud drop number density
805    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  nc_p       !< pointer: prognostic value of cloud drop number density
806    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  nr         !< pointer: rain drop number density
807    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  nr_p       !< pointer: prognostic value of rain drop number density
808    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  prho       !< pointer: potential density
809    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  pt         !< pointer: potential temperature
810    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  pt_p       !< pointer: prognostic value of potential temperature
811    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  q          !< pointer: specific humidity
812    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  q_p        !< pointer: prognostic value of specific humidity
813    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  qc         !< pointer: cloud water content
814    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  qc_p       !< pointer: cloud water content
815    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  ql         !< pointer: liquid water content
816    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  ql_c       !< pointer: change in liquid water content due to
817                                                                   !< condensation/evaporation during last time step
818    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  qr         !< pointer: rain water content
819    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  qr_p       !< pointer: prognostic value of rain water content
820    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  rho_ocean  !< pointer: density of ocean
821    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  s          !< pointer: passive scalar
822    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  s_p        !< pointer: prognostic value of passive scalar
823    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  sa         !< pointer: ocean salinity
824    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  sa_p       !< pointer: prognostic value of ocean salinity
825    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tdiss_m    !< pointer: weighted tendency of diss for previous sub-timestep (Runge-Kutta)
826    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  te_m       !< pointer: weighted tendency of e for previous sub-timestep (Runge-Kutta)
827    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tnc_m      !< pointer: weighted tendency of nc for previous sub-timestep (Runge-Kutta)
828    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tnr_m      !< pointer: weighted tendency of nr for previous sub-timestep (Runge-Kutta)
829    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tpt_m      !< pointer: weighted tendency of pt for previous sub-timestep (Runge-Kutta)
830    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tq_m       !< pointer: weighted tendency of q for previous sub-timestep (Runge-Kutta)
831    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tqc_m      !< pointer: weighted tendency of qc for previous sub-timestep (Runge-Kutta)
832    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tqr_m      !< pointer: weighted tendency of qr for previous sub-timestep (Runge-Kutta)
833    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  ts_m       !< pointer: weighted tendency of s for previous sub-timestep (Runge-Kutta)
834    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tsa_m      !< pointer: weighted tendency of sa for previous sub-timestep (Runge-Kutta)
835    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tu_m       !< pointer: weighted tendency of u for previous sub-timestep (Runge-Kutta)
836    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tv_m       !< pointer: weighted tendency of v for previous sub-timestep (Runge-Kutta)
837    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  tw_m       !< pointer: weighted tendency of w for previous sub-timestep (Runge-Kutta)
838    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  u          !< pointer: horizontal velocity component u (x-direction)
839    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  u_p        !< pointer: prognostic value of u
840    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  v          !< pointer: horizontal velocity component v (y-direction)
841    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  v_p        !< pointer: prognostic value of v
842    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  vpt        !< pointer: virtual potential temperature
843    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  w          !< pointer: vertical velocity component w (z-direction)
844    REAL(wp), DIMENSION(:,:,:), POINTER, CONTIGUOUS ::  w_p        !< pointer: prognostic value of w
845#endif
846
847    REAL(wp), DIMENSION(:,:,:,:), ALLOCATABLE ::  tri    !<  array to hold the tridiagonal matrix for solution of the Poisson equation in Fourier space (4th dimension for threads)
848
849    REAL(wp), DIMENSION(:), ALLOCATABLE ::  rho_air      !< air density profile on the uv grid
850    REAL(wp), DIMENSION(:), ALLOCATABLE ::  rho_air_zw   !< air density profile on the w grid
851    REAL(wp), DIMENSION(:), ALLOCATABLE ::  drho_air     !< inverse air density profile on the uv grid
852    REAL(wp), DIMENSION(:), ALLOCATABLE ::  drho_air_zw  !< inverse air density profile on the w grid
853
854    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  rho_air_mg     !< air density profiles on the uv grid for multigrid
855    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  rho_air_zw_mg  !< air density profiles on the w grid for multigrid
856
857    REAL(wp), DIMENSION(:), ALLOCATABLE ::  heatflux_input_conversion       !< conversion factor array for heatflux input
858    REAL(wp), DIMENSION(:), ALLOCATABLE ::  waterflux_input_conversion      !< conversion factor array for waterflux input
859    REAL(wp), DIMENSION(:), ALLOCATABLE ::  momentumflux_input_conversion   !< conversion factor array for momentumflux input
860    REAL(wp), DIMENSION(:), ALLOCATABLE ::  heatflux_output_conversion      !< conversion factor array for heatflux output
861    REAL(wp), DIMENSION(:), ALLOCATABLE ::  waterflux_output_conversion     !< conversion factor array for waterflux output
862    REAL(wp), DIMENSION(:), ALLOCATABLE ::  momentumflux_output_conversion  !< conversion factor array for momentumflux output
863
864    SAVE
865
866 END MODULE arrays_3d
867
868
869!------------------------------------------------------------------------------!
870! Description:
871! ------------
872!> Definition of variables needed for time-averaging of 2d/3d data.
873!------------------------------------------------------------------------------!
874 MODULE averaging
875 
876    USE kinds
877
878    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  lwp_av                 !< avg. liquid water path
879    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  precipitation_rate_av  !< avg. precipitation rate
880    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  ol_av                  !< avg. Obukhov length
881    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  qsws_av                !< avg. surface moisture flux
882    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  ssws_av                !< avg. surface scalar flux
883    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  shf_av                 !< avg. surface heat flux
884    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  ts_av                  !< avg. characteristic temperature scale
885    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  us_av                  !< avg. friction velocity
886    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  z0_av                  !< avg. roughness length for momentum
887    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  z0h_av                 !< avg. roughness length for heat
888    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  z0q_av                 !< avg. roughness length for moisture
889
890    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  diss_av       !< avg. tke dissipation rate
891    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  e_av          !< avg. subgrid-scale tke
892    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  kh_av         !< avg. eddy diffusivity for heat
893    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  km_av         !< avg. eddy diffusivity for momentum
894    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  lpt_av        !< avg. liquid water potential temperature
895    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  nc_av         !< avg. cloud drop number density
896    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  nr_av         !< avg. rain drop number density
897    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  p_av          !< avg. perturbation pressure
898    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  pc_av         !< avg. particle/droplet concentration
899    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  pr_av         !< avg. particle/droplet radius
900    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  prr_av        !< avg. precipitation rate
901    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  pt_av         !< avg. potential temperature
902    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  q_av          !< avg. specific humidity
903                                                                      !< (or total water content with active cloud physics)
904    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qc_av         !< avg. cloud water content
905    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ql_av         !< avg. liquid water content
906    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ql_c_av       !< avg. change in liquid water content due to
907                                                                      !< condensation/evaporation during last time step
908    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ql_v_av       !< avg. volume of liquid water
909    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  ql_vp_av      !< avg. liquid water weighting factor
910    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qr_av         !< avg. rain water content
911    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  qv_av         !< avg. water vapor content (specific humidity)
912    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  rho_ocean_av  !< avg. ocean density
913    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  s_av          !< avg. passive scalar
914    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  sa_av         !< avg. salinity
915    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  u_av          !< avg. horizontal velocity component u
916    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  v_av          !< avg. horizontal velocity component v
917    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  vpt_av        !< avg. virtual potential temperature
918    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  w_av          !< avg. vertical velocity component
919 
920 END MODULE averaging
921
922
923!------------------------------------------------------------------------------!
924! Description:
925! ------------
926!> Definition of variables and constants for cloud physics.
927!------------------------------------------------------------------------------!
928 MODULE cloud_parameters
929 
930    USE kinds
931
932    REAL(wp) ::  cp = 1005.0_wp                            !< heat capacity of dry air (J kg-1 K-1)
933    REAL(wp) ::  l_v = 2.5E+06_wp                          !< latent heat of vaporization (J kg-1)
934    REAL(wp) ::  l_d_cp                                    !< l_v / cp
935    REAL(wp) ::  l_d_r                                     !< l_v / r_d
936    REAL(wp) ::  l_d_rv                                    !< l_v / r_v   
937    REAL(wp) ::  molecular_weight_of_solute = 0.05844_wp   !< mol. m. NaCl (kg mol-1)
938    REAL(wp) ::  molecular_weight_of_water = 0.01801528_wp !< mol. m. H2O (kg mol-1)
939    REAL(wp) ::  rho_l = 1.0E3_wp                          !< density of water (kg m-3)
940    REAL(wp) ::  rho_s = 2165.0_wp                         !< density of NaCl (kg m-3)
941    REAL(wp) ::  r_d = 287.0_wp                            !< sp. gas const. dry air (J kg-1 K-1)
942    REAL(wp) ::  r_v = 461.51_wp                           !< sp. gas const. water vapor (J kg-1 K-1)
943    REAL(wp) ::  vanthoff = 2.0_wp                         !< van't Hoff factor for NaCl
944
945
946
947    REAL(wp), DIMENSION(:), ALLOCATABLE ::  hyrho   !< density of air calculated with hydrostatic pressure
948    REAL(wp), DIMENSION(:), ALLOCATABLE ::  pt_d_t  !< ratio of potential and actual temperature
949    REAL(wp), DIMENSION(:), ALLOCATABLE ::  t_d_pt  !< ratio of actual and potential temperature
950
951    SAVE
952
953 END MODULE cloud_parameters
954
955
956!------------------------------------------------------------------------------!
957! Description:
958! ------------
959!> Definition of general constants.
960!------------------------------------------------------------------------------!
961 MODULE constants
962 
963    USE kinds
964
965    REAL(wp) ::  pi = 3.141592654_wp  !< PI
966    REAL(wp) ::  adv_mom_1            !< 1/4 - constant used in 5th-order advection scheme for momentum advection (1st-order part)
967    REAL(wp) ::  adv_mom_3            !< 1/24 - constant used in 5th-order advection scheme for momentum advection (3rd-order part)
968    REAL(wp) ::  adv_mom_5            !< 1/120 - constant used in 5th-order advection scheme for momentum advection (5th-order part)
969    REAL(wp) ::  adv_sca_1            !< 1/2 - constant used in 5th-order advection scheme for scalar advection (1st-order part)
970    REAL(wp) ::  adv_sca_3            !< 1/12 - constant used in 5th-order advection scheme for scalar advection (3rd-order part)
971    REAL(wp) ::  adv_sca_5            !< 1/60 - constant used in 5th-order advection scheme for scalar advection (5th-order part)
972   
973    SAVE
974
975 END MODULE constants
976
977 
978!------------------------------------------------------------------------------!
979! Description:
980! ------------
981!> Definition of parameters for program control
982!------------------------------------------------------------------------------!
983 MODULE control_parameters
984
985    USE kinds
986
987    TYPE file_status
988       LOGICAL ::  opened         !< file is currently open
989       LOGICAL ::  opened_before  !< file is currently closed, but has been openend before
990    END TYPE file_status
991   
992    INTEGER, PARAMETER      ::  mask_xyz_dimension = 100  !< limit of mask dimensions (100 points in each direction)
993    INTEGER, PARAMETER      ::  max_masks = 50            !< maximum number of masks
994    INTEGER(iwp), PARAMETER ::  varnamelength = 30        !< length of output variable names
995
996    TYPE(file_status), DIMENSION(200+2*max_masks) ::                &  !< indicates if file is open or if it has been opened before
997                             openfile = file_status(.FALSE.,.FALSE.)
998
999    CHARACTER (LEN=1)    ::  cycle_mg = 'w'                               !< namelist parameter (see documentation)
1000    CHARACTER (LEN=1)    ::  timestep_reason = ' '                        !< 'A'dvection or 'D'iffusion criterion, written to RUN_CONTROL file
1001    CHARACTER (LEN=8)    ::  coupling_char = ''                           !< appended to filenames in coupled or nested runs ('_O': ocean PE,
1002                                                                          !< '_NV': vertically nested atmosphere PE, '_N##': PE of nested domain ##
1003    CHARACTER (LEN=8)    ::  most_method = 'newton'                       !< namelist parameter
1004    CHARACTER (LEN=8)    ::  run_date                                     !< date of simulation run, printed to HEADER file
1005    CHARACTER (LEN=8)    ::  run_time                                     !< time of simulation run, printed to HEADER file
1006    CHARACTER (LEN=9)    ::  simulated_time_chr                           !< simulated time, printed to RUN_CONTROL file
1007    CHARACTER (LEN=11)   ::  topography_grid_convention = ' '             !< namelist parameter
1008    CHARACTER (LEN=12)   ::  version = ' '                                !< PALM version number
1009    CHARACTER (LEN=12)   ::  revision = ' '                               !< PALM revision number
1010    CHARACTER (LEN=12)   ::  user_interface_current_revision = ' '        !< revision number of the currently used user-interface (must match user_interface_required_revision)
1011    CHARACTER (LEN=12)   ::  user_interface_required_revision = ' '       !< required user-interface revision number
1012    CHARACTER (LEN=16)   ::  conserve_volume_flow_mode = 'default'        !< namelist parameter
1013    CHARACTER (LEN=16)   ::  loop_optimization = 'cache'                  !< namelist parameter
1014    CHARACTER (LEN=16)   ::  momentum_advec = 'ws-scheme'                 !< namelist parameter
1015    CHARACTER (LEN=16)   ::  psolver = 'poisfft'                          !< namelist parameter
1016    CHARACTER (LEN=16)   ::  scalar_advec = 'ws-scheme'                   !< namelist parameter
1017    CHARACTER (LEN=20)   ::  approximation = 'boussinesq'                 !< namelist parameter
1018    CHARACTER (LEN=40)   ::  flux_input_mode = 'approximation-specific'   !< type of flux input: dynamic or kinematic
1019    CHARACTER (LEN=40)   ::  flux_output_mode = 'approximation-specific'  !< type of flux output: dynamic or kinematic
1020    CHARACTER (LEN=20)   ::  bc_e_b = 'neumann'                           !< namelist parameter
1021    CHARACTER (LEN=20)   ::  bc_lr = 'cyclic'                             !< namelist parameter
1022    CHARACTER (LEN=20)   ::  bc_ns = 'cyclic'                             !< namelist parameter
1023    CHARACTER (LEN=20)   ::  bc_p_b = 'neumann'                           !< namelist parameter
1024    CHARACTER (LEN=20)   ::  bc_p_t = 'dirichlet'                         !< namelist parameter
1025    CHARACTER (LEN=20)   ::  bc_pt_b = 'dirichlet'                        !< namelist parameter
1026    CHARACTER (LEN=20)   ::  bc_pt_t = 'initial_gradient'                 !< namelist parameter
1027    CHARACTER (LEN=20)   ::  bc_q_b = 'dirichlet'                         !< namelist parameter
1028    CHARACTER (LEN=20)   ::  bc_q_t = 'neumann'                           !< namelist parameter
1029    CHARACTER (LEN=20)   ::  bc_s_b = 'dirichlet'                         !< namelist parameter
1030    CHARACTER (LEN=20)   ::  bc_s_t = 'initial_gradient'                  !< namelist parameter
1031    CHARACTER (LEN=20)   ::  bc_sa_t = 'neumann'                          !< namelist parameter
1032    CHARACTER (LEN=20)   ::  bc_uv_b = 'dirichlet'                        !< namelist parameter
1033    CHARACTER (LEN=20)   ::  bc_uv_t = 'dirichlet'                        !< namelist parameter
1034    CHARACTER (LEN=20)   ::  aerosol_bulk = 'nacl'                        !< namelist parameter
1035    CHARACTER (LEN=20)   ::  cloud_scheme = 'saturation_adjust'           !< namelist parameter
1036    CHARACTER (LEN=20)   ::  coupling_mode = 'uncoupled'                  !< coupling mode for atmosphere-ocean coupling 
1037    CHARACTER (LEN=20)   ::  coupling_mode_remote = 'uncoupled'           !< coupling mode of the remote process in case of coupled atmosphere-ocean runs
1038    CHARACTER (LEN=20)   ::  dissipation_1d = 'detering'                  !< namelist parameter
1039    CHARACTER (LEN=20)   ::  fft_method = 'temperton-algorithm'           !< namelist parameter
1040    CHARACTER (LEN=20)   ::  mixing_length_1d = 'blackadar'               !< namelist parameter
1041    CHARACTER (LEN=20)   ::  random_generator = 'random-parallel'         !< namelist parameter
1042    CHARACTER (LEN=20)   ::  reference_state = 'initial_profile'          !< namelist parameter 
1043    CHARACTER (LEN=20)   ::  timestep_scheme = 'runge-kutta-3'            !< namelist parameter       
1044    CHARACTER (LEN=20)   ::  turbulence_closure = 'Moeng_Wyngaard'        !< namelist parameter
1045    CHARACTER (LEN=40)   ::  topography = 'flat'                          !< namelist parameter
1046    CHARACTER (LEN=64)   ::  host = '????'                                !< hostname on which PALM is running, ENVPAR namelist parameter provided by mrun
1047    CHARACTER (LEN=80)   ::  log_message                                  !< user-defined message for debugging (sse data_log.f90)
1048    CHARACTER (LEN=80)   ::  run_identifier                               !< run identifier as given by mrun option -d, ENVPAR namelist parameter provided by mrun
1049    CHARACTER (LEN=100)  ::  initializing_actions = ' '                   !< namelist parameter
1050    CHARACTER (LEN=210)  ::  run_description_header                       !< string containing diverse run informations as run identifier, coupling mode, host, ensemble number, run date and time
1051    CHARACTER (LEN=1000) ::  message_string = ' '                         !< dynamic string for error message output
1052
1053    CHARACTER (LEN=varnamelength), DIMENSION(500) ::  data_output = ' '       !< namelist parameter
1054    CHARACTER (LEN=varnamelength), DIMENSION(500) ::  data_output_user = ' '  !< namelist parameter
1055    CHARACTER (LEN=varnamelength), DIMENSION(500) ::  doav = ' '              !< label array for multi-dimensional,
1056                                                                              !< averaged output quantities
1057                                           
1058    CHARACTER (LEN=varnamelength), DIMENSION(max_masks,100) ::  data_output_masks = ' '       !< namelist parameter
1059    CHARACTER (LEN=varnamelength), DIMENSION(max_masks,100) ::  data_output_masks_user = ' '  !< namelist parameter
1060
1061    CHARACTER (LEN=varnamelength), DIMENSION(300) ::  data_output_pr = ' '  !< namelist parameter
1062   
1063    CHARACTER (LEN=varnamelength), DIMENSION(200) ::  data_output_pr_user = ' '  !< namelist parameter
1064   
1065    CHARACTER (LEN=varnamelength), DIMENSION(max_masks,0:1,100) ::  domask = ' ' !< label array for multi-dimensional,
1066                                                                                 !< masked output quantities
1067   
1068    CHARACTER (LEN=varnamelength), DIMENSION(0:1,500) ::  do2d = ' '  !< label array for 2d output quantities
1069    CHARACTER (LEN=varnamelength), DIMENSION(0:1,500) ::  do3d = ' '  !< label array for 3d output quantities
1070
1071    INTEGER(iwp), PARAMETER ::  fl_max = 100     !< maximum number of virtual-flight measurements
1072    INTEGER(iwp), PARAMETER ::  var_fl_max = 20  !< maximum number of different sampling variables in virtual flight measurements
1073   
1074    INTEGER(iwp) ::  abort_mode = 1                    !< abort condition (nested runs)
1075    INTEGER(iwp) ::  average_count_pr = 0              !< number of samples in vertical-profile output
1076    INTEGER(iwp) ::  average_count_3d = 0              !< number of samples in 3d output
1077    INTEGER(iwp) ::  current_timestep_number = 0       !< current timestep number, printed to RUN_CONTROL file
1078    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
1079    INTEGER(iwp) ::  dist_range = 0                    !< switch for steering the horizontal disturbance range, 1: inflow disturbances in case of non-cyclic horizontal BC, 0: otherwise
1080    INTEGER(iwp) ::  disturbance_level_ind_b           !< lowest grid index where flow disturbance is applied
1081    INTEGER(iwp) ::  disturbance_level_ind_t           !< highest grid index where flow disturbance is applied
1082    INTEGER(iwp) ::  doav_n = 0                        !< number of 2d/3d output quantities subject to time averaging
1083    INTEGER(iwp) ::  dopr_n = 0                        !< number of profile output quantities subject to time averaging
1084    INTEGER(iwp) ::  dopr_time_count = 0               !< number of output intervals for profile output
1085    INTEGER(iwp) ::  dopts_time_count = 0              !< number of output intervals for particle data timeseries
1086    INTEGER(iwp) ::  dots_time_count = 0               !< number of output intervals for timeseries output
1087    INTEGER(iwp) ::  dp_level_ind_b = 0                !< lowest grid index for external pressure gradient forcing
1088    INTEGER(iwp) ::  dvrp_filecount = 0                !< parameter for dvr visualization software
1089    INTEGER(iwp) ::  dz_stretch_level_index            !< vertical grid level index above which the vertical grid spacing is stretched
1090    INTEGER(iwp) ::  ensemble_member_nr = 0            !< namelist parameter
1091    INTEGER(iwp) ::  gamma_mg                          !< switch for steering the multigrid cycle: 1: v-cycle, 2: w-cycle
1092    INTEGER(iwp) ::  gathered_size                     !< number of total domain grid points of the grid level which is gathered on PE0 (multigrid solver)
1093    INTEGER(iwp) ::  grid_level                        !< current grid level handled in the multigrid solver
1094    INTEGER(iwp) ::  ibc_e_b                           !< integer flag for bc_e_b
1095    INTEGER(iwp) ::  ibc_p_b                           !< integer flag for bc_p_b
1096    INTEGER(iwp) ::  ibc_p_t                           !< integer flag for bc_p_t
1097    INTEGER(iwp) ::  ibc_pt_b                          !< integer flag for bc_pt_b
1098    INTEGER(iwp) ::  ibc_pt_t                          !< integer flag for bc_pt_t
1099    INTEGER(iwp) ::  ibc_q_b                           !< integer flag for bc_q_b
1100    INTEGER(iwp) ::  ibc_q_t                           !< integer flag for bc_q_t
1101    INTEGER(iwp) ::  ibc_s_b                           !< integer flag for bc_s_b
1102    INTEGER(iwp) ::  ibc_s_t                           !< integer flag for bc_s_t
1103    INTEGER(iwp) ::  ibc_sa_t                          !< integer flag for bc_sa_t
1104    INTEGER(iwp) ::  ibc_uv_b                          !< integer flag for bc_uv_b
1105    INTEGER(iwp) ::  ibc_uv_t                          !< integer flag for bc_uv_t
1106    INTEGER(iwp) ::  inflow_disturbance_begin = -1     !< namelist parameter
1107    INTEGER(iwp) ::  inflow_disturbance_end = -1       !< namelist parameter
1108    INTEGER(iwp) ::  intermediate_timestep_count       !< number of current Runge-Kutta substep
1109    INTEGER(iwp) ::  intermediate_timestep_count_max   !< maximum number of Runge-Kutta substeps
1110    INTEGER(iwp) ::  io_group = 0                      !< I/O group to which the PE belongs (= #PE / io_blocks)
1111    INTEGER(iwp) ::  io_blocks = 1                     !< number of blocks for which I/O is done in sequence (total number of PEs / maximum_parallel_io_streams)
1112    INTEGER(iwp) ::  iran = -1234567                   !< integer random number used for flow disturbances
1113    INTEGER(iwp) ::  masks = 0                         !< counter for number of masked output quantities
1114    INTEGER(iwp) ::  maximum_grid_level                !< number of grid levels that the multigrid solver is using
1115    INTEGER(iwp) ::  maximum_parallel_io_streams = -1  !< maximum number of parallel io streams that the underlying parallel file system allows, set with mrun option -w, ENVPAR namelist parameter, provided by mrun
1116    INTEGER(iwp) ::  max_pr_user = 0                   !< number of user-defined profiles (must not change within a job chain)
1117    INTEGER(iwp) ::  mgcycles = 0                      !< number of multigrid cycles that the multigrid solver has actually carried out
1118    INTEGER(iwp) ::  mg_cycles = 4                     !< namelist parameter
1119    INTEGER(iwp) ::  mg_switch_to_pe0_level = -1       !< namelist parameter
1120    INTEGER(iwp) ::  mid                               !< masked output running index
1121    INTEGER(iwp) ::  ngsrb = 2                         !< namelist parameter
1122    INTEGER(iwp) ::  nr_timesteps_this_run = 0         !< number of timesteps (cpu time measurements)
1123    INTEGER(iwp) ::  nsor = 20                         !< namelist parameter
1124    INTEGER(iwp) ::  nsor_ini = 100                    !< namelist parameter
1125    INTEGER(iwp) ::  n_sor                             !< number of iterations to be used in SOR-scheme
1126    INTEGER(iwp) ::  normalizing_region = 0            !< namelist parameter
1127    INTEGER(iwp) ::  num_leg=0                         !< number of different legs in virtual flight measurements
1128    INTEGER(iwp) ::  num_var_fl                        !< number of sampling/output variables in virtual flight measurements
1129    INTEGER(iwp) ::  num_var_fl_user=0                 !< number of user-defined sampling/output variables in virtual flight measurements
1130    INTEGER(iwp) ::  nz_do3d = -9999                   !< namelist parameter
1131    INTEGER(iwp) ::  prt_time_count = 0                !< number of output intervals for particle data output
1132    INTEGER(iwp) ::  recycling_plane                   !< position of recycling plane along x (in grid points) in case of turbulence recycling
1133    INTEGER(iwp) ::  runnr = 0                         !< number of run in job chain
1134    INTEGER(iwp) ::  subdomain_size                    !< number of grid points in (3d) subdomain including ghost points
1135    INTEGER(iwp) ::  terminate_coupled = 0             !< switch for steering termination in case of coupled runs
1136    INTEGER(iwp) ::  terminate_coupled_remote = 0      !< switch for steering termination in case of coupled runs (condition of the remote model)
1137    INTEGER(iwp) ::  timestep_count = 0                !< number of timesteps carried out since the beginning of the initial run
1138    INTEGER(iwp) ::  y_shift = 0                       !< namelist parameter
1139    INTEGER(iwp) ::  dist_nxl(0:1)                               !< left boundary of disturbance region
1140    INTEGER(iwp) ::  dist_nxr(0:1)                               !< right boundary of disturbance region
1141    INTEGER(iwp) ::  dist_nyn(0:1)                               !< north boundary of disturbance region
1142    INTEGER(iwp) ::  dist_nys(0:1)                               !< south boundary of disturbance region
1143    INTEGER(iwp) ::  do2d_no(0:1) = 0                            !< number of 2d output quantities
1144    INTEGER(iwp) ::  do2d_xy_time_count(0:1)                     !< number of output intervals for 2d data (xy)
1145    INTEGER(iwp) ::  do2d_xz_time_count(0:1)                     !< number of output intervals for 2d data (xz)
1146    INTEGER(iwp) ::  do2d_yz_time_count(0:1)                     !< number of output intervals for 2d data (yz)
1147    INTEGER(iwp) ::  do3d_no(0:1) = 0                            !< number of 3d output quantities
1148    INTEGER(iwp) ::  do3d_time_count(0:1)                        !< number of output intervals for 3d data
1149    INTEGER(iwp) ::  domask_no(max_masks,0:1) = 0                !< number of masked output quantities
1150    INTEGER(iwp) ::  domask_time_count(max_masks,0:1)            !< number of output intervals for masked data
1151    INTEGER(iwp) ::  mask_size(max_masks,3) = -1                 !< size of mask array per mask and dimension (for netcdf output)
1152    INTEGER(iwp) ::  mask_size_l(max_masks,3) = -1               !< subdomain size of mask array per mask and dimension (for netcdf output)
1153    INTEGER(iwp) ::  mask_start_l(max_masks,3) = -1              !< subdomain start index of mask array (for netcdf output)
1154    INTEGER(iwp) ::  pt_vertical_gradient_level_ind(10) = -9999  !< grid index values of pt_vertical_gradient_level(s)
1155    INTEGER(iwp) ::  q_vertical_gradient_level_ind(10) = -9999   !< grid index values of q_vertical_gradient_level(s)
1156    INTEGER(iwp) ::  s_vertical_gradient_level_ind(10) = -9999   !< grid index values of s_vertical_gradient_level(s)   
1157    INTEGER(iwp) ::  sa_vertical_gradient_level_ind(10) = -9999  !< grid index values of sa_vertical_gradient_level(s)
1158    INTEGER(iwp) ::  section(100,3)                              !< collective array for section_xy/xz/yz
1159    INTEGER(iwp) ::  section_xy(100) = -9999                     !< namelist parameter
1160    INTEGER(iwp) ::  section_xz(100) = -9999                     !< namelist parameter
1161    INTEGER(iwp) ::  section_yz(100) = -9999                     !< namelist parameter
1162    INTEGER(iwp) ::  ug_vertical_gradient_level_ind(10) = -9999  !< grid index values of ug_vertical_gradient_level(s)
1163    INTEGER(iwp) ::  vg_vertical_gradient_level_ind(10) = -9999  !< grid index values of vg_vertical_gradient_level(s)
1164    INTEGER(iwp) ::  subs_vertical_gradient_level_i(10) = -9999  !< grid index values of subs_vertical_gradient_level(s)
1165
1166    INTEGER(iwp), DIMENSION(0:1) ::  ntdim_2d_xy  !< number of output intervals for 2d data (xy)
1167    INTEGER(iwp), DIMENSION(0:1) ::  ntdim_2d_xz  !< number of output intervals for 2d data (xz)
1168    INTEGER(iwp), DIMENSION(0:1) ::  ntdim_2d_yz  !< number of output intervals for 2d data (yz)
1169    INTEGER(iwp), DIMENSION(0:1) ::  ntdim_3d     !< number of output intervals for 3d data
1170
1171    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  grid_level_count  !< internal switch for steering the multigrid v- and w-cycles
1172
1173    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  mask_i         !< subdomain grid index of masked output point on x-dimension
1174    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  mask_j         !< subdomain grid index of masked output point on y-dimension
1175    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  mask_k         !< subdomain grid index of masked output point on z-dimension
1176    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  mask_i_global  !< global grid index of masked output point on x-dimension
1177    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  mask_j_global  !< global grid index of masked output point on y-dimension
1178    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  mask_k_global  !< global grid index of masked output point on z-dimension
1179
1180    LOGICAL ::  aerosol_nacl =.TRUE.                         !< nacl aerosol for bulk scheme
1181    LOGICAL ::  aerosol_c3h4o4 =.FALSE.                      !< malonic acid aerosol for bulk scheme
1182    LOGICAL ::  aerosol_nh4no3 =.FALSE.                      !< malonic acid aerosol for bulk scheme
1183    LOGICAL ::  air_chemistry = .FALSE.                      !< chemistry model switch
1184    LOGICAL ::  bc_lr_cyc =.TRUE.                            !< left-right boundary condition cyclic?
1185    LOGICAL ::  bc_lr_dirrad = .FALSE.                       !< left-right boundary condition dirichlet/radiation?
1186    LOGICAL ::  bc_lr_raddir = .FALSE.                       !< left-right boundary condition radiation/dirichlet?
1187    LOGICAL ::  bc_ns_cyc = .TRUE.                           !< north-south boundary condition cyclic?
1188    LOGICAL ::  bc_ns_dirrad = .FALSE.                       !< north-south boundary condition dirichlet/radiation?
1189    LOGICAL ::  bc_ns_raddir = .FALSE.                       !< north-south boundary condition radiation/dirichlet?
1190    LOGICAL ::  call_microphysics_at_all_substeps = .FALSE.  !< namelist parameter
1191    LOGICAL ::  call_psolver_at_all_substeps = .TRUE.        !< namelist parameter
1192    LOGICAL ::  cloud_droplets = .FALSE.                     !< namelist parameter
1193    LOGICAL ::  cloud_physics = .FALSE.                      !< namelist parameter
1194    LOGICAL ::  cloud_top_radiation = .FALSE.                !< namelist parameter
1195    LOGICAL ::  complex_terrain = .FALSE.                    !< namelist parameter
1196    LOGICAL ::  conserve_volume_flow = .FALSE.               !< namelist parameter
1197    LOGICAL ::  constant_diffusion = .FALSE.                 !< diffusion coefficient constant?
1198    LOGICAL ::  constant_flux_layer = .TRUE.                 !< namelist parameter
1199    LOGICAL ::  constant_heatflux = .TRUE.                   !< heat flux at all surfaces constant?
1200    LOGICAL ::  constant_top_heatflux = .TRUE.               !< heat flux at domain top constant?
1201    LOGICAL ::  constant_top_momentumflux = .FALSE.          !< momentum flux at domain topconstant?
1202    LOGICAL ::  constant_top_salinityflux = .TRUE.           !< salinity flux at ocean domain top?
1203    LOGICAL ::  constant_top_scalarflux = .TRUE.             !< passive-scalar flux at domain top constant?
1204    LOGICAL ::  constant_scalarflux = .TRUE.                 !< passive-scalar flux at surfaces constant?
1205    LOGICAL ::  constant_waterflux = .TRUE.                  !< water flux at all surfaces constant?
1206    LOGICAL ::  create_disturbances = .TRUE.                 !< namelist parameter
1207    LOGICAL ::  data_output_during_spinup = .FALSE.          !< namelist parameter
1208    LOGICAL ::  data_output_2d_on_each_pe = .TRUE.           !< namelist parameter
1209    LOGICAL ::  disturbance_created = .FALSE.                !< flow disturbance imposed?
1210    LOGICAL ::  do2d_at_begin = .FALSE.                      !< namelist parameter
1211    LOGICAL ::  do3d_at_begin = .FALSE.                      !< namelist parameter
1212    LOGICAL ::  do_sum = .FALSE.                             !< contribute to time average of profile data?
1213    LOGICAL ::  dp_external = .FALSE.                        !< namelist parameter
1214    LOGICAL ::  dp_smooth = .FALSE.                          !< namelist parameter
1215    LOGICAL ::  dt_fixed = .FALSE.                           !< fixed timestep (namelist parameter dt set)?
1216    LOGICAL ::  dt_3d_reached                                !< internal timestep for particle advection
1217    LOGICAL ::  dt_3d_reached_l                              !< internal timestep for particle advection
1218    LOGICAL ::  first_call_lpm = .TRUE.                      !< call lpm only once per timestep?
1219    LOGICAL ::  force_print_header = .FALSE.                 !< namelist parameter
1220    LOGICAL ::  force_bound_l = .FALSE.                      !< flag indicating domain boundary on left side to set forcing boundary conditions
1221    LOGICAL ::  force_bound_n = .FALSE.                      !< flag indicating domain boundary on north side to set forcing boundary conditions
1222    LOGICAL ::  force_bound_r = .FALSE.                      !< flag indicating domain boundary on right side to set forcing boundary conditions
1223    LOGICAL ::  force_bound_s = .FALSE.                      !< flag indicating domain boundary on south side to set forcing boundary conditions
1224    LOGICAL ::  forcing = .FALSE.                            !< flag controlling forcing from large-scale model     
1225    LOGICAL ::  galilei_transformation = .FALSE.             !< namelist parameter
1226    LOGICAL ::  humidity = .FALSE.                           !< namelist parameter
1227    LOGICAL ::  humidity_remote = .FALSE.                    !< switch for receiving near-surface humidity flux (atmosphere-ocean coupling)
1228    LOGICAL ::  inflow_l = .FALSE.                           !< left domain boundary has non-cyclic inflow?
1229    LOGICAL ::  inflow_n = .FALSE.                           !< north domain boundary has non-cyclic inflow?
1230    LOGICAL ::  inflow_r = .FALSE.                           !< right domain boundary has non-cyclic inflow?
1231    LOGICAL ::  inflow_s = .FALSE.                           !< south domain boundary has non-cyclic inflow?
1232    LOGICAL ::  large_scale_forcing = .FALSE.                !< namelist parameter
1233    LOGICAL ::  large_scale_subsidence = .FALSE.             !< namelist parameter
1234    LOGICAL ::  land_surface = .FALSE.                       !< use land surface model?
1235    LOGICAL ::  les_mw = .FALSE.                             !< use Moeng-Wyngaard turbulence closure for LES mode
1236    LOGICAL ::  lsf_exception = .FALSE.                      !< use of lsf with buildings (temporary)?
1237    LOGICAL ::  lsf_surf = .TRUE.                            !< use surface forcing (large scale forcing)?
1238    LOGICAL ::  lsf_vert = .TRUE.                            !< use atmospheric forcing (large scale forcing)?
1239    LOGICAL ::  masking_method = .FALSE.                     !< namelist parameter
1240    LOGICAL ::  microphysics_sat_adjust = .FALSE.            !< use saturation adjust bulk scheme?
1241    LOGICAL ::  microphysics_kessler = .FALSE.               !< use kessler bulk scheme?
1242    LOGICAL ::  microphysics_morrison = .FALSE.              !< use 2-moment Morrison (add. prog. eq. for nc and qc)
1243    LOGICAL ::  microphysics_seifert = .FALSE.               !< use 2-moment Seifert and Beheng scheme
1244    LOGICAL ::  mg_switch_to_pe0 = .FALSE.                   !< internal multigrid switch for steering the ghost point exchange in case that data has been collected on PE0
1245    LOGICAL ::  nest_bound_l = .FALSE.                       !< flag indicating nested domain boundary on left side
1246    LOGICAL ::  nest_bound_n = .FALSE.                       !< flag indicating nested domain boundary on north side
1247    LOGICAL ::  nest_bound_r = .FALSE.                       !< flag indicating nested domain boundary on right side
1248    LOGICAL ::  nest_bound_s = .FALSE.                       !< flag indicating nested domain boundary on south side
1249    LOGICAL ::  nest_domain  = .FALSE.                       !< domain is nested into a parent domain?
1250    LOGICAL ::  neutral = .FALSE.                            !< namelist parameter
1251    LOGICAL ::  nudging = .FALSE.                            !< namelist parameter
1252    LOGICAL ::  ocean = .FALSE.                              !< namelist parameter
1253    LOGICAL ::  outflow_l = .FALSE.                          !< left domain boundary has non-cyclic outflow?
1254    LOGICAL ::  outflow_n = .FALSE.                          !< north domain boundary has non-cyclic outflow?
1255    LOGICAL ::  outflow_r = .FALSE.                          !< right domain boundary has non-cyclic outflow?
1256    LOGICAL ::  outflow_s = .FALSE.                          !< south domain boundary has non-cyclic outflow?
1257    LOGICAL ::  passive_scalar = .FALSE.                     !< namelist parameter
1258    LOGICAL ::  precipitation = .FALSE.                      !< namelist parameter
1259    LOGICAL ::  random_heatflux = .FALSE.                    !< namelist parameter
1260    LOGICAL ::  rans_mode = .FALSE.                          !< switch between RANS and LES mode
1261    LOGICAL ::  rans_tke_e = .FALSE.                         !< use TKE-e turbulence closure for RANS mode
1262    LOGICAL ::  rans_tke_l = .FALSE.                         !< use TKE-l turbulence closure for RANS mode
1263    LOGICAL ::  recycling_yshift = .FALSE.                   !< namelist parameter
1264    LOGICAL ::  run_control_header = .FALSE.                 !< onetime output of RUN_CONTROL header
1265    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
1266    LOGICAL ::  scalar_rayleigh_damping = .TRUE.             !< namelist parameter
1267    LOGICAL ::  sloping_surface = .FALSE.                    !< use sloped surface? (namelist parameter alpha_surface)
1268    LOGICAL ::  spinup = .FALSE.                             !< perform model spinup without atmosphere code?
1269    LOGICAL ::  stop_dt = .FALSE.                            !< internal switch to stop the time stepping
1270    LOGICAL ::  synchronous_exchange = .FALSE.               !< namelist parameter
1271    LOGICAL ::  synthetic_turbulence_generator = .FALSE.     !< flag for synthetic turbulence generator module
1272    LOGICAL ::  terminate_run = .FALSE.                      !< terminate run (cpu-time limit, restarts)?
1273    LOGICAL ::  topo_no_distinct = .FALSE.                   !< flag controlling classification of topography surfaces
1274    LOGICAL ::  transpose_compute_overlap = .FALSE.          !< namelist parameter
1275    LOGICAL ::  turbulent_inflow = .FALSE.                   !< namelist parameter
1276    LOGICAL ::  turbulent_outflow = .FALSE.                  !< namelist parameter
1277    LOGICAL ::  urban_surface = .FALSE.                      !< use urban surface model?
1278    LOGICAL ::  use_cmax = .TRUE.                            !< namelist parameter
1279    LOGICAL ::  use_initial_profile_as_reference = .FALSE.   !< use of initial profiles as reference state?
1280    LOGICAL ::  use_prescribed_profile_data = .FALSE.        !< use of prescribed wind profiles?
1281                                                             !< (namelist parameters u_profile, v_profile)
1282    LOGICAL ::  use_single_reference_value = .FALSE.         !< use of single value as reference state?
1283    LOGICAL ::  use_subsidence_tendencies = .FALSE.          !< namelist parameter
1284    LOGICAL ::  use_surface_fluxes = .FALSE.                 !< namelist parameter
1285    LOGICAL ::  use_top_fluxes = .FALSE.                     !< namelist parameter
1286    LOGICAL ::  use_ug_for_galilei_tr = .TRUE.               !< namelist parameter
1287    LOGICAL ::  use_upstream_for_tke = .FALSE.               !< namelist parameter
1288    LOGICAL ::  uv_exposure = .FALSE.                        !< switch for uv exposure model
1289    LOGICAL ::  virtual_flight = .FALSE.                     !< use virtual flight model?
1290    LOGICAL ::  wall_adjustment = .TRUE.                     !< namelist parameter
1291    LOGICAL ::  wind_turbine = .FALSE.                       !< flag for use of wind turbine model
1292    LOGICAL ::  write_binary = .FALSE.                       !< ENVPAR namelist parameter to steer restart I/O (ENVPAR is created by mrun)
1293    LOGICAL ::  ws_scheme_sca = .FALSE.                      !< use Wicker-Skamarock scheme (scalar advection)?
1294    LOGICAL ::  ws_scheme_mom = .FALSE.                      !< use Wicker-Skamarock scheme (momentum advection)?
1295
1296    LOGICAL ::  data_output_xy(0:1) = .FALSE.                !< output of xy cross-section data?
1297    LOGICAL ::  data_output_xz(0:1) = .FALSE.                !< output of xz cross-section data?
1298    LOGICAL ::  data_output_yz(0:1) = .FALSE.                !< output of yz cross-section data?
1299
1300    REAL(wp) ::  advected_distance_x = 0.0_wp                  !< advected distance of model domain along x
1301                                                               !< (galilei transformation)
1302    REAL(wp) ::  advected_distance_y = 0.0_wp                  !< advected distance of model domain along y
1303                                                               !< (galilei transformation)
1304    REAL(wp) ::  alpha_surface = 0.0_wp                        !< namelist parameter
1305    REAL(wp) ::  atmos_ocean_sign = 1.0_wp                     !< vertical-grid conversion factor
1306                                                               !< (=1.0 in atmosphere, =-1.0 in ocean)
1307    REAL(wp) ::  averaging_interval = 0.0_wp                   !< namelist parameter
1308    REAL(wp) ::  averaging_interval_pr = 9999999.9_wp          !< namelist parameter
1309    REAL(wp) ::  bc_pt_t_val                                   !< vertical gradient of pt near domain top
1310    REAL(wp) ::  bc_q_t_val                                    !< vertical gradient of humidity near domain top
1311    REAL(wp) ::  bc_s_t_val                                    !< vertical gradient of passive scalar near domain top
1312    REAL(wp) ::  bottom_salinityflux = 0.0_wp                  !< namelist parameter
1313    REAL(wp) ::  building_height = 50.0_wp                     !< namelist parameter
1314    REAL(wp) ::  building_length_x = 50.0_wp                   !< namelist parameter
1315    REAL(wp) ::  building_length_y = 50.0_wp                   !< namelist parameter
1316    REAL(wp) ::  building_wall_left = 9999999.9_wp             !< namelist parameter
1317    REAL(wp) ::  building_wall_south = 9999999.9_wp            !< namelist parameter
1318    REAL(wp) ::  canyon_height = 50.0_wp                       !< namelist parameter
1319    REAL(wp) ::  canyon_width_x = 9999999.9_wp                 !< namelist parameter
1320    REAL(wp) ::  canyon_width_y = 9999999.9_wp                 !< namelist parameter
1321    REAL(wp) ::  canyon_wall_left = 9999999.9_wp               !< namelist parameter
1322    REAL(wp) ::  canyon_wall_south = 9999999.9_wp              !< namelist parameter
1323    REAL(wp) ::  cfl_factor = -1.0_wp                          !< namelist parameter
1324    REAL(wp) ::  cos_alpha_surface                             !< cosine of alpha_surface
1325    REAL(wp) ::  coupling_start_time = 0.0_wp                  !< namelist parameter
1326    REAL(wp) ::  disturbance_amplitude = 0.25_wp               !< namelist parameter
1327    REAL(wp) ::  disturbance_energy_limit = 0.01_wp            !< namelist parameter
1328    REAL(wp) ::  disturbance_level_b = -9999999.9_wp           !< namelist parameter
1329    REAL(wp) ::  disturbance_level_t = -9999999.9_wp           !< namelist parameter
1330    REAL(wp) ::  dp_level_b = 0.0_wp                           !< namelist parameter
1331    REAL(wp) ::  dt = -1.0_wp                                  !< namelist parameter
1332    REAL(wp) ::  dt_averaging_input = 0.0_wp                   !< namelist parameter
1333    REAL(wp) ::  dt_averaging_input_pr = 9999999.9_wp          !< namelist parameter
1334    REAL(wp) ::  dt_coupling = 9999999.9_wp                    !< namelist parameter
1335    REAL(wp) ::  dt_data_output = 9999999.9_wp                 !< namelist parameter
1336    REAL(wp) ::  dt_data_output_av = 9999999.9_wp              !< namelist parameter
1337    REAL(wp) ::  dt_disturb = 9999999.9_wp                     !< namelist parameter
1338    REAL(wp) ::  dt_dopr = 9999999.9_wp                        !< namelist parameter
1339    REAL(wp) ::  dt_dopr_listing = 9999999.9_wp                !< namelist parameter
1340    REAL(wp) ::  dt_dopts = 9999999.9_wp                       !< namelist parameter
1341    REAL(wp) ::  dt_dots = 9999999.9_wp                        !< namelist parameter
1342    REAL(wp) ::  dt_do2d_xy = 9999999.9_wp                     !< namelist parameter
1343    REAL(wp) ::  dt_do2d_xz = 9999999.9_wp                     !< namelist parameter
1344    REAL(wp) ::  dt_do2d_yz = 9999999.9_wp                     !< namelist parameter
1345    REAL(wp) ::  dt_do3d = 9999999.9_wp                        !< namelist parameter
1346    REAL(wp) ::  dt_dvrp = 9999999.9_wp                        !< namelist parameter
1347    REAL(wp) ::  dt_max = 20.0_wp                              !< namelist parameter
1348    REAL(wp) ::  dt_restart = 9999999.9_wp                     !< namelist parameter
1349    REAL(wp) ::  dt_run_control = 60.0_wp                      !< namelist parameter
1350    REAL(wp) ::  dt_spinup = 60.0_wp                           !< namelist parameter
1351    REAL(wp) ::  dt_3d = 1.0_wp                                !< time step
1352    REAL(wp) ::  dz = -1.0_wp                                  !< namelist parameter
1353    REAL(wp) ::  dz_max = 9999999.9_wp                         !< namelist parameter
1354    REAL(wp) ::  dz_stretch_factor = 1.08_wp                   !< namelist parameter
1355    REAL(wp) ::  dz_stretch_level = 100000.0_wp                !< namelist parameter
1356    REAL(wp) ::  e_init = 0.0_wp                               !< namelist parameter
1357    REAL(wp) ::  e_min = 0.0_wp                                !< namelist parameter
1358    REAL(wp) ::  end_time = 0.0_wp                             !< namelist parameter
1359    REAL(wp) ::  f = 0.0_wp                                    !< Coriolis parameter
1360    REAL(wp) ::  fs = 0.0_wp                                   !< Coriolis parameter
1361    REAL(wp) ::  g = 9.81_wp                                   !< gravitational acceleration
1362    REAL(wp) ::  inflow_damping_height = 9999999.9_wp          !< namelist parameter
1363    REAL(wp) ::  inflow_damping_width = 9999999.9_wp           !< namelist parameter
1364    REAL(wp) ::  kappa = 0.4_wp                                !< von Karman constant
1365    REAL(wp) ::  km_constant = -1.0_wp                         !< namelist parameter
1366    REAL(wp) ::  latitude = 55.0_wp                            !< namelist parameter
1367    REAL(wp) ::  longitude = 0.0_wp                            !< namelist parameter
1368    REAL(wp) ::  mask_scale_x = 1.0_wp                         !< namelist parameter
1369    REAL(wp) ::  mask_scale_y = 1.0_wp                         !< namelist parameter
1370    REAL(wp) ::  mask_scale_z = 1.0_wp                         !< namelist parameter
1371    REAL(wp) ::  maximum_cpu_time_allowed = 0.0_wp             !< given wall time for run
1372    REAL(wp) ::  molecular_viscosity = 1.461E-5_wp             !< molecular viscosity (used in lsm and lpm)
1373    REAL(wp) ::  old_dt = 1.0E-10_wp                           !< length of previous timestep
1374    REAL(wp) ::  omega = 7.29212E-5_wp                         !< namelist parameter
1375    REAL(wp) ::  omega_sor = 1.8_wp                            !< namelist parameter
1376    REAL(wp) ::  outflow_source_plane = -9999999.9_wp          !< namelist parameter
1377    REAL(wp) ::  particle_maximum_age = 9999999.9_wp           !< namelist parameter
1378    REAL(wp) ::  prandtl_number = 1.0_wp                       !< namelist parameter
1379    REAL(wp) ::  precipitation_amount_interval = 9999999.9_wp  !< namelist parameter
1380    REAL(wp) ::  prho_reference                                !< reference state of potential density
1381    REAL(wp) ::  pt_damping_factor = 0.0_wp                    !< namelist parameter
1382    REAL(wp) ::  pt_damping_width = 0.0_wp                     !< namelist parameter
1383    REAL(wp) ::  pt_reference = 9999999.9_wp                   !< namelist parameter
1384    REAL(wp) ::  pt_slope_offset = 0.0_wp                      !< temperature difference between left and right
1385                                                               !< boundary of total domain
1386    REAL(wp) ::  pt_surface = 300.0_wp                         !< namelist parameter
1387    REAL(wp) ::  pt_surface_initial_change = 0.0_wp            !< namelist parameter
1388    REAL(wp) ::  q_surface = 0.0_wp                            !< namelist parameter
1389    REAL(wp) ::  q_surface_initial_change = 0.0_wp             !< namelist parameter
1390    REAL(wp) ::  rayleigh_damping_factor = -1.0_wp             !< namelist parameter
1391    REAL(wp) ::  rayleigh_damping_height = -1.0_wp             !< namelist parameter
1392    REAL(wp) ::  recycling_width = 9999999.9_wp                !< namelist parameter
1393    REAL(wp) ::  residual_limit = 1.0E-4_wp                    !< namelist parameter
1394    REAL(wp) ::  restart_time = 9999999.9_wp                   !< namelist parameter
1395    REAL(wp) ::  rho_reference                                 !< reference state of density
1396    REAL(wp) ::  rho_surface                                   !< surface value of density
1397    REAL(wp) ::  roughness_length = 0.1_wp                     !< namelist parameter
1398    REAL(wp) ::  sa_surface = 35.0_wp                          !< namelist parameter
1399    REAL(wp) ::  simulated_time = 0.0_wp                       !< elapsed simulated time
1400    REAL(wp) ::  simulated_time_at_begin                       !< elapsed simulated time of previous run (job chain)
1401    REAL(wp) ::  sin_alpha_surface                             !< sine of alpha_surface (sloped surface)
1402    REAL(wp) ::  skip_time_data_output = 0.0_wp                !< namelist parameter
1403    REAL(wp) ::  skip_time_data_output_av = 9999999.9_wp       !< namelist parameter
1404    REAL(wp) ::  skip_time_dopr = 9999999.9_wp                 !< namelist parameter
1405    REAL(wp) ::  skip_time_do2d_xy = 9999999.9_wp              !< namelist parameter
1406    REAL(wp) ::  skip_time_do2d_xz = 9999999.9_wp              !< namelist parameter
1407    REAL(wp) ::  skip_time_do2d_yz = 9999999.9_wp              !< namelist parameter
1408    REAL(wp) ::  skip_time_do3d = 9999999.9_wp                 !< namelist parameter
1409    REAL(wp) ::  spinup_pt_amplitude = 9999999.9_wp            !< namelist parameter
1410    REAL(wp) ::  spinup_pt_mean = 9999999.9_wp                 !< namelist parameter
1411    REAL(wp) ::  spinup_time = 0.0_wp                          !< namelist parameter
1412    REAL(wp) ::  surface_heatflux = 9999999.9_wp               !< namelist parameter
1413    REAL(wp) ::  surface_pressure = 1013.25_wp                 !< namelist parameter
1414    REAL(wp) ::  surface_scalarflux = 9999999.9_wp             !< namelist parameter
1415    REAL(wp) ::  surface_waterflux = 9999999.9_wp              !< namelist parameter
1416    REAL(wp) ::  s_surface = 0.0_wp                            !< namelist parameter
1417    REAL(wp) ::  s_surface_initial_change = 0.0_wp             !< namelist parameter
1418    REAL(wp) ::  termination_time_needed = 35.0_wp             !< namelist parameter
1419    REAL(wp) ::  time_coupling = 0.0_wp                        !< time since last coupling (surface_coupler)
1420    REAL(wp) ::  time_disturb = 0.0_wp                         !< time since last flow disturbance
1421    REAL(wp) ::  time_dopr = 0.0_wp                            !< time since last profile output
1422    REAL(wp) ::  time_dopr_av = 0.0_wp                         !< time since last averaged profile output
1423    REAL(wp) ::  time_dopr_listing = 0.0_wp                    !< time since last profile output (ASCII) on file
1424    REAL(wp) ::  time_dopts = 0.0_wp                           !< time since last particle timeseries output
1425    REAL(wp) ::  time_dosp = 0.0_wp                            !< time since last spectra output
1426    REAL(wp) ::  time_dosp_av = 0.0_wp                         !< time since last averaged spectra output
1427    REAL(wp) ::  time_dots = 0.0_wp                            !< time since last timeseries output
1428    REAL(wp) ::  time_do2d_xy = 0.0_wp                         !< time since last xy cross-section output
1429    REAL(wp) ::  time_do2d_xz = 0.0_wp                         !< time since last xz cross-section output
1430    REAL(wp) ::  time_do2d_yz = 0.0_wp                         !< time since last yz cross-section output
1431    REAL(wp) ::  time_do3d = 0.0_wp                            !< time since last 3d output
1432    REAL(wp) ::  time_do_av = 0.0_wp                           !< time since last averaged-data output
1433    REAL(wp) ::  time_do_sla = 0.0_wp                          !< time since last
1434    REAL(wp) ::  time_dvrp = 0.0_wp                            !< time since last dvrp output
1435    REAL(wp) ::  time_restart = 9999999.9_wp                   !< time at which run shall be terminated and restarted
1436    REAL(wp) ::  time_run_control = 0.0_wp                     !< time since last RUN_CONTROL output
1437    REAL(wp) ::  time_since_reference_point                    !< time after atmosphere-ocean coupling has been activated, or time after spinup phase of LSM has been finished
1438    REAL(wp) ::  top_heatflux = 9999999.9_wp                   !< namelist parameter
1439    REAL(wp) ::  top_momentumflux_u = 9999999.9_wp             !< namelist parameter
1440    REAL(wp) ::  top_momentumflux_v = 9999999.9_wp             !< namelist parameter
1441    REAL(wp) ::  top_salinityflux = 9999999.9_wp               !< namelist parameter
1442    REAL(wp) ::  top_scalarflux = 9999999.9_wp                 !< namelist parameter
1443    REAL(wp) ::  tunnel_height = 9999999.9_wp                  !< namelist parameter
1444    REAL(wp) ::  tunnel_length = 9999999.9_wp                  !< namelist parameter
1445    REAL(wp) ::  tunnel_width_x = 9999999.9_wp                 !< namelist parameter
1446    REAL(wp) ::  tunnel_width_y = 9999999.9_wp                 !< namelist parameter
1447    REAL(wp) ::  tunnel_wall_depth = 9999999.9_wp              !< namelist parameter
1448    REAL(wp) ::  ug_surface = 0.0_wp                           !< namelist parameter
1449    REAL(wp) ::  u_bulk = 0.0_wp                               !< namelist parameter
1450    REAL(wp) ::  u_gtrans = 0.0_wp                             !< transformed wind component (galilei transformation)
1451    REAL(wp) ::  vg_surface = 0.0_wp                           !< namelist parameter
1452    REAL(wp) ::  vpt_reference = 9999999.9_wp                  !< reference state of virtual potential temperature
1453    REAL(wp) ::  v_bulk = 0.0_wp                               !< namelist parameter
1454    REAL(wp) ::  v_gtrans = 0.0_wp                             !< transformed wind component (galilei transformation)
1455    REAL(wp) ::  wall_adjustment_factor = 1.8_wp               !< adjustment factor for mixing length l
1456    REAL(wp) ::  zeta_max = 20.0_wp                            !< namelist parameter
1457    REAL(wp) ::  zeta_min = -20.0_wp                           !< namelist parameter
1458    REAL(wp) ::  z_max_do2d = -1.0_wp                          !< namelist parameter
1459    REAL(wp) ::  z0h_factor = 1.0_wp                           !< namelist parameter
1460
1461    REAL(wp) ::  do2d_xy_last_time(0:1) = -1.0_wp                  !< time of previous xy output
1462    REAL(wp) ::  do2d_xz_last_time(0:1) = -1.0_wp                  !< time of previous xz output
1463    REAL(wp) ::  do2d_yz_last_time(0:1) = -1.0_wp                  !< time of previous yz output
1464    REAL(wp) ::  dpdxy(1:2) = 0.0_wp                               !< namelist parameter
1465    REAL(wp) ::  dt_domask(max_masks) = 9999999.9_wp               !< namelist parameter
1466    REAL(wp) ::  mask_scale(3)                                     !< collective array for mask_scale_x/y/z
1467    REAL(wp) ::  pt_vertical_gradient(10) = 0.0_wp                 !< namelist parameter
1468    REAL(wp) ::  pt_vertical_gradient_level(10) = -999999.9_wp   !< namelist parameter
1469    REAL(wp) ::  q_vertical_gradient(10) = 0.0_wp                  !< namelist parameter
1470    REAL(wp) ::  q_vertical_gradient_level(10) = -999999.9_wp    !< namelist parameter
1471    REAL(wp) ::  s_vertical_gradient(10) = 0.0_wp                  !< namelist parameter
1472    REAL(wp) ::  s_vertical_gradient_level(10) = -999999.9_wp    !< namelist parameter
1473    REAL(wp) ::  sa_vertical_gradient(10) = 0.0_wp                 !< namelist parameter
1474    REAL(wp) ::  sa_vertical_gradient_level(10) = -999999.9_wp   !< namelist parameter
1475    REAL(wp) ::  skip_time_domask(max_masks) = 9999999.9_wp        !< namelist parameter
1476    REAL(wp) ::  threshold(20) = 0.0_wp                            !< namelist parameter
1477    REAL(wp) ::  time_domask(max_masks) = 0.0_wp                   !< namelist parameter
1478    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
1479                 0.0_wp, 0.0_wp, 0.0_wp, 0.0_wp, 0.0_wp, 0.0_wp /)
1480    REAL(wp) ::  u_profile(100) = 9999999.9_wp                     !< namelist parameter
1481    REAL(wp) ::  uv_heights(100) = 9999999.9_wp                    !< namelist parameter
1482    REAL(wp) ::  v_profile(100) = 9999999.9_wp                     !< namelist parameter
1483    REAL(wp) ::  ug_vertical_gradient(10) = 0.0_wp                 !< namelist parameter
1484    REAL(wp) ::  ug_vertical_gradient_level(10) = -9999999.9_wp    !< namelist parameter
1485    REAL(wp) ::  vg_vertical_gradient(10) = 0.0_wp                 !< namelist parameter
1486    REAL(wp) ::  vg_vertical_gradient_level(10) = -9999999.9_wp    !< namelist parameter
1487    REAL(wp) ::  volume_flow(1:3) = 0.0_wp                         !< volume flow through 1:yz-plane, 2: xz-plane, 3: xy-plane (nest childs only)
1488    REAL(wp) ::  volume_flow_area(1:3) = 0.0_wp                    !< area of the respective volume flow planes
1489    REAL(wp) ::  volume_flow_initial(1:3) = 0.0_wp                 !< initial volume flow (t=0) through the respective volume flow planes
1490    REAL(wp) ::  wall_heatflux(0:5) = 0.0_wp                       !< namelist parameter
1491    REAL(wp) ::  wall_humidityflux(0:5) = 0.0_wp                   !< namelist parameter
1492    REAL(wp) ::  wall_salinityflux(0:5) = 0.0_wp                   !< namelist parameter
1493    REAL(wp) ::  wall_scalarflux(0:5) = 0.0_wp                     !< namelist parameter
1494    REAL(wp) ::  subs_vertical_gradient(10) = 0.0_wp               !< namelist parameter
1495    REAL(wp) ::  subs_vertical_gradient_level(10) = -9999999.9_wp  !< namelist parameter
1496
1497    REAL(wp), DIMENSION(:), ALLOCATABLE ::  dp_smooth_factor  !< smoothing factor for external pressure gradient forcing
1498
1499    REAL(wp), DIMENSION(max_masks,mask_xyz_dimension) ::  mask_x = -1.0_wp  !< namelist parameter
1500    REAL(wp), DIMENSION(max_masks,mask_xyz_dimension) ::  mask_y = -1.0_wp  !< namelist parameter
1501    REAL(wp), DIMENSION(max_masks,mask_xyz_dimension) ::  mask_z = -1.0_wp  !< namelist parameter
1502   
1503    REAL(wp), DIMENSION(max_masks,3) ::  mask_x_loop = -1.0_wp  !< namelist parameter
1504    REAL(wp), DIMENSION(max_masks,3) ::  mask_y_loop = -1.0_wp  !< namelist parameter
1505    REAL(wp), DIMENSION(max_masks,3) ::  mask_z_loop = -1.0_wp  !< namelist parameter
1506   
1507!
1508!--    internal mask arrays ("mask,dimension,selection")
1509       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  mask       !< collective array for mask_x/y/z
1510       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  mask_loop  !< collective array for mask_x/y/z_loop
1511
1512    SAVE
1513
1514 END MODULE control_parameters
1515
1516
1517!------------------------------------------------------------------------------!
1518! Description:
1519! ------------
1520!> Definition of variables used with dvrp-software.
1521!------------------------------------------------------------------------------!
1522 MODULE dvrp_variables
1523
1524    USE kinds
1525
1526    CHARACTER (LEN=10) ::  dvrp_output = 'rtsp'        !< dvr namelist parameter
1527    CHARACTER (LEN=10) ::  particle_color = 'none'     !< dvr namelist parameter
1528    CHARACTER (LEN=10) ::  particle_dvrpsize = 'none'  !< dvr namelist parameter
1529
1530    CHARACTER (LEN=20), DIMENSION(10) ::  mode_dvrp = &  !< dvr namelist parameter
1531                                     (/ ( '                    ', i9 = 1,10 ) /)
1532
1533    CHARACTER (LEN=80) ::  dvrp_directory = 'default'                     !< dvr namelist parameter
1534    CHARACTER (LEN=80) ::  dvrp_file      = 'default'                     !< dvr namelist parameter
1535    CHARACTER (LEN=80) ::  dvrp_host      = 'origin.rvs.uni-hannover.de'  !< dvr namelist parameter
1536    CHARACTER (LEN=80) ::  dvrp_password  = '********'                    !< dvr namelist parameter
1537    CHARACTER (LEN=80) ::  dvrp_username  = ' '                           !< dvr namelist parameter
1538
1539    INTEGER(iwp) ::  cluster_size = 1                   !< dvr namelist parameter
1540    INTEGER(iwp) ::  dvrp_colortable_entries = 4        !< internal dvr software variable
1541    INTEGER(iwp) ::  dvrp_colortable_entries_prt = 22   !< internal dvr software variable
1542    INTEGER(iwp) ::  islice_dvrp                        !< internal dvr software variable
1543    INTEGER(iwp) ::  nx_dvrp                            !< internal dvr software variable
1544    INTEGER(iwp) ::  nxl_dvrp                           !< internal dvr software variable
1545    INTEGER(iwp) ::  nxr_dvrp                           !< internal dvr software variable
1546    INTEGER(iwp) ::  ny_dvrp                            !< internal dvr software variable
1547    INTEGER(iwp) ::  nyn_dvrp                           !< internal dvr software variable
1548    INTEGER(iwp) ::  nys_dvrp                           !< internal dvr software variable
1549    INTEGER(iwp) ::  nz_dvrp                            !< internal dvr software variable
1550    INTEGER(iwp) ::  pathlines_fadeintime = 5           !< dvr namelist parameter
1551    INTEGER(iwp) ::  pathlines_fadeouttime = 5          !< dvr namelist parameter
1552    INTEGER(iwp) ::  pathlines_linecount = 1000         !< dvr namelist parameter
1553    INTEGER(iwp) ::  pathlines_maxhistory = 40          !< dvr namelist parameter
1554    INTEGER(iwp) ::  pathlines_wavecount = 10           !< dvr namelist parameter
1555    INTEGER(iwp) ::  pathlines_wavetime = 50            !< dvr namelist parameter
1556    INTEGER(iwp) ::  vc_gradient_normals = 0            !< dvr namelist parameter
1557    INTEGER(iwp) ::  vc_mode = 0                        !< dvr namelist parameter
1558    INTEGER(iwp) ::  vc_size_x = 2                      !< dvr namelist parameter
1559    INTEGER(iwp) ::  vc_size_y = 2                      !< dvr namelist parameter
1560    INTEGER(iwp) ::  vc_size_z = 2                      !< dvr namelist parameter
1561
1562    INTEGER(iwp), DIMENSION(10) ::  slicer_position_dvrp  !< internal dvr software variable
1563
1564    LOGICAL ::  cyclic_dvrp = .FALSE.                      !< internal dvr software variable
1565    LOGICAL ::  dvrp_overlap                               !< internal dvr software variable
1566    LOGICAL ::  dvrp_total_overlap                         !< internal dvr software variable
1567    LOGICAL ::  local_dvrserver_running                    !< namelist parameter (ENVPAR namelist provided by mrun)
1568    LOGICAL ::  lock_steering_update = .FALSE.             !< internal dvr software variable
1569    LOGICAL ::  use_seperate_pe_for_dvrp_output = .FALSE.  !< internal dvr software variable
1570
1571    REAL(wp) ::  clip_dvrp_l = 9999999.9_wp  !< dvr namelist parameter
1572    REAL(wp) ::  clip_dvrp_n = 9999999.9_wp  !< dvr namelist parameter
1573    REAL(wp) ::  clip_dvrp_r = 9999999.9_wp  !< dvr namelist parameter
1574    REAL(wp) ::  clip_dvrp_s = 9999999.9_wp  !< dvr namelist parameter
1575    REAL(wp) ::  superelevation = 1.0_wp     !< dvr namelist parameter
1576    REAL(wp) ::  superelevation_x = 1.0_wp   !< dvr namelist parameter
1577    REAL(wp) ::  superelevation_y = 1.0_wp   !< dvr namelist parameter
1578    REAL(wp) ::  vc_alpha = 38.0_wp          !< dvr namelist parameter
1579
1580    REAL(wp), DIMENSION(2) ::  color_interval = (/ 0.0_wp, 1.0_wp /)     !< dvr namelist parameter
1581    REAL(wp), DIMENSION(2) ::  dvrpsize_interval = (/ 0.0_wp, 1.0_wp /)  !< dvr namelist parameter
1582
1583    REAL(wp), DIMENSION(3) ::  groundplate_color = (/ 0.0_wp, 0.6_wp, 0.0_wp /)  !< dvr namelist parameter
1584    REAL(wp), DIMENSION(3) ::  topography_color = (/ 0.8_wp, 0.7_wp, 0.6_wp /)   !< dvr namelist parameter
1585
1586    REAL(wp), DIMENSION(2,10) ::  slicer_range_limits_dvrp  !< dvr namelist parameter
1587
1588    REAL(wp), DIMENSION(3,10) ::  isosurface_color  !< dvr namelist parameter
1589
1590    REAL(sp), DIMENSION(2,100) ::  interval_values_dvrp          !< internal dvr software variable
1591    REAL(sp), DIMENSION(2,100) ::  interval_values_dvrp_prt      !< internal dvr software variable
1592    REAL(sp), DIMENSION(2,100) ::  interval_h_dvrp               !< internal dvr software variable
1593    REAL(sp), DIMENSION(2,100) ::  interval_h_dvrp_prt           !< internal dvr software variable
1594    REAL(sp), DIMENSION(2,100) ::  interval_l_dvrp = 0.5_sp      !< internal dvr software variable
1595    REAL(sp), DIMENSION(2,100) ::  interval_l_dvrp_prt = 0.5_sp  !< internal dvr software variable
1596    REAL(sp), DIMENSION(2,100) ::  interval_s_dvrp = 1.0_sp      !< internal dvr software variable
1597    REAL(sp), DIMENSION(2,100) ::  interval_s_dvrp_prt = 1.0_sp  !< internal dvr software variable
1598    REAL(sp), DIMENSION(2,100) ::  interval_a_dvrp = 0.0_sp      !< internal dvr software variable
1599    REAL(sp), DIMENSION(2,100) ::  interval_a_dvrp_prt = 0.0_sp  !< internal dvr software variable
1600
1601    DATA  slicer_range_limits_dvrp / -1.0_wp, 1.0_wp, -1.0_wp, 1.0_wp, -1.0_wp, 1.0_wp, &  !< internal dvr software variable
1602                                     -1.0_wp, 1.0_wp, -1.0_wp, 1.0_wp, -1.0_wp, 1.0_wp, &
1603                                     -1.0_wp, 1.0_wp, -1.0_wp, 1.0_wp, -1.0_wp, 1.0_wp, &
1604                                     -1.0_wp, 1.0_wp /
1605
1606    DATA  isosurface_color / 0.9_wp, 0.9_wp, 0.9_wp,  0.8_wp, 0.1_wp, 0.1_wp,  0.1_wp, 0.1_wp, 0.8_wp, &  !< internal dvr software variable
1607                             0.1_wp, 0.8_wp, 0.1_wp,  0.6_wp, 0.1_wp, 0.1_wp,  0.1_wp, 0.1_wp, 0.6_wp, &
1608                             0.1_wp, 0.6_wp, 0.1_wp,  0.4_wp, 0.1_wp, 0.1_wp,  0.1_wp, 0.1_wp, 0.4_wp, &
1609                             0.1_wp, 0.4_wp, 0.1_wp /
1610
1611    DATA  interval_h_dvrp / 270.0_wp, 225.0_wp, 225.0_wp, 180.0_wp, 70.0_wp, 25.0_wp, &  !< internal dvr software variable
1612                            25.0_wp, -25.0_wp, 192 * 0.0_wp /
1613
1614    DATA  interval_h_dvrp_prt / 270.0_wp, 225.0_wp, 225.0_wp, 180.0_wp, 70.0_wp, 25.0_wp, &  !< internal dvr software variable
1615                                25.0_wp, -25.0_wp, 192 * 0.0_wp /
1616
1617    REAL(sp), DIMENSION(:), ALLOCATABLE ::  xcoor_dvrp  !< internal dvr software variable
1618    REAL(sp), DIMENSION(:), ALLOCATABLE ::  ycoor_dvrp  !< internal dvr software variable
1619    REAL(sp), DIMENSION(:), ALLOCATABLE ::  zcoor_dvrp  !< internal dvr software variable
1620
1621    TYPE steering
1622       CHARACTER (LEN=24) ::  name  !< internal dvr software variable
1623       REAL(sp)           ::  min   !< internal dvr software variable
1624       REAL(sp)           ::  max   !< internal dvr software variable
1625       INTEGER(iwp)       ::  imin  !< internal dvr software variable
1626       INTEGER(iwp)       ::  imax  !< internal dvr software variable
1627    END TYPE steering
1628
1629    TYPE(steering), DIMENSION(:), ALLOCATABLE ::  steering_dvrp  !< internal dvr software variable
1630
1631    SAVE
1632
1633 END MODULE dvrp_variables
1634
1635
1636!------------------------------------------------------------------------------!
1637! Description:
1638! ------------
1639!> Definition of grid spacings.
1640!------------------------------------------------------------------------------!
1641 MODULE grid_variables
1642
1643    USE kinds
1644
1645    REAL(wp) ::  ddx          !< 1/dx
1646    REAL(wp) ::  ddx2         !< 1/dx2
1647    REAL(wp) ::  dx = 1.0_wp  !< horizontal grid size (along x-direction)
1648    REAL(wp) ::  dx2          !< dx*dx
1649    REAL(wp) ::  ddy          !< 1/dy
1650    REAL(wp) ::  ddy2         !< 1/dy2
1651    REAL(wp) ::  dy = 1.0_wp  !< horizontal grid size (along y-direction)
1652    REAL(wp) ::  dy2          !< dy*dy
1653
1654    REAL(wp), DIMENSION(:), ALLOCATABLE ::  ddx2_mg  !< 1/dx_l**2 (dx_l: grid spacing along x on different multigrid level)
1655    REAL(wp), DIMENSION(:), ALLOCATABLE ::  ddy2_mg  !< 1/dy_l**2 (dy_l: grid spacing along y on different multigrid level)
1656
1657    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  zu_s_inner  !< height of topography top on scalar grid
1658    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  zw_w_inner  !< height of topography top on w grid
1659                                             
1660    SAVE
1661
1662 END MODULE grid_variables
1663
1664
1665!------------------------------------------------------------------------------!
1666! Description:
1667! ------------
1668!> Definition of array bounds, number of gridpoints, and wall flag arrays.
1669!------------------------------------------------------------------------------!
1670 MODULE indices
1671
1672    USE kinds
1673
1674    INTEGER(iwp) ::  nbgp = 3     !< number of boundary ghost points
1675    INTEGER(iwp) ::  ngp_sums     !< number of vertical profile grid points time number of output profiles - used for allreduce statements in MPI calls
1676    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
1677    INTEGER(iwp) ::  nnx          !< number of subdomain grid points in x-direction
1678    INTEGER(iwp) ::  nx = 0       !< nx+1 = total number of grid points in x-direction
1679    INTEGER(iwp) ::  nx_a         !< in coupled atmosphere-ocean runs: total number of grid points along x (atmosphere)
1680    INTEGER(iwp) ::  nx_o         !< in coupled atmosphere-ocean runs: total number of grid points along x (ocean)
1681    INTEGER(iwp) ::  nxl          !< left-most grid index of subdomain (excluding ghost points)
1682    INTEGER(iwp) ::  nxlg         !< left-most grid index of subdomain (including ghost points)
1683    INTEGER(iwp) ::  nxlu         !< =nxl+1 (at left domain boundary with inflow from left), else =nxl (used for u-velocity component)
1684    INTEGER(iwp) ::  nxr          !< right-most grid index of subdomain (excluding ghost points)
1685    INTEGER(iwp) ::  nxrg         !< right-most grid index of subdomain (including ghost points)
1686    INTEGER(iwp) ::  nx_on_file   !< nx of previous run in job chain
1687    INTEGER(iwp) ::  nny          !< number of subdomain grid points in y-direction
1688    INTEGER(iwp) ::  ny = 0       !< ny+1 = total number of grid points in y-direction
1689    INTEGER(iwp) ::  ny_a         !< in coupled atmosphere-ocean runs: total number of grid points along y (atmosphere)
1690    INTEGER(iwp) ::  ny_o         !< in coupled atmosphere-ocean runs: total number of grid points along y (ocean)
1691    INTEGER(iwp) ::  nyn          !< north-most grid index of subdomain (excluding ghost points)
1692    INTEGER(iwp) ::  nyng         !< north-most grid index of subdomain (including ghost points)
1693    INTEGER(iwp) ::  nys          !< south-most grid index of subdomain (excluding ghost points)
1694    INTEGER(iwp) ::  nysg         !< south-most grid index of subdomain (including ghost points)
1695    INTEGER(iwp) ::  nysv         !< =nys+1 (at south domain boundary with inflow from south), else =nys (used for v-velocity component)
1696    INTEGER(iwp) ::  ny_on_file   !< ny of previous run in job chain
1697    INTEGER(iwp) ::  nnz          !< number of subdomain grid points in z-direction
1698    INTEGER(iwp) ::  nz = 0       !< total number of grid points in z-direction
1699    INTEGER(iwp) ::  nzb          !< bottom grid index of computational domain
1700    INTEGER(iwp) ::  nzb_diff     !< will be removed
1701    INTEGER(iwp) ::  nzb_max      !< vertical index of topography top
1702    INTEGER(iwp) ::  nzt          !< nzt+1 = top grid index of computational domain
1703
1704    INTEGER(idp), DIMENSION(:), ALLOCATABLE ::  ngp_3d        !< number of grid points of the total domain
1705    INTEGER(idp), DIMENSION(:), ALLOCATABLE ::  ngp_3d_inner  !< ! need to have 64 bit for grids > 2E9
1706                   
1707    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  ngp_2dh  !< number of grid points of a horizontal cross section through the total domain
1708    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  nxl_mg   !< left-most grid index of subdomain on different multigrid level
1709    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  nxr_mg   !< right-most grid index of subdomain on different multigrid level
1710    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  nyn_mg   !< north-most grid index of subdomain on different multigrid level
1711    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  nys_mg   !< south-most grid index of subdomain on different multigrid level
1712    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  nzt_mg   !< top-most grid index of subdomain on different multigrid level
1713
1714
1715    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  ngp_2dh_outer     !< number of horizontal grid points which are non-topography and non-surface-bounded
1716    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  ngp_2dh_s_inner   !< number of horizontal grid points which are non-topography
1717    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
1718    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  nzb_diff_s_inner  !< will be removed
1719    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  nzb_diff_s_outer  !< will be removed
1720    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  nzb_inner         !< will be removed
1721    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  nzb_outer         !< will be removed
1722    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  nzb_s_inner       !< will be removed
1723    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  nzb_s_outer       !< will be removed
1724    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  nzb_u_inner       !< will be removed
1725    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  nzb_u_outer       !< will be removed
1726    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  nzb_v_inner       !< will be removed
1727    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  nzb_v_outer       !< will be removed
1728    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  nzb_w_inner       !< will be removed
1729    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  nzb_w_outer       !< will be removed
1730
1731    INTEGER(iwp), DIMENSION(:,:,:), POINTER ::  flags  !< pointer to wall_flags_1-10
1732
1733    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE,  TARGET ::  wall_flags_1   !< topograpyh masking flag on multigrid level 1
1734    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE,  TARGET ::  wall_flags_2   !< topograpyh masking flag on multigrid level 2
1735    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE,  TARGET ::  wall_flags_3   !< topograpyh masking flag on multigrid level 3
1736    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE,  TARGET ::  wall_flags_4   !< topograpyh masking flag on multigrid level 4
1737    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE,  TARGET ::  wall_flags_5   !< topograpyh masking flag on multigrid level 5
1738    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE,  TARGET ::  wall_flags_6   !< topograpyh masking flag on multigrid level 6
1739    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE,  TARGET ::  wall_flags_7   !< topograpyh masking flag on multigrid level 7
1740    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE,  TARGET ::  wall_flags_8   !< topograpyh masking flag on multigrid level 8
1741    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE,  TARGET ::  wall_flags_9   !< topograpyh masking flag on multigrid level 9
1742    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE,  TARGET ::  wall_flags_10  !< topograpyh masking flag on multigrid level 10
1743
1744    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE ::  advc_flags_1            !< flags used to degrade order of advection scheme
1745    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE ::  advc_flags_2            !< flags used to degrade order of advection scheme
1746    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE ::  wall_flags_0            !< flags to mask topography and surface-bounded grid points
1747
1748    SAVE
1749
1750 END MODULE indices
1751
1752
1753!------------------------------------------------------------------------------!
1754! Description:
1755! ------------
1756!> Interfaces for special subroutines which use optional parameters.
1757!------------------------------------------------------------------------------!
1758 MODULE interfaces
1759
1760    INTERFACE
1761
1762!------------------------------------------------------------------------------!
1763! Description:
1764! ------------
1765!> @todo Missing subroutine description.
1766!------------------------------------------------------------------------------!
1767       SUBROUTINE global_min_max ( i1, i2, j1, j2, k1, k2, array, mode, offset, &
1768                                   result, result_ijk, result1, result1_ijk )
1769
1770          USE kinds
1771
1772          CHARACTER (LEN=*), INTENT(IN) ::  mode                      !< mode of global min/max function: can be 'min', 'max', 'minmax', 'abs', or 'absoff'
1773          INTEGER(iwp), INTENT(IN)      ::  i1                        !< internal index of min/max function
1774          INTEGER(iwp), INTENT(IN)      ::  i2                        !< internal index of min/max function
1775          INTEGER(iwp), INTENT(IN)      ::  j1                        !< internal index of min/max function
1776          INTEGER(iwp), INTENT(IN)      ::  j2                        !< internal index of min/max function
1777          INTEGER(iwp), INTENT(IN)      ::  k1                        !< internal index of min/max function
1778          INTEGER(iwp), INTENT(IN)      ::  k2                        !< internal index of min/max function
1779          INTEGER(iwp)                  ::  result_ijk(3)             !< grid index result of min/max function
1780          INTEGER(iwp), OPTIONAL        ::  result1_ijk(3)            !< optional grid index result of min/max function
1781          REAL(wp)                      ::  offset                    !< min/max function calculates absolute value with respect to an offset
1782          REAL(wp)                      ::  result                    !< result of min/max function
1783          REAL(wp), OPTIONAL            ::  result1                   !< optional result of min/max function
1784          REAL(wp), INTENT(IN)          ::  array(i1:i2,j1:j2,k1:k2)  !< input array of min/max function
1785
1786       END SUBROUTINE global_min_max
1787
1788    END INTERFACE
1789
1790    SAVE
1791
1792 END MODULE interfaces
1793
1794
1795!------------------------------------------------------------------------------!
1796! Description:
1797! ------------
1798!> Interfaces for subroutines with pointer arguments called in
1799!> prognostic_equations.
1800!------------------------------------------------------------------------------!
1801 MODULE pointer_interfaces
1802
1803    INTERFACE
1804
1805!------------------------------------------------------------------------------!
1806! Description:
1807! ------------
1808!> @todo Missing subroutine description.
1809!------------------------------------------------------------------------------!
1810       SUBROUTINE advec_s_bc( sk, sk_char )
1811
1812          USE kinds
1813
1814          CHARACTER (LEN=*), INTENT(IN) ::  sk_char  !< string for treated scalar in Bott-Chlond scheme
1815#if defined( __nopointer )
1816          REAL(wp), DIMENSION(:,:,:) ::  sk  !< treated scalar array in Bott-Chlond scheme
1817#else
1818          REAL(wp), DIMENSION(:,:,:), POINTER ::  sk  !< treated scalar array in Bott-Chlond scheme
1819#endif
1820       END SUBROUTINE advec_s_bc
1821
1822    END INTERFACE
1823
1824    SAVE
1825
1826 END MODULE pointer_interfaces
1827
1828
1829!------------------------------------------------------------------------------!
1830! Description:
1831! ------------
1832!> Definition of variables which define processor topology and the exchange of
1833!> ghost point layers. This module must be placed in all routines containing
1834!> MPI-calls.
1835!------------------------------------------------------------------------------!
1836 MODULE pegrid
1837
1838    USE kinds
1839
1840#if defined( __parallel )
1841#if defined( __mpifh )
1842    INCLUDE "mpif.h"
1843#else
1844    USE MPI
1845#endif
1846#endif
1847    CHARACTER(LEN=2) ::  send_receive = 'al'     !<
1848    CHARACTER(LEN=7) ::  myid_char = ''          !< character string containing processor id number
1849   
1850    INTEGER(iwp) ::  comm1dx                     !< communicator for domain decomposition along x
1851    INTEGER(iwp) ::  comm1dy                     !< communicator for domain decomposition along y
1852    INTEGER(iwp) ::  comm2d                      !< standard 2d (xy) communicator used in PALM for the process group the PE belongs to
1853    INTEGER(iwp) ::  comm_inter                  !< intercommunicator that connects atmosphere/ocean process groups
1854    INTEGER(iwp) ::  comm_palm                   !< internal communicator used during the MPI setup at the beginning of a run
1855    INTEGER(iwp) ::  id_inflow = 0               !< myidx of procs at inflow (turbulent inflow method)
1856    INTEGER(iwp) ::  id_outflow = 0              !< myidx of procs at outflow (turbulent outflow method)
1857    INTEGER(iwp) ::  id_outflow_source = 0       !< myidx of procs including ouflow source plane (turbulent outflow method)
1858    INTEGER(iwp) ::  id_recycling = 0            !< myidx of procs containing the recycling plane (turbulence recycling method)
1859    INTEGER(iwp) ::  ierr                        !< standard error parameter in MPI calls
1860    INTEGER(iwp) ::  myid = 0                    !< id number of processor element
1861    INTEGER(iwp) ::  myidx = 0                   !< id number of processor elements with same position along x-direction
1862    INTEGER(iwp) ::  myidy = 0                   !< id number of processor elements with same position along y-direction
1863    INTEGER(iwp) ::  ndim = 2                    !< dimension of the virtual PE grid
1864    INTEGER(iwp) ::  ngp_a                       !< used in atmosphere/ocean coupling: total number of horizontal grid points (atmosphere)
1865    INTEGER(iwp) ::  ngp_o                       !< used in atmosphere/ocean coupling: total number of horizontal grid points (ocean)
1866    INTEGER(iwp) ::  ngp_xy                      !< used in atmosphere/ocean coupling: number of grid points of the subdomain
1867    INTEGER(iwp) ::  ngp_y                       !< number of subdomain grid points along y including ghost points
1868    INTEGER(iwp) ::  npex = -1                   !< number of processor elements in x-direction
1869    INTEGER(iwp) ::  npey = -1                   !< number of processor elements in y-direction
1870    INTEGER(iwp) ::  numprocs = 1                !< total number of appointed processor elements
1871    INTEGER(iwp) ::  numprocs_previous_run = -1  !< total number of appointed processor elements in previous run (job chain)
1872    INTEGER(iwp) ::  pleft                       !< MPI-address of the processor left of the current one
1873    INTEGER(iwp) ::  pnorth                      !< MPI-address of the processor north of the current one
1874    INTEGER(iwp) ::  pright                      !< MPI-address of the processor right of the current one
1875    INTEGER(iwp) ::  psouth                      !< MPI-address of the processor south of the current one
1876    INTEGER(iwp) ::  req_count = 0               !< MPI return variable - checks if Send-Receive operation is already finished
1877    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
1878    INTEGER(iwp) ::  sendrecvcount_yz            !< number of subdomain gridpoints to be exchanged in third (2d) transposition y --> z
1879    INTEGER(iwp) ::  sendrecvcount_zx            !< number of subdomain gridpoints to be exchanged in first (2d) transposition z --> x
1880    INTEGER(iwp) ::  sendrecvcount_zyd           !< number of subdomain gridpoints to be exchanged in direct transpositions z --> y (used for calculating spectra)
1881    INTEGER(iwp) ::  target_id                   !< in atmosphere/ocean coupling: id of the ocean/atmosphere counterpart PE with whom the atmosphere/ocean PE exchanges data
1882    INTEGER(iwp) ::  tasks_per_node = -9999      !< MPI tasks per compute node
1883    INTEGER(iwp) ::  threads_per_task = 1        !< number of OPENMP threads per MPI task
1884    INTEGER(iwp) ::  type_x                      !< derived MPI datatype for 2-D ghost-point exchange - north / south
1885    INTEGER(iwp) ::  type_xy                     !< derived MPI datatype for 2-D ghost-point exchange - north / south
1886    INTEGER(iwp) ::  type_y                      !< derived MPI datatype for 2-D exchange in atmosphere-ocean coupler
1887
1888    INTEGER(iwp) ::  pdims(2) = 1  !< number of processors along x-y dimension
1889    INTEGER(iwp) ::  req(100)      !< MPI return variable indicating if send-receive operation is finished
1890
1891    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  hor_index_bounds               !< horizontal index bounds
1892    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  hor_index_bounds_previous_run  !< horizontal index bounds of previous run
1893
1894    LOGICAL ::  collective_wait = .FALSE.          !< switch to set an explicit MPI barrier in front of all collective MPI calls
1895
1896#if defined( __parallel )
1897    INTEGER(iwp) ::  ibuf(12)                 !< internal buffer for calculating MPI settings
1898    INTEGER(iwp) ::  pcoord(2)                !< PE coordinates along x and y
1899    INTEGER(iwp) ::  status(MPI_STATUS_SIZE)  !< MPI status variable used in various MPI calls
1900   
1901    INTEGER(iwp), DIMENSION(MPI_STATUS_SIZE,100) ::  wait_stat  !< MPI status variable used in various MPI calls
1902   
1903    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  ngp_xz      !< number of ghost points in xz-plane on different multigrid level
1904    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  ngp_xz_int  !< number of ghost points in xz-plane on different multigrid level
1905    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  ngp_yz      !< number of ghost points in yz-plane on different multigrid level
1906    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  ngp_yz_int  !< number of ghost points in yz-plane on different multigrid level
1907    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  type_x_int  !< derived MPI datatype for 2-D integer ghost-point exchange - north / south
1908    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  type_xz     !< derived MPI datatype for 3-D integer ghost-point exchange - north / south
1909    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  type_xz_int !< derived MPI datatype for 3-D integer ghost-point exchange - north / south
1910    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  type_y_int  !< derived MPI datatype for 2-D integer ghost-point exchange - left / right
1911    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  type_yz     !< derived MPI datatype for 3-D integer ghost-point exchange - left / right
1912    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  type_yz_int !< derived MPI datatype for 3-D integer ghost-point exchange - left / right
1913
1914    LOGICAL ::  left_border_pe  = .FALSE.  !< = .TRUE. if PE is on left border of computational domain
1915    LOGICAL ::  north_border_pe = .FALSE.  !< = .TRUE. if PE is on north border of computational domain
1916    LOGICAL ::  reorder = .TRUE.           !< switch to allow MPI the reorder of ranking (e.g. row-major or column-major)
1917    LOGICAL ::  right_border_pe = .FALSE.  !< = .TRUE. if PE is on right border of computational domain
1918    LOGICAL ::  south_border_pe = .FALSE.  !< = .TRUE. if PE is on south border of computational domain
1919
1920    LOGICAL, DIMENSION(2) ::  cyclic = (/ .TRUE. , .TRUE. /)  !< boundary conditions of the virtual PE grid
1921    LOGICAL, DIMENSION(2) ::  remain_dims                     !< internal array used to determine sub-topologies for transpositions
1922#endif
1923
1924    SAVE
1925
1926 END MODULE pegrid
1927
1928
1929!------------------------------------------------------------------------------!
1930! Description:
1931! ------------
1932!> Definition of variables which control PROFIL-output.
1933!------------------------------------------------------------------------------!
1934 MODULE profil_parameter
1935
1936    USE kinds
1937
1938    INTEGER(iwp), PARAMETER ::  crmax = 100  !< maximum number of coordinate systems for profile output
1939
1940    CHARACTER (LEN=20), DIMENSION(20) ::  cross_ts_profiles = &  !< time series to be plotted into one coordinate system, respectively
1941                           (/ ' E E*               ', ' dt                 ', &
1942                              ' u* w*              ', ' th*                ', &
1943                              ' umax vmax wmax     ', ' div_old div_new    ', &
1944                              ' z_i_wpt z_i_pt     ', ' w"pt"0 w"pt" wpt   ', &
1945                              ' pt(0) pt(zp)       ', ' splux spluy spluz  ', &
1946                              ' L                  ',                         &
1947                            ( '                    ', i9 = 1, 9 ) /)
1948
1949    CHARACTER (LEN=100), DIMENSION(crmax) ::  cross_profiles = &  !< quantities to be plotted into one coordinate system, respectively
1950                           (/ ' u v                           ', &
1951                              ' pt                            ', &
1952                              ' w"pt" w*pt* w*pt*BC wpt wptBC ', &
1953                              ' w"u" w*u* wu w"v" w*v* wv     ', &
1954                              ' km kh                         ', &
1955                              ' l                             ', &
1956                         ( '                               ', i9 = 1, 94 ) /)
1957
1958    INTEGER(iwp) ::  profile_columns = 2  !< number of coordinate systems on a profile plot per column
1959    INTEGER(iwp) ::  profile_rows = 3     !< number of coordinate systems on a profile plot per row
1960
1961    INTEGER(iwp) ::  dopr_index(300) = 0                !< index number of respective profile quantity
1962    INTEGER(iwp) ::  dopr_initial_index(300) = 0        !< index number of initial profiles to be output
1963               
1964    SAVE
1965
1966 END MODULE profil_parameter
1967
1968!------------------------------------------------------------------------------!
1969! Description:
1970! ------------
1971!> Definition of statistical quantities, e.g. global sums.
1972!------------------------------------------------------------------------------!
1973 MODULE statistics
1974
1975    USE kinds
1976
1977    CHARACTER (LEN=40) ::  region(0:9)  !< label for statistic region
1978 
1979    INTEGER(iwp) ::  pr_palm = 200          !< maximum number of output profiles
1980    INTEGER(iwp) ::  statistic_regions = 0  !< identifier for statistic regions
1981
1982    INTEGER(iwp) ::  u_max_ijk(3) = -1  !< index values (i,j,k) of location where u_max occurs
1983    INTEGER(iwp) ::  v_max_ijk(3) = -1  !< index values (i,j,k) of location where v_max occurs
1984    INTEGER(iwp) ::  w_max_ijk(3) = -1  !< index values (i,j,k) of location where w_max occurs
1985   
1986    LOGICAL ::  flow_statistics_called = .FALSE.  !< flag that tells other routines if flow statistics was executed
1987                                                  !< (after each timestep)
1988   
1989    REAL(wp) ::  u_max  !< maximum of absolute u-veloctiy in entire domain
1990    REAL(wp) ::  v_max  !< maximum of absolute v-veloctiy in entire domain
1991    REAL(wp) ::  w_max  !< maximum of absolute w-veloctiy in entire domain
1992   
1993    REAL(wp), DIMENSION(:), ALLOCATABLE ::  mean_surface_level_height  !< mean surface level height for the different statistic regions
1994    REAL(wp), DIMENSION(:), ALLOCATABLE ::  sums_divnew_l              !< subdomain sum (_l) of divergence after pressure
1995                                                                       !< solver call (new)
1996    REAL(wp), DIMENSION(:), ALLOCATABLE ::  sums_divold_l              !< subdomain sum (_l) of divergence before pressure
1997                                                                       !< solver call (old)
1998    REAL(wp), DIMENSION(:), ALLOCATABLE ::  weight_substep             !< weighting factor for substeps in timestepping
1999    REAL(wp), DIMENSION(:), ALLOCATABLE ::  weight_pres                !< substep weighting factor for pressure solver
2000   
2001    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums             !< global sum array for the various output quantities
2002    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wsts_bc_l   !< subdomain sum of sensible heat flux in Bott-Chlond scheme
2003    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  ts_value         !< timeseries output array for the various output quantities
2004    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wsus_ws_l   !< subdomain sum of vertical momentum flux w'u' (5th-order advection scheme only)
2005    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wsvs_ws_l   !< subdomain sum of vertical momentum flux w'v' (5th-order advection scheme only)
2006    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_us2_ws_l    !< subdomain sum of horizontal momentum flux u'u' (5th-order advection scheme only)
2007    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_vs2_ws_l    !< subdomain sum of horizontal momentum flux v'v' (5th-order advection scheme only)
2008    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_ws2_ws_l    !< subdomain sum of vertical momentum flux w'w' (5th-order advection scheme only)
2009    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wsncs_ws_l  !< subdomain sum of vertical clouddrop-number concentration flux w'nc' (5th-order advection scheme only)
2010    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wsnrs_ws_l  !< subdomain sum of vertical raindrop-number concentration flux w'nr' (5th-order advection scheme only)
2011    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wspts_ws_l  !< subdomain sum of vertical sensible heat flux w'pt' (5th-order advection scheme only)
2012    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wsqs_ws_l   !< subdomain sum of vertical latent heat flux w'q' (5th-order advection scheme only)
2013    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wsqcs_ws_l  !< subdomain sum of vertical cloudwater flux w'qc' (5th-order advection scheme only)
2014    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wsqrs_ws_l  !< subdomain sum of vertical rainwater flux w'qr' (5th-order advection scheme only)
2015    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wssas_ws_l  !< subdomain sum of vertical salinity flux w'sa' (5th-order advection scheme only)
2016    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_wsss_ws_l   !< subdomain sum of vertical passive scalar flux w's' (5th-order advection scheme only)
2017    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  sums_ls_l        !< subdomain sum of large scale forcing and nudging tendencies
2018                                             
2019    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  hom_sum             !< sum array for horizontal mean
2020    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  rmask               !< REAL flag array (0.0 or 1.0) for statistic regions
2021    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  sums_l              !< subdomain sum (_l) gathered for various quantities
2022    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  sums_l_l            !< subdomain sum (_l) of mixing length from diffusivities
2023
2024    REAL(wp), DIMENSION(:,:,:,:), ALLOCATABLE ::  hom  !< horizontal mean of various quantities (profiles/timeseries)
2025
2026    SAVE
2027
2028 END MODULE statistics
2029
2030
2031
2032!------------------------------------------------------------------------------!
2033! Description:
2034! ------------
2035!> Definition of indices for transposed arrays.
2036!------------------------------------------------------------------------------!
2037 MODULE transpose_indices
2038
2039    USE kinds
2040
2041    INTEGER(iwp) ::  nxl_y   !< internal index bound for transpositions
2042    INTEGER(iwp) ::  nxl_yd  !< internal index bound for transpositions
2043    INTEGER(iwp) ::  nxl_z   !< internal index bound for transpositions
2044    INTEGER(iwp) ::  nxr_y   !< internal index bound for transpositions
2045    INTEGER(iwp) ::  nxr_yd  !< internal index bound for transpositions
2046    INTEGER(iwp) ::  nxr_z   !< internal index bound for transpositions
2047    INTEGER(iwp) ::  nyn_x   !< internal index bound for transpositions
2048    INTEGER(iwp) ::  nyn_z   !< internal index bound for transpositions
2049    INTEGER(iwp) ::  nys_x   !< internal index bound for transpositions
2050    INTEGER(iwp) ::  nys_z   !< internal index bound for transpositions
2051    INTEGER(iwp) ::  nzb_x   !< internal index bound for transpositions
2052    INTEGER(iwp) ::  nzb_y   !< internal index bound for transpositions
2053    INTEGER(iwp) ::  nzb_yd  !< internal index bound for transpositions
2054    INTEGER(iwp) ::  nzt_x   !< internal index bound for transpositions
2055    INTEGER(iwp) ::  nzt_y   !< internal index bound for transpositions
2056    INTEGER(iwp) ::  nzt_yd  !< internal index bound for transpositions
2057               
2058    SAVE
2059
2060 END MODULE transpose_indices
Note: See TracBrowser for help on using the repository browser.