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

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

Add flag for saturation check

  • Property svn:keywords set to Id
File size: 36.1 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-2020 Leibniz Universitaet Hannover
18!------------------------------------------------------------------------------!
19!
20! Current revisions:
21! -----------------
22!
23!
24! Former revisions:
25! -----------------
26! $Id: parin.f90 4505 2020-04-20 15:37:15Z schwenkel $
27! Add flag for saturation check
28!
29! 4495 2020-04-13 20:11:20Z raasch
30! restart data handling with MPI-IO added
31!
32! 4360 2020-01-07 11:25:50Z suehring
33! removed recycling_yshift
34!
35! 4227 2019-09-10 18:04:34Z gronemeier
36! implement new palm_date_time_mod
37!
38! 4146 2019-08-07 07:47:36Z gronemeier
39! added rotation_angle to initialization_parameters
40!
41! 4191 2019-08-27 15:45:07Z gronemeier
42! bugfix: add recycling_method_for_thermodynamic_quantities to inipar namelist
43!
44! 4183 2019-08-23 07:33:16Z oliver.maas
45! replaced recycle_absolute_quantities by recycling_method_for_thermodynamic_quantities
46!
47! 4182 2019-08-22 15:20:23Z scharf
48! Corrected "Former revisions" section
49!
50! 4176 2019-08-20 14:10:41Z oliver.maas
51! added recycle_absolute_quantities to initialization_parameters namelist
52!
53! 4173 2019-08-20 12:04:06Z gronemeier
54! add vdi_internal_controls
55!
56! 4131 2019-08-02 11:06:18Z monakurppa
57! Allocate hom and hom_sum to allow profile output for salsa variables.
58!
59! 4079 2019-07-09 18:04:41Z suehring
60! +monotonic_limiter_z
61!
62! 4022 2019-06-12 11:52:39Z suehring
63! Change default top boundary condition for pressure to Neumann in offline
64! nesting case
65!
66! 4017 2019-06-06 12:16:46Z schwenkel
67! Introduce alternative switch for debug output during timestepping
68!
69! 3885 2019-04-11 11:29:34Z kanani
70! Changes related to global restructuring of location messages and introduction
71! of additional debug messages
72!
73! 3806 2019-03-21 12:45:50Z raasch
74! additional check for lateral boundary conditions added
75!
76! 3747 2019-02-16 15:15:23Z gronemeier
77! removed setting of parameter region
78!
79! 3746 2019-02-16 12:41:27Z gronemeier
80! Removed most_method
81!
82! 3649 2019-01-02 16:52:21Z suehring
83! Delete debug-print statements
84!
85! Revision 1.1  1997/07/24 11:22:50  raasch
86! Initial revision
87!
88!
89! Description:
90! ------------
91!> This subroutine reads variables controling the run from the NAMELIST files
92!>
93!> @todo: Revise max_pr_cs (profiles for chemistry)
94!------------------------------------------------------------------------------!
95 SUBROUTINE parin
96 
97
98    USE arrays_3d,                                                             &
99        ONLY:  pt_init, q_init, ref_state, s_init, sa_init,                    &
100               ug, u_init, v_init, vg
101
102    USE chem_modules
103
104    USE control_parameters
105
106    USE cpulog,                                                                &
107        ONLY:  cpu_log_barrierwait
108
109    USE grid_variables,                                                        &
110        ONLY:  dx, dy
111
112    USE indices,                                                               &
113        ONLY:  nx, ny, nz
114
115    USE kinds
116
117    USE model_1d_mod,                                                          &
118        ONLY:  damp_level_1d, dt_pr_1d, dt_run_control_1d, end_time_1d
119
120    USE module_interface,                                                      &
121        ONLY:  module_interface_parin
122
123    USE netcdf_interface,                                                      &
124        ONLY:  netcdf_data_format, netcdf_deflate, netcdf_precision
125
126    USE pegrid
127
128    USE pmc_interface,                                                         &
129        ONLY:  nested_run, nesting_mode
130
131    USE profil_parameter,                                                      &
132        ONLY:  cross_profiles, profile_columns, profile_rows
133
134    USE progress_bar,                                                          &
135        ONLY :  progress_bar_disabled
136
137    USE read_restart_data_mod,                                                 &
138        ONLY:  rrd_global
139
140    USE statistics,                                                            &
141        ONLY:  hom, hom_sum, pr_palm, statistic_regions
142
143    USE turbulence_closure_mod,                                                &
144        ONLY:  rans_const_c, rans_const_sigma
145
146    USE vertical_nesting_mod,                                                  &
147        ONLY:  vnest_start_time
148
149
150    IMPLICIT NONE
151
152    CHARACTER (LEN=80) ::  line  !< dummy string that contains the current line of the parameter file
153
154    INTEGER(iwp) ::  global_id      !< process id with respect to MPI_COMM_WORLD
155    INTEGER(iwp) ::  global_procs   !< # of procs with respect to MPI_COMM_WORLD
156    INTEGER(iwp) ::  i              !<
157    INTEGER(iwp) ::  ioerr          !< error flag for open/read/write
158
159    NAMELIST /inipar/  alpha_surface, approximation, bc_e_b,     &
160                       bc_lr, bc_ns, bc_p_b, bc_p_t, bc_pt_b, bc_pt_t, bc_q_b, &
161             bc_q_t,bc_s_b, bc_s_t, bc_uv_b, bc_uv_t,                 &
162             building_height, building_length_x,          &
163             building_length_y, building_wall_left, building_wall_south,       &
164             calc_soil_moisture_during_spinup,                                 &
165             call_psolver_at_all_substeps,  &
166             canyon_height,                                                    &
167             canyon_width_x, canyon_width_y, canyon_wall_left,                 &
168             canyon_wall_south, cfl_factor, check_realistic_q, cloud_droplets, &
169             collective_wait, complex_terrain,           &
170             conserve_volume_flow,                                             &
171             conserve_volume_flow_mode, constant_flux_layer,                   &
172             coupling_start_time,             &
173             cycle_mg, damp_level_1d,                                          &
174             data_output_during_spinup,                                        &
175             origin_date_time,                                                 &
176             dissipation_1d,                                                   &
177             dp_external, dp_level_b, dp_smooth, dpdxy,    &
178             dt, dt_pr_1d, dt_run_control_1d, dt_spinup, dx, dy, dz, dz_max,   &
179             dz_stretch_factor, dz_stretch_level, dz_stretch_level_start,      &
180             dz_stretch_level_end, end_time_1d, ensemble_member_nr, e_init,    &
181             e_min, fft_method, flux_input_mode, flux_output_mode,             &
182             galilei_transformation, humidity,                                 &
183             inflow_damping_height, inflow_damping_width,                      &
184             inflow_disturbance_begin, inflow_disturbance_end,                 &
185             initializing_actions, km_constant,                                &
186             large_scale_forcing, large_scale_subsidence, latitude,            &
187             longitude,                                 &
188             loop_optimization, lsf_exception, masking_method, mg_cycles,      &
189             mg_switch_to_pe0_level, mixing_length_1d, momentum_advec,         &
190             monotonic_limiter_z,                                              &
191             netcdf_precision, neutral, ngsrb,                                 &
192             nsor, nsor_ini, nudging, nx, ny, nz, ocean_mode, omega,           &
193             omega_sor, outflow_source_plane, passive_scalar,                  &
194             prandtl_number, psolver, pt_damping_factor,        &
195             pt_damping_width, pt_reference, pt_surface,                       &
196             pt_surface_initial_change, pt_vertical_gradient,                  &
197             pt_vertical_gradient_level, q_surface, q_surface_initial_change,  &
198             q_vertical_gradient, q_vertical_gradient_level,                   &
199             random_generator, random_heatflux, rans_const_c, rans_const_sigma,&
200             rayleigh_damping_factor, rayleigh_damping_height,                 &
201             recycling_method_for_thermodynamic_quantities, recycling_width,   &
202             reference_state, residual_limit,                                  &
203             rotation_angle,                                                   &
204             roughness_length,                                                 &
205             scalar_advec,   &
206             scalar_rayleigh_damping,                              &
207             spinup_time, spinup_pt_amplitude, spinup_pt_mean,                 &
208             statistic_regions, subs_vertical_gradient,                        &
209             subs_vertical_gradient_level, surface_heatflux, surface_pressure, &
210             surface_scalarflux, surface_waterflux,                            &
211             s_surface, s_surface_initial_change, s_vertical_gradient,         &
212             s_vertical_gradient_level, timestep_scheme,                       &
213             topography, topography_grid_convention, top_heatflux,             &
214             top_momentumflux_u, top_momentumflux_v,                           &
215             top_scalarflux, transpose_compute_overlap,                        &
216             tunnel_height, tunnel_length, tunnel_width_x, tunnel_width_y,     &
217             tunnel_wall_depth, turbulence_closure,                            &
218             turbulent_inflow, turbulent_outflow,                              &
219             use_subsidence_tendencies, ug_surface, ug_vertical_gradient,      &
220             use_free_convection_scaling,                                      &
221             ug_vertical_gradient_level, use_surface_fluxes, use_cmax,         &
222             use_top_fluxes, use_ug_for_galilei_tr, use_upstream_for_tke,      &
223             uv_heights, u_bulk, u_profile, vdi_checks, vg_surface,            &
224             vg_vertical_gradient,  &
225             vg_vertical_gradient_level, v_bulk, v_profile,&
226             wall_adjustment, wall_heatflux, wall_humidityflux,                &
227             wall_scalarflux, y_shift, zeta_max, zeta_min,  &
228             z0h_factor
229
230    NAMELIST /initialization_parameters/  alpha_surface,                       &
231             approximation, bc_e_b,                                            &
232             bc_lr, bc_ns, bc_p_b, bc_p_t, bc_pt_b, bc_pt_t, bc_q_b,           &
233             bc_q_t,bc_s_b, bc_s_t, bc_uv_b, bc_uv_t,                          &
234             building_height, building_length_x,                               &
235             building_length_y, building_wall_left, building_wall_south,       &
236             calc_soil_moisture_during_spinup,                                 &
237             call_psolver_at_all_substeps,                                     &
238             canyon_height,                                                    &
239             canyon_width_x, canyon_width_y, canyon_wall_left,                 &
240             canyon_wall_south, cfl_factor, check_realistic_q, cloud_droplets, &
241             collective_wait, complex_terrain,                                 &
242             conserve_volume_flow,                                             &
243             conserve_volume_flow_mode, constant_flux_layer,                   &
244             coupling_start_time,                                              &
245             cycle_mg, damp_level_1d,                                          &
246             data_output_during_spinup,                                        &
247             origin_date_time,                                                 &
248             dissipation_1d,                                                   &
249             dp_external, dp_level_b, dp_smooth, dpdxy,                        &
250             dt, dt_pr_1d, dt_run_control_1d, dt_spinup, dx, dy, dz, dz_max,   &
251             dz_stretch_factor, dz_stretch_level, dz_stretch_level_start,      &
252             dz_stretch_level_end, end_time_1d, ensemble_member_nr, e_init,    &
253             e_min, fft_method, flux_input_mode, flux_output_mode,             &
254             galilei_transformation, humidity,                                 &
255             inflow_damping_height, inflow_damping_width,                      &
256             inflow_disturbance_begin, inflow_disturbance_end,                 &
257             initializing_actions, km_constant,                                &
258             large_scale_forcing, large_scale_subsidence, latitude,            &
259             longitude,                                                        &
260             loop_optimization, lsf_exception, masking_method, mg_cycles,      &
261             mg_switch_to_pe0_level, mixing_length_1d, momentum_advec,         &
262             monotonic_limiter_z,                                              &
263             netcdf_precision, neutral, ngsrb,                                 &
264             nsor, nsor_ini, nudging, nx, ny, nz, ocean_mode, omega,           &
265             omega_sor, outflow_source_plane, passive_scalar,                  &
266             prandtl_number, psolver, pt_damping_factor,                       &
267             pt_damping_width, pt_reference, pt_surface,                       &
268             pt_surface_initial_change, pt_vertical_gradient,                  &
269             pt_vertical_gradient_level, q_surface, q_surface_initial_change,  &
270             q_vertical_gradient, q_vertical_gradient_level,                   &
271             random_generator, random_heatflux, rans_const_c, rans_const_sigma,&
272             rayleigh_damping_factor, rayleigh_damping_height,                 &
273             recycling_method_for_thermodynamic_quantities, recycling_width,   &
274             reference_state, residual_limit,                                  &
275             restart_data_format, restart_data_format_input, restart_data_format_output,           &
276             rotation_angle,                                                   &
277             roughness_length, scalar_advec,                                   &
278             scalar_rayleigh_damping,                                          &
279             spinup_time, spinup_pt_amplitude, spinup_pt_mean,                 &
280             statistic_regions, subs_vertical_gradient,                        &
281             subs_vertical_gradient_level, surface_heatflux, surface_pressure, &
282             surface_scalarflux, surface_waterflux,                            &
283             s_surface, s_surface_initial_change, s_vertical_gradient,         &
284             s_vertical_gradient_level, timestep_scheme,                       &
285             topography, topography_grid_convention, top_heatflux,             &
286             top_momentumflux_u, top_momentumflux_v,                           &
287             top_scalarflux, transpose_compute_overlap,                        &
288             tunnel_height, tunnel_length, tunnel_width_x, tunnel_width_y,     &
289             tunnel_wall_depth, turbulence_closure,                            &
290             turbulent_inflow, turbulent_outflow,                              &
291             use_subsidence_tendencies, ug_surface, ug_vertical_gradient,      &
292             ug_vertical_gradient_level, use_surface_fluxes, use_cmax,         &
293             use_top_fluxes, use_ug_for_galilei_tr, use_upstream_for_tke,      &
294             use_free_convection_scaling,                                      &
295             uv_heights, u_bulk, u_profile, vdi_checks,                        &
296             vg_surface, vg_vertical_gradient,  &
297             vg_vertical_gradient_level, v_bulk, v_profile,                    &
298             wall_adjustment, wall_heatflux, wall_humidityflux,                &
299             wall_scalarflux, y_shift, zeta_max, zeta_min, z0h_factor
300             
301    NAMELIST /d3par/  averaging_interval, averaging_interval_pr,               &
302             cpu_log_barrierwait, create_disturbances,                         &
303             cross_profiles, data_output, data_output_masks,                   &
304             data_output_pr, data_output_2d_on_each_pe,                        &
305             debug_output,                                                     &
306             debug_output_timestep,                                            &
307             disturbance_amplitude,                                            &
308             disturbance_energy_limit, disturbance_level_b,                    &
309             disturbance_level_t, do2d_at_begin, do3d_at_begin,                &
310             dt, dt_averaging_input, dt_averaging_input_pr,                    &
311             dt_coupling, dt_data_output, dt_data_output_av, dt_disturb,       &
312             dt_domask, dt_dopr, dt_dopr_listing, dt_dots, dt_do2d_xy,         &
313             dt_do2d_xz, dt_do2d_yz, dt_do3d, dt_max, dt_restart,              &
314             dt_run_control,end_time, force_print_header, mask_k_over_surface, &
315             mask_scale_x,                                                     &
316             mask_scale_y, mask_scale_z, mask_x, mask_y, mask_z, mask_x_loop,  &
317             mask_y_loop, mask_z_loop, netcdf_data_format, netcdf_deflate,     &
318             normalizing_region, npex, npey, nz_do3d,                          &
319             profile_columns, profile_rows,     &
320             restart_time, section_xy, section_xz, section_yz,                 &
321             skip_time_data_output, skip_time_data_output_av, skip_time_dopr,  &
322             skip_time_do2d_xy, skip_time_do2d_xz, skip_time_do2d_yz,          &
323             skip_time_do3d, skip_time_domask, synchronous_exchange,           &
324             termination_time_needed, vnest_start_time
325
326    NAMELIST /runtime_parameters/  averaging_interval, averaging_interval_pr,  &
327             cpu_log_barrierwait, create_disturbances,                         &
328             cross_profiles, data_output, data_output_masks,                   &
329             data_output_pr, data_output_2d_on_each_pe,                        &
330             debug_output,                                                     &
331             debug_output_timestep,                                            &
332             disturbance_amplitude,                                            &
333             disturbance_energy_limit, disturbance_level_b,                    &
334             disturbance_level_t, do2d_at_begin, do3d_at_begin,                &
335             dt, dt_averaging_input, dt_averaging_input_pr,                    &
336             dt_coupling, dt_data_output, dt_data_output_av, dt_disturb,       &
337             dt_domask, dt_dopr, dt_dopr_listing, dt_dots, dt_do2d_xy,         &
338             dt_do2d_xz, dt_do2d_yz, dt_do3d, dt_max, dt_restart,              &
339             dt_run_control,end_time, force_print_header, mask_k_over_surface, &
340             mask_scale_x,                                                     &
341             mask_scale_y, mask_scale_z, mask_x, mask_y, mask_z, mask_x_loop,  &
342             mask_y_loop, mask_z_loop, netcdf_data_format, netcdf_deflate,     &
343             normalizing_region, npex, npey, nz_do3d,                          &
344             profile_columns, profile_rows,     &
345             restart_time, section_xy, section_xz, section_yz,                 &
346             restart_data_format, restart_data_format_input, restart_data_format_output,           &
347             skip_time_data_output, skip_time_data_output_av, skip_time_dopr,  &
348             skip_time_do2d_xy, skip_time_do2d_xz, skip_time_do2d_yz,          &
349             skip_time_do3d, skip_time_domask, synchronous_exchange,           &
350             termination_time_needed, vnest_start_time
351
352    NAMELIST /envpar/  progress_bar_disabled, host,                            &
353                       maximum_cpu_time_allowed, maximum_parallel_io_streams,  &
354                       read_svf, revision, run_identifier, tasks_per_node,     &
355                       write_binary, write_svf
356
357!
358!-- First read values of environment variables (this NAMELIST file is
359!-- generated by palmrun)
360    CALL location_message( 'reading environment parameters from ENVPAR', 'start' )
361
362    OPEN ( 90, FILE='ENVPAR', STATUS='OLD', FORM='FORMATTED', IOSTAT=ioerr )
363
364    IF ( ioerr /= 0 )  THEN
365       message_string = 'local file ENVPAR not found' //                       &
366                        '&some variables for steering may not be properly set'
367       CALL message( 'parin', 'PA0276', 0, 1, 0, 6, 0 )
368    ELSE
369       READ ( 90, envpar, IOSTAT=ioerr )
370       IF ( ioerr < 0 )  THEN
371          message_string = 'no envpar-NAMELIST found in local file '  //       &
372                           'ENVPAR& or some variables for steering may '  //   &
373                           'not be properly set'
374          CALL message( 'parin', 'PA0278', 0, 1, 0, 6, 0 )
375       ELSEIF ( ioerr > 0 )  THEN
376          message_string = 'errors in local file ENVPAR' //                    &
377                           '&some variables for steering may not be properly set'
378          CALL message( 'parin', 'PA0277', 0, 1, 0, 6, 0 )
379       ENDIF
380       CLOSE ( 90 )
381    ENDIF
382
383    CALL location_message( 'reading environment parameters from ENVPAR', 'finished' )
384!
385!-- Calculate the number of groups into which parallel I/O is split.
386!-- The default for files which are opened by all PEs (or where each
387!-- PE opens his own independent file) is, that all PEs are doing input/output
388!-- in parallel at the same time. This might cause performance or even more
389!-- severe problems depending on the configuration of the underlying file
390!-- system.
391!-- Calculation of the number of blocks and the I/O group must be based on all
392!-- PEs involved in this run. Since myid and numprocs are related to the
393!-- comm2d communicator, which gives only a subset of all PEs in case of
394!-- nested runs, that information must be inquired again from the global
395!-- communicator.
396!-- First, set the default:
397#if defined( __parallel )
398    CALL MPI_COMM_RANK( MPI_COMM_WORLD, global_id, ierr )
399    CALL MPI_COMM_SIZE( MPI_COMM_WORLD, global_procs, ierr )
400#else
401    global_id    = 0
402    global_procs = 1
403#endif
404    IF ( maximum_parallel_io_streams == -1  .OR.                               &
405         maximum_parallel_io_streams > global_procs )  THEN
406       maximum_parallel_io_streams = global_procs
407    ENDIF
408!
409!-- Now calculate the number of io_blocks and the io_group to which the
410!-- respective PE belongs. I/O of the groups is done in serial, but in parallel
411!-- for all PEs belonging to the same group.
412    io_blocks = global_procs / maximum_parallel_io_streams
413    io_group  = MOD( global_id+1, io_blocks )
414   
415    CALL location_message( 'reading NAMELIST parameters from PARIN', 'start' )
416!
417!-- Data is read in parallel by groups of PEs
418    DO  i = 0, io_blocks-1
419       IF ( i == io_group )  THEN
420
421!
422!--       Open the NAMELIST-file which is send with this job
423          CALL check_open( 11 )
424
425!
426!--       Read the control parameters for initialization.
427!--       The namelist "inipar" must be provided in the NAMELIST-file.
428          READ ( 11, initialization_parameters, ERR=10, END=11 )
429          GOTO 14
430         
431 10       BACKSPACE( 11 )
432          READ( 11 , '(A)') line
433          CALL parin_fail_message( 'initialization_parameters', line )
434
435 11       REWIND ( 11 )
436          READ ( 11, inipar, ERR=12, END=13 )
437 
438          message_string = 'namelist inipar is deprecated and will be ' //    &
439                          'removed in near future. & Please use namelist ' // &
440                          'initialization_parameters instead'
441          CALL message( 'parin', 'PA0017', 0, 1, 0, 6, 0 )
442 
443          GOTO 14
444 
445 12       BACKSPACE( 11 )
446          READ( 11 , '(A)') line
447          CALL parin_fail_message( 'inipar', line )
448
449 13       message_string = 'no initialization_parameters-namelist found'
450          CALL message( 'parin', 'PA0272', 1, 2, 0, 6, 0 )
451
452!
453!--       Try to read runtime parameters given by the user for this run
454!--       (namelist "runtime_parameters"). The namelist "runtime_parmeters"   
455!--       can be omitted. In that case default values are used for the         
456!--       parameters.
457 14       line = ' '
458
459          REWIND ( 11 )
460          line = ' '
461          DO WHILE ( INDEX( line, '&runtime_parameters' ) == 0 )
462             READ ( 11, '(A)', END=16 )  line
463          ENDDO
464          BACKSPACE ( 11 )
465
466!
467!--       Read namelist
468          READ ( 11, runtime_parameters, ERR = 15 )
469          GOTO 18
470
471 15       BACKSPACE( 11 )
472          READ( 11 , '(A)') line
473          CALL parin_fail_message( 'runtime_parameters', line )
474
475 16       REWIND ( 11 )
476          line = ' '
477          DO WHILE ( INDEX( line, '&d3par' ) == 0 )
478             READ ( 11, '(A)', END=18 )  line
479          ENDDO
480          BACKSPACE ( 11 )
481
482!
483!--       Read namelist
484          READ ( 11, d3par, ERR = 17, END = 18 )
485
486          message_string = 'namelist d3par is deprecated and will be ' //      &
487                          'removed in near future. &Please use namelist ' //   &
488                          'runtime_parameters instead'
489          CALL message( 'parin', 'PA0487', 0, 1, 0, 6, 0 )
490
491          GOTO 18
492
493 17       BACKSPACE( 11 )
494          READ( 11 , '(A)') line
495          CALL parin_fail_message( 'd3par', line )
496
497 18       CONTINUE
498
499!
500!--       Check for module namelists and read them
501          CALL module_interface_parin
502
503!
504!--       If required, read control parameters from restart file (produced by
505!--       a prior run). All PEs are reading from file created by PE0 (see
506!--       check_open)
507          IF ( TRIM( initializing_actions ) == 'read_restart_data' )  THEN
508
509!
510!--          If not set by the user in the runtime parameters, the data format for restart
511!--          input needs to be set now! This is normally done later in check parameters.
512             IF ( TRIM( restart_data_format ) /= 'fortran_binary'  .AND.                           &
513                  TRIM( restart_data_format ) /= 'mpi' )  THEN
514                message_string = 'illegal restart data format "' // TRIM( restart_data_format ) // '"'
515                CALL message( 'parin', 'PA....', 1, 2, 0, 6, 0 )
516             ENDIF
517             IF ( TRIM( restart_data_format_input ) == 'undefined' )  THEN
518                restart_data_format_input = restart_data_format
519             ENDIF
520
521             CALL rrd_global
522!
523!--          Increment the run count
524             runnr = runnr + 1
525!
526!--          In case of a restart run, the number of user-defined profiles on
527!--          the restart file (already stored in max_pr_user) has to match the
528!--          one given for the current run. max_pr_user_tmp is calculated in
529!--          user_parin and max_pr_user is read in via rrd_global.
530             IF ( max_pr_user /= max_pr_user_tmp )  THEN
531                WRITE( message_string, * ) 'the number of user-defined ',      &
532                      'profiles given in data_output_pr (', max_pr_user_tmp,   &
533                      ') does not match the one ',                             &
534                      'found in the restart file (', max_pr_user, ')'
535                CALL message( 'user_parin', 'UI0009', 1, 2, 0, 6, 0 )
536             ENDIF
537          ELSE
538             max_pr_user = max_pr_user_tmp
539          ENDIF
540!
541!--       Activate spinup
542          IF ( land_surface .OR. urban_surface )  THEN
543             IF ( spinup_time > 0.0_wp )  THEN
544                coupling_start_time = spinup_time
545                time_since_reference_point = simulated_time - coupling_start_time
546                IF ( spinup_pt_mean == 9999999.9_wp )  THEN
547                   spinup_pt_mean = pt_surface
548                ENDIF
549                end_time = end_time + spinup_time
550                IF ( TRIM( initializing_actions ) /= 'read_restart_data' )  THEN
551                   spinup = .TRUE.
552                ELSEIF (        TRIM( initializing_actions ) == 'read_restart_data'      &
553                         .AND.  time_since_reference_point > 0.0_wp )  THEN
554                   data_output_during_spinup = .FALSE.  !< required for correct ntdim calculation
555                                                        !< in check_parameters for restart run
556                ENDIF
557             ENDIF
558          ENDIF
559
560!
561!--       In case of nested runs, explicitly set nesting boundary conditions.
562!--       This will overwrite the user settings and basic defaults.
563!--       bc_lr and bc_ns always need to be cyclic for vertical nesting.
564          IF ( nested_run )  THEN
565             IF ( nesting_mode == 'vertical' )  THEN
566                IF (bc_lr /= 'cyclic' .OR. bc_ns /= 'cyclic' )  THEN
567                   WRITE ( message_string, *) 'bc_lr and bc_ns were set to ,', &
568                        'cyclic for vertical nesting'
569                   CALL message( 'parin', 'PA0428', 0, 0, 0, 6, 0 )
570                   bc_lr   = 'cyclic'
571                   bc_ns   = 'cyclic'
572                ENDIF
573                IF ( child_domain )  THEN
574                   bc_uv_t  = 'nested'
575                   bc_pt_t  = 'nested'
576                   bc_q_t   = 'nested'
577                   bc_s_t   = 'nested'
578                   bc_cs_t  = 'nested'
579                   bc_p_t   = 'neumann' 
580                ENDIF
581!
582!--          For other nesting modes only set boundary conditions for
583!--          nested domains.
584             ELSE
585                IF ( child_domain )  THEN
586                   bc_lr    = 'nested'
587                   bc_ns    = 'nested'
588                   bc_uv_t  = 'nested'
589                   bc_pt_t  = 'nested'
590                   bc_q_t   = 'nested'
591                   bc_s_t   = 'nested'
592                   bc_cs_t  = 'nested'
593                   bc_p_t   = 'neumann'
594                ENDIF
595             ENDIF
596          ENDIF
597!
598!--       Set boundary conditions also in case the model is offline-nested in
599!--       larger-scale models.
600          IF ( nesting_offline )  THEN
601             bc_lr    = 'nesting_offline'
602             bc_ns    = 'nesting_offline'
603             bc_uv_t  = 'nesting_offline'
604             bc_pt_t  = 'nesting_offline'
605             bc_q_t   = 'nesting_offline'
606           !  bc_s_t   = 'nesting_offline'  ! scalar boundary condition is not clear yet
607           !  bc_cs_t  = 'nesting_offline'  ! same for chemical species
608             bc_p_t   = 'neumann'
609          ENDIF
610
611!         
612!--       In case of nested runs, make sure that initializing_actions =
613!--       'set_constant_profiles' even though the constant-profiles
614!--       initializations for the prognostic variables will be overwritten
615!--       by pmci_child_initialize and pmci_parent_initialize. This is,
616!--       however, important e.g. to make sure that diagnostic variables
617!--       are set properly. An exception is made in case of restart runs and
618!--       if user decides to do everything by its own.
619          IF ( child_domain  .AND.  .NOT. (                                    &
620               TRIM( initializing_actions ) == 'read_restart_data'      .OR.   &
621               TRIM( initializing_actions ) == 'set_constant_profiles'  .OR.   &
622               TRIM( initializing_actions ) == 'by_user' ) )  THEN
623             message_string = 'initializing_actions = ' //                     &
624                              TRIM( initializing_actions ) // ' has been ' //  &
625                              'changed to set_constant_profiles in child ' //  &
626                              'domain.' 
627             CALL message( 'parin', 'PA0492', 0, 0, 0, 6, 0 )
628
629             initializing_actions = 'set_constant_profiles'
630          ENDIF           
631!
632!--       Check validity of lateral boundary conditions. This has to be done
633!--       here because they are already used in init_pegrid and init_grid and
634!--       therefore cannot be check in check_parameters
635          IF ( bc_lr /= 'cyclic'  .AND.  bc_lr /= 'dirichlet/radiation'  .AND. &
636               bc_lr /= 'radiation/dirichlet'  .AND.  bc_lr /= 'nested'  .AND. &
637               bc_lr /= 'nesting_offline' )  THEN
638             message_string = 'unknown boundary condition: bc_lr = "' // &
639                              TRIM( bc_lr ) // '"'
640             CALL message( 'parin', 'PA0049', 1, 2, 0, 6, 0 )
641          ENDIF
642          IF ( bc_ns /= 'cyclic'  .AND.  bc_ns /= 'dirichlet/radiation'  .AND. &
643               bc_ns /= 'radiation/dirichlet'  .AND.  bc_ns /= 'nested'  .AND. &
644               bc_ns /= 'nesting_offline' )  THEN
645             message_string = 'unknown boundary condition: bc_ns = "' // &
646                              TRIM( bc_ns ) // '"'
647             CALL message( 'parin', 'PA0050', 1, 2, 0, 6, 0 )
648          ENDIF
649!
650!--       Set internal variables used for speed optimization in if clauses
651          IF ( bc_lr /= 'cyclic' )               bc_lr_cyc    = .FALSE.
652          IF ( bc_lr == 'dirichlet/radiation' )  bc_lr_dirrad = .TRUE.
653          IF ( bc_lr == 'radiation/dirichlet' )  bc_lr_raddir = .TRUE.
654          IF ( bc_ns /= 'cyclic' )               bc_ns_cyc    = .FALSE.
655          IF ( bc_ns == 'dirichlet/radiation' )  bc_ns_dirrad = .TRUE.
656          IF ( bc_ns == 'radiation/dirichlet' )  bc_ns_raddir = .TRUE.
657!
658!--       Radiation-Dirichlet conditions are allowed along one of the horizontal directions only.
659!--       In general, such conditions along x and y may work, but require a) some code changes
660!--       (e.g. concerning allocation of c_u, c_v ... arrays), and b) a careful model setup by the
661!--       user, in order to guarantee that there is a clearly defined outflow at two sides.
662!--       Otherwise, the radiation condition may produce wrong results.
663          IF ( ( bc_lr_dirrad .OR. bc_lr_raddir )  .AND.  ( bc_ns_dirrad .OR. bc_ns_raddir ) )  THEN
664             message_string = 'bc_lr = "' // TRIM( bc_lr ) // '" and bc_ns = "' //                 &
665                              TRIM( bc_ns ) // '" are not allowed to be set at the same time'
666             CALL message( 'parin', 'PA0589', 1, 2, 0, 6, 0 )
667          ENDIF
668!
669!--       Check in case of initial run, if the grid point numbers are well
670!--       defined and allocate some arrays which are already needed in
671!--       init_pegrid or check_parameters. During restart jobs, these arrays
672!--       will be allocated in rrd_global. All other arrays are allocated
673!--       in init_3d_model.
674          IF ( TRIM( initializing_actions ) /= 'read_restart_data' )  THEN
675
676             IF ( nx <= 0 )  THEN
677                WRITE( message_string, * ) 'no value or wrong value given',    &
678                                           ' for nx: nx=', nx
679                CALL message( 'parin', 'PA0273', 1, 2, 0, 6, 0 )
680             ENDIF
681             IF ( ny <= 0 )  THEN
682                WRITE( message_string, * ) 'no value or wrong value given',    &
683                                           ' for ny: ny=', ny
684                CALL message( 'parin', 'PA0274', 1, 2, 0, 6, 0 )
685             ENDIF
686             IF ( nz <= 0 )  THEN
687                WRITE( message_string, * ) 'no value or wrong value given',    &
688                                           ' for nz: nz=', nz
689                CALL message( 'parin', 'PA0275', 1, 2, 0, 6, 0 )
690             ENDIF
691
692!
693!--          As a side condition, routine flow_statistics require at least 14
694!--          vertical grid levels (they are used to store time-series data)
695!>           @todo   Remove this restriction
696             IF ( nz < 14 )  THEN
697                WRITE( message_string, * ) 'nz >= 14 is required'
698                CALL message( 'parin', 'PA0362', 1, 2, 0, 6, 0 )
699             ENDIF
700
701!
702!--          ATTENTION: in case of changes to the following statement please
703!--                  also check the allocate statement in routine rrd_global
704             ALLOCATE( pt_init(0:nz+1), q_init(0:nz+1), s_init(0:nz+1),        &
705                       ref_state(0:nz+1), sa_init(0:nz+1), ug(0:nz+1),         &
706                       u_init(0:nz+1), v_init(0:nz+1), vg(0:nz+1),             &
707                    hom(0:nz+1,2,pr_palm+max_pr_user+max_pr_cs+max_pr_salsa,0:statistic_regions),  &
708                    hom_sum(0:nz+1,pr_palm+max_pr_user+max_pr_cs+max_pr_salsa,0:statistic_regions) )
709
710             hom = 0.0_wp
711
712          ENDIF
713
714!
715!--       NAMELIST-file is not needed anymore
716          CALL close_file( 11 )
717
718       ENDIF
719#if defined( __parallel )
720       CALL MPI_BARRIER( MPI_COMM_WORLD, ierr )
721#endif
722    ENDDO
723
724    CALL location_message( 'reading NAMELIST parameters from PARIN', 'finished' )
725
726 END SUBROUTINE parin
Note: See TracBrowser for help on using the repository browser.