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

Last change on this file since 3655 was 3648, checked in by suehring, 3 years ago

Rename surface_output_mod into surface_data_output_mod, same with all corresponding subroutines

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