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

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

Bugfix, initialize strings with intent(out) attribute, delete debug prints

  • Property svn:keywords set to Id
File size: 46.2 KB
Line 
1!> @file parin.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: parin.f90 3649 2019-01-02 16:52:21Z knoop $
27! Delete debug-print statements
28!
29! 3646 2018-12-28 17:58:49Z kanani
30! Bugfix: for restarts, reset data_output_during_spinup to FALSE to enable
31! correct calculation of ntdim in check_parameters
32!
33! 3637 2018-12-20 01:51:36Z knoop
34! Implementation of the PALM module interface
35!
36! 3569 2018-11-27 17:03:40Z kanani
37! dom_dwd_user, Schrempf:
38! Remove uv exposure model code, this is now part of biometeorology_mod.
39!
40! 3545 2018-11-21 11:19:41Z gronemeier
41! remove rans_mode from initialization_parameters
42!
43! 3525 2018-11-14 16:06:14Z kanani
44! Changes related to clean-up of biometeorology (dom_dwd_user)
45!
46! 3473 2018-10-30 20:50:15Z suehring
47! Add virtual measurement module
48!
49! 3472 2018-10-30 20:43:50Z suehring
50! Add indoor model (kanani, srissman, tlang),
51! minor formatting
52!
53! 3467 2018-10-30 19:05:21Z suehring
54! Implementation of a new aerosol module salsa.
55!
56! 3448 2018-10-29 18:14:31Z kanani
57! Add biometeorology
58!
59! 3435 2018-10-26 18:25:44Z gronemeier
60! Add mask_k_over_surface
61!
62! 3421 2018-10-24 18:39:32Z gronemeier
63! Added module for data output at surfaces
64!
65! 3355 2018-10-16 14:03:34Z knoop
66! - offline nesting separated from large-scale forcing module
67! - top boundary condition for pressure in offline nesting changed
68!
69! 3343 2018-10-15 10:38:52Z suehring
70! Introduced reading of date_init to inipar.(Russo)
71! Add extra profiles for chemistry (basit)
72!
73! 3294 2018-10-01 02:37:10Z raasch
74! changes concerning modularization of ocean option
75!
76! 3274 2018-09-24 15:42:55Z knoop
77! Modularization of all bulk cloud physics code components
78!
79! 3248 2018-09-14 09:42:06Z sward
80! Minor formating changes
81!
82! 3246 2018-09-13 15:14:50Z sward
83! Added error handling for input namelist via parin_fail_message
84!
85! 3240 2018-09-12 12:04:40Z Giersch
86! A check that controls the number of user-defined profiles on the restart file
87! with the one given for the current run has been added.
88!
89! 3204 2018-08-23 10:49:05Z raasch
90! additional check for nz
91!
92! 3184 2018-07-27 17:13:09Z suehring
93! Bugfix, comment setting of chemistry and passive scalar top boundary condition
94! in case of offline nesting
95!
96! 3183 2018-07-27 14:25:55Z suehring
97! Rename variables and boundary conditions in mesoscale-offline nesting mode
98!
99! 3182 2018-07-27 13:36:03Z suehring
100! Added multi agent system
101!
102! 3157 2018-07-19 21:08:49Z maronga
103! added use_free_convection_scaling
104!
105! 3083 2018-06-19 14:03:12Z gronemeier
106! Added rans_const_c and rans_const_sigma as input parameters (TG)
107!
108! 3065 2018-06-12 07:03:02Z Giersch
109! New initialization parameters added
110!
111! 3049 2018-05-29 13:52:36Z Giersch
112! Error messages revised
113!
114! 3045 2018-05-28 07:55:41Z Giersch
115! z_max_do2d removed, error messages revised
116!
117! 2995 2018-04-19 12:13:16Z Giersch
118! time_since_reference_point must be calculated/initialized before the first 
119! call of functions related to the radiation model which occur in
120! time_integration_spinup or time_integration
121!
122! 2980 2018-04-17 15:19:27Z suehring
123! Revise message call
124!
125! 2975 2018-04-16 15:22:20Z suehring
126! - Informative message when initializing_actions has been changed
127!   to set_constant_profile in child domain
128! - Change location in message call
129!
130! 2967 2018-04-13 11:22:08Z raasch
131! bugfix: missing parallel cpp-directives added
132!
133! 2941 2018-04-03 11:54:58Z kanani
134! Fix for spinup in case of restart run
135!
136! 2938 2018-03-27 15:52:42Z suehring
137! Change initialization in case child domain should be initialized with Inifor.
138!
139! 2936 2018-03-27 14:49:27Z suehring
140! inipar renamed to initialization_parameters.
141! d3par renamed to runtime_parameters.
142!
143! 2921 2018-03-22 15:05:23Z Giersch
144! Activation of spinup has been moved from lsm/usm_parin to parin itself
145!
146! 2906 2018-03-19 08:56:40Z Giersch
147! ENVIRONMENT variables read/write_svf has been added
148!
149! 2894 2018-03-15 09:17:58Z Giersch
150! read_var_list has been renamed to rrd_global, all module related _parin
151! routines are called before reading the global restart data to overwrite them
152! in case of restart runs
153!
154! 2881 2018-03-13 16:24:40Z suehring
155! Added flag for switching on/off calculation of soil moisture
156!
157! 2849 2018-03-05 10:49:33Z Giersch
158! Position of d3par namelist in parameter file is unimportant now
159!
160! 2826 2018-02-21 12:39:28Z Giersch
161! Bugfix in setting the default boundary conditions for nest domains
162!
163! 2817 2018-02-19 16:32:21Z knoop
164! Preliminary gust module interface implemented
165!
166! 2773 2018-01-30 14:12:54Z suehring
167! Nesting for chemical species implemented
168!
169! 2766 2018-01-22 17:17:47Z kanani
170! Removed preprocessor directive __chem
171!
172! 2718 2018-01-02 08:49:38Z maronga
173! Corrected "Former revisions" section
174!
175! 2696 2017-12-14 17:12:51Z kanani
176! Change in file header (GPL part)
177! Implementation of uv exposure model (FK)
178! Added rans_mode and turbulence_closure to inipar (TG)
179! Implementation of chemistry module
180! Sorting of USE list (FK)
181! Forcing implemented, and initialization with inifor (MS)
182!
183! 2600 2017-11-01 14:11:20Z raasch
184! some comments added and variables renamed concerning r2599
185!
186! 2599 2017-11-01 13:18:45Z hellstea
187! The i/o grouping is updated to work correctly also in nested runs.
188!
189! 2575 2017-10-24 09:57:58Z maronga
190! Renamed phi -> latitude, added longitude
191!
192! 2563 2017-10-19 15:36:10Z Giersch
193! Changed position where restart files are closed.
194!
195! 2550 2017-10-16 17:12:01Z boeske
196! Added complex_terrain
197!
198! 2544 2017-10-13 18:09:32Z maronga
199! Moved day_of_year_init and time_utc_init to inipar.
200!
201! 2397 2017-09-04 16:22:48Z suehring
202! Enable initialization of 3d model by user in the child domain.
203!
204! 2375 2017-08-29 14:10:28Z schwenkel
205! Added aerosol initialization for bulk microphysics
206!
207! 2372 2017-08-25 12:37:32Z sward
208! y_shift added to namelist
209!
210! 2365 2017-08-21 14:59:59Z kanani
211! Vertical grid nesting: add vnest_start_time to d3par (SadiqHuq)
212!
213! 2339 2017-08-07 13:55:26Z gronemeier
214! corrected timestamp in header
215!
216! 2338 2017-08-07 12:15:38Z gronemeier
217! Modularize 1D model
218!
219! 2310 2017-07-11 09:37:02Z gronemeier
220! Bugfix: re-arranged call for error messages for ENVPAR file
221!
222! 2304 2017-07-04 14:35:55Z suehring
223! Bugfix, enable restarts for child domain.
224!
225! 2298 2017-06-29 09:28:18Z raasch
226! -return_addres, return_username in ENVPAR, -cross_ts_uymax, cross_ts_uymin in
227! d3par
228!
229! 2296 2017-06-28 07:53:56Z maronga
230! Added parameters for model spinup
231!
232! 2292 2017-06-20 09:51:42Z schwenkel
233! Implementation of new microphysic scheme: cloud_scheme = 'morrison'
234! includes two more prognostic equations for cloud drop concentration (nc) 
235! and cloud water content (qc).
236!
237! 2267 2017-06-09 09:33:25Z gronemeier
238! Bugfix: removed skipping of reading namelists in case of omitted d3par
239!
240! 2259 2017-06-08 09:09:11Z gronemeier
241! Implemented synthetic turbulence generator
242!
243! 2233 2017-05-30 18:08:54Z suehring
244!
245! 2232 2017-05-30 17:47:52Z suehring
246! typo corrected
247! +wall_salinityflux
248! +tunnel_height, tunnel_lenght, tunnel_width_x, tunnel_width_y,
249!  tunnel_wall_depth
250!
251! 2118 2017-01-17 16:38:49Z raasch
252! -background_communication from inipar
253!
254! 2050 2016-11-08 15:00:55Z gronemeier
255! Implement turbulent outflow condition
256!
257! 2037 2016-10-26 11:15:40Z knoop
258! Anelastic approximation implemented
259!
260! 2035 2016-10-24 15:06:17Z suehring
261! Remove check for npex and npey in nesting case
262!
263! 2011 2016-09-19 17:29:57Z kanani
264! Added flag lsf_exception to allow explicit enabling of large scale forcing
265! together with buildings on flat terrain.
266!
267! 2007 2016-08-24 15:47:17Z kanani
268! Added call to urban surface model for reading of &urban_surface_par
269!
270! 2004 2016-08-24 10:25:59Z suehring
271! Humidity and passive scalar treated separately in nesting mode
272!
273! 2000 2016-08-20 18:09:15Z knoop
274! Forced header and separation lines into 80 columns
275!
276! 1992 2016-08-12 15:14:59Z suehring
277! +top_scalarflux
278!
279! 1960 2016-07-12 16:34:24Z suehring
280! Allocation of s_init
281!
282! 1957 2016-07-07 10:43:48Z suehring
283! flight module added
284!
285! 1955 2016-07-01 12:38:59Z hellstea
286! The parameter intializating_actions is set to 'set_constant_profiles for
287! all nest domains in order to make sure that diagnostic variables are properly
288! initialized for nest domains. Prognostic variables are later initialized by
289! interpolation from the parent domain.
290!
291! 1917 2016-05-27 14:28:12Z witha
292! Initial version of purely vertical nesting introduced.
293!
294! 1914 2016-05-26 14:44:07Z witha
295! Added call to wind turbine model for reading of &wind_turbine_par
296!
297! 1849 2016-04-08 11:33:18Z hoffmann
298! Adapted for modularization of microphysics
299!
300! 1833 2016-04-07 14:23:03Z raasch
301! call of spectra_parin
302!
303! 1831 2016-04-07 13:15:51Z hoffmann
304! turbulence renamed collision_turbulence, drizzle renamed
305! cloud_water_sedimentation
306! curvature_solution_effects removed
307!
308! 1826 2016-04-07 12:01:39Z maronga
309! Added call to radiation model for reading of &radiation_par.
310! Added call to plant canopy model for reading of &canopy_par.
311!
312! 1817 2016-04-06 15:44:20Z maronga
313! Added call to land surface model for reading of &lsm_par
314!
315! 1804 2016-04-05 16:30:18Z maronga
316! Removed code for parameter file check (__check)
317!
318! 1783 2016-03-06 18:36:17Z raasch
319! +netcdf_deflate in d3par, netcdf module and variable names changed
320!
321! 1764 2016-02-28 12:45:19Z raasch
322! cpp-statements for nesting removed, explicit settings of boundary conditions
323! in nest domains,
324! bugfix: npex/npey message moved from inipar to d3par
325! bugfix: check of lateral boundary conditions from check_parameters to here,
326! because they will be already used in init_pegrid and init_grid
327!
328! 1762 2016-02-25 12:31:13Z hellstea
329! Introduction of nested domain feature
330!
331! 1691 2015-10-26 16:17:44Z maronga
332! Added parameter most_method. Renamed prandtl_layer to constant_flux_layer.
333!
334! 1682 2015-10-07 23:56:08Z knoop
335! Code annotations made doxygen readable
336!
337! 1560 2015-03-06 10:48:54Z keck
338! +recycling_yshift
339!
340! 1496 2014-12-02 17:25:50Z maronga
341! Renamed: "radiation -> "cloud_top_radiation"
342!
343! 1484 2014-10-21 10:53:05Z kanani
344! Changes due to new module structure of the plant canopy model:
345!   canopy-model related parameters moved to new package canopy_par in
346!   subroutine package_parin
347!
348! 1429 2014-07-15 12:53:45Z knoop
349! +ensemble_member_nr to prepare the random_generator for ensemble runs
350!
351! 1402 2014-05-09 14:25:13Z raasch
352! location messages modified, progress_bar_disabled included in envpar-NAMELIST
353!
354! 1384 2014-05-02 14:31:06Z raasch
355! location messages added
356!
357! 1365 2014-04-22 15:03:56Z boeske
358! Usage of large scale forcing enabled:
359! +use_subsidence_tendencies
360!
361! 1361 2014-04-16 15:17:48Z hoffmann
362! +call_microphysics_at_all_substeps
363!
364! 1359 2014-04-11 17:15:14Z hoffmann
365! REAL constants provided with KIND-attribute
366!
367! 1353 2014-04-08 15:21:23Z heinze
368! REAL constants provided with KIND-attribute
369!
370! 1327 2014-03-21 11:00:16Z raasch
371! -data_output_format, do3d_compress, do3d_comp_prec
372!
373! 1320 2014-03-20 08:40:49Z raasch
374! ONLY-attribute added to USE-statements,
375! kind-parameters added to all INTEGER and REAL declaration statements,
376! kinds are defined in new module kinds,
377! old module precision_kind is removed,
378! revision history before 2012 removed,
379! comment fields (!:) to be used for variable explanations added to
380! all variable declaration statements
381!
382! 1318 2014-03-17 13:35:16Z raasch
383! +cpu_log_barrierwait in d3par
384!
385! 1301 2014-03-06 13:29:46Z heinze
386! +large_scale_subsidence
387!
388! 1241 2013-10-30 11:36:58Z heinze
389! +nudging
390! +large_scale_forcing
391!
392! 1216 2013-08-26 09:31:42Z raasch
393! +transpose_compute_overlap in inipar
394!
395! 1195 2013-07-01 12:27:57Z heinze
396! Bugfix: allocate ref_state
397!
398! 1179 2013-06-14 05:57:58Z raasch
399! +reference_state in inipar
400!
401! 1159 2013-05-21 11:58:22Z fricke
402! +use_cmax
403!
404! 1128 2013-04-12 06:19:32Z raasch
405! +background_communication in inipar
406!
407! 1115 2013-03-26 18:16:16Z hoffmann
408! unused variables removed
409!
410! 1092 2013-02-02 11:24:22Z raasch
411! unused variables removed
412!
413! 1065 2012-11-22 17:42:36Z hoffmann
414! +nc, c_sedimentation, limiter_sedimentation, turbulence
415! -mu_constant, mu_constant_value
416!
417! 1053 2012-11-13 17:11:03Z hoffmann
418! necessary expansions according to the two new prognostic equations (nr, qr)
419! of the two-moment cloud physics scheme and steering parameters:
420! +*_init, *_surface, *_surface_initial_change, *_vertical_gradient,
421! +*_vertical_gradient_level, surface_waterflux_*,
422! +cloud_scheme, drizzle, mu_constant, mu_constant_value, ventilation_effect
423!
424! 1036 2012-10-22 13:43:42Z raasch
425! code put under GPL (PALM 3.9)
426!
427! 1015 2012-09-27 09:23:24Z raasch
428! -adjust_mixing_length
429!
430! 1003 2012-09-14 14:35:53Z raasch
431! -grid_matching
432!
433! 1001 2012-09-13 14:08:46Z raasch
434! -cut_spline_overshoot, long_filter_factor, overshoot_limit_*, ups_limit_*
435!
436! 996 2012-09-07 10:41:47Z raasch
437! -use_prior_plot1d_parameters
438!
439! 978 2012-08-09 08:28:32Z fricke
440! -km_damp_max, outflow_damping_width
441! +pt_damping_factor, pt_damping_width
442! +z0h_factor
443!
444! 964 2012-07-26 09:14:24Z raasch
445! -cross_normalized_x, cross_normalized_y, cross_xtext, z_max_do1d,
446! z_max_do1d_normalized
447!
448! 940 2012-07-09 14:31:00Z raasch
449! +neutral in inipar
450!
451! 927 2012-06-06 19:15:04Z raasch
452! +masking_method in inipar
453!
454! 824 2012-02-17 09:09:57Z raasch
455! +curvature_solution_effects in inipar
456!
457! 809 2012-01-30 13:32:58Z maronga
458! Bugfix: replaced .AND. and .NOT. with && and ! in the preprocessor directives
459!
460! 807 2012-01-25 11:53:51Z maronga
461! New cpp directive "__check" implemented which is used by check_namelist_files
462!
463! Revision 1.1  1997/07/24 11:22:50  raasch
464! Initial revision
465!
466!
467! Description:
468! ------------
469!> This subroutine reads variables controling the run from the NAMELIST files
470!>
471!> @todo: Revise max_pr_cs (profiles for chemistry)
472!------------------------------------------------------------------------------!
473 SUBROUTINE parin
474 
475
476    USE arrays_3d,                                                             &
477        ONLY:  pt_init, q_init, ref_state, s_init, sa_init,                    &
478               ug, u_init, v_init, vg
479
480    USE chem_modules
481
482    USE control_parameters
483
484    USE cpulog,                                                                &
485        ONLY:  cpu_log_barrierwait
486
487    USE date_and_time_mod,                                                     &
488        ONLY:  date_init, day_of_year_init, time_utc_init
489
490    USE dvrp_variables,                                                        &
491        ONLY:  local_dvrserver_running
492
493    USE grid_variables,                                                        &
494        ONLY:  dx, dy
495
496    USE indices,                                                               &
497        ONLY:  nx, ny, nz
498
499    USE kinds
500
501    USE model_1d_mod,                                                          &
502        ONLY:  damp_level_1d, dt_pr_1d, dt_run_control_1d, end_time_1d
503
504    USE module_interface,                                                      &
505        ONLY:  module_interface_parin
506
507    USE netcdf_interface,                                                      &
508        ONLY:  netcdf_data_format, netcdf_deflate, netcdf_precision
509
510    USE pegrid
511
512    USE pmc_interface,                                                         &
513        ONLY:  nested_run, nesting_mode
514
515    USE profil_parameter,                                                      &
516        ONLY:  cross_profiles, profile_columns, profile_rows
517
518    USE progress_bar,                                                          &
519        ONLY :  progress_bar_disabled
520
521    USE read_restart_data_mod,                                                 &
522        ONLY:  rrd_global
523
524    USE statistics,                                                            &
525        ONLY:  hom, hom_sum, pr_palm, region, statistic_regions
526
527    USE turbulence_closure_mod,                                                &
528        ONLY:  rans_const_c, rans_const_sigma
529
530    USE vertical_nesting_mod,                                                  &
531        ONLY:  vnest_start_time
532
533
534    IMPLICIT NONE
535
536    CHARACTER (LEN=80) ::  line  !< dummy string that contains the current line of the parameter file
537
538    INTEGER(iwp) ::  global_id      !< process id with respect to MPI_COMM_WORLD
539    INTEGER(iwp) ::  global_procs   !< # of procs with respect to MPI_COMM_WORLD
540    INTEGER(iwp) ::  i              !<
541    INTEGER(iwp) ::  ioerr          !< error flag for open/read/write
542
543    NAMELIST /inipar/  alpha_surface, approximation, bc_e_b,     &
544                       bc_lr, bc_ns, bc_p_b, bc_p_t, bc_pt_b, bc_pt_t, bc_q_b, &
545             bc_q_t,bc_s_b, bc_s_t, bc_uv_b, bc_uv_t,                 &
546             building_height, building_length_x,          &
547             building_length_y, building_wall_left, building_wall_south,       &
548             calc_soil_moisture_during_spinup,                                 &
549             call_psolver_at_all_substeps,  &
550             canyon_height,                                                    &
551             canyon_width_x, canyon_width_y, canyon_wall_left,                 &
552             canyon_wall_south, cfl_factor, cloud_droplets,   &
553             collective_wait, complex_terrain,           &
554             conserve_volume_flow,                                             &
555             conserve_volume_flow_mode, constant_flux_layer,                   &
556             coupling_start_time,             &
557             cycle_mg, damp_level_1d,                                          &
558             data_output_during_spinup,                                        &
559             date_init,                                                        &
560             day_of_year_init,                                                 &
561             dissipation_1d,                                                   &
562             dp_external, dp_level_b, dp_smooth, dpdxy,    &
563             dt, dt_pr_1d, dt_run_control_1d, dt_spinup, dx, dy, dz, dz_max,   &
564             dz_stretch_factor, dz_stretch_level, dz_stretch_level_start,      &
565             dz_stretch_level_end, end_time_1d, ensemble_member_nr, e_init,    &
566             e_min, fft_method, flux_input_mode, flux_output_mode,             &
567             galilei_transformation, humidity,                                 &
568             inflow_damping_height, inflow_damping_width,                      &
569             inflow_disturbance_begin, inflow_disturbance_end,                 &
570             initializing_actions, km_constant,                                &
571             large_scale_forcing, large_scale_subsidence, latitude,            &
572             longitude,                                 &
573             loop_optimization, lsf_exception, masking_method, mg_cycles,      &
574             mg_switch_to_pe0_level, mixing_length_1d, momentum_advec,         &
575             most_method,                                                      &
576             netcdf_precision, neutral, ngsrb,                                 &
577             nsor, nsor_ini, nudging, nx, ny, nz, ocean_mode, omega,           &
578             omega_sor, outflow_source_plane, passive_scalar,                  &
579             prandtl_number, psolver, pt_damping_factor,        &
580             pt_damping_width, pt_reference, pt_surface,                       &
581             pt_surface_initial_change, pt_vertical_gradient,                  &
582             pt_vertical_gradient_level, q_surface, q_surface_initial_change,  &
583             q_vertical_gradient, q_vertical_gradient_level,                   &
584             random_generator, random_heatflux, rans_const_c, rans_const_sigma,&
585             rayleigh_damping_factor, rayleigh_damping_height,                 &
586             recycling_width, recycling_yshift,                                &
587             reference_state, residual_limit,                                  &
588             roughness_length,                                                 &
589             scalar_advec,   &
590             scalar_rayleigh_damping,                              &
591             spinup_time, spinup_pt_amplitude, spinup_pt_mean,                 &
592             statistic_regions, subs_vertical_gradient,                        &
593             subs_vertical_gradient_level, surface_heatflux, surface_pressure, &
594             surface_scalarflux, surface_waterflux,                            &
595             s_surface, s_surface_initial_change, s_vertical_gradient,         &
596             s_vertical_gradient_level, time_utc_init, timestep_scheme,        &
597             topography, topography_grid_convention, top_heatflux,             &
598             top_momentumflux_u, top_momentumflux_v,                           &
599             top_scalarflux, transpose_compute_overlap,                        &
600             tunnel_height, tunnel_length, tunnel_width_x, tunnel_width_y,     &
601             tunnel_wall_depth, turbulence_closure,                            &
602             turbulent_inflow, turbulent_outflow,                              &
603             use_subsidence_tendencies, ug_surface, ug_vertical_gradient,      &
604             use_free_convection_scaling,                                      &
605             ug_vertical_gradient_level, use_surface_fluxes, use_cmax,         &
606             use_top_fluxes, use_ug_for_galilei_tr, use_upstream_for_tke,      &
607             uv_heights, u_bulk, u_profile, vg_surface, vg_vertical_gradient,  &
608             vg_vertical_gradient_level, v_bulk, v_profile,&
609             wall_adjustment, wall_heatflux, wall_humidityflux,                &
610             wall_scalarflux, y_shift, zeta_max, zeta_min,  &
611             z0h_factor
612
613    NAMELIST /initialization_parameters/  alpha_surface,                       &
614             approximation, bc_e_b,                                            &
615             bc_lr, bc_ns, bc_p_b, bc_p_t, bc_pt_b, bc_pt_t, bc_q_b,           &
616             bc_q_t,bc_s_b, bc_s_t, bc_uv_b, bc_uv_t,                          &
617             building_height, building_length_x,                               &
618             building_length_y, building_wall_left, building_wall_south,       &
619             calc_soil_moisture_during_spinup,                                 &
620             call_psolver_at_all_substeps,                                     &
621             canyon_height,                                                    &
622             canyon_width_x, canyon_width_y, canyon_wall_left,                 &
623             canyon_wall_south, cfl_factor, cloud_droplets,                    &
624             collective_wait, complex_terrain,                                 &
625             conserve_volume_flow,                                             &
626             conserve_volume_flow_mode, constant_flux_layer,                   &
627             coupling_start_time,                                              &
628             cycle_mg, damp_level_1d,                                          &
629             data_output_during_spinup,                                        &
630             date_init,                                                        &
631             day_of_year_init,                                                 &
632             dissipation_1d,                                                   &
633             dp_external, dp_level_b, dp_smooth, dpdxy,                        &
634             dt, dt_pr_1d, dt_run_control_1d, dt_spinup, dx, dy, dz, dz_max,   &
635             dz_stretch_factor, dz_stretch_level, dz_stretch_level_start,      &
636             dz_stretch_level_end, end_time_1d, ensemble_member_nr, e_init,    &
637             e_min, fft_method, flux_input_mode, flux_output_mode,             &
638             galilei_transformation, humidity,                                 &
639             inflow_damping_height, inflow_damping_width,                      &
640             inflow_disturbance_begin, inflow_disturbance_end,                 &
641             initializing_actions, km_constant,                                &
642             large_scale_forcing, large_scale_subsidence, latitude,            &
643             longitude,                                                        &
644             loop_optimization, lsf_exception, masking_method, mg_cycles,      &
645             mg_switch_to_pe0_level, mixing_length_1d, momentum_advec,         &
646             most_method,                                                      &
647             netcdf_precision, neutral, ngsrb,                                 &
648             nsor, nsor_ini, nudging, nx, ny, nz, ocean_mode, omega,           &
649             omega_sor, outflow_source_plane, passive_scalar,                  &
650             prandtl_number, psolver, pt_damping_factor,                       &
651             pt_damping_width, pt_reference, pt_surface,                       &
652             pt_surface_initial_change, pt_vertical_gradient,                  &
653             pt_vertical_gradient_level, q_surface, q_surface_initial_change,  &
654             q_vertical_gradient, q_vertical_gradient_level,                   &
655             random_generator, random_heatflux, rans_const_c, rans_const_sigma,&
656             rayleigh_damping_factor, rayleigh_damping_height,                 &
657             recycling_width, recycling_yshift,                                &
658             reference_state, residual_limit,                                  &
659             roughness_length, scalar_advec,                                   &
660             scalar_rayleigh_damping,                                          &
661             spinup_time, spinup_pt_amplitude, spinup_pt_mean,                 &
662             statistic_regions, subs_vertical_gradient,                        &
663             subs_vertical_gradient_level, surface_heatflux, surface_pressure, &
664             surface_scalarflux, surface_waterflux,                            &
665             s_surface, s_surface_initial_change, s_vertical_gradient,         &
666             s_vertical_gradient_level, time_utc_init, timestep_scheme,        &
667             topography, topography_grid_convention, top_heatflux,             &
668             top_momentumflux_u, top_momentumflux_v,                           &
669             top_scalarflux, transpose_compute_overlap,                        &
670             tunnel_height, tunnel_length, tunnel_width_x, tunnel_width_y,     &
671             tunnel_wall_depth, turbulence_closure,                            &
672             turbulent_inflow, turbulent_outflow,                              &
673             use_subsidence_tendencies, ug_surface, ug_vertical_gradient,      &
674             ug_vertical_gradient_level, use_surface_fluxes, use_cmax,         &
675             use_top_fluxes, use_ug_for_galilei_tr, use_upstream_for_tke,      &
676             use_free_convection_scaling,                                      &
677             uv_heights, u_bulk, u_profile, vg_surface, vg_vertical_gradient,  &
678             vg_vertical_gradient_level, v_bulk, v_profile,                    &
679             wall_adjustment, wall_heatflux, wall_humidityflux,                &
680             wall_scalarflux, y_shift, zeta_max, zeta_min, z0h_factor
681             
682    NAMELIST /d3par/  averaging_interval, averaging_interval_pr,               &
683             cpu_log_barrierwait, create_disturbances,                         &
684             cross_profiles, data_output, data_output_masks,                   &
685             data_output_pr, data_output_2d_on_each_pe, disturbance_amplitude, &
686             disturbance_energy_limit, disturbance_level_b,                    &
687             disturbance_level_t, do2d_at_begin, do3d_at_begin,                &
688             dt, dt_averaging_input, dt_averaging_input_pr,                    &
689             dt_coupling, dt_data_output, dt_data_output_av, dt_disturb,       &
690             dt_domask, dt_dopr, dt_dopr_listing, dt_dots, dt_do2d_xy,         &
691             dt_do2d_xz, dt_do2d_yz, dt_do3d, dt_max, dt_restart,              &
692             dt_run_control,end_time, force_print_header, mask_k_over_surface, &
693             mask_scale_x,                                                     &
694             mask_scale_y, mask_scale_z, mask_x, mask_y, mask_z, mask_x_loop,  &
695             mask_y_loop, mask_z_loop, netcdf_data_format, netcdf_deflate,     &
696             normalizing_region, npex, npey, nz_do3d,                          &
697             profile_columns, profile_rows,     &
698             restart_time, section_xy, section_xz, section_yz,                 &
699             skip_time_data_output, skip_time_data_output_av, skip_time_dopr,  &
700             skip_time_do2d_xy, skip_time_do2d_xz, skip_time_do2d_yz,          &
701             skip_time_do3d, skip_time_domask, synchronous_exchange,           &
702             termination_time_needed, vnest_start_time
703
704    NAMELIST /runtime_parameters/  averaging_interval, averaging_interval_pr,  &
705             cpu_log_barrierwait, create_disturbances,                         &
706             cross_profiles, data_output, data_output_masks,                   &
707             data_output_pr, data_output_2d_on_each_pe, disturbance_amplitude, &
708             disturbance_energy_limit, disturbance_level_b,                    &
709             disturbance_level_t, do2d_at_begin, do3d_at_begin,                &
710             dt, dt_averaging_input, dt_averaging_input_pr,                    &
711             dt_coupling, dt_data_output, dt_data_output_av, dt_disturb,       &
712             dt_domask, dt_dopr, dt_dopr_listing, dt_dots, dt_do2d_xy,         &
713             dt_do2d_xz, dt_do2d_yz, dt_do3d, dt_max, dt_restart,              &
714             dt_run_control,end_time, force_print_header, mask_k_over_surface, &
715             mask_scale_x,                                                     &
716             mask_scale_y, mask_scale_z, mask_x, mask_y, mask_z, mask_x_loop,  &
717             mask_y_loop, mask_z_loop, netcdf_data_format, netcdf_deflate,     &
718             normalizing_region, npex, npey, nz_do3d,                          &
719             profile_columns, profile_rows,     &
720             restart_time, section_xy, section_xz, section_yz,                 &
721             skip_time_data_output, skip_time_data_output_av, skip_time_dopr,  &
722             skip_time_do2d_xy, skip_time_do2d_xz, skip_time_do2d_yz,          &
723             skip_time_do3d, skip_time_domask, synchronous_exchange,           &
724             termination_time_needed, vnest_start_time
725
726    NAMELIST /envpar/  progress_bar_disabled, host, local_dvrserver_running,   &
727                       maximum_cpu_time_allowed, maximum_parallel_io_streams,  &
728                       read_svf, revision, run_identifier, tasks_per_node,     &
729                       write_binary, write_svf
730
731!
732!-- First read values of environment variables (this NAMELIST file is
733!-- generated by palmrun)
734    CALL location_message( 'reading environment parameters from ENVPAR', .FALSE. )
735
736    OPEN ( 90, FILE='ENVPAR', STATUS='OLD', FORM='FORMATTED', IOSTAT=ioerr )
737
738    IF ( ioerr /= 0 )  THEN
739       message_string = 'local file ENVPAR not found' //                       &
740                        '&some variables for steering may not be properly set'
741       CALL message( 'parin', 'PA0276', 0, 1, 0, 6, 0 )
742    ELSE
743       READ ( 90, envpar, IOSTAT=ioerr )
744       IF ( ioerr < 0 )  THEN
745          message_string = 'no envpar-NAMELIST found in local file '  //       &
746                           'ENVPAR& or some variables for steering may '  //   &
747                           'not be properly set'
748          CALL message( 'parin', 'PA0278', 0, 1, 0, 6, 0 )
749       ELSEIF ( ioerr > 0 )  THEN
750          message_string = 'errors in local file ENVPAR' //                    &
751                           '&some variables for steering may not be properly set'
752          CALL message( 'parin', 'PA0277', 0, 1, 0, 6, 0 )
753       ENDIF
754       CLOSE ( 90 )
755    ENDIF
756
757    CALL location_message( 'finished', .TRUE. )
758!
759!-- Calculate the number of groups into which parallel I/O is split.
760!-- The default for files which are opened by all PEs (or where each
761!-- PE opens his own independent file) is, that all PEs are doing input/output
762!-- in parallel at the same time. This might cause performance or even more
763!-- severe problems depending on the configuration of the underlying file
764!-- system.
765!-- Calculation of the number of blocks and the I/O group must be based on all
766!-- PEs involved in this run. Since myid and numprocs are related to the
767!-- comm2d communicator, which gives only a subset of all PEs in case of
768!-- nested runs, that information must be inquired again from the global
769!-- communicator.
770!-- First, set the default:
771#if defined( __parallel )
772    CALL MPI_COMM_RANK( MPI_COMM_WORLD, global_id, ierr )
773    CALL MPI_COMM_SIZE( MPI_COMM_WORLD, global_procs, ierr )
774#else
775    global_id    = 0
776    global_procs = 1
777#endif
778    IF ( maximum_parallel_io_streams == -1  .OR.                               &
779         maximum_parallel_io_streams > global_procs )  THEN
780       maximum_parallel_io_streams = global_procs
781    ENDIF
782!
783!-- Now calculate the number of io_blocks and the io_group to which the
784!-- respective PE belongs. I/O of the groups is done in serial, but in parallel
785!-- for all PEs belonging to the same group.
786    io_blocks = global_procs / maximum_parallel_io_streams
787    io_group  = MOD( global_id+1, io_blocks )
788   
789    CALL location_message( 'reading NAMELIST parameters from PARIN', .FALSE. )
790!
791!-- Data is read in parallel by groups of PEs
792    DO  i = 0, io_blocks-1
793       IF ( i == io_group )  THEN
794
795!
796!--       Open the NAMELIST-file which is send with this job
797          CALL check_open( 11 )
798
799!
800!--       Read the control parameters for initialization.
801!--       The namelist "inipar" must be provided in the NAMELIST-file.
802          READ ( 11, initialization_parameters, ERR=10, END=11 )
803          GOTO 14
804         
805 10       BACKSPACE( 11 )
806          READ( 11 , '(A)') line
807          CALL parin_fail_message( 'initialization_parameters', line )
808
809 11       REWIND ( 11 )
810          READ ( 11, inipar, ERR=12, END=13 )
811 
812          message_string = 'namelist inipar is deprecated and will be ' //    &
813                          'removed in near future. & Please use namelist ' // &
814                          'initialization_parameters instead'
815          CALL message( 'parin', 'PA0017', 0, 1, 0, 6, 0 )
816 
817          GOTO 14
818 
819 12       BACKSPACE( 11 )
820          READ( 11 , '(A)') line
821          CALL parin_fail_message( 'inipar', line )
822
823 13       message_string = 'no initialization_parameters-namelist found'
824          CALL message( 'parin', 'PA0272', 1, 2, 0, 6, 0 )
825
826!
827!--       Try to read runtime parameters given by the user for this run
828!--       (namelist "runtime_parameters"). The namelist "runtime_parmeters"   
829!--       can be omitted. In that case default values are used for the         
830!--       parameters.
831 14       line = ' '
832
833          REWIND ( 11 )
834          line = ' '
835          DO WHILE ( INDEX( line, '&runtime_parameters' ) == 0 )
836             READ ( 11, '(A)', END=16 )  line
837          ENDDO
838          BACKSPACE ( 11 )
839
840!
841!--       Read namelist
842          READ ( 11, runtime_parameters, ERR = 15 )
843          GOTO 18
844
845 15       BACKSPACE( 11 )
846          READ( 11 , '(A)') line
847          CALL parin_fail_message( 'runtime_parameters', line )
848
849 16       REWIND ( 11 )
850          line = ' '
851          DO WHILE ( INDEX( line, '&d3par' ) == 0 )
852             READ ( 11, '(A)', END=18 )  line
853          ENDDO
854          BACKSPACE ( 11 )
855
856!
857!--       Read namelist
858          READ ( 11, d3par, ERR = 17, END = 18 )
859
860          message_string = 'namelist d3par is deprecated and will be ' //      &
861                          'removed in near future. &Please use namelist ' //   &
862                          'runtime_parameters instead'
863          CALL message( 'parin', 'PA0487', 0, 1, 0, 6, 0 )
864
865          GOTO 18
866
867 17       BACKSPACE( 11 )
868          READ( 11 , '(A)') line
869          CALL parin_fail_message( 'd3par', line )
870
871 18       CONTINUE
872
873!
874!--       Check for module namelists and read them
875          CALL module_interface_parin
876
877!
878!--       If required, read control parameters from restart file (produced by
879!--       a prior run). All PEs are reading from file created by PE0 (see
880!--       check_open)
881          IF ( TRIM( initializing_actions ) == 'read_restart_data' )  THEN
882
883             CALL rrd_global
884!
885!--          Increment the run count
886             runnr = runnr + 1
887!
888!--          In case of a restart run, the number of user-defined profiles on
889!--          the restart file (already stored in max_pr_user) has to match the
890!--          one given for the current run. max_pr_user_tmp is calculated in
891!--          user_parin and max_pr_user is read in via rrd_global.
892             IF ( max_pr_user /= max_pr_user_tmp )  THEN
893                WRITE( message_string, * ) 'the number of user-defined ',      &
894                      'profiles given in data_output_pr (', max_pr_user_tmp,   &
895                      ') does not match the one ',                             &
896                      'found in the restart file (', max_pr_user, ')'
897                CALL message( 'user_parin', 'UI0009', 1, 2, 0, 6, 0 )
898             ENDIF
899          ELSE
900             max_pr_user = max_pr_user_tmp
901          ENDIF
902!
903!--       Activate spinup
904          IF ( land_surface .OR. urban_surface )  THEN
905             IF ( spinup_time > 0.0_wp )  THEN
906                coupling_start_time = spinup_time
907                time_since_reference_point = simulated_time - coupling_start_time
908                IF ( spinup_pt_mean == 9999999.9_wp )  THEN
909                   spinup_pt_mean = pt_surface
910                ENDIF
911                end_time = end_time + spinup_time
912                IF ( TRIM( initializing_actions ) /= 'read_restart_data' )  THEN
913                   spinup = .TRUE.
914                ELSEIF (        TRIM( initializing_actions ) == 'read_restart_data'      &
915                         .AND.  time_since_reference_point > 0.0_wp )  THEN
916                   data_output_during_spinup = .FALSE.  !< required for correct ntdim calculation
917                                                        !< in check_parameters for restart run
918                ENDIF
919             ENDIF
920          ENDIF
921
922!
923!--       In case of nested runs, explicitly set nesting boundary conditions.
924!--       This will overwrite the user settings and basic defaults.
925!--       bc_lr and bc_ns always need to be cyclic for vertical nesting.
926          IF ( nested_run )  THEN
927             IF ( nesting_mode == 'vertical' )  THEN
928                IF (bc_lr /= 'cyclic' .OR. bc_ns /= 'cyclic' )  THEN
929                   WRITE ( message_string, *) 'bc_lr and bc_ns were set to ,', &
930                        'cyclic for vertical nesting'
931                   CALL message( 'parin', 'PA0428', 0, 0, 0, 6, 0 )
932                   bc_lr   = 'cyclic'
933                   bc_ns   = 'cyclic'
934                ENDIF
935                IF ( child_domain )  THEN
936                   bc_uv_t  = 'nested'
937                   bc_pt_t  = 'nested'
938                   bc_q_t   = 'nested'
939                   bc_s_t   = 'nested'
940                   bc_cs_t  = 'nested'
941                   bc_p_t   = 'neumann' 
942                ENDIF
943!
944!--          For other nesting modes only set boundary conditions for
945!--          nested domains.
946             ELSE
947                IF ( child_domain )  THEN
948                   bc_lr    = 'nested'
949                   bc_ns    = 'nested'
950                   bc_uv_t  = 'nested'
951                   bc_pt_t  = 'nested'
952                   bc_q_t   = 'nested'
953                   bc_s_t   = 'nested'
954                   bc_cs_t  = 'nested'
955                   bc_p_t   = 'neumann'
956                ENDIF
957             ENDIF
958          ENDIF
959!
960!--       Set boundary conditions also in case the model is offline-nested in
961!--       larger-scale models.
962          IF ( nesting_offline )  THEN
963             bc_lr    = 'nesting_offline'
964             bc_ns    = 'nesting_offline'
965             bc_uv_t  = 'nesting_offline'
966             bc_pt_t  = 'nesting_offline'
967             bc_q_t   = 'nesting_offline'
968           !  bc_s_t   = 'nesting_offline'  ! scalar boundary condition is not clear
969           !  bc_cs_t  = 'nesting_offline'  ! same for chemical species
970!
971!--          For the pressure set Dirichlet conditions, in contrast to the
972!--          self nesting. This gives less oscilations within the
973!--          free atmosphere since the pressure solver has more degrees of
974!--          freedom. In constrast to the self nesting, this might be
975!--          justified since the top boundary is far away from the domain
976!--          of interest.
977             bc_p_t   = 'dirichlet' !'neumann'
978          ENDIF
979
980!         
981!--       In case of nested runs, make sure that initializing_actions =
982!--       'set_constant_profiles' even though the constant-profiles
983!--       initializations for the prognostic variables will be overwritten
984!--       by pmci_child_initialize and pmci_parent_initialize. This is,
985!--       however, important e.g. to make sure that diagnostic variables
986!--       are set properly. An exception is made in case of restart runs and
987!--       if user decides to do everything by its own.
988          IF ( child_domain  .AND.  .NOT. (                                    &
989               TRIM( initializing_actions ) == 'read_restart_data'      .OR.   &
990               TRIM( initializing_actions ) == 'set_constant_profiles'  .OR.   &
991               TRIM( initializing_actions ) == 'by_user' ) )  THEN
992             message_string = 'initializing_actions = ' //                     &
993                              TRIM( initializing_actions ) // ' has been ' //  &
994                              'changed to set_constant_profiles in child ' //  &
995                              'domain.' 
996             CALL message( 'parin', 'PA0492', 0, 0, 0, 6, 0 )
997
998             initializing_actions = 'set_constant_profiles'
999          ENDIF           
1000!
1001!--       Check validity of lateral boundary conditions. This has to be done
1002!--       here because they are already used in init_pegrid and init_grid and
1003!--       therefore cannot be check in check_parameters
1004          IF ( bc_lr /= 'cyclic'  .AND.  bc_lr /= 'dirichlet/radiation'  .AND. &
1005               bc_lr /= 'radiation/dirichlet'  .AND.  bc_lr /= 'nested'  .AND. &
1006               bc_lr /= 'nesting_offline' )  THEN
1007             message_string = 'unknown boundary condition: bc_lr = "' // &
1008                              TRIM( bc_lr ) // '"'
1009             CALL message( 'parin', 'PA0049', 1, 2, 0, 6, 0 )
1010          ENDIF
1011          IF ( bc_ns /= 'cyclic'  .AND.  bc_ns /= 'dirichlet/radiation'  .AND. &
1012               bc_ns /= 'radiation/dirichlet'  .AND.  bc_ns /= 'nested'  .AND. &
1013               bc_ns /= 'nesting_offline' )  THEN
1014             message_string = 'unknown boundary condition: bc_ns = "' // &
1015                              TRIM( bc_ns ) // '"'
1016             CALL message( 'parin', 'PA0050', 1, 2, 0, 6, 0 )
1017          ENDIF
1018!
1019!--       Set internal variables used for speed optimization in if clauses
1020          IF ( bc_lr /= 'cyclic' )               bc_lr_cyc    = .FALSE.
1021          IF ( bc_lr == 'dirichlet/radiation' )  bc_lr_dirrad = .TRUE.
1022          IF ( bc_lr == 'radiation/dirichlet' )  bc_lr_raddir = .TRUE.
1023          IF ( bc_ns /= 'cyclic' )               bc_ns_cyc    = .FALSE.
1024          IF ( bc_ns == 'dirichlet/radiation' )  bc_ns_dirrad = .TRUE.
1025          IF ( bc_ns == 'radiation/dirichlet' )  bc_ns_raddir = .TRUE.
1026
1027!
1028!--       Definition of names of areas used for computing statistics. They must
1029!--       be defined at this place, because they are allowed to be redefined by
1030!--       the user in user_parin.
1031          region = 'total domain'
1032
1033!
1034!--       Check in case of initial run, if the grid point numbers are well
1035!--       defined and allocate some arrays which are already needed in
1036!--       init_pegrid or check_parameters. During restart jobs, these arrays
1037!--       will be allocated in rrd_global. All other arrays are allocated
1038!--       in init_3d_model.
1039          IF ( TRIM( initializing_actions ) /= 'read_restart_data' )  THEN
1040
1041             IF ( nx <= 0 )  THEN
1042                WRITE( message_string, * ) 'no value or wrong value given',    &
1043                                           ' for nx: nx=', nx
1044                CALL message( 'parin', 'PA0273', 1, 2, 0, 6, 0 )
1045             ENDIF
1046             IF ( ny <= 0 )  THEN
1047                WRITE( message_string, * ) 'no value or wrong value given',    &
1048                                           ' for ny: ny=', ny
1049                CALL message( 'parin', 'PA0274', 1, 2, 0, 6, 0 )
1050             ENDIF
1051             IF ( nz <= 0 )  THEN
1052                WRITE( message_string, * ) 'no value or wrong value given',    &
1053                                           ' for nz: nz=', nz
1054                CALL message( 'parin', 'PA0275', 1, 2, 0, 6, 0 )
1055             ENDIF
1056
1057!
1058!--          As a side condition, routine flow_statistics require at least 14
1059!--          vertical grid levels (they are used to store time-series data)
1060!>           @todo   Remove this restriction
1061             IF ( nz < 14 )  THEN
1062                WRITE( message_string, * ) 'nz >= 14 is required'
1063                CALL message( 'parin', 'PA0362', 1, 2, 0, 6, 0 )
1064             ENDIF
1065
1066!
1067!--          ATTENTION: in case of changes to the following statement please
1068!--                  also check the allocate statement in routine rrd_global
1069             ALLOCATE( pt_init(0:nz+1), q_init(0:nz+1), s_init(0:nz+1),        &
1070                       ref_state(0:nz+1), sa_init(0:nz+1), ug(0:nz+1),         &
1071                       u_init(0:nz+1), v_init(0:nz+1), vg(0:nz+1),             &
1072                       hom(0:nz+1,2,pr_palm+max_pr_user+max_pr_cs,0:statistic_regions),  &
1073                       hom_sum(0:nz+1,pr_palm+max_pr_user+max_pr_cs,0:statistic_regions) )
1074
1075             hom = 0.0_wp
1076
1077          ENDIF
1078
1079!
1080!--       NAMELIST-file is not needed anymore
1081          CALL close_file( 11 )
1082
1083       ENDIF
1084#if defined( __parallel )
1085       CALL MPI_BARRIER( MPI_COMM_WORLD, ierr )
1086#endif
1087    ENDDO
1088
1089    CALL location_message( 'finished', .TRUE. )
1090
1091 END SUBROUTINE parin
Note: See TracBrowser for help on using the repository browser.