source: palm/trunk/SOURCE/init_3d_model.f90 @ 4177

Last change on this file since 4177 was 4168, checked in by suehring, 5 years ago

Replace get_topography_top_index functions by pre-calculated arrays in order to save computational resources

  • Property svn:keywords set to Id
  • Property svn:mergeinfo set to False
    /palm/branches/chemistry/SOURCE/init_3d_model.f902047-3190,​3218-3297
    /palm/branches/forwind/SOURCE/init_3d_model.f901564-1913
    /palm/branches/mosaik_M2/init_3d_model.f902360-3471
    /palm/branches/palm4u/SOURCE/init_3d_model.f902540-2692
    /palm/branches/rans/SOURCE/init_3d_model.f902078-3128
    /palm/branches/resler/SOURCE/init_3d_model.f902023-3605
    /palm/branches/salsa/SOURCE/init_3d_model.f902503-3581
File size: 96.4 KB
Line 
1!> @file init_3d_model.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: init_3d_model.f90 4168 2019-08-16 13:50:17Z gronemeier $
27! Replace function get_topography_top_index by topo_top_ind
28!
29! 4151 2019-08-09 08:24:30Z suehring
30! Add netcdf directive around input calls (fix for last commit)
31!
32! 4150 2019-08-08 20:00:47Z suehring
33! Input of additional surface variables independent on land- or urban-surface
34! model
35!
36! 4131 2019-08-02 11:06:18Z monakurppa
37! Allocate sums and sums_l to allow profile output for salsa variables.
38!
39! 4130 2019-08-01 13:04:13Z suehring
40! Effectively reduce 3D initialization to 1D initial profiles. This is because
41! 3D initialization produces structures in the w-component that are correlated
42! with the processor grid for some unknown reason 
43!
44! 4090 2019-07-11 15:06:47Z Giersch
45! Unused variables removed
46!
47! 4088 2019-07-11 13:57:56Z Giersch
48! Pressure and density profile calculations revised using basic functions
49!
50! 4048 2019-06-21 21:00:21Z knoop
51! Further modularization of particle code components
52!
53! 4017 2019-06-06 12:16:46Z schwenkel
54! Convert most location messages to debug messages to reduce output in
55! job logfile to a minimum
56!
57!
58! unused variable removed
59!
60! 3937 2019-04-29 15:09:07Z suehring
61! Move initialization of synthetic turbulence generator behind initialization
62! of offline nesting. Remove call for stg_adjust, as this is now already done
63! in stg_init.
64!
65! 3900 2019-04-16 15:17:43Z suehring
66! Fix problem with LOD = 2 initialization
67!
68! 3885 2019-04-11 11:29:34Z kanani
69! Changes related to global restructuring of location messages and introduction
70! of additional debug messages
71!
72! 3849 2019-04-01 16:35:16Z knoop
73! Move initialization of rmask before initializing user_init_arrays
74!
75! 3711 2019-01-31 13:44:26Z knoop
76! Introduced module_interface_init_checks for post-init checks in modules
77!
78! 3700 2019-01-26 17:03:42Z knoop
79! Some interface calls moved to module_interface + cleanup
80!
81! 3648 2019-01-02 16:35:46Z suehring
82! Rename subroutines for surface-data output
83!
84! 3636 2018-12-19 13:48:34Z raasch
85! nopointer option removed
86!
87! 3609 2018-12-07 13:37:59Z suehring
88! Furhter correction in initialization of surfaces in cyclic-fill case
89!
90! 3608 2018-12-07 12:59:57Z suehring
91! Bugfix in initialization of surfaces in cyclic-fill case
92!
93! 3589 2018-11-30 15:09:51Z suehring
94! Move the control parameter "salsa" from salsa_mod to control_parameters
95! (M. Kurppa)
96!
97! 3582 2018-11-29 19:16:36Z suehring
98! Bugfix in initialization of turbulence generator
99!
100! 3569 2018-11-27 17:03:40Z kanani
101! dom_dwd_user, Schrempf:
102! Remove uv exposure model code, this is now part of biometeorology_mod,
103! remove bio_init_arrays.
104!
105! 3547 2018-11-21 13:21:24Z suehring
106! variables documented
107!
108! 3525 2018-11-14 16:06:14Z kanani
109! Changes related to clean-up of biometeorology (dom_dwd_user)
110!
111! 3524 2018-11-14 13:36:44Z raasch
112! preprocessor directive added to avoid the compiler to complain about unused
113! variable
114!
115! 3473 2018-10-30 20:50:15Z suehring
116! Add virtual measurement module
117!
118! 3472 2018-10-30 20:43:50Z suehring
119! Add indoor model (kanani, srissman, tlang)
120!
121! 3467 2018-10-30 19:05:21Z suehring
122! Implementation of a new aerosol module salsa.
123!
124! 3458 2018-10-30 14:51:23Z kanani
125! from chemistry branch r3443, basit:
126! bug fixed in sums and sums_l for chemistry profile output
127!
128! 3448 2018-10-29 18:14:31Z kanani
129! Add biometeorology
130!
131! 3421 2018-10-24 18:39:32Z gronemeier
132! Initialize surface data output
133!
134! 3415 2018-10-24 11:57:50Z suehring
135! Set bottom boundary condition for geostrophic wind components in inifor
136! initialization
137!
138! 3347 2018-10-15 14:21:08Z suehring
139! - Separate offline nesting from large_scale_nudging_mod
140! - Improve the synthetic turbulence generator
141!
142! 3298 2018-10-02 12:21:11Z kanani
143! Minor formatting (kanani)
144! Added CALL to the chem_emissions module (Russo)
145!
146! 3294 2018-10-01 02:37:10Z raasch
147! allocate and set stokes drift velocity profiles
148!
149! 3298 2018-10-02 12:21:11Z kanani
150! Minor formatting (kanani)
151! Added CALL to the chem_emissions module (Russo)
152!
153! 3294 2018-10-01 02:37:10Z raasch
154! changes concerning modularization of ocean option
155!
156! 3289 2018-09-28 10:23:58Z suehring
157! Introduce module parameter for number of inflow profiles
158!
159! 3288 2018-09-28 10:23:08Z suehring
160! Modularization of all bulk cloud physics code components
161!
162! 3241 2018-09-12 15:02:00Z raasch
163! unused variables removed
164!
165! 3234 2018-09-07 13:46:58Z schwenkel
166! The increase of dots_num in case of radiation or land surface model must
167! be done before user_init is called
168!
169! 3183 2018-07-27 14:25:55Z suehring
170! Revise Inifor initialization
171!
172! 3182 2018-07-27 13:36:03Z suehring
173! Added multi agent system
174!
175! 3129 2018-07-16 07:45:13Z gronemeier
176! Move initialization call for nudging and 1D/3D offline nesting.
177! Revise initialization with inifor data.
178!
179! 3045 2018-05-28 07:55:41Z Giersch
180! Error messages revised
181!
182! 3045 2018-05-28 07:55:41Z Giersch
183! Error messages revised
184!
185! 3042 2018-05-25 10:44:37Z schwenkel
186! Changed the name specific humidity to mixing ratio
187!
188! 3040 2018-05-25 10:22:08Z schwenkel
189! Add option to initialize warm air bubble close to surface
190!
191! 3014 2018-05-09 08:42:38Z maronga
192! Bugfix: initialization of ts_value missing
193!
194! 3011 2018-05-07 14:38:42Z schwenkel
195! removed redundant if statement
196!
197! 3004 2018-04-27 12:33:25Z Giersch
198! precipitation_rate removed
199!
200! 2995 2018-04-19 12:13:16Z Giersch
201! CALL radiation_control is not necessary during initialization because
202! calculation of radiative fluxes at model start is done in radiation_init
203! in any case
204!
205! 2977 2018-04-17 10:27:57Z kanani
206! Implement changes from branch radiation (r2948-2971) with minor modifications
207! (moh.hefny):
208! - set radiation_interactions according to the existence of urban/land vertical
209!   surfaces and trees to activiate RTM
210! - set average_radiation to TRUE if RTM is activiated
211!
212! 2938 2018-03-27 15:52:42Z suehring
213! - Revise Inifor initialization for geostrophic wind components
214! - Initialize synthetic turbulence generator in case of Inifor initialization 
215!
216! 2936 2018-03-27 14:49:27Z suehring
217! Synchronize parent and child models after initialization.
218! Remove obsolete masking of topography grid points for Runge-Kutta weighted
219! tendency arrays.
220!
221! 2920 2018-03-22 11:22:01Z kanani
222! Add call for precalculating apparent solar positions (moh.hefny)
223!
224! 2906 2018-03-19 08:56:40Z Giersch
225! The variables read/write_svf_on_init have been removed. Instead ENVIRONMENT
226! variables read/write_svf have been introduced. Location_message has been
227! added.
228!
229! 2894 2018-03-15 09:17:58Z Giersch
230! Renamed routines with respect to reading restart data, file 13 is closed in
231! rrd_read_parts_of_global now
232!
233! 2867 2018-03-09 09:40:23Z suehring
234! Further bugfix concerning call of user_init.
235!
236! 2864 2018-03-08 11:57:45Z suehring
237! Bugfix, move call of user_init in front of initialization of grid-point
238! arrays
239!
240! 2817 2018-02-19 16:32:21Z knoop
241! Preliminary gust module interface implemented
242!
243! 2776 2018-01-31 10:44:42Z Giersch
244! Variable use_synthetic_turbulence_generator has been abbreviated
245!
246! 2766 2018-01-22 17:17:47Z kanani
247! Removed preprocessor directive __chem
248!
249! 2758 2018-01-17 12:55:21Z suehring
250! In case of spinup of land- and urban-surface model, do not mask wind velocity
251! at first computational grid level
252!
253! 2746 2018-01-15 12:06:04Z suehring
254! Move flag plant canopy to modules
255!
256! 2718 2018-01-02 08:49:38Z maronga
257! Corrected "Former revisions" section
258!
259! 2705 2017-12-18 11:26:23Z maronga
260! Bugfix for reading initial profiles from ls/nuding file
261!
262! 2701 2017-12-15 15:40:50Z suehring
263! Changes from last commit documented
264!
265! 2700 2017-12-15 14:12:35Z suehring
266! Bugfix, missing initialization of surface attributes in case of
267! inifor-initialization branch
268!
269! 2698 2017-12-14 18:46:24Z suehring
270! Bugfix in get_topography_top_index
271!
272! 2696 2017-12-14 17:12:51Z kanani
273! Change in file header (GPL part)
274! Implementation of uv exposure model (FK)
275! Moved initialisation of diss, e, kh, km to turbulence_closure_mod (TG)
276! Added chemical emissions (FK)
277! Initialize masking arrays and number-of-grid-points arrays before initialize
278! LSM, USM and radiation module
279! Initialization with inifor (MS)
280!
281! 2618 2017-11-16 15:37:30Z suehring
282! Reorder calls of init_surfaces.
283!
284! 2564 2017-10-19 15:56:56Z Giersch
285! Variable wind_turbine was added to control_parameters.
286!
287! 2550 2017-10-16 17:12:01Z boeske
288! Modifications to cyclic fill method and turbulence recycling method in case of
289! complex terrain simulations
290!
291! 2513 2017-10-04 09:24:39Z kanani
292! Bugfix in storing initial scalar profile (wrong index)
293!
294! 2350 2017-08-15 11:48:26Z kanani
295! Bugfix in nopointer version
296!
297! 2339 2017-08-07 13:55:26Z gronemeier
298! corrected timestamp in header
299!
300! 2338 2017-08-07 12:15:38Z gronemeier
301! Modularize 1D model
302!
303! 2329 2017-08-03 14:24:56Z knoop
304! Removed temporary bugfix (r2327) as bug is properly resolved by this revision
305!
306! 2327 2017-08-02 07:40:57Z maronga
307! Temporary bugfix
308!
309! 2320 2017-07-21 12:47:43Z suehring
310! Modularize large-scale forcing and nudging
311!
312! 2292 2017-06-20 09:51:42Z schwenkel
313! Implementation of new microphysic scheme: cloud_scheme = 'morrison'
314! includes two more prognostic equations for cloud drop concentration (nc) 
315! and cloud water content (qc).
316!
317! 2277 2017-06-12 10:47:51Z kanani
318! Removed unused variable sums_up_fraction_l
319!
320! 2270 2017-06-09 12:18:47Z maronga
321! dots_num must be increased when LSM and/or radiation is used
322!
323! 2259 2017-06-08 09:09:11Z gronemeier
324! Implemented synthetic turbulence generator
325!
326! 2252 2017-06-07 09:35:37Z knoop
327! rho_air now depending on surface_pressure even in Boussinesq mode
328!
329! 2233 2017-05-30 18:08:54Z suehring
330!
331! 2232 2017-05-30 17:47:52Z suehring
332! Adjustments to new topography and surface concept:
333!   - Modify passed parameters for disturb_field
334!   - Topography representation via flags
335!   - Remove unused arrays.
336!   - Move initialization of surface-related quantities to surface_mod
337!
338! 2172 2017-03-08 15:55:25Z knoop
339! Bugfix: moved parallel random generator initialization into its module
340!
341! 2118 2017-01-17 16:38:49Z raasch
342! OpenACC directives removed
343!
344! 2037 2016-10-26 11:15:40Z knoop
345! Anelastic approximation implemented
346!
347! 2031 2016-10-21 15:11:58Z knoop
348! renamed variable rho to rho_ocean
349!
350! 2011 2016-09-19 17:29:57Z kanani
351! Flag urban_surface is now defined in module control_parameters.
352!
353! 2007 2016-08-24 15:47:17Z kanani
354! Added support for urban surface model,
355! adjusted location_message in case of plant_canopy
356!
357! 2000 2016-08-20 18:09:15Z knoop
358! Forced header and separation lines into 80 columns
359!
360! 1992 2016-08-12 15:14:59Z suehring
361! Initializaton of scalarflux at model top
362! Bugfixes in initialization of surface and top salinity flux, top scalar and
363! humidity fluxes
364!
365! 1960 2016-07-12 16:34:24Z suehring
366! Separate humidity and passive scalar
367! Increase dimension for mean_inflow_profiles
368! Remove inadvertent write-statement
369! Bugfix, large-scale forcing is still not implemented for passive scalars
370!
371! 1957 2016-07-07 10:43:48Z suehring
372! flight module added
373!
374! 1920 2016-05-30 10:50:15Z suehring
375! Initialize us with very small number to avoid segmentation fault during
376! calculation of Obukhov length
377!
378! 1918 2016-05-27 14:35:57Z raasch
379! intermediate_timestep_count is set 0 instead 1 for first call of pres,
380! bugfix: initialization of local sum arrays are moved to the beginning of the
381!         routine because otherwise results from pres are overwritten
382!
383! 1914 2016-05-26 14:44:07Z witha
384! Added initialization of the wind turbine model
385!
386! 1878 2016-04-19 12:30:36Z hellstea
387! The zeroth element of weight_pres removed as unnecessary
388!
389! 1849 2016-04-08 11:33:18Z hoffmann
390! Adapted for modularization of microphysics.
391! precipitation_amount, precipitation_rate, prr moved to arrays_3d.
392! Initialization of nc_1d, nr_1d, pt_1d, qc_1d, qr_1d, q_1d moved to
393! bcm_init.
394!
395! 1845 2016-04-08 08:29:13Z raasch
396! nzb_2d replaced by nzb_u|v_inner
397!
398! 1833 2016-04-07 14:23:03Z raasch
399! initialization of spectra quantities moved to spectra_mod
400!
401! 1831 2016-04-07 13:15:51Z hoffmann
402! turbulence renamed collision_turbulence
403!
404! 1826 2016-04-07 12:01:39Z maronga
405! Renamed radiation calls.
406! Renamed canopy model calls.
407!
408! 1822 2016-04-07 07:49:42Z hoffmann
409! icloud_scheme replaced by microphysics_*
410!
411! 1817 2016-04-06 15:44:20Z maronga
412! Renamed lsm calls.
413!
414! 1815 2016-04-06 13:49:59Z raasch
415! zero-settings for velocities inside topography re-activated (was deactivated
416! in r1762)
417!
418! 1788 2016-03-10 11:01:04Z maronga
419! Added z0q.
420! Syntax layout improved.
421!
422! 1783 2016-03-06 18:36:17Z raasch
423! netcdf module name changed + related changes
424!
425! 1764 2016-02-28 12:45:19Z raasch
426! bugfix: increase size of volume_flow_area_l and volume_flow_initial_l by 1
427!
428! 1762 2016-02-25 12:31:13Z hellstea
429! Introduction of nested domain feature
430!
431! 1738 2015-12-18 13:56:05Z raasch
432! calculate mean surface level height for each statistic region
433!
434! 1734 2015-12-02 12:17:12Z raasch
435! no initial disturbances in case that the disturbance energy limit has been
436! set zero
437!
438! 1707 2015-11-02 15:24:52Z maronga
439! Bugfix: transfer of Richardson number from 1D model to Obukhov length caused
440! devision by zero in neutral stratification
441!
442! 1691 2015-10-26 16:17:44Z maronga
443! Call to init_surface_layer added. rif is replaced by ol and zeta.
444!
445! 1682 2015-10-07 23:56:08Z knoop
446! Code annotations made doxygen readable
447!
448! 1615 2015-07-08 18:49:19Z suehring
449! Enable turbulent inflow for passive_scalar and humidity
450!
451! 1585 2015-04-30 07:05:52Z maronga
452! Initialization of radiation code is now done after LSM initializtion
453!
454! 1575 2015-03-27 09:56:27Z raasch
455! adjustments for psolver-queries
456!
457! 1551 2015-03-03 14:18:16Z maronga
458! Allocation of land surface arrays is now done in the subroutine lsm_init_arrays,
459! which is part of land_surface_model.
460!
461! 1507 2014-12-10 12:14:18Z suehring
462! Bugfix: set horizontal velocity components to zero inside topography
463!
464! 1496 2014-12-02 17:25:50Z maronga
465! Added initialization of the land surface and radiation schemes
466!
467! 1484 2014-10-21 10:53:05Z kanani
468! Changes due to new module structure of the plant canopy model:
469! canopy-related initialization (e.g. lad and canopy_heat_flux) moved to new
470! subroutine init_plant_canopy within the module plant_canopy_model_mod,
471! call of subroutine init_plant_canopy added.
472!
473! 1431 2014-07-15 14:47:17Z suehring
474! var_d added, in order to normalize spectra.
475!
476! 1429 2014-07-15 12:53:45Z knoop
477! Ensemble run capability added to parallel random number generator
478!
479! 1411 2014-05-16 18:01:51Z suehring
480! Initial horizontal velocity profiles were not set to zero at the first vertical
481! grid level in case of non-cyclic lateral boundary conditions.
482!
483! 1406 2014-05-16 13:47:01Z raasch
484! bugfix: setting of initial velocities at k=1 to zero not in case of a
485! no-slip boundary condition for uv
486!
487! 1402 2014-05-09 14:25:13Z raasch
488! location messages modified
489!
490! 1400 2014-05-09 14:03:54Z knoop
491! Parallel random number generator added
492!
493! 1384 2014-05-02 14:31:06Z raasch
494! location messages added
495!
496! 1361 2014-04-16 15:17:48Z hoffmann
497! tend_* removed
498! Bugfix: w_subs is not allocated anymore if it is already allocated
499!
500! 1359 2014-04-11 17:15:14Z hoffmann
501! module lpm_init_mod added to use statements, because lpm_init has become a
502! module
503!
504! 1353 2014-04-08 15:21:23Z heinze
505! REAL constants provided with KIND-attribute
506!
507! 1340 2014-03-25 19:45:13Z kanani
508! REAL constants defined as wp-kind
509!
510! 1322 2014-03-20 16:38:49Z raasch
511! REAL constants defined as wp-kind
512! module interfaces removed
513!
514! 1320 2014-03-20 08:40:49Z raasch
515! ONLY-attribute added to USE-statements,
516! kind-parameters added to all INTEGER and REAL declaration statements,
517! kinds are defined in new module kinds,
518! revision history before 2012 removed,
519! comment fields (!:) to be used for variable explanations added to
520! all variable declaration statements
521!
522! 1316 2014-03-17 07:44:59Z heinze
523! Bugfix: allocation of w_subs
524!
525! 1299 2014-03-06 13:15:21Z heinze
526! Allocate w_subs due to extension of large scale subsidence in combination
527! with large scale forcing data (LSF_DATA)
528!
529! 1241 2013-10-30 11:36:58Z heinze
530! Overwrite initial profiles in case of nudging
531! Inititialize shf and qsws in case of large_scale_forcing
532!
533! 1221 2013-09-10 08:59:13Z raasch
534! +rflags_s_inner in copyin statement, use copyin for most arrays instead of
535! copy
536!
537! 1212 2013-08-15 08:46:27Z raasch
538! array tri is allocated and included in data copy statement
539!
540! 1195 2013-07-01 12:27:57Z heinze
541! Bugfix: move allocation of ref_state to parin.f90 and read_var_list.f90
542!
543! 1179 2013-06-14 05:57:58Z raasch
544! allocate and set ref_state to be used in buoyancy terms
545!
546! 1171 2013-05-30 11:27:45Z raasch
547! diss array is allocated with full size if accelerator boards are used
548!
549! 1159 2013-05-21 11:58:22Z fricke
550! -bc_lr_dirneu, bc_lr_neudir, bc_ns_dirneu, bc_ns_neudir
551!
552! 1153 2013-05-10 14:33:08Z raasch
553! diss array is allocated with dummy elements even if it is not needed
554! (required by PGI 13.4 / CUDA 5.0)
555!
556! 1115 2013-03-26 18:16:16Z hoffmann
557! unused variables removed
558!
559! 1113 2013-03-10 02:48:14Z raasch
560! openACC directive modified
561!
562! 1111 2013-03-08 23:54:10Z raasch
563! openACC directives added for pres
564! array diss allocated only if required
565!
566! 1092 2013-02-02 11:24:22Z raasch
567! unused variables removed
568!
569! 1065 2012-11-22 17:42:36Z hoffmann
570! allocation of diss (dissipation rate) in case of turbulence = .TRUE. added
571!
572! 1053 2012-11-13 17:11:03Z hoffmann
573! allocation and initialisation of necessary data arrays for the two-moment
574! cloud physics scheme the two new prognostic equations (nr, qr):
575! +dr, lambda_r, mu_r, sed_*, xr, *s, *sws, *swst, *, *_p, t*_m, *_1, *_2, *_3,
576! +tend_*, prr
577!
578! 1036 2012-10-22 13:43:42Z raasch
579! code put under GPL (PALM 3.9)
580!
581! 1032 2012-10-21 13:03:21Z letzel
582! save memory by not allocating pt_2 in case of neutral = .T.
583!
584! 1025 2012-10-07 16:04:41Z letzel
585! bugfix: swap indices of mask for ghost boundaries
586!
587! 1015 2012-09-27 09:23:24Z raasch
588! mask is set to zero for ghost boundaries
589!
590! 1010 2012-09-20 07:59:54Z raasch
591! cpp switch __nopointer added for pointer free version
592!
593! 1003 2012-09-14 14:35:53Z raasch
594! nxra,nyna, nzta replaced ny nxr, nyn, nzt
595!
596! 1001 2012-09-13 14:08:46Z raasch
597! all actions concerning leapfrog scheme removed
598!
599! 996 2012-09-07 10:41:47Z raasch
600! little reformatting
601!
602! 978 2012-08-09 08:28:32Z fricke
603! outflow damping layer removed
604! roughness length for scalar quantites z0h added
605! damping zone for the potential temperatur in case of non-cyclic lateral
606! boundaries added
607! initialization of ptdf_x, ptdf_y
608! initialization of c_u_m, c_u_m_l, c_v_m, c_v_m_l, c_w_m, c_w_m_l
609!
610! 849 2012-03-15 10:35:09Z raasch
611! init_particles renamed lpm_init
612!
613! 825 2012-02-19 03:03:44Z raasch
614! wang_collision_kernel renamed wang_kernel
615!
616! Revision 1.1  1998/03/09 16:22:22  raasch
617! Initial revision
618!
619!
620! Description:
621! ------------
622!> Allocation of arrays and initialization of the 3D model via
623!> a) pre-run the 1D model
624!> or
625!> b) pre-set constant linear profiles
626!> or
627!> c) read values of a previous run
628!------------------------------------------------------------------------------!
629 SUBROUTINE init_3d_model
630
631
632    USE advec_ws
633
634    USE arrays_3d
635
636    USE basic_constants_and_equations_mod,                                     &
637        ONLY:  c_p, g, l_v, pi, exner_function, exner_function_invers,         &
638               ideal_gas_law_rho, ideal_gas_law_rho_pt, barometric_formula
639
640    USE bulk_cloud_model_mod,                                                  &
641        ONLY:  bulk_cloud_model
642
643    USE chem_modules,                                                          &
644        ONLY:  max_pr_cs ! ToDo: this dependency needs to be removed cause it is ugly #new_dom
645
646    USE control_parameters
647
648    USE grid_variables,                                                        &
649        ONLY:  dx, dy, ddx2_mg, ddy2_mg
650
651    USE indices
652
653    USE kinds
654 
655    USE lsf_nudging_mod,                                                       &
656        ONLY:  ls_forcing_surf
657
658    USE model_1d_mod,                                                          &
659        ONLY:  init_1d_model, l1d, u1d, v1d
660
661    USE module_interface,                                                      &
662        ONLY:  module_interface_init_arrays,                                   &
663               module_interface_init,                                          &
664               module_interface_init_checks
665
666    USE multi_agent_system_mod,                                                &
667        ONLY:  agents_active, mas_init
668
669    USE netcdf_interface,                                                      &
670        ONLY:  dots_max
671
672    USE netcdf_data_input_mod,                                                 &
673        ONLY:  char_fill,                                                      &
674               check_existence,                                                &
675               close_input_file,                                               &
676               get_attribute,                                                  &
677               get_variable,                                                   &
678               init_3d,                                                        &
679               input_pids_static,                                              &
680               inquire_num_variables,                                          &
681               inquire_variable_names,                                         &
682               input_file_static,                                              &
683               netcdf_data_input_init_3d,                                      &
684               open_read_file,                                                 &
685               real_2d
686               
687    USE nesting_offl_mod,                                                      &
688        ONLY:  nesting_offl_init
689
690    USE pegrid
691
692#if defined( __parallel )
693    USE pmc_interface,                                                         &
694        ONLY:  nested_run
695#endif
696
697    USE random_function_mod 
698
699    USE random_generator_parallel,                                             &
700        ONLY:  init_parallel_random_generator
701
702    USE read_restart_data_mod,                                                 &
703        ONLY:  rrd_read_parts_of_global, rrd_local
704
705    USE statistics,                                                            &
706        ONLY:  hom, hom_sum, mean_surface_level_height, pr_palm, rmask,        &
707               statistic_regions, sums, sums_divnew_l, sums_divold_l, sums_l,  &
708               sums_l_l, sums_wsts_bc_l, ts_value,                             &
709               weight_pres, weight_substep
710
711    USE synthetic_turbulence_generator_mod,                                    &
712        ONLY:  stg_init, use_syn_turb_gen
713
714    USE surface_layer_fluxes_mod,                                              &
715        ONLY:  init_surface_layer_fluxes
716
717    USE surface_mod,                                                           &
718        ONLY :  init_single_surface_properties,                                &
719                init_surface_arrays,                                           &
720                init_surfaces,                                                 &
721                surf_def_h,                                                    &
722                surf_def_v,                                                    &
723                surf_lsm_h,                                                    &
724                surf_usm_h
725
726#if defined( _OPENACC )
727    USE surface_mod,                                                           &
728        ONLY :  bc_h
729#endif
730
731    USE surface_data_output_mod,                                               &
732        ONLY:  surface_data_output_init
733
734    USE transpose_indices
735
736    IMPLICIT NONE
737
738    CHARACTER(LEN=50), DIMENSION(:), ALLOCATABLE ::  vars_pids_static  !< variable names in static input file
739   
740    INTEGER(iwp) ::  i                    !< grid index in x direction
741    INTEGER(iwp) ::  ind_array(1)         !< dummy used to determine start index for external pressure forcing
742    INTEGER(iwp) ::  j                    !< grid index in y direction
743    INTEGER(iwp) ::  k                    !< grid index in z direction
744    INTEGER(iwp) ::  k_surf               !< surface level index
745    INTEGER(iwp) ::  l                    !< running index over surface orientation   
746    INTEGER(iwp) ::  m                    !< index of surface element in surface data type   
747    INTEGER(iwp) ::  num_vars_pids_static !< number of variables in static input file
748    INTEGER(iwp) ::  nz_u_shift           !< topography-top index on u-grid, used to vertically shift initial profiles
749    INTEGER(iwp) ::  nz_v_shift           !< topography-top index on v-grid, used to vertically shift initial profiles
750    INTEGER(iwp) ::  nz_w_shift           !< topography-top index on w-grid, used to vertically shift initial profiles
751    INTEGER(iwp) ::  nz_s_shift           !< topography-top index on scalar-grid, used to vertically shift initial profiles
752    INTEGER(iwp) ::  nz_u_shift_l         !< topography-top index on u-grid, used to vertically shift initial profiles
753    INTEGER(iwp) ::  nz_v_shift_l         !< topography-top index on v-grid, used to vertically shift initial profiles
754    INTEGER(iwp) ::  nz_w_shift_l         !< topography-top index on w-grid, used to vertically shift initial profiles
755    INTEGER(iwp) ::  nz_s_shift_l         !< topography-top index on scalar-grid, used to vertically shift initial profiles
756    INTEGER(iwp) ::  nzt_l                !< index of top PE boundary for multigrid level
757    INTEGER(iwp) ::  pids_static_id       !< file id for static input file
758    INTEGER(iwp) ::  sr                   !< index of statistic region
759
760    INTEGER(iwp), DIMENSION(:), ALLOCATABLE   ::  ngp_2dh_l  !< toal number of horizontal grid points in statistical region on subdomain
761
762    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  ngp_2dh_outer_l    !< number of horizontal non-wall bounded grid points on subdomain
763    INTEGER(iwp), DIMENSION(:,:), ALLOCATABLE ::  ngp_2dh_s_inner_l  !< number of horizontal non-topography grid points on subdomain
764
765
766   
767    REAL(wp), DIMENSION(:), ALLOCATABLE ::  init_l        !< dummy array used for averaging 3D data to obtain inital profiles
768    REAL(wp), DIMENSION(:), ALLOCATABLE ::  p_hydrostatic !< hydrostatic pressure
769
770    REAL(wp) ::  dx_l !< grid spacing along x on different multigrid level
771    REAL(wp) ::  dy_l !< grid spacing along y on different multigrid level
772
773    REAL(wp), DIMENSION(1:3) ::  volume_flow_area_l     !< area of lateral and top model domain surface on local subdomain
774    REAL(wp), DIMENSION(1:3) ::  volume_flow_initial_l  !< initial volume flow into model domain
775
776    REAL(wp), DIMENSION(:), ALLOCATABLE ::  mean_surface_level_height_l !< mean surface level height on subdomain
777    REAL(wp), DIMENSION(:), ALLOCATABLE ::  ngp_3d_inner_l    !< total number of non-topography grid points on subdomain
778    REAL(wp), DIMENSION(:), ALLOCATABLE ::  ngp_3d_inner_tmp  !< total number of non-topography grid points
779
780    TYPE(real_2d) ::  tmp_2d !< temporary variable to input additional surface-data from static file
781   
782    CALL location_message( 'model initialization', 'start' )
783
784    IF ( debug_output )  CALL debug_message( 'allocating arrays', 'start' )
785!
786!-- Allocate arrays
787    ALLOCATE( mean_surface_level_height(0:statistic_regions),                  &
788              mean_surface_level_height_l(0:statistic_regions),                &
789              ngp_2dh(0:statistic_regions), ngp_2dh_l(0:statistic_regions),    &
790              ngp_3d(0:statistic_regions),                                     &
791              ngp_3d_inner(0:statistic_regions),                               &
792              ngp_3d_inner_l(0:statistic_regions),                             &
793              ngp_3d_inner_tmp(0:statistic_regions),                           &
794              sums_divnew_l(0:statistic_regions),                              &
795              sums_divold_l(0:statistic_regions) )
796    ALLOCATE( dp_smooth_factor(nzb:nzt), rdf(nzb+1:nzt), rdf_sc(nzb+1:nzt) )
797    ALLOCATE( ngp_2dh_outer(nzb:nzt+1,0:statistic_regions),                    &
798              ngp_2dh_outer_l(nzb:nzt+1,0:statistic_regions),                  &
799              ngp_2dh_s_inner(nzb:nzt+1,0:statistic_regions),                  &
800              ngp_2dh_s_inner_l(nzb:nzt+1,0:statistic_regions),                &
801              rmask(nysg:nyng,nxlg:nxrg,0:statistic_regions),                  &
802              sums(nzb:nzt+1,pr_palm+max_pr_user+max_pr_cs+max_pr_salsa),      &
803              sums_l(nzb:nzt+1,pr_palm+max_pr_user+max_pr_cs+max_pr_salsa,0:threads_per_task-1),   &
804              sums_l_l(nzb:nzt+1,0:statistic_regions,0:threads_per_task-1),    &
805              sums_wsts_bc_l(nzb:nzt+1,0:statistic_regions) )
806    ALLOCATE( ts_value(dots_max,0:statistic_regions) )
807    ALLOCATE( ptdf_x(nxlg:nxrg), ptdf_y(nysg:nyng) )
808
809    ALLOCATE( d(nzb+1:nzt,nys:nyn,nxl:nxr),                                    &
810              p(nzb:nzt+1,nysg:nyng,nxlg:nxrg),                                &
811              tend(nzb:nzt+1,nysg:nyng,nxlg:nxrg) )
812
813    ALLOCATE( pt_1(nzb:nzt+1,nysg:nyng,nxlg:nxrg),                             &
814              pt_3(nzb:nzt+1,nysg:nyng,nxlg:nxrg),                             &
815              u_1(nzb:nzt+1,nysg:nyng,nxlg:nxrg),                              &
816              u_2(nzb:nzt+1,nysg:nyng,nxlg:nxrg),                              &
817              u_3(nzb:nzt+1,nysg:nyng,nxlg:nxrg),                              &
818              v_1(nzb:nzt+1,nysg:nyng,nxlg:nxrg),                              &
819              v_2(nzb:nzt+1,nysg:nyng,nxlg:nxrg),                              &
820              v_3(nzb:nzt+1,nysg:nyng,nxlg:nxrg),                              &
821              w_1(nzb:nzt+1,nysg:nyng,nxlg:nxrg),                              &
822              w_2(nzb:nzt+1,nysg:nyng,nxlg:nxrg),                              &
823              w_3(nzb:nzt+1,nysg:nyng,nxlg:nxrg) )
824    IF (  .NOT.  neutral )  THEN
825       ALLOCATE( pt_2(nzb:nzt+1,nysg:nyng,nxlg:nxrg) )
826    ENDIF
827!
828!-- Pre-set masks for regional statistics. Default is the total model domain.
829!-- Ghost points are excluded because counting values at the ghost boundaries
830!-- would bias the statistics
831    rmask = 1.0_wp
832    rmask(:,nxlg:nxl-1,:) = 0.0_wp;  rmask(:,nxr+1:nxrg,:) = 0.0_wp
833    rmask(nysg:nys-1,:,:) = 0.0_wp;  rmask(nyn+1:nyng,:,:) = 0.0_wp
834!
835!-- Following array is required for perturbation pressure within the iterative
836!-- pressure solvers. For the multistep schemes (Runge-Kutta), array p holds
837!-- the weighted average of the substeps and cannot be used in the Poisson
838!-- solver.
839    IF ( psolver == 'sor' )  THEN
840       ALLOCATE( p_loc(nzb:nzt+1,nysg:nyng,nxlg:nxrg) )
841    ELSEIF ( psolver(1:9) == 'multigrid' )  THEN
842!
843!--    For performance reasons, multigrid is using one ghost layer only
844       ALLOCATE( p_loc(nzb:nzt+1,nys-1:nyn+1,nxl-1:nxr+1) )
845    ENDIF
846
847!
848!-- Array for storing constant coeffficients of the tridiagonal solver
849    IF ( psolver == 'poisfft' )  THEN
850       ALLOCATE( tri(nxl_z:nxr_z,nys_z:nyn_z,0:nz-1,2) )
851       ALLOCATE( tric(nxl_z:nxr_z,nys_z:nyn_z,0:nz-1) )
852    ENDIF
853
854    IF ( humidity )  THEN
855!
856!--    3D-humidity
857       ALLOCATE( q_1(nzb:nzt+1,nysg:nyng,nxlg:nxrg),                           &
858                 q_2(nzb:nzt+1,nysg:nyng,nxlg:nxrg),                           &
859                 q_3(nzb:nzt+1,nysg:nyng,nxlg:nxrg),                           &
860                 vpt_1(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ) 
861    ENDIF   
862   
863    IF ( passive_scalar )  THEN
864
865!
866!--    3D scalar arrays
867       ALLOCATE( s_1(nzb:nzt+1,nysg:nyng,nxlg:nxrg),                           &
868                 s_2(nzb:nzt+1,nysg:nyng,nxlg:nxrg),                           &
869                 s_3(nzb:nzt+1,nysg:nyng,nxlg:nxrg) )
870
871    ENDIF
872
873!
874!-- Allocate and set 1d-profiles for Stokes drift velocity. It may be set to
875!-- non-zero values later in ocean_init
876    ALLOCATE( u_stokes_zu(nzb:nzt+1), u_stokes_zw(nzb:nzt+1),                  &
877              v_stokes_zu(nzb:nzt+1), v_stokes_zw(nzb:nzt+1) )
878    u_stokes_zu(:) = 0.0_wp
879    u_stokes_zw(:) = 0.0_wp
880    v_stokes_zu(:) = 0.0_wp
881    v_stokes_zw(:) = 0.0_wp
882
883!
884!-- Allocation of anelastic and Boussinesq approximation specific arrays
885    ALLOCATE( p_hydrostatic(nzb:nzt+1) )
886    ALLOCATE( rho_air(nzb:nzt+1) )
887    ALLOCATE( rho_air_zw(nzb:nzt+1) )
888    ALLOCATE( drho_air(nzb:nzt+1) )
889    ALLOCATE( drho_air_zw(nzb:nzt+1) )
890!
891!-- Density profile calculation for anelastic and Boussinesq approximation
892!-- In case of a Boussinesq approximation, a constant density is calculated
893!-- mainly for output purposes. This density do not need to be considered
894!-- in the model's system of equations.
895    IF ( TRIM( approximation ) == 'anelastic' )  THEN
896       DO  k = nzb, nzt+1
897          p_hydrostatic(k) = barometric_formula(zu(k), pt_surface *            & 
898                             exner_function(surface_pressure * 100.0_wp),      &
899                             surface_pressure * 100.0_wp)
900         
901          rho_air(k) = ideal_gas_law_rho_pt(p_hydrostatic(k), pt_init(k))
902       ENDDO
903       
904       DO  k = nzb, nzt
905          rho_air_zw(k) = 0.5_wp * ( rho_air(k) + rho_air(k+1) )
906       ENDDO
907       
908       rho_air_zw(nzt+1)  = rho_air_zw(nzt)                                    &
909                            + 2.0_wp * ( rho_air(nzt+1) - rho_air_zw(nzt)  )
910                           
911    ELSE
912       DO  k = nzb, nzt+1
913          p_hydrostatic(k) = barometric_formula(zu(nzb), pt_surface *          & 
914                             exner_function(surface_pressure * 100.0_wp),      &
915                             surface_pressure * 100.0_wp)
916
917          rho_air(k) = ideal_gas_law_rho_pt(p_hydrostatic(k), pt_init(nzb))
918       ENDDO
919       
920       DO  k = nzb, nzt
921          rho_air_zw(k) = 0.5_wp * ( rho_air(k) + rho_air(k+1) )
922       ENDDO
923       
924       rho_air_zw(nzt+1)  = rho_air_zw(nzt)                                    &
925                            + 2.0_wp * ( rho_air(nzt+1) - rho_air_zw(nzt)  )
926                           
927    ENDIF
928!
929!-- compute the inverse density array in order to avoid expencive divisions
930    drho_air    = 1.0_wp / rho_air
931    drho_air_zw = 1.0_wp / rho_air_zw
932
933!
934!-- Allocation of flux conversion arrays
935    ALLOCATE( heatflux_input_conversion(nzb:nzt+1) )
936    ALLOCATE( waterflux_input_conversion(nzb:nzt+1) )
937    ALLOCATE( momentumflux_input_conversion(nzb:nzt+1) )
938    ALLOCATE( heatflux_output_conversion(nzb:nzt+1) )
939    ALLOCATE( waterflux_output_conversion(nzb:nzt+1) )
940    ALLOCATE( momentumflux_output_conversion(nzb:nzt+1) )
941
942!
943!-- calculate flux conversion factors according to approximation and in-/output mode
944    DO  k = nzb, nzt+1
945
946        IF ( TRIM( flux_input_mode ) == 'kinematic' )  THEN
947            heatflux_input_conversion(k)      = rho_air_zw(k)
948            waterflux_input_conversion(k)     = rho_air_zw(k)
949            momentumflux_input_conversion(k)  = rho_air_zw(k)
950        ELSEIF ( TRIM( flux_input_mode ) == 'dynamic' ) THEN
951            heatflux_input_conversion(k)      = 1.0_wp / c_p
952            waterflux_input_conversion(k)     = 1.0_wp / l_v
953            momentumflux_input_conversion(k)  = 1.0_wp
954        ENDIF
955
956        IF ( TRIM( flux_output_mode ) == 'kinematic' )  THEN
957            heatflux_output_conversion(k)     = drho_air_zw(k)
958            waterflux_output_conversion(k)    = drho_air_zw(k)
959            momentumflux_output_conversion(k) = drho_air_zw(k)
960        ELSEIF ( TRIM( flux_output_mode ) == 'dynamic' ) THEN
961            heatflux_output_conversion(k)     = c_p
962            waterflux_output_conversion(k)    = l_v
963            momentumflux_output_conversion(k) = 1.0_wp
964        ENDIF
965
966        IF ( .NOT. humidity ) THEN
967            waterflux_input_conversion(k)  = 1.0_wp
968            waterflux_output_conversion(k) = 1.0_wp
969        ENDIF
970
971    ENDDO
972
973!
974!-- In case of multigrid method, compute grid lengths and grid factors for the
975!-- grid levels with respective density on each grid
976    IF ( psolver(1:9) == 'multigrid' )  THEN
977
978       ALLOCATE( ddx2_mg(maximum_grid_level) )
979       ALLOCATE( ddy2_mg(maximum_grid_level) )
980       ALLOCATE( dzu_mg(nzb+1:nzt+1,maximum_grid_level) )
981       ALLOCATE( dzw_mg(nzb+1:nzt+1,maximum_grid_level) )
982       ALLOCATE( f1_mg(nzb+1:nzt,maximum_grid_level) )
983       ALLOCATE( f2_mg(nzb+1:nzt,maximum_grid_level) )
984       ALLOCATE( f3_mg(nzb+1:nzt,maximum_grid_level) )
985       ALLOCATE( rho_air_mg(nzb:nzt+1,maximum_grid_level) )
986       ALLOCATE( rho_air_zw_mg(nzb:nzt+1,maximum_grid_level) )
987
988       dzu_mg(:,maximum_grid_level) = dzu
989       rho_air_mg(:,maximum_grid_level) = rho_air
990!       
991!--    Next line to ensure an equally spaced grid.
992       dzu_mg(1,maximum_grid_level) = dzu(2)
993       rho_air_mg(nzb,maximum_grid_level) = rho_air(nzb) +                     &
994                                             (rho_air(nzb) - rho_air(nzb+1))
995
996       dzw_mg(:,maximum_grid_level) = dzw
997       rho_air_zw_mg(:,maximum_grid_level) = rho_air_zw
998       nzt_l = nzt
999       DO  l = maximum_grid_level-1, 1, -1
1000           dzu_mg(nzb+1,l) = 2.0_wp * dzu_mg(nzb+1,l+1)
1001           dzw_mg(nzb+1,l) = 2.0_wp * dzw_mg(nzb+1,l+1)
1002           rho_air_mg(nzb,l)    = rho_air_mg(nzb,l+1) + (rho_air_mg(nzb,l+1) - rho_air_mg(nzb+1,l+1))
1003           rho_air_zw_mg(nzb,l) = rho_air_zw_mg(nzb,l+1) + (rho_air_zw_mg(nzb,l+1) - rho_air_zw_mg(nzb+1,l+1))
1004           rho_air_mg(nzb+1,l)    = rho_air_mg(nzb+1,l+1)
1005           rho_air_zw_mg(nzb+1,l) = rho_air_zw_mg(nzb+1,l+1)
1006           nzt_l = nzt_l / 2
1007           DO  k = 2, nzt_l+1
1008              dzu_mg(k,l) = dzu_mg(2*k-2,l+1) + dzu_mg(2*k-1,l+1)
1009              dzw_mg(k,l) = dzw_mg(2*k-2,l+1) + dzw_mg(2*k-1,l+1)
1010              rho_air_mg(k,l)    = rho_air_mg(2*k-1,l+1)
1011              rho_air_zw_mg(k,l) = rho_air_zw_mg(2*k-1,l+1)
1012           ENDDO
1013       ENDDO
1014
1015       nzt_l = nzt
1016       dx_l  = dx
1017       dy_l  = dy
1018       DO  l = maximum_grid_level, 1, -1
1019          ddx2_mg(l) = 1.0_wp / dx_l**2
1020          ddy2_mg(l) = 1.0_wp / dy_l**2
1021          DO  k = nzb+1, nzt_l
1022             f2_mg(k,l) = rho_air_zw_mg(k,l) / ( dzu_mg(k+1,l) * dzw_mg(k,l) )
1023             f3_mg(k,l) = rho_air_zw_mg(k-1,l) / ( dzu_mg(k,l)   * dzw_mg(k,l) )
1024             f1_mg(k,l) = 2.0_wp * ( ddx2_mg(l) + ddy2_mg(l) ) &
1025                          * rho_air_mg(k,l) + f2_mg(k,l) + f3_mg(k,l)
1026          ENDDO
1027          nzt_l = nzt_l / 2
1028          dx_l  = dx_l * 2.0_wp
1029          dy_l  = dy_l * 2.0_wp
1030       ENDDO
1031
1032    ENDIF
1033
1034!
1035!-- 1D-array for large scale subsidence velocity
1036    IF ( .NOT. ALLOCATED( w_subs ) )  THEN
1037       ALLOCATE ( w_subs(nzb:nzt+1) )
1038       w_subs = 0.0_wp
1039    ENDIF
1040
1041!
1042!-- Arrays to store velocity data from t-dt and the phase speeds which
1043!-- are needed for radiation boundary conditions
1044    IF ( bc_radiation_l )  THEN
1045       ALLOCATE( u_m_l(nzb:nzt+1,nysg:nyng,1:2),                               &
1046                 v_m_l(nzb:nzt+1,nysg:nyng,0:1),                               &
1047                 w_m_l(nzb:nzt+1,nysg:nyng,0:1) )
1048    ENDIF
1049    IF ( bc_radiation_r )  THEN
1050       ALLOCATE( u_m_r(nzb:nzt+1,nysg:nyng,nx-1:nx),                           &
1051                 v_m_r(nzb:nzt+1,nysg:nyng,nx-1:nx),                           &
1052                 w_m_r(nzb:nzt+1,nysg:nyng,nx-1:nx) )
1053    ENDIF
1054    IF ( bc_radiation_l  .OR.  bc_radiation_r )  THEN
1055       ALLOCATE( c_u(nzb:nzt+1,nysg:nyng), c_v(nzb:nzt+1,nysg:nyng),           &
1056                 c_w(nzb:nzt+1,nysg:nyng) )
1057    ENDIF
1058    IF ( bc_radiation_s )  THEN
1059       ALLOCATE( u_m_s(nzb:nzt+1,0:1,nxlg:nxrg),                               &
1060                 v_m_s(nzb:nzt+1,1:2,nxlg:nxrg),                               &
1061                 w_m_s(nzb:nzt+1,0:1,nxlg:nxrg) )
1062    ENDIF
1063    IF ( bc_radiation_n )  THEN
1064       ALLOCATE( u_m_n(nzb:nzt+1,ny-1:ny,nxlg:nxrg),                           &
1065                 v_m_n(nzb:nzt+1,ny-1:ny,nxlg:nxrg),                           &
1066                 w_m_n(nzb:nzt+1,ny-1:ny,nxlg:nxrg) )
1067    ENDIF
1068    IF ( bc_radiation_s  .OR.  bc_radiation_n )  THEN
1069       ALLOCATE( c_u(nzb:nzt+1,nxlg:nxrg), c_v(nzb:nzt+1,nxlg:nxrg),           &
1070                 c_w(nzb:nzt+1,nxlg:nxrg) )
1071    ENDIF
1072    IF ( bc_radiation_l  .OR.  bc_radiation_r  .OR.  bc_radiation_s  .OR.      &
1073         bc_radiation_n )  THEN
1074       ALLOCATE( c_u_m_l(nzb:nzt+1), c_v_m_l(nzb:nzt+1), c_w_m_l(nzb:nzt+1) )                   
1075       ALLOCATE( c_u_m(nzb:nzt+1), c_v_m(nzb:nzt+1), c_w_m(nzb:nzt+1) )
1076    ENDIF
1077
1078!
1079!-- Initial assignment of the pointers
1080    IF ( .NOT. neutral )  THEN
1081       pt => pt_1;  pt_p => pt_2;  tpt_m => pt_3
1082    ELSE
1083       pt => pt_1;  pt_p => pt_1;  tpt_m => pt_3
1084    ENDIF
1085    u  => u_1;   u_p  => u_2;   tu_m  => u_3
1086    v  => v_1;   v_p  => v_2;   tv_m  => v_3
1087    w  => w_1;   w_p  => w_2;   tw_m  => w_3
1088
1089    IF ( humidity )  THEN
1090       q => q_1;  q_p => q_2;  tq_m => q_3
1091       vpt  => vpt_1
1092    ENDIF
1093   
1094    IF ( passive_scalar )  THEN
1095       s => s_1;  s_p => s_2;  ts_m => s_3
1096    ENDIF   
1097
1098!
1099!-- Initialize surface arrays
1100    CALL init_surface_arrays
1101!
1102!-- Allocate arrays for other modules
1103    CALL module_interface_init_arrays
1104
1105
1106!
1107!-- Allocate arrays containing the RK coefficient for calculation of
1108!-- perturbation pressure and turbulent fluxes. At this point values are
1109!-- set for pressure calculation during initialization (where no timestep
1110!-- is done). Further below the values needed within the timestep scheme
1111!-- will be set.
1112    ALLOCATE( weight_substep(1:intermediate_timestep_count_max),               &
1113              weight_pres(1:intermediate_timestep_count_max) )
1114    weight_substep = 1.0_wp
1115    weight_pres    = 1.0_wp
1116    intermediate_timestep_count = 0  ! needed when simulated_time = 0.0
1117       
1118    IF ( debug_output )  CALL debug_message( 'allocating arrays', 'end' )
1119
1120!
1121!-- Initialize time series
1122    ts_value = 0.0_wp
1123
1124!
1125!-- Initialize local summation arrays for routine flow_statistics.
1126!-- This is necessary because they may not yet have been initialized when they
1127!-- are called from flow_statistics (or - depending on the chosen model run -
1128!-- are never initialized)
1129    sums_divnew_l      = 0.0_wp
1130    sums_divold_l      = 0.0_wp
1131    sums_l_l           = 0.0_wp
1132    sums_wsts_bc_l     = 0.0_wp
1133   
1134!
1135!-- Initialize model variables
1136    IF ( TRIM( initializing_actions ) /= 'read_restart_data'  .AND.            &
1137         TRIM( initializing_actions ) /= 'cyclic_fill' )  THEN
1138!
1139!--    Initialization with provided input data derived from larger-scale model
1140       IF ( INDEX( initializing_actions, 'inifor' ) /= 0 )  THEN
1141          IF ( debug_output )  CALL debug_message( 'initializing with INIFOR', 'start' )
1142!
1143!--       Read initial 1D profiles or 3D data from NetCDF file, depending
1144!--       on the provided level-of-detail.
1145!--       At the moment, only u, v, w, pt and q are provided.
1146          CALL netcdf_data_input_init_3d
1147!
1148!--       Please note, Inifor provides data from nzb+1 to nzt.
1149!--       Bottom and top boundary conditions for Inifor profiles are already
1150!--       set (just after reading), so that this is not necessary here.
1151!--       Depending on the provided level-of-detail, initial Inifor data is
1152!--       either stored on data type (lod=1), or directly on 3D arrays (lod=2).
1153!--       In order to obtain also initial profiles in case of lod=2 (which
1154!--       is required for e.g. damping), average over 3D data.
1155          IF( init_3d%lod_u == 1 )  THEN
1156             u_init = init_3d%u_init
1157          ELSEIF( init_3d%lod_u == 2 )  THEN
1158             ALLOCATE( init_l(nzb:nzt+1) ) 
1159             DO  k = nzb, nzt+1
1160                init_l(k) = SUM( u(k,nys:nyn,nxl:nxr) )
1161             ENDDO
1162             init_l = init_l / REAL( ( nx + 1 ) * ( ny + 1 ), KIND = wp )
1163
1164#if defined( __parallel )
1165             CALL MPI_ALLREDUCE( init_l, u_init, nzt+1-nzb+1,                  &
1166                                 MPI_REAL, MPI_SUM, comm2d, ierr )
1167#else
1168             u_init = init_l
1169#endif
1170             DEALLOCATE( init_l )
1171
1172          ENDIF
1173           
1174          IF( init_3d%lod_v == 1 )  THEN 
1175             v_init = init_3d%v_init
1176          ELSEIF( init_3d%lod_v == 2 )  THEN
1177             ALLOCATE( init_l(nzb:nzt+1) ) 
1178             DO  k = nzb, nzt+1
1179                init_l(k) = SUM( v(k,nys:nyn,nxl:nxr) )
1180             ENDDO
1181             init_l = init_l / REAL( ( nx + 1 ) * ( ny + 1 ), KIND = wp )
1182
1183#if defined( __parallel )
1184             CALL MPI_ALLREDUCE( init_l, v_init, nzt+1-nzb+1,                  &
1185                                 MPI_REAL, MPI_SUM, comm2d, ierr )
1186#else
1187             v_init = init_l
1188#endif
1189             DEALLOCATE( init_l )
1190          ENDIF
1191          IF( .NOT. neutral )  THEN
1192             IF( init_3d%lod_pt == 1 )  THEN
1193                pt_init = init_3d%pt_init
1194             ELSEIF( init_3d%lod_pt == 2 )  THEN
1195                ALLOCATE( init_l(nzb:nzt+1) ) 
1196                DO  k = nzb, nzt+1
1197                   init_l(k) = SUM( pt(k,nys:nyn,nxl:nxr) )
1198                ENDDO
1199                init_l = init_l / REAL( ( nx + 1 ) * ( ny + 1 ), KIND = wp )
1200
1201#if defined( __parallel )
1202                CALL MPI_ALLREDUCE( init_l, pt_init, nzt+1-nzb+1,               &
1203                                    MPI_REAL, MPI_SUM, comm2d, ierr )
1204#else
1205                pt_init = init_l
1206#endif
1207                DEALLOCATE( init_l )
1208             ENDIF
1209          ENDIF
1210
1211
1212          IF( humidity )  THEN
1213             IF( init_3d%lod_q == 1 )  THEN
1214                q_init = init_3d%q_init
1215             ELSEIF( init_3d%lod_q == 2 )  THEN
1216                ALLOCATE( init_l(nzb:nzt+1) ) 
1217                DO  k = nzb, nzt+1
1218                   init_l(k) = SUM( q(k,nys:nyn,nxl:nxr) )
1219                ENDDO
1220                init_l = init_l / REAL( ( nx + 1 ) * ( ny + 1 ), KIND = wp )
1221
1222#if defined( __parallel )
1223                CALL MPI_ALLREDUCE( init_l, q_init, nzt+1-nzb+1,               &
1224                                    MPI_REAL, MPI_SUM, comm2d, ierr )
1225#else
1226                q_init = init_l
1227#endif
1228                DEALLOCATE( init_l )
1229             ENDIF
1230          ENDIF
1231
1232!
1233!--       Write initial profiles onto 3D arrays.
1234!--       Work-around, 3D initialization of u,v,w creates artificial
1235!--       structures wich correlate with the processor grid. The reason
1236!--       for this is still unknown. To work-around this, 3D initialization
1237!--       will be effectively reduce to a 1D initialization where no such
1238!--       artificial structures appear.
1239          DO  i = nxlg, nxrg
1240             DO  j = nysg, nyng
1241                IF( init_3d%lod_u == 1  .OR.  init_3d%lod_u == 2 )             &
1242                   u(:,j,i) = u_init(:)
1243                IF( init_3d%lod_v == 1  .OR.  init_3d%lod_u == 2 )             &
1244                   v(:,j,i) = v_init(:)
1245                IF( .NOT. neutral  .AND.                                       &
1246                    ( init_3d%lod_pt == 1  .OR.  init_3d%lod_pt == 2 ) )       &
1247                   pt(:,j,i) = pt_init(:)
1248                IF( humidity  .AND.                                            &
1249                    ( init_3d%lod_q == 1  .OR.  init_3d%lod_q == 2 ) )         &
1250                   q(:,j,i) = q_init(:)
1251             ENDDO
1252          ENDDO
1253!
1254!--       Set geostrophic wind components. 
1255          IF ( init_3d%from_file_ug )  THEN
1256             ug(:) = init_3d%ug_init(:)
1257          ENDIF
1258          IF ( init_3d%from_file_vg )  THEN
1259             vg(:) = init_3d%vg_init(:)
1260          ENDIF
1261!
1262!--       Set bottom and top boundary condition for geostrophic wind
1263          ug(nzt+1) = ug(nzt)
1264          vg(nzt+1) = vg(nzt)
1265          ug(nzb)   = ug(nzb+1)
1266          vg(nzb)   = vg(nzb+1)
1267!
1268!--       Set inital w to 0
1269          w = 0.0_wp
1270
1271          IF ( passive_scalar )  THEN
1272             DO  i = nxlg, nxrg
1273                DO  j = nysg, nyng
1274                   s(:,j,i) = s_init
1275                ENDDO
1276             ENDDO
1277          ENDIF
1278
1279!
1280!--       Set velocity components at non-atmospheric / oceanic grid points to
1281!--       zero.
1282          u = MERGE( u, 0.0_wp, BTEST( wall_flags_0, 1 ) )
1283          v = MERGE( v, 0.0_wp, BTEST( wall_flags_0, 2 ) )
1284          w = MERGE( w, 0.0_wp, BTEST( wall_flags_0, 3 ) )
1285!
1286!--       Initialize surface variables, e.g. friction velocity, momentum
1287!--       fluxes, etc.
1288          CALL init_surfaces
1289
1290          IF ( debug_output )  CALL debug_message( 'initializing with INIFOR', 'end' )
1291!
1292!--    Initialization via computed 1D-model profiles
1293       ELSEIF ( INDEX( initializing_actions, 'set_1d-model_profiles' ) /= 0 )  THEN
1294
1295          IF ( debug_output )  CALL debug_message( 'initializing with 1D model profiles', 'start' )
1296!
1297!--       Use solutions of the 1D model as initial profiles,
1298!--       start 1D model
1299          CALL init_1d_model
1300!
1301!--       Transfer initial profiles to the arrays of the 3D model
1302          DO  i = nxlg, nxrg
1303             DO  j = nysg, nyng
1304                pt(:,j,i) = pt_init
1305                u(:,j,i)  = u1d
1306                v(:,j,i)  = v1d
1307             ENDDO
1308          ENDDO
1309
1310          IF ( humidity )  THEN
1311             DO  i = nxlg, nxrg
1312                DO  j = nysg, nyng
1313                   q(:,j,i) = q_init
1314                ENDDO
1315             ENDDO
1316          ENDIF
1317
1318          IF ( passive_scalar )  THEN
1319             DO  i = nxlg, nxrg
1320                DO  j = nysg, nyng
1321                   s(:,j,i) = s_init
1322                ENDDO
1323             ENDDO   
1324          ENDIF
1325!
1326!--          Store initial profiles for output purposes etc.
1327          IF ( .NOT. constant_diffusion )  THEN
1328             hom(:,1,25,:) = SPREAD( l1d, 2, statistic_regions+1 )
1329          ENDIF
1330!
1331!--       Set velocities back to zero
1332          u = MERGE( u, 0.0_wp, BTEST( wall_flags_0, 1 ) )
1333          v = MERGE( v, 0.0_wp, BTEST( wall_flags_0, 2 ) )         
1334!
1335!--       WARNING: The extra boundary conditions set after running the
1336!--       -------  1D model impose an error on the divergence one layer
1337!--                below the topography; need to correct later
1338!--       ATTENTION: Provisional correction for Piacsek & Williams
1339!--       ---------  advection scheme: keep u and v zero one layer below
1340!--                  the topography.
1341          IF ( ibc_uv_b == 1 )  THEN
1342!
1343!--          Neumann condition
1344             DO  i = nxl-1, nxr+1
1345                DO  j = nys-1, nyn+1
1346                   u(nzb,j,i) = u(nzb+1,j,i)
1347                   v(nzb,j,i) = v(nzb+1,j,i)
1348                ENDDO
1349             ENDDO
1350
1351          ENDIF
1352!
1353!--       Initialize surface variables, e.g. friction velocity, momentum
1354!--       fluxes, etc.
1355          CALL init_surfaces
1356
1357          IF ( debug_output )  CALL debug_message( 'initializing with 1D model profiles', 'end' )
1358
1359       ELSEIF ( INDEX(initializing_actions, 'set_constant_profiles') /= 0 )    &
1360       THEN
1361
1362          IF ( debug_output )  CALL debug_message( 'initializing with constant profiles', 'start' )
1363
1364!
1365!--       Use constructed initial profiles (velocity constant with height,
1366!--       temperature profile with constant gradient)
1367          DO  i = nxlg, nxrg
1368             DO  j = nysg, nyng
1369                pt(:,j,i) = pt_init
1370                u(:,j,i)  = u_init
1371                v(:,j,i)  = v_init
1372             ENDDO
1373          ENDDO
1374!
1375!--       Mask topography
1376          u = MERGE( u, 0.0_wp, BTEST( wall_flags_0, 1 ) )
1377          v = MERGE( v, 0.0_wp, BTEST( wall_flags_0, 2 ) )
1378!
1379!--       Set initial horizontal velocities at the lowest computational grid
1380!--       levels to zero in order to avoid too small time steps caused by the
1381!--       diffusion limit in the initial phase of a run (at k=1, dz/2 occurs
1382!--       in the limiting formula!).
1383!--       Please note, in case land- or urban-surface model is used and a
1384!--       spinup is applied, masking the lowest computational level is not
1385!--       possible as MOST as well as energy-balance parametrizations will not
1386!--       work with zero wind velocity.
1387          IF ( ibc_uv_b /= 1  .AND.  .NOT.  spinup )  THEN
1388             DO  i = nxlg, nxrg
1389                DO  j = nysg, nyng
1390                   DO  k = nzb, nzt
1391                      u(k,j,i) = MERGE( u(k,j,i), 0.0_wp,                      &
1392                                        BTEST( wall_flags_0(k,j,i), 20 ) )
1393                      v(k,j,i) = MERGE( v(k,j,i), 0.0_wp,                      &
1394                                        BTEST( wall_flags_0(k,j,i), 21 ) )
1395                   ENDDO
1396                ENDDO
1397             ENDDO
1398          ENDIF
1399
1400          IF ( humidity )  THEN
1401             DO  i = nxlg, nxrg
1402                DO  j = nysg, nyng
1403                   q(:,j,i) = q_init
1404                ENDDO
1405             ENDDO
1406          ENDIF
1407         
1408          IF ( passive_scalar )  THEN
1409             DO  i = nxlg, nxrg
1410                DO  j = nysg, nyng
1411                   s(:,j,i) = s_init
1412                ENDDO
1413             ENDDO
1414          ENDIF
1415
1416!
1417!--       Compute initial temperature field and other constants used in case
1418!--       of a sloping surface
1419          IF ( sloping_surface )  CALL init_slope
1420!
1421!--       Initialize surface variables, e.g. friction velocity, momentum
1422!--       fluxes, etc.
1423          CALL init_surfaces
1424         
1425          IF ( debug_output )  CALL debug_message( 'initializing with constant profiles', 'end' )
1426
1427       ELSEIF ( INDEX(initializing_actions, 'by_user') /= 0 )                  &
1428       THEN
1429
1430          IF ( debug_output )  CALL debug_message( 'initializing by user', 'start' )
1431!
1432!--       Pre-initialize surface variables, i.e. setting start- and end-indices
1433!--       at each (j,i)-location. Please note, this does not supersede
1434!--       user-defined initialization of surface quantities.
1435          CALL init_surfaces
1436!
1437!--       Initialization will completely be done by the user
1438          CALL user_init_3d_model
1439
1440          IF ( debug_output )  CALL debug_message( 'initializing by user', 'end' )
1441
1442       ENDIF
1443
1444       IF ( debug_output )  CALL debug_message( 'initializing statistics, boundary conditions, etc.', 'start' )
1445
1446!
1447!--    Bottom boundary
1448       IF ( ibc_uv_b == 0 .OR. ibc_uv_b == 2  )  THEN
1449          u(nzb,:,:) = 0.0_wp
1450          v(nzb,:,:) = 0.0_wp
1451       ENDIF
1452
1453!
1454!--    Apply channel flow boundary condition
1455       IF ( TRIM( bc_uv_t ) == 'dirichlet_0' )  THEN
1456          u(nzt+1,:,:) = 0.0_wp
1457          v(nzt+1,:,:) = 0.0_wp
1458       ENDIF
1459
1460!
1461!--    Calculate virtual potential temperature
1462       IF ( humidity )  vpt = pt * ( 1.0_wp + 0.61_wp * q )
1463
1464!
1465!--    Store initial profiles for output purposes etc.. Please note, in case of
1466!--    initialization of u, v, w, pt, and q via output data derived from larger
1467!--    scale models, data will not be horizontally homogeneous. Actually, a mean
1468!--    profile should be calculated before.   
1469       hom(:,1,5,:) = SPREAD( u(:,nys,nxl), 2, statistic_regions+1 )
1470       hom(:,1,6,:) = SPREAD( v(:,nys,nxl), 2, statistic_regions+1 )
1471       IF ( ibc_uv_b == 0 .OR. ibc_uv_b == 2)  THEN
1472          hom(nzb,1,5,:) = 0.0_wp
1473          hom(nzb,1,6,:) = 0.0_wp
1474       ENDIF
1475       hom(:,1,7,:)  = SPREAD( pt(:,nys,nxl), 2, statistic_regions+1 )
1476
1477       IF ( humidity )  THEN
1478!
1479!--       Store initial profile of total water content, virtual potential
1480!--       temperature
1481          hom(:,1,26,:) = SPREAD(   q(:,nys,nxl), 2, statistic_regions+1 )
1482          hom(:,1,29,:) = SPREAD( vpt(:,nys,nxl), 2, statistic_regions+1 )
1483!
1484!--       Store initial profile of mixing ratio and potential
1485!--       temperature
1486          IF ( bulk_cloud_model  .OR.  cloud_droplets ) THEN
1487             hom(:,1,27,:) = SPREAD(  q(:,nys,nxl), 2, statistic_regions+1 )
1488             hom(:,1,28,:) = SPREAD( pt(:,nys,nxl), 2, statistic_regions+1 )
1489          ENDIF
1490       ENDIF
1491
1492!
1493!--    Store initial scalar profile
1494       IF ( passive_scalar )  THEN
1495          hom(:,1,121,:) = SPREAD(  s(:,nys,nxl), 2, statistic_regions+1 )
1496       ENDIF
1497
1498!
1499!--    Initialize the random number generators (from numerical recipes)
1500       CALL random_function_ini
1501       
1502       IF ( random_generator == 'random-parallel' )  THEN
1503          CALL init_parallel_random_generator( nx, nys, nyn, nxl, nxr )
1504       ENDIF
1505!
1506!--    Set the reference state to be used in the buoyancy terms (for ocean runs
1507!--    the reference state will be set (overwritten) in init_ocean)
1508       IF ( use_single_reference_value )  THEN
1509          IF (  .NOT.  humidity )  THEN
1510             ref_state(:) = pt_reference
1511          ELSE
1512             ref_state(:) = vpt_reference
1513          ENDIF
1514       ELSE
1515          IF (  .NOT.  humidity )  THEN
1516             ref_state(:) = pt_init(:)
1517          ELSE
1518             ref_state(:) = vpt(:,nys,nxl)
1519          ENDIF
1520       ENDIF
1521
1522!
1523!--    For the moment, vertical velocity is zero
1524       w = 0.0_wp
1525
1526!
1527!--    Initialize array sums (must be defined in first call of pres)
1528       sums = 0.0_wp
1529
1530!
1531!--    In case of iterative solvers, p must get an initial value
1532       IF ( psolver(1:9) == 'multigrid'  .OR.  psolver == 'sor' )  p = 0.0_wp
1533!
1534!--    Impose vortex with vertical axis on the initial velocity profile
1535       IF ( INDEX( initializing_actions, 'initialize_vortex' ) /= 0 )  THEN
1536          CALL init_rankine
1537       ENDIF
1538
1539!
1540!--    Impose temperature anomaly (advection test only) or warm air bubble
1541!--    close to surface
1542       IF ( INDEX( initializing_actions, 'initialize_ptanom' ) /= 0  .OR.  &
1543            INDEX( initializing_actions, 'initialize_bubble' ) /= 0  )  THEN
1544          CALL init_pt_anomaly
1545       ENDIF
1546       
1547!
1548!--    If required, change the surface temperature at the start of the 3D run
1549       IF ( pt_surface_initial_change /= 0.0_wp )  THEN
1550          pt(nzb,:,:) = pt(nzb,:,:) + pt_surface_initial_change
1551       ENDIF
1552
1553!
1554!--    If required, change the surface humidity/scalar at the start of the 3D
1555!--    run
1556       IF ( humidity  .AND.  q_surface_initial_change /= 0.0_wp )              &
1557          q(nzb,:,:) = q(nzb,:,:) + q_surface_initial_change
1558         
1559       IF ( passive_scalar .AND.  s_surface_initial_change /= 0.0_wp )         &
1560          s(nzb,:,:) = s(nzb,:,:) + s_surface_initial_change
1561       
1562
1563!
1564!--    Initialize old and new time levels.
1565       tpt_m = 0.0_wp; tu_m = 0.0_wp; tv_m = 0.0_wp; tw_m = 0.0_wp
1566       pt_p = pt; u_p = u; v_p = v; w_p = w
1567
1568       IF ( humidity  )  THEN
1569          tq_m = 0.0_wp
1570          q_p = q
1571       ENDIF
1572       
1573       IF ( passive_scalar )  THEN
1574          ts_m = 0.0_wp
1575          s_p  = s
1576       ENDIF       
1577
1578       IF ( debug_output )  CALL debug_message( 'initializing statistics, boundary conditions, etc.', 'end' )
1579
1580    ELSEIF ( TRIM( initializing_actions ) == 'read_restart_data'  .OR.         &
1581             TRIM( initializing_actions ) == 'cyclic_fill' )                   &
1582    THEN
1583
1584       IF ( debug_output )  CALL debug_message( 'initializing in case of restart / cyclic_fill', 'start' )
1585!
1586!--    Initialize surface elements and its attributes, e.g. heat- and
1587!--    momentumfluxes, roughness, scaling parameters. As number of surface
1588!--    elements might be different between runs, e.g. in case of cyclic fill,
1589!--    and not all surface elements are read, surface elements need to be
1590!--    initialized before.
1591!--    Please note, in case of cyclic fill, surfaces should be initialized
1592!--    after restart data is read, else, individual settings of surface
1593!--    parameters will be overwritten from data of precursor run, hence,
1594!--    init_surfaces is called a second time after reading the restart data.
1595       CALL init_surfaces                       
1596!
1597!--    When reading data for cyclic fill of 3D prerun data files, read
1598!--    some of the global variables from the restart file which are required
1599!--    for initializing the inflow
1600       IF ( TRIM( initializing_actions ) == 'cyclic_fill' )  THEN
1601
1602          DO  i = 0, io_blocks-1
1603             IF ( i == io_group )  THEN
1604                CALL rrd_read_parts_of_global
1605             ENDIF
1606#if defined( __parallel )
1607             CALL MPI_BARRIER( comm2d, ierr )
1608#endif
1609          ENDDO
1610
1611       ENDIF
1612
1613!
1614!--    Read processor specific binary data from restart file
1615       DO  i = 0, io_blocks-1
1616          IF ( i == io_group )  THEN
1617             CALL rrd_local
1618          ENDIF
1619#if defined( __parallel )
1620          CALL MPI_BARRIER( comm2d, ierr )
1621#endif
1622       ENDDO
1623!
1624!--    In case of cyclic fill, call init_surfaces a second time, so that
1625!--    surface properties such as heat fluxes are initialized as prescribed.
1626       IF ( TRIM( initializing_actions ) == 'cyclic_fill' )                    &
1627          CALL init_surfaces
1628
1629!
1630!--    In case of complex terrain and cyclic fill method as initialization,
1631!--    shift initial data in the vertical direction for each point in the
1632!--    x-y-plane depending on local surface height
1633       IF ( complex_terrain  .AND.                                             &
1634            TRIM( initializing_actions ) == 'cyclic_fill' )  THEN
1635          DO  i = nxlg, nxrg
1636             DO  j = nysg, nyng
1637                nz_u_shift = topo_top_ind(j,i,1)
1638                nz_v_shift = topo_top_ind(j,i,2)
1639                nz_w_shift = topo_top_ind(j,i,3)
1640                nz_s_shift = topo_top_ind(j,i,0)
1641
1642                u(nz_u_shift:nzt+1,j,i)  = u(0:nzt+1-nz_u_shift,j,i)               
1643
1644                v(nz_v_shift:nzt+1,j,i)  = v(0:nzt+1-nz_v_shift,j,i)
1645
1646                w(nz_w_shift:nzt+1,j,i)  = w(0:nzt+1-nz_w_shift,j,i)
1647
1648                p(nz_s_shift:nzt+1,j,i)  =  p(0:nzt+1-nz_s_shift,j,i)
1649                pt(nz_s_shift:nzt+1,j,i) = pt(0:nzt+1-nz_s_shift,j,i)
1650             ENDDO
1651          ENDDO
1652       ENDIF
1653!
1654!--    Initialization of the turbulence recycling method
1655       IF ( TRIM( initializing_actions ) == 'cyclic_fill'  .AND.               &
1656            turbulent_inflow )  THEN
1657!
1658!--       First store the profiles to be used at the inflow.
1659!--       These profiles are the (temporally) and horizontally averaged vertical
1660!--       profiles from the prerun. Alternatively, prescribed profiles
1661!--       for u,v-components can be used.
1662          ALLOCATE( mean_inflow_profiles(nzb:nzt+1,1:num_mean_inflow_profiles) )
1663
1664          IF ( use_prescribed_profile_data )  THEN
1665             mean_inflow_profiles(:,1) = u_init            ! u
1666             mean_inflow_profiles(:,2) = v_init            ! v
1667          ELSE
1668             mean_inflow_profiles(:,1) = hom_sum(:,1,0)    ! u
1669             mean_inflow_profiles(:,2) = hom_sum(:,2,0)    ! v
1670          ENDIF
1671          mean_inflow_profiles(:,4) = hom_sum(:,4,0)       ! pt
1672          IF ( humidity )                                                      &
1673             mean_inflow_profiles(:,6) = hom_sum(:,41,0)   ! q
1674          IF ( passive_scalar )                                                &
1675             mean_inflow_profiles(:,7) = hom_sum(:,115,0)   ! s
1676!
1677!--       In case of complex terrain, determine vertical displacement at inflow
1678!--       boundary and adjust mean inflow profiles
1679          IF ( complex_terrain )  THEN
1680             IF ( nxlg <= 0 .AND. nxrg >= 0 .AND. nysg <= 0 .AND. nyng >= 0 )  THEN
1681                nz_u_shift_l = topo_top_ind(j,i,1)
1682                nz_v_shift_l = topo_top_ind(j,i,2)
1683                nz_w_shift_l = topo_top_ind(j,i,3)
1684                nz_s_shift_l = topo_top_ind(j,i,0)
1685             ELSE
1686                nz_u_shift_l = 0
1687                nz_v_shift_l = 0
1688                nz_w_shift_l = 0
1689                nz_s_shift_l = 0
1690             ENDIF
1691
1692#if defined( __parallel )
1693             CALL MPI_ALLREDUCE(nz_u_shift_l, nz_u_shift, 1, MPI_INTEGER,      &
1694                                MPI_MAX, comm2d, ierr)
1695             CALL MPI_ALLREDUCE(nz_v_shift_l, nz_v_shift, 1, MPI_INTEGER,      &
1696                                MPI_MAX, comm2d, ierr)
1697             CALL MPI_ALLREDUCE(nz_w_shift_l, nz_w_shift, 1, MPI_INTEGER,      & 
1698                                MPI_MAX, comm2d, ierr)
1699             CALL MPI_ALLREDUCE(nz_s_shift_l, nz_s_shift, 1, MPI_INTEGER,      &
1700                                MPI_MAX, comm2d, ierr)
1701#else
1702             nz_u_shift = nz_u_shift_l
1703             nz_v_shift = nz_v_shift_l
1704             nz_w_shift = nz_w_shift_l
1705             nz_s_shift = nz_s_shift_l
1706#endif
1707
1708             mean_inflow_profiles(:,1) = 0.0_wp
1709             mean_inflow_profiles(nz_u_shift:nzt+1,1) = hom_sum(0:nzt+1-nz_u_shift,1,0)  ! u
1710
1711             mean_inflow_profiles(:,2) = 0.0_wp
1712             mean_inflow_profiles(nz_v_shift:nzt+1,2) = hom_sum(0:nzt+1-nz_v_shift,2,0)  ! v
1713
1714             mean_inflow_profiles(nz_s_shift:nzt+1,4) = hom_sum(0:nzt+1-nz_s_shift,4,0)  ! pt
1715
1716          ENDIF
1717
1718!
1719!--       If necessary, adjust the horizontal flow field to the prescribed
1720!--       profiles
1721          IF ( use_prescribed_profile_data )  THEN
1722             DO  i = nxlg, nxrg
1723                DO  j = nysg, nyng
1724                   DO  k = nzb, nzt+1
1725                      u(k,j,i) = u(k,j,i) - hom_sum(k,1,0) + u_init(k)
1726                      v(k,j,i) = v(k,j,i) - hom_sum(k,2,0) + v_init(k)
1727                   ENDDO
1728                ENDDO
1729             ENDDO
1730          ENDIF
1731
1732!
1733!--       Use these mean profiles at the inflow (provided that Dirichlet
1734!--       conditions are used)
1735          IF ( bc_dirichlet_l )  THEN
1736             DO  j = nysg, nyng
1737                DO  k = nzb, nzt+1
1738                   u(k,j,nxlg:-1)  = mean_inflow_profiles(k,1)
1739                   v(k,j,nxlg:-1)  = mean_inflow_profiles(k,2)
1740                   w(k,j,nxlg:-1)  = 0.0_wp
1741                   pt(k,j,nxlg:-1) = mean_inflow_profiles(k,4)
1742                   IF ( humidity )                                             &
1743                      q(k,j,nxlg:-1)  = mean_inflow_profiles(k,6)
1744                   IF ( passive_scalar )                                       &
1745                      s(k,j,nxlg:-1)  = mean_inflow_profiles(k,7)                     
1746                ENDDO
1747             ENDDO
1748          ENDIF
1749
1750!
1751!--       Calculate the damping factors to be used at the inflow. For a
1752!--       turbulent inflow the turbulent fluctuations have to be limited
1753!--       vertically because otherwise the turbulent inflow layer will grow
1754!--       in time.
1755          IF ( inflow_damping_height == 9999999.9_wp )  THEN
1756!
1757!--          Default: use the inversion height calculated by the prerun; if
1758!--          this is zero, inflow_damping_height must be explicitly
1759!--          specified.
1760             IF ( hom_sum(nzb+6,pr_palm,0) /= 0.0_wp )  THEN
1761                inflow_damping_height = hom_sum(nzb+6,pr_palm,0)
1762             ELSE
1763                WRITE( message_string, * ) 'inflow_damping_height must be ',   &
1764                     'explicitly specified because&the inversion height ',     &
1765                     'calculated by the prerun is zero.'
1766                CALL message( 'init_3d_model', 'PA0318', 1, 2, 0, 6, 0 )
1767             ENDIF
1768
1769          ENDIF
1770
1771          IF ( inflow_damping_width == 9999999.9_wp )  THEN
1772!
1773!--          Default for the transition range: one tenth of the undamped
1774!--          layer
1775             inflow_damping_width = 0.1_wp * inflow_damping_height
1776
1777          ENDIF
1778
1779          ALLOCATE( inflow_damping_factor(nzb:nzt+1) )
1780
1781          DO  k = nzb, nzt+1
1782
1783             IF ( zu(k) <= inflow_damping_height )  THEN
1784                inflow_damping_factor(k) = 1.0_wp
1785             ELSEIF ( zu(k) <= ( inflow_damping_height + inflow_damping_width ) )  THEN
1786                inflow_damping_factor(k) = 1.0_wp -                            &
1787                                           ( zu(k) - inflow_damping_height ) / &
1788                                           inflow_damping_width
1789             ELSE
1790                inflow_damping_factor(k) = 0.0_wp
1791             ENDIF
1792
1793          ENDDO
1794
1795       ENDIF
1796
1797!
1798!--    Inside buildings set velocities back to zero
1799       IF ( TRIM( initializing_actions ) == 'cyclic_fill' .AND.                &
1800            topography /= 'flat' )  THEN
1801!
1802!--       Inside buildings set velocities back to zero.
1803!--       Other scalars (pt, q, s, p, sa, ...) are ignored at present,
1804!--       maybe revise later.
1805          DO  i = nxlg, nxrg
1806             DO  j = nysg, nyng
1807                DO  k = nzb, nzt
1808                   u(k,j,i)     = MERGE( u(k,j,i), 0.0_wp,                     &
1809                                         BTEST( wall_flags_0(k,j,i), 1 ) )
1810                   v(k,j,i)     = MERGE( v(k,j,i), 0.0_wp,                     &
1811                                         BTEST( wall_flags_0(k,j,i), 2 ) )
1812                   w(k,j,i)     = MERGE( w(k,j,i), 0.0_wp,                     &
1813                                         BTEST( wall_flags_0(k,j,i), 3 ) )
1814                ENDDO
1815             ENDDO
1816          ENDDO
1817
1818       ENDIF
1819
1820!
1821!--    Calculate initial temperature field and other constants used in case
1822!--    of a sloping surface
1823       IF ( sloping_surface )  CALL init_slope
1824
1825!
1826!--    Initialize new time levels (only done in order to set boundary values
1827!--    including ghost points)
1828       pt_p = pt; u_p = u; v_p = v; w_p = w
1829       IF ( humidity )  THEN
1830          q_p = q
1831       ENDIF
1832       IF ( passive_scalar )  s_p  = s
1833!
1834!--    Allthough tendency arrays are set in prognostic_equations, they have
1835!--    have to be predefined here because they are used (but multiplied with 0)
1836!--    there before they are set.
1837       tpt_m = 0.0_wp; tu_m = 0.0_wp; tv_m = 0.0_wp; tw_m = 0.0_wp
1838       IF ( humidity )  THEN
1839          tq_m = 0.0_wp
1840       ENDIF
1841       IF ( passive_scalar )  ts_m  = 0.0_wp
1842
1843       IF ( debug_output )  CALL debug_message( 'initializing in case of restart / cyclic_fill', 'end' )
1844
1845    ELSE
1846!
1847!--    Actually this part of the programm should not be reached
1848       message_string = 'unknown initializing problem'
1849       CALL message( 'init_3d_model', 'PA0193', 1, 2, 0, 6, 0 )
1850    ENDIF
1851
1852
1853    IF (  TRIM( initializing_actions ) /= 'read_restart_data' )  THEN
1854!
1855!--    Initialize old timelevels needed for radiation boundary conditions
1856       IF ( bc_radiation_l )  THEN
1857          u_m_l(:,:,:) = u(:,:,1:2)
1858          v_m_l(:,:,:) = v(:,:,0:1)
1859          w_m_l(:,:,:) = w(:,:,0:1)
1860       ENDIF
1861       IF ( bc_radiation_r )  THEN
1862          u_m_r(:,:,:) = u(:,:,nx-1:nx)
1863          v_m_r(:,:,:) = v(:,:,nx-1:nx)
1864          w_m_r(:,:,:) = w(:,:,nx-1:nx)
1865       ENDIF
1866       IF ( bc_radiation_s )  THEN
1867          u_m_s(:,:,:) = u(:,0:1,:)
1868          v_m_s(:,:,:) = v(:,1:2,:)
1869          w_m_s(:,:,:) = w(:,0:1,:)
1870       ENDIF
1871       IF ( bc_radiation_n )  THEN
1872          u_m_n(:,:,:) = u(:,ny-1:ny,:)
1873          v_m_n(:,:,:) = v(:,ny-1:ny,:)
1874          w_m_n(:,:,:) = w(:,ny-1:ny,:)
1875       ENDIF
1876       
1877    ENDIF
1878
1879!
1880!-- Calculate the initial volume flow at the right and north boundary
1881    IF ( conserve_volume_flow )  THEN
1882
1883       IF ( use_prescribed_profile_data )  THEN
1884
1885          volume_flow_initial_l = 0.0_wp
1886          volume_flow_area_l    = 0.0_wp
1887
1888          IF ( nxr == nx )  THEN
1889             DO  j = nys, nyn
1890                DO  k = nzb+1, nzt
1891                   volume_flow_initial_l(1) = volume_flow_initial_l(1) +       &
1892                                              u_init(k) * dzw(k)               &
1893                                     * MERGE( 1.0_wp, 0.0_wp,                  &
1894                                              BTEST( wall_flags_0(k,j,nxr), 1 )&
1895                                            )
1896
1897                   volume_flow_area_l(1)    = volume_flow_area_l(1) + dzw(k)   &
1898                                     * MERGE( 1.0_wp, 0.0_wp,                  &
1899                                              BTEST( wall_flags_0(k,j,nxr), 1 )&
1900                                            )
1901                ENDDO
1902             ENDDO
1903          ENDIF
1904         
1905          IF ( nyn == ny )  THEN
1906             DO  i = nxl, nxr
1907                DO  k = nzb+1, nzt
1908                   volume_flow_initial_l(2) = volume_flow_initial_l(2) +       &
1909                                              v_init(k) * dzw(k)               &       
1910                                     * MERGE( 1.0_wp, 0.0_wp,                  &
1911                                              BTEST( wall_flags_0(k,nyn,i), 2 )&
1912                                            )
1913                   volume_flow_area_l(2)    = volume_flow_area_l(2) + dzw(k)   &       
1914                                     * MERGE( 1.0_wp, 0.0_wp,                  &
1915                                              BTEST( wall_flags_0(k,nyn,i), 2 )&
1916                                            )
1917                ENDDO
1918             ENDDO
1919          ENDIF
1920
1921#if defined( __parallel )
1922          CALL MPI_ALLREDUCE( volume_flow_initial_l(1), volume_flow_initial(1),&
1923                              2, MPI_REAL, MPI_SUM, comm2d, ierr )
1924          CALL MPI_ALLREDUCE( volume_flow_area_l(1), volume_flow_area(1),      &
1925                              2, MPI_REAL, MPI_SUM, comm2d, ierr )
1926
1927#else
1928          volume_flow_initial = volume_flow_initial_l
1929          volume_flow_area    = volume_flow_area_l
1930#endif 
1931
1932       ELSEIF ( TRIM( initializing_actions ) == 'cyclic_fill' )  THEN
1933
1934          volume_flow_initial_l = 0.0_wp
1935          volume_flow_area_l    = 0.0_wp
1936
1937          IF ( nxr == nx )  THEN
1938             DO  j = nys, nyn
1939                DO  k = nzb+1, nzt
1940                   volume_flow_initial_l(1) = volume_flow_initial_l(1) +       &
1941                                              hom_sum(k,1,0) * dzw(k)          &
1942                                     * MERGE( 1.0_wp, 0.0_wp,                  &
1943                                              BTEST( wall_flags_0(k,j,nx), 1 ) &
1944                                            )
1945                   volume_flow_area_l(1)    = volume_flow_area_l(1) + dzw(k)   &
1946                                     * MERGE( 1.0_wp, 0.0_wp,                  &
1947                                              BTEST( wall_flags_0(k,j,nx), 1 ) &
1948                                            )
1949                ENDDO
1950             ENDDO
1951          ENDIF
1952         
1953          IF ( nyn == ny )  THEN
1954             DO  i = nxl, nxr
1955                DO  k = nzb+1, nzt
1956                   volume_flow_initial_l(2) = volume_flow_initial_l(2) +       &
1957                                              hom_sum(k,2,0) * dzw(k)          &       
1958                                     * MERGE( 1.0_wp, 0.0_wp,                  &
1959                                              BTEST( wall_flags_0(k,ny,i), 2 ) &
1960                                            )
1961                   volume_flow_area_l(2)    = volume_flow_area_l(2) + dzw(k)   &       
1962                                     * MERGE( 1.0_wp, 0.0_wp,                  &
1963                                              BTEST( wall_flags_0(k,ny,i), 2 ) &
1964                                            )
1965                ENDDO
1966             ENDDO
1967          ENDIF
1968
1969#if defined( __parallel )
1970          CALL MPI_ALLREDUCE( volume_flow_initial_l(1), volume_flow_initial(1),&
1971                              2, MPI_REAL, MPI_SUM, comm2d, ierr )
1972          CALL MPI_ALLREDUCE( volume_flow_area_l(1), volume_flow_area(1),      &
1973                              2, MPI_REAL, MPI_SUM, comm2d, ierr )
1974
1975#else
1976          volume_flow_initial = volume_flow_initial_l
1977          volume_flow_area    = volume_flow_area_l
1978#endif 
1979
1980       ELSEIF ( TRIM( initializing_actions ) /= 'read_restart_data' )  THEN
1981
1982          volume_flow_initial_l = 0.0_wp
1983          volume_flow_area_l    = 0.0_wp
1984
1985          IF ( nxr == nx )  THEN
1986             DO  j = nys, nyn
1987                DO  k = nzb+1, nzt
1988                   volume_flow_initial_l(1) = volume_flow_initial_l(1) +       &
1989                                              u(k,j,nx) * dzw(k)               &
1990                                     * MERGE( 1.0_wp, 0.0_wp,                  &
1991                                              BTEST( wall_flags_0(k,j,nx), 1 ) &
1992                                            )
1993                   volume_flow_area_l(1)    = volume_flow_area_l(1) + dzw(k)   &
1994                                     * MERGE( 1.0_wp, 0.0_wp,                  &
1995                                              BTEST( wall_flags_0(k,j,nx), 1 ) &
1996                                            )
1997                ENDDO
1998             ENDDO
1999          ENDIF
2000         
2001          IF ( nyn == ny )  THEN
2002             DO  i = nxl, nxr
2003                DO  k = nzb+1, nzt
2004                   volume_flow_initial_l(2) = volume_flow_initial_l(2) +       &
2005                                              v(k,ny,i) * dzw(k)               &       
2006                                     * MERGE( 1.0_wp, 0.0_wp,                  &
2007                                              BTEST( wall_flags_0(k,ny,i), 2 ) &
2008                                            )
2009                   volume_flow_area_l(2)    = volume_flow_area_l(2) + dzw(k)   &       
2010                                     * MERGE( 1.0_wp, 0.0_wp,                  &
2011                                              BTEST( wall_flags_0(k,ny,i), 2 ) &
2012                                            )
2013                ENDDO
2014             ENDDO
2015          ENDIF
2016
2017#if defined( __parallel )
2018          CALL MPI_ALLREDUCE( volume_flow_initial_l(1), volume_flow_initial(1),&
2019                              2, MPI_REAL, MPI_SUM, comm2d, ierr )
2020          CALL MPI_ALLREDUCE( volume_flow_area_l(1), volume_flow_area(1),      &
2021                              2, MPI_REAL, MPI_SUM, comm2d, ierr )
2022
2023#else
2024          volume_flow_initial = volume_flow_initial_l
2025          volume_flow_area    = volume_flow_area_l
2026#endif 
2027
2028       ENDIF
2029
2030!
2031!--    In case of 'bulk_velocity' mode, volume_flow_initial is calculated
2032!--    from u|v_bulk instead
2033       IF ( TRIM( conserve_volume_flow_mode ) == 'bulk_velocity' )  THEN
2034          volume_flow_initial(1) = u_bulk * volume_flow_area(1)
2035          volume_flow_initial(2) = v_bulk * volume_flow_area(2)
2036       ENDIF
2037
2038    ENDIF
2039!
2040!-- In the following, surface properties can be further initialized with
2041!-- input from static driver file.
2042!-- At the moment this affects only default surfaces. For example,
2043!-- roughness length or sensible / latent heat fluxes can be initialized
2044!-- heterogeneously for default surfaces. Therefore, a generic routine
2045!-- from netcdf_data_input_mod is called to read a 2D array.
2046    IF ( input_pids_static )  THEN
2047!
2048!--    Allocate memory for possible static input
2049       ALLOCATE( tmp_2d%var(nys:nyn,nxl:nxr) )
2050       tmp_2d%var = 0.0_wp
2051!
2052!--    Open the static input file
2053#if defined( __netcdf )
2054       CALL open_read_file( TRIM( input_file_static ) //                    &
2055                            TRIM( coupling_char ),                          &
2056                            pids_static_id )
2057                           
2058       CALL inquire_num_variables( pids_static_id, num_vars_pids_static )
2059!
2060!--    Allocate memory to store variable names and read them
2061       ALLOCATE( vars_pids_static(1:num_vars_pids_static) )
2062       CALL inquire_variable_names( pids_static_id, vars_pids_static )
2063!
2064!--    Input roughness length.
2065       IF ( check_existence( vars_pids_static, 'z0' ) )  THEN
2066!
2067!--       Read _FillValue attribute
2068          CALL get_attribute( pids_static_id, char_fill, tmp_2d%fill,          &
2069                              .FALSE., 'z0' )                                 
2070!                                                                             
2071!--       Read variable                                                       
2072          CALL get_variable( pids_static_id, 'z0', tmp_2d%var,                 &
2073                             nxl, nxr, nys, nyn )                             
2074!                                                                             
2075!--       Initialize roughness length. Note, z0 will be only initialized at   
2076!--       default-type surfaces. At natural or urban z0 is implicitly         
2077!--       initialized bythe respective parameter lists.                       
2078!--       Initialize horizontal surface elements.                             
2079          CALL init_single_surface_properties( surf_def_h(0)%z0,               &
2080                                               tmp_2d%var,                     &
2081                                               surf_def_h(0)%ns,               &
2082                                               tmp_2d%fill,                    &
2083                                               surf_def_h(0)%i,                &
2084                                               surf_def_h(0)%j )               
2085!                                                                             
2086!--       Initialize roughness also at vertical surface elements.             
2087!--       Note, the actual 2D input arrays are only defined on the             
2088!--       subdomain. Therefore, pass the index arrays with their respective   
2089!--       offset values.                                                       
2090          DO  l = 0, 3                                                         
2091             CALL init_single_surface_properties(                              &
2092                                         surf_def_v(l)%z0,                     &
2093                                         tmp_2d%var,                           &
2094                                         surf_def_v(l)%ns,                     &
2095                                         tmp_2d%fill,                          &
2096                                         surf_def_v(l)%i + surf_def_v(l)%ioff, &
2097                                         surf_def_v(l)%j + surf_def_v(l)%joff )
2098          ENDDO
2099         
2100       ENDIF
2101!
2102!--    Additional variables, e.g. shf, qsws, etc, can be initialized the
2103!--    same way.
2104                           
2105!
2106!--    Finally, close the input file.
2107       CALL close_input_file( pids_static_id )
2108#endif
2109       DEALLOCATE( tmp_2d%var )
2110    ENDIF
2111!
2112!-- Finally, if random_heatflux is set, disturb shf at horizontal
2113!-- surfaces. Actually, this should be done in surface_mod, where all other
2114!-- initializations of surface quantities are done. However, this
2115!-- would create a ring dependency, hence, it is done here. Maybe delete
2116!-- disturb_heatflux and tranfer the respective code directly into the
2117!-- initialization in surface_mod.         
2118    IF ( TRIM( initializing_actions ) /= 'read_restart_data'  .AND.            &
2119         TRIM( initializing_actions ) /= 'cyclic_fill' )  THEN
2120 
2121       IF ( use_surface_fluxes  .AND.  constant_heatflux  .AND.                &
2122            random_heatflux )  THEN
2123          IF ( surf_def_h(0)%ns >= 1 )  CALL disturb_heatflux( surf_def_h(0) )
2124          IF ( surf_lsm_h%ns    >= 1 )  CALL disturb_heatflux( surf_lsm_h    )
2125          IF ( surf_usm_h%ns    >= 1 )  CALL disturb_heatflux( surf_usm_h    )
2126       ENDIF
2127    ENDIF
2128
2129!
2130!-- Compute total sum of grid points and the mean surface level height for each
2131!-- statistic region. These are mainly used for horizontal averaging of
2132!-- turbulence statistics.
2133!-- ngp_2dh: number of grid points of a horizontal cross section through the
2134!--          respective statistic region
2135!-- ngp_3d:  number of grid points of the respective statistic region
2136    ngp_2dh_outer_l   = 0
2137    ngp_2dh_outer     = 0
2138    ngp_2dh_s_inner_l = 0
2139    ngp_2dh_s_inner   = 0
2140    ngp_2dh_l         = 0
2141    ngp_2dh           = 0
2142    ngp_3d_inner_l    = 0.0_wp
2143    ngp_3d_inner      = 0
2144    ngp_3d            = 0
2145    ngp_sums          = ( nz + 2 ) * ( pr_palm + max_pr_user )
2146
2147    mean_surface_level_height   = 0.0_wp
2148    mean_surface_level_height_l = 0.0_wp
2149!
2150!-- To do: New concept for these non-topography grid points!
2151    DO  sr = 0, statistic_regions
2152       DO  i = nxl, nxr
2153          DO  j = nys, nyn
2154             IF ( rmask(j,i,sr) == 1.0_wp )  THEN
2155!
2156!--             All xy-grid points
2157                ngp_2dh_l(sr) = ngp_2dh_l(sr) + 1
2158!
2159!--             Determine mean surface-level height. In case of downward-
2160!--             facing walls are present, more than one surface level exist.
2161!--             In this case, use the lowest surface-level height.
2162                IF ( surf_def_h(0)%start_index(j,i) <=                         &
2163                     surf_def_h(0)%end_index(j,i) )  THEN
2164                   m = surf_def_h(0)%start_index(j,i)
2165                   k = surf_def_h(0)%k(m)
2166                   mean_surface_level_height_l(sr) =                           &
2167                                       mean_surface_level_height_l(sr) + zw(k-1)
2168                ENDIF
2169                IF ( surf_lsm_h%start_index(j,i) <=                            &
2170                     surf_lsm_h%end_index(j,i) )  THEN
2171                   m = surf_lsm_h%start_index(j,i)
2172                   k = surf_lsm_h%k(m)
2173                   mean_surface_level_height_l(sr) =                           &
2174                                       mean_surface_level_height_l(sr) + zw(k-1)
2175                ENDIF
2176                IF ( surf_usm_h%start_index(j,i) <=                            &
2177                     surf_usm_h%end_index(j,i) )  THEN
2178                   m = surf_usm_h%start_index(j,i)
2179                   k = surf_usm_h%k(m)
2180                   mean_surface_level_height_l(sr) =                           &
2181                                       mean_surface_level_height_l(sr) + zw(k-1)
2182                ENDIF
2183
2184                k_surf = k - 1
2185
2186                DO  k = nzb, nzt+1
2187!
2188!--                xy-grid points above topography
2189                   ngp_2dh_outer_l(k,sr) = ngp_2dh_outer_l(k,sr)     +         &
2190                                  MERGE( 1, 0, BTEST( wall_flags_0(k,j,i), 24 ) )
2191
2192                   ngp_2dh_s_inner_l(k,sr) = ngp_2dh_s_inner_l(k,sr) +         &
2193                                  MERGE( 1, 0, BTEST( wall_flags_0(k,j,i), 22 ) )
2194
2195                ENDDO
2196!
2197!--             All grid points of the total domain above topography
2198                ngp_3d_inner_l(sr) = ngp_3d_inner_l(sr) + ( nz - k_surf + 2 )
2199
2200
2201
2202             ENDIF
2203          ENDDO
2204       ENDDO
2205    ENDDO
2206
2207    sr = statistic_regions + 1
2208#if defined( __parallel )
2209    IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
2210    CALL MPI_ALLREDUCE( ngp_2dh_l(0), ngp_2dh(0), sr, MPI_INTEGER, MPI_SUM,    &
2211                        comm2d, ierr )
2212    IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
2213    CALL MPI_ALLREDUCE( ngp_2dh_outer_l(0,0), ngp_2dh_outer(0,0), (nz+2)*sr,   &
2214                        MPI_INTEGER, MPI_SUM, comm2d, ierr )
2215    IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
2216    CALL MPI_ALLREDUCE( ngp_2dh_s_inner_l(0,0), ngp_2dh_s_inner(0,0),          &
2217                        (nz+2)*sr, MPI_INTEGER, MPI_SUM, comm2d, ierr )
2218    IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
2219    CALL MPI_ALLREDUCE( ngp_3d_inner_l(0), ngp_3d_inner_tmp(0), sr, MPI_REAL,  &
2220                        MPI_SUM, comm2d, ierr )
2221    ngp_3d_inner = INT( ngp_3d_inner_tmp, KIND = SELECTED_INT_KIND( 18 ) )
2222    IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
2223    CALL MPI_ALLREDUCE( mean_surface_level_height_l(0),                        &
2224                        mean_surface_level_height(0), sr, MPI_REAL,            &
2225                        MPI_SUM, comm2d, ierr )
2226    mean_surface_level_height = mean_surface_level_height / REAL( ngp_2dh )
2227#else
2228    ngp_2dh         = ngp_2dh_l
2229    ngp_2dh_outer   = ngp_2dh_outer_l
2230    ngp_2dh_s_inner = ngp_2dh_s_inner_l
2231    ngp_3d_inner    = INT( ngp_3d_inner_l, KIND = SELECTED_INT_KIND( 18 ) )
2232    mean_surface_level_height = mean_surface_level_height_l / REAL( ngp_2dh_l )
2233#endif
2234
2235    ngp_3d = INT ( ngp_2dh, KIND = SELECTED_INT_KIND( 18 ) ) * &
2236             INT ( (nz + 2 ), KIND = SELECTED_INT_KIND( 18 ) )
2237
2238!
2239!-- Set a lower limit of 1 in order to avoid zero divisions in flow_statistics,
2240!-- buoyancy, etc. A zero value will occur for cases where all grid points of
2241!-- the respective subdomain lie below the surface topography
2242    ngp_2dh_outer   = MAX( 1, ngp_2dh_outer(:,:)   ) 
2243    ngp_3d_inner    = MAX( INT(1, KIND = SELECTED_INT_KIND( 18 )),             &
2244                           ngp_3d_inner(:) )
2245    ngp_2dh_s_inner = MAX( 1, ngp_2dh_s_inner(:,:) ) 
2246
2247    DEALLOCATE( mean_surface_level_height_l, ngp_2dh_l, ngp_2dh_outer_l,       &
2248                ngp_3d_inner_l, ngp_3d_inner_tmp )
2249!
2250!-- Initialize surface forcing corresponding to large-scale forcing. Therein,
2251!-- initialize heat-fluxes, etc. via datatype. Revise it later!
2252    IF ( large_scale_forcing .AND. lsf_surf )  THEN
2253       IF ( use_surface_fluxes  .AND.  constant_heatflux )  THEN
2254          CALL ls_forcing_surf ( simulated_time )
2255       ENDIF
2256    ENDIF
2257!
2258!-- Initializae 3D offline nesting in COSMO model and read data from
2259!-- external NetCDF file.
2260    IF ( nesting_offline )  CALL nesting_offl_init
2261!
2262!-- Initialize quantities for special advections schemes
2263    CALL init_advec
2264
2265!
2266!-- Impose random perturbation on the horizontal velocity field and then
2267!-- remove the divergences from the velocity field at the initial stage
2268    IF ( create_disturbances  .AND.  disturbance_energy_limit /= 0.0_wp  .AND. &
2269         TRIM( initializing_actions ) /= 'read_restart_data'  .AND.            &
2270         TRIM( initializing_actions ) /= 'cyclic_fill' )  THEN
2271
2272       IF ( debug_output )  CALL debug_message( 'creating disturbances + applying pressure solver', 'start' )
2273!
2274!--    Needed for both disturb_field and pres
2275!$ACC DATA &
2276!$ACC CREATE(tend(nzb:nzt+1,nysg:nyng,nxlg:nxrg)) &
2277!$ACC COPY(u(nzb:nzt+1,nysg:nyng,nxlg:nxrg)) &
2278!$ACC COPY(v(nzb:nzt+1,nysg:nyng,nxlg:nxrg))
2279
2280       CALL disturb_field( 'u', tend, u )
2281       CALL disturb_field( 'v', tend, v )
2282
2283!$ACC DATA &
2284!$ACC CREATE(d(nzb+1:nzt,nys:nyn,nxl:nxr)) &
2285!$ACC COPY(w(nzb:nzt+1,nysg:nyng,nxlg:nxrg)) &
2286!$ACC COPY(p(nzb:nzt+1,nysg:nyng,nxlg:nxrg)) &
2287!$ACC COPYIN(rho_air(nzb:nzt+1), rho_air_zw(nzb:nzt+1)) &
2288!$ACC COPYIN(ddzu(1:nzt+1), ddzw(1:nzt+1)) &
2289!$ACC COPYIN(wall_flags_0(nzb:nzt+1,nysg:nyng,nxlg:nxrg)) &
2290!$ACC COPYIN(bc_h(0:1)) &
2291!$ACC COPYIN(bc_h(0)%i(1:bc_h(0)%ns)) &
2292!$ACC COPYIN(bc_h(0)%j(1:bc_h(0)%ns)) &
2293!$ACC COPYIN(bc_h(0)%k(1:bc_h(0)%ns)) &
2294!$ACC COPYIN(bc_h(1)%i(1:bc_h(1)%ns)) &
2295!$ACC COPYIN(bc_h(1)%j(1:bc_h(1)%ns)) &
2296!$ACC COPYIN(bc_h(1)%k(1:bc_h(1)%ns))
2297
2298       n_sor = nsor_ini
2299       CALL pres
2300       n_sor = nsor
2301
2302!$ACC END DATA
2303!$ACC END DATA
2304
2305       IF ( debug_output )  CALL debug_message( 'creating disturbances + applying pressure solver', 'end' )
2306
2307    ENDIF
2308
2309    IF ( .NOT. ocean_mode )  THEN
2310
2311       ALLOCATE( hyp(nzb:nzt+1) )
2312       ALLOCATE( d_exner(nzb:nzt+1) )
2313       ALLOCATE( exner(nzb:nzt+1) )
2314       ALLOCATE( hyrho(nzb:nzt+1) )
2315!
2316!--    Check temperature in case of too large domain height
2317       DO  k = nzb, nzt+1
2318          IF ( ( pt_surface * exner_function(surface_pressure * 100.0_wp) - g/c_p * zu(k) ) < 0.0_wp )  THEN
2319             WRITE( message_string, * )  'absolute temperature < 0.0 at zu(', k, &
2320                                         ') = ', zu(k)
2321             CALL message( 'init_3d_model', 'PA0142', 1, 2, 0, 6, 0 )
2322          ENDIF
2323       ENDDO
2324
2325!
2326!--    Calculate vertical profile of the hydrostatic pressure (hyp)
2327       hyp    = barometric_formula(zu, pt_surface * exner_function(surface_pressure * 100.0_wp), surface_pressure * 100.0_wp)
2328       d_exner = exner_function_invers(hyp)
2329       exner = 1.0_wp / exner_function_invers(hyp)
2330       hyrho  = ideal_gas_law_rho_pt(hyp, pt_init)
2331!
2332!--    Compute reference density
2333       rho_surface = ideal_gas_law_rho(surface_pressure * 100.0_wp, pt_surface * exner_function(surface_pressure * 100.0_wp))
2334
2335    ENDIF
2336
2337!
2338!-- If required, initialize particles
2339    IF ( agents_active )  CALL mas_init
2340!
2341!-- Initialization of synthetic turbulence generator
2342    IF ( use_syn_turb_gen )  CALL stg_init
2343!
2344!-- Initializing actions for all other modules
2345    CALL module_interface_init
2346!
2347!-- Initialize surface layer (done after LSM as roughness length are required
2348!-- for initialization
2349    IF ( constant_flux_layer )  CALL init_surface_layer_fluxes
2350!
2351!-- Initialize surface data output
2352    IF ( surface_output )  CALL surface_data_output_init
2353!
2354!-- Initialize the ws-scheme.   
2355    IF ( ws_scheme_sca .OR. ws_scheme_mom )  CALL ws_init
2356!
2357!-- Perform post-initializing checks for all other modules
2358    CALL module_interface_init_checks
2359
2360!
2361!-- Setting weighting factors for calculation of perturbation pressure
2362!-- and turbulent quantities from the RK substeps
2363    IF ( TRIM(timestep_scheme) == 'runge-kutta-3' )  THEN      ! for RK3-method
2364
2365       weight_substep(1) = 1._wp/6._wp
2366       weight_substep(2) = 3._wp/10._wp
2367       weight_substep(3) = 8._wp/15._wp
2368
2369       weight_pres(1)    = 1._wp/3._wp
2370       weight_pres(2)    = 5._wp/12._wp
2371       weight_pres(3)    = 1._wp/4._wp
2372
2373    ELSEIF ( TRIM(timestep_scheme) == 'runge-kutta-2' )  THEN  ! for RK2-method
2374
2375       weight_substep(1) = 1._wp/2._wp
2376       weight_substep(2) = 1._wp/2._wp
2377         
2378       weight_pres(1)    = 1._wp/2._wp
2379       weight_pres(2)    = 1._wp/2._wp       
2380
2381    ELSE                                     ! for Euler-method
2382
2383       weight_substep(1) = 1.0_wp     
2384       weight_pres(1)    = 1.0_wp                   
2385
2386    ENDIF
2387
2388!
2389!-- Initialize Rayleigh damping factors
2390    rdf    = 0.0_wp
2391    rdf_sc = 0.0_wp
2392    IF ( rayleigh_damping_factor /= 0.0_wp )  THEN
2393
2394       IF (  .NOT.  ocean_mode )  THEN
2395          DO  k = nzb+1, nzt
2396             IF ( zu(k) >= rayleigh_damping_height )  THEN
2397                rdf(k) = rayleigh_damping_factor *                             &
2398                      ( SIN( pi * 0.5_wp * ( zu(k) - rayleigh_damping_height ) &
2399                             / ( zu(nzt) - rayleigh_damping_height ) )         &
2400                      )**2
2401             ENDIF
2402          ENDDO
2403       ELSE
2404!
2405!--       In ocean mode, rayleigh damping is applied in the lower part of the
2406!--       model domain
2407          DO  k = nzt, nzb+1, -1
2408             IF ( zu(k) <= rayleigh_damping_height )  THEN
2409                rdf(k) = rayleigh_damping_factor *                             &
2410                      ( SIN( pi * 0.5_wp * ( rayleigh_damping_height - zu(k) ) &
2411                             / ( rayleigh_damping_height - zu(nzb+1) ) )       &
2412                      )**2
2413             ENDIF
2414          ENDDO
2415       ENDIF
2416
2417    ENDIF
2418    IF ( scalar_rayleigh_damping )  rdf_sc = rdf
2419
2420!
2421!-- Initialize the starting level and the vertical smoothing factor used for
2422!-- the external pressure gradient
2423    dp_smooth_factor = 1.0_wp
2424    IF ( dp_external )  THEN
2425!
2426!--    Set the starting level dp_level_ind_b only if it has not been set before
2427!--    (e.g. in init_grid).
2428       IF ( dp_level_ind_b == 0 )  THEN
2429          ind_array = MINLOC( ABS( dp_level_b - zu ) )
2430          dp_level_ind_b = ind_array(1) - 1 + nzb 
2431                                        ! MINLOC uses lower array bound 1
2432       ENDIF
2433       IF ( dp_smooth )  THEN
2434          dp_smooth_factor(:dp_level_ind_b) = 0.0_wp
2435          DO  k = dp_level_ind_b+1, nzt
2436             dp_smooth_factor(k) = 0.5_wp * ( 1.0_wp + SIN( pi *               &
2437                        ( REAL( k - dp_level_ind_b, KIND=wp ) /                &
2438                          REAL( nzt - dp_level_ind_b, KIND=wp ) - 0.5_wp ) ) )
2439          ENDDO
2440       ENDIF
2441    ENDIF
2442
2443!
2444!-- Initialize damping zone for the potential temperature in case of
2445!-- non-cyclic lateral boundaries. The damping zone has the maximum value
2446!-- at the inflow boundary and decreases to zero at pt_damping_width.
2447    ptdf_x = 0.0_wp
2448    ptdf_y = 0.0_wp
2449    IF ( bc_lr_dirrad )  THEN
2450       DO  i = nxl, nxr
2451          IF ( ( i * dx ) < pt_damping_width )  THEN
2452             ptdf_x(i) = pt_damping_factor * ( SIN( pi * 0.5_wp *              &
2453                            REAL( pt_damping_width - i * dx, KIND=wp ) / (     &
2454                            REAL( pt_damping_width, KIND=wp ) ) ) )**2 
2455          ENDIF
2456       ENDDO
2457    ELSEIF ( bc_lr_raddir )  THEN
2458       DO  i = nxl, nxr
2459          IF ( ( i * dx ) > ( nx * dx - pt_damping_width ) )  THEN
2460             ptdf_x(i) = pt_damping_factor *                                   &
2461                         SIN( pi * 0.5_wp *                                    &
2462                                 ( ( i - nx ) * dx + pt_damping_width ) /      &
2463                                 REAL( pt_damping_width, KIND=wp ) )**2
2464          ENDIF
2465       ENDDO 
2466    ELSEIF ( bc_ns_dirrad )  THEN
2467       DO  j = nys, nyn
2468          IF ( ( j * dy ) > ( ny * dy - pt_damping_width ) )  THEN
2469             ptdf_y(j) = pt_damping_factor *                                   &
2470                         SIN( pi * 0.5_wp *                                    &
2471                                 ( ( j - ny ) * dy + pt_damping_width ) /      &
2472                                 REAL( pt_damping_width, KIND=wp ) )**2
2473          ENDIF
2474       ENDDO 
2475    ELSEIF ( bc_ns_raddir )  THEN
2476       DO  j = nys, nyn
2477          IF ( ( j * dy ) < pt_damping_width )  THEN
2478             ptdf_y(j) = pt_damping_factor *                                   &
2479                         SIN( pi * 0.5_wp *                                    &
2480                                ( pt_damping_width - j * dy ) /                &
2481                                REAL( pt_damping_width, KIND=wp ) )**2
2482          ENDIF
2483       ENDDO
2484    ENDIF
2485
2486!
2487!-- Input binary data file is not needed anymore. This line must be placed
2488!-- after call of user_init!
2489    CALL close_file( 13 )
2490!
2491!-- In case of nesting, put an barrier to assure that all parent and child
2492!-- domains finished initialization.
2493#if defined( __parallel )
2494    IF ( nested_run )  CALL MPI_BARRIER( MPI_COMM_WORLD, ierr )
2495#endif
2496
2497
2498    CALL location_message( 'model initialization', 'finished' )
2499
2500 END SUBROUTINE init_3d_model
Note: See TracBrowser for help on using the repository browser.