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

Last change on this file since 1764 was 1764, checked in by raasch, 7 years ago

update of the nested domain system + some bugfixes

  • Property svn:keywords set to Id
File size: 22.1 KB
Line 
1!> @file parin.f90
2!--------------------------------------------------------------------------------!
3! This file is part of PALM.
4!
5! PALM is free software: you can redistribute it and/or modify it under the terms
6! of the GNU General Public License as published by the Free Software Foundation,
7! either version 3 of the License, or (at your option) any later version.
8!
9! PALM is distributed in the hope that it will be useful, but WITHOUT ANY
10! WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
11! A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
12!
13! You should have received a copy of the GNU General Public License along with
14! PALM. If not, see <http://www.gnu.org/licenses/>.
15!
16! Copyright 1997-2015 Leibniz Universitaet Hannover
17!--------------------------------------------------------------------------------!
18!
19! Current revisions:
20! -----------------
21! cpp-statements for nesting removed, explicit settings of boundary conditions
22! in nest domains,
23! bugfix: npex/npey message moved from inipar to d3par
24! bugfix: check of lateral boundary conditions from check_parameters to here,
25! because they will be already used in init_pegrid and init_grid
26!
27! Former revisions:
28! -----------------
29! $Id: parin.f90 1764 2016-02-28 12:45:19Z raasch $
30!
31! 1762 2016-02-25 12:31:13Z hellstea
32! Introduction of nested domain feature
33!
34! 1691 2015-10-26 16:17:44Z maronga
35! Added parameter most_method. Renamed prandtl_layer to constant_flux_layer.
36!
37! 1682 2015-10-07 23:56:08Z knoop
38! Code annotations made doxygen readable
39!
40! 1560 2015-03-06 10:48:54Z keck
41! +recycling_yshift
42!
43! 1496 2014-12-02 17:25:50Z maronga
44! Renamed: "radiation -> "cloud_top_radiation"
45!
46! 1484 2014-10-21 10:53:05Z kanani
47! Changes due to new module structure of the plant canopy model:
48!   canopy-model related parameters moved to new package canopy_par in
49!   subroutine package_parin
50!
51! 1429 2014-07-15 12:53:45Z knoop
52! +ensemble_member_nr to prepare the random_generator for ensemble runs
53!
54! 1402 2014-05-09 14:25:13Z raasch
55! location messages modified, batch_job included in envpar-NAMELIST
56!
57! 1384 2014-05-02 14:31:06Z raasch
58! location messages added
59!
60! 1365 2014-04-22 15:03:56Z boeske
61! Usage of large scale forcing enabled:
62! +use_subsidence_tendencies
63!
64! 1361 2014-04-16 15:17:48Z hoffmann
65! +call_microphysics_at_all_substeps
66!
67! 1359 2014-04-11 17:15:14Z hoffmann
68! REAL constants provided with KIND-attribute
69!
70! 1353 2014-04-08 15:21:23Z heinze
71! REAL constants provided with KIND-attribute
72!
73! 1327 2014-03-21 11:00:16Z raasch
74! -data_output_format, do3d_compress, do3d_comp_prec
75!
76! 1320 2014-03-20 08:40:49Z raasch
77! ONLY-attribute added to USE-statements,
78! kind-parameters added to all INTEGER and REAL declaration statements,
79! kinds are defined in new module kinds,
80! old module precision_kind is removed,
81! revision history before 2012 removed,
82! comment fields (!:) to be used for variable explanations added to
83! all variable declaration statements
84!
85! 1318 2014-03-17 13:35:16Z raasch
86! +cpu_log_barrierwait in d3par
87!
88! 1301 2014-03-06 13:29:46Z heinze
89! +large_scale_subsidence
90!
91! 1241 2013-10-30 11:36:58Z heinze
92! +nudging
93! +large_scale_forcing
94!
95! 1216 2013-08-26 09:31:42Z raasch
96! +transpose_compute_overlap in inipar
97!
98! 1195 2013-07-01 12:27:57Z heinze
99! Bugfix: allocate ref_state
100!
101! 1179 2013-06-14 05:57:58Z raasch
102! +reference_state in inipar
103!
104! 1159 2013-05-21 11:58:22Z fricke
105! +use_cmax
106!
107! 1128 2013-04-12 06:19:32Z raasch
108! +background_communication in inipar
109!
110! 1115 2013-03-26 18:16:16Z hoffmann
111! unused variables removed
112!
113! 1092 2013-02-02 11:24:22Z raasch
114! unused variables removed
115!
116! 1065 2012-11-22 17:42:36Z hoffmann
117! +nc, c_sedimentation, limiter_sedimentation, turbulence
118! -mu_constant, mu_constant_value
119!
120! 1053 2012-11-13 17:11:03Z hoffmann
121! necessary expansions according to the two new prognostic equations (nr, qr)
122! of the two-moment cloud physics scheme and steering parameters:
123! +*_init, *_surface, *_surface_initial_change, *_vertical_gradient,
124! +*_vertical_gradient_level, surface_waterflux_*,
125! +cloud_scheme, drizzle, mu_constant, mu_constant_value, ventilation_effect
126!
127! 1036 2012-10-22 13:43:42Z raasch
128! code put under GPL (PALM 3.9)
129!
130! 1015 2012-09-27 09:23:24Z raasch
131! -adjust_mixing_length
132!
133! 1003 2012-09-14 14:35:53Z raasch
134! -grid_matching
135!
136! 1001 2012-09-13 14:08:46Z raasch
137! -cut_spline_overshoot, long_filter_factor, overshoot_limit_*, ups_limit_*
138!
139! 996 2012-09-07 10:41:47Z raasch
140! -use_prior_plot1d_parameters
141!
142! 978 2012-08-09 08:28:32Z fricke
143! -km_damp_max, outflow_damping_width
144! +pt_damping_factor, pt_damping_width
145! +z0h_factor
146!
147! 964 2012-07-26 09:14:24Z raasch
148! -cross_normalized_x, cross_normalized_y, cross_xtext, z_max_do1d,
149! z_max_do1d_normalized
150!
151! 940 2012-07-09 14:31:00Z raasch
152! +neutral in inipar
153!
154! 927 2012-06-06 19:15:04Z raasch
155! +masking_method in inipar
156!
157! 824 2012-02-17 09:09:57Z raasch
158! +curvature_solution_effects in inipar
159!
160! 809 2012-01-30 13:32:58Z maronga
161! Bugfix: replaced .AND. and .NOT. with && and ! in the preprocessor directives
162!
163! 807 2012-01-25 11:53:51Z maronga
164! New cpp directive "__check" implemented which is used by check_namelist_files
165!
166! Revision 1.1  1997/07/24 11:22:50  raasch
167! Initial revision
168!
169!
170! Description:
171! ------------
172!> This subroutine reads variables controling the run from the NAMELIST files
173!------------------------------------------------------------------------------!
174 SUBROUTINE parin
175 
176
177    USE arrays_3d,                                                             &
178        ONLY:  pt_init, q_init, ref_state, sa_init, ug, u_init, v_init,        &
179               vg
180
181    USE cloud_parameters,                                                      &
182        ONLY:  c_sedimentation, curvature_solution_effects,                    &
183               limiter_sedimentation, nc_const, ventilation_effect
184
185    USE control_parameters
186
187    USE cpulog,                                                                &
188        ONLY:  cpu_log_barrierwait
189
190    USE dvrp_variables,                                                        &
191        ONLY:  local_dvrserver_running
192
193    USE grid_variables,                                                        &
194        ONLY:  dx, dy
195
196    USE indices,                                                               &
197        ONLY:  nx, ny, nz
198
199    USE kinds
200
201    USE model_1d,                                                              &
202        ONLY:  damp_level_1d, dt_pr_1d, dt_run_control_1d, end_time_1d
203
204    USE pegrid
205
206    USE pmc_interface,                                                         &
207        ONLY:  nested_run
208
209    USE profil_parameter,                                                      &
210        ONLY:  cross_profiles, cross_ts_uymax, cross_ts_uymin,                 &
211               profile_columns, profile_rows
212
213    USE progress_bar,                                                          &
214        ONLY :  batch_job
215
216    USE statistics,                                                            &
217        ONLY:  hom, hom_sum, pr_palm, region, statistic_regions
218
219
220    IMPLICIT NONE
221
222    INTEGER(iwp) ::  i   !<
223
224
225    NAMELIST /inipar/  alpha_surface, background_communication, bc_e_b, bc_lr, &
226                       bc_ns, bc_p_b, bc_p_t, bc_pt_b, bc_pt_t, bc_q_b,        &
227             bc_q_t,bc_s_b, bc_s_t, bc_sa_t, bc_uv_b, bc_uv_t,                 &
228             bottom_salinityflux, building_height, building_length_x,          &
229             building_length_y, building_wall_left, building_wall_south,       &
230             call_psolver_at_all_substeps, call_microphysics_at_all_substeps,  &
231             canyon_height,                                                    &
232             canyon_width_x, canyon_width_y, canyon_wall_left,                 &
233             canyon_wall_south, c_sedimentation, cfl_factor, cloud_droplets,   &
234             cloud_physics, cloud_scheme, cloud_top_radiation,                 &
235             collective_wait, conserve_volume_flow,                            &
236             conserve_volume_flow_mode, constant_flux_layer,                   &
237             coupling_start_time,                                              &
238             curvature_solution_effects, cycle_mg, damp_level_1d,              &
239             dissipation_1d,                                                   &
240             dp_external, dp_level_b, dp_smooth, dpdxy,                        &
241             drizzle, dt, dt_pr_1d, dt_run_control_1d, dx, dy, dz, dz_max,     & 
242             dz_stretch_factor, dz_stretch_level, end_time_1d,                 &
243             ensemble_member_nr,                                               &
244             e_init, e_min, fft_method, galilei_transformation, humidity,      &
245             inflow_damping_height, inflow_damping_width,                      &
246             inflow_disturbance_begin, inflow_disturbance_end,                 &
247             initializing_actions, km_constant,                                &
248             large_scale_forcing, large_scale_subsidence,                      &
249             limiter_sedimentation,                                            &
250             loop_optimization, masking_method, mg_cycles,                     &
251             mg_switch_to_pe0_level, mixing_length_1d, momentum_advec,         &
252             most_method, nc_const, netcdf_precision, neutral, ngsrb,          &
253             nsor, nsor_ini, nudging, nx, ny, nz, ocean, omega, omega_sor,     &
254             passive_scalar, phi,                                              &
255             prandtl_number, precipitation, psolver, pt_damping_factor,        &
256             pt_damping_width, pt_reference, pt_surface,                       &
257             pt_surface_initial_change, pt_vertical_gradient,                  &
258             pt_vertical_gradient_level, q_surface, q_surface_initial_change,  &
259             q_vertical_gradient, q_vertical_gradient_level,                   &
260             random_generator, random_heatflux,                                &
261             rayleigh_damping_factor, rayleigh_damping_height,                 &
262             recycling_width, recycling_yshift,                                &
263             reference_state, residual_limit,                                  &
264             roughness_length, sa_surface,                                     &
265             sa_vertical_gradient, sa_vertical_gradient_level, scalar_advec,   &
266             scalar_rayleigh_damping,                                          &
267             statistic_regions, subs_vertical_gradient,                        &
268             subs_vertical_gradient_level, surface_heatflux, surface_pressure, &
269             surface_scalarflux, surface_waterflux,                            &
270             s_surface, s_surface_initial_change, s_vertical_gradient,         &
271             s_vertical_gradient_level, timestep_scheme,                       &
272             topography, topography_grid_convention, top_heatflux,             &
273             top_momentumflux_u, top_momentumflux_v, top_salinityflux,         &
274             transpose_compute_overlap, turbulence, turbulent_inflow,          &
275             use_subsidence_tendencies, ug_surface, ug_vertical_gradient,      &
276             ug_vertical_gradient_level, use_surface_fluxes, use_cmax,         &
277             use_top_fluxes, use_ug_for_galilei_tr, use_upstream_for_tke,      &
278             uv_heights, u_bulk, u_profile, vg_surface, vg_vertical_gradient,  &
279             vg_vertical_gradient_level, v_bulk, v_profile, ventilation_effect,&
280             wall_adjustment, wall_heatflux, wall_humidityflux,                &
281             wall_scalarflux, zeta_max, zeta_min, z0h_factor
282     
283    NAMELIST /d3par/  averaging_interval, averaging_interval_pr,               &
284             cpu_log_barrierwait, create_disturbances,                         &
285             cross_profiles, cross_ts_uymax, cross_ts_uymin,                   &
286             data_output, data_output_masks,                                   &
287             data_output_pr, data_output_2d_on_each_pe, disturbance_amplitude, &
288             disturbance_energy_limit, disturbance_level_b,                    &
289             disturbance_level_t, do2d_at_begin, do3d_at_begin,                &
290             dt, dt_averaging_input, dt_averaging_input_pr,                    &
291             dt_coupling, dt_data_output, dt_data_output_av, dt_disturb,       &
292             dt_domask, dt_dopr, dt_dopr_listing, dt_dots, dt_do2d_xy,         &
293             dt_do2d_xz, dt_do2d_yz, dt_do3d, dt_max, dt_restart,              &
294             dt_run_control,end_time, force_print_header, mask_scale_x,        &
295             mask_scale_y, mask_scale_z, mask_x, mask_y, mask_z, mask_x_loop,  &
296             mask_y_loop, mask_z_loop, netcdf_data_format, normalizing_region, &
297             npex, npey, nz_do3d, precipitation_amount_interval,               &
298             profile_columns, profile_rows, restart_time, section_xy,          &
299             section_xz, section_yz, skip_time_data_output,                    &
300             skip_time_data_output_av, skip_time_dopr, skip_time_do2d_xy,      &
301             skip_time_do2d_xz, skip_time_do2d_yz, skip_time_do3d,             &
302             skip_time_domask, synchronous_exchange, termination_time_needed,  &
303             z_max_do2d
304
305
306    NAMELIST /envpar/  batch_job, host, local_dvrserver_running,               &
307                       maximum_cpu_time_allowed, maximum_parallel_io_streams,  &
308                       revision, return_addres, return_username,               &
309                       run_identifier, tasks_per_node, write_binary
310
311!
312!-- First read values of environment variables (this NAMELIST file is
313!-- generated by mrun)
314    CALL location_message( 'reading environment parameters from ENVPAR', .FALSE. )
315    OPEN ( 90, FILE='ENVPAR', STATUS='OLD', FORM='FORMATTED', ERR=30 )
316    READ ( 90, envpar, ERR=31, END=32 )
317    CLOSE ( 90 )
318    CALL location_message( 'finished', .TRUE. )
319
320!
321!-- Calculate the number of groups into which parallel I/O is split.
322!-- The default for files which are opened by all PEs (or where each
323!-- PE opens his own independent file) is, that all PEs are doing input/output
324!-- in parallel at the same time. This might cause performance or even more
325!-- severe problems depending on the configuration of the underlying file
326!-- system.
327!-- First, set the default:
328    IF ( maximum_parallel_io_streams == -1  .OR.                               &
329         maximum_parallel_io_streams > numprocs )  THEN
330       maximum_parallel_io_streams = numprocs
331    ENDIF
332!
333!-- Now calculate the number of io_blocks and the io_group to which the
334!-- respective PE belongs. I/O of the groups is done in serial, but in parallel
335!-- for all PEs belonging to the same group.
336!-- These settings are repeated in init_pegrid for the communicator comm2d,
337!-- which is not available here
338    io_blocks = numprocs / maximum_parallel_io_streams
339    io_group  = MOD( myid+1, io_blocks )
340
341    CALL location_message( 'reading NAMELIST parameters from PARIN', .FALSE. )
342!
343!-- Data is read in parallel by groups of PEs
344    DO  i = 0, io_blocks-1
345       IF ( i == io_group )  THEN
346
347!
348!--       Open the NAMELIST-file which is send with this job
349          CALL check_open( 11 )
350
351!
352!--       Read the control parameters for initialization.
353!--       The namelist "inipar" must be provided in the NAMELIST-file.
354          READ ( 11, inipar, ERR=10, END=11 )
355
356#if defined ( __check )
357!
358!--       In case of a namelist file check, &inipar from the p3d file is
359!--       used. The p3d file here must be closed and the p3df file for reading
360!--       3dpar is opened.
361          IF ( check_restart == 1 )  THEN
362             CALL close_file( 11 )
363             check_restart = 2
364             CALL check_open( 11 )             
365             initializing_actions = 'read_restart_data'
366          ENDIF
367#endif
368          GOTO 12
369
370 10       message_string = 'errors in \$inipar &or no \$inipar-namelist ' //   &
371                           'found (CRAY-machines only)'
372          CALL message( 'parin', 'PA0271', 1, 2, 0, 6, 0 )
373
374 11       message_string = 'no \$inipar-namelist found'
375          CALL message( 'parin', 'PA0272', 1, 2, 0, 6, 0 )
376
377!
378!--       If required, read control parameters from restart file (produced by
379!--       a prior run). All PEs are reading from file created by PE0 (see
380!--       check_open)
381 12       IF ( TRIM( initializing_actions ) == 'read_restart_data' )  THEN
382#if ! defined ( __check )
383             CALL read_var_list
384!
385!--          The restart file will be reopened when reading the subdomain data
386             CALL close_file( 13 )
387
388!
389!--          Increment the run count
390             runnr = runnr + 1
391#endif
392          ENDIF
393
394!
395!--       In case of nested runs, explicitly set nesting boundary conditions
396!--       except for the root domain. This will overwrite the user settings.
397          IF ( nest_domain )  THEN
398             bc_lr   = 'nested'
399             bc_ns   = 'nested'
400             bc_uv_t = 'nested'
401             bc_pt_t = 'nested'
402             bc_p_t  = 'neumann'
403          ENDIF
404!
405!--       Check validity of lateral boundary conditions. This has to be done
406!--       here because they are already used in init_pegrid and init_grid and
407!--       therefore cannot be check in check_parameters
408          IF ( bc_lr /= 'cyclic'  .AND.  bc_lr /= 'dirichlet/radiation'  .AND. &
409               bc_lr /= 'radiation/dirichlet'  .AND.  bc_lr /= 'nested' )  THEN
410             message_string = 'unknown boundary condition: bc_lr = "' // &
411                              TRIM( bc_lr ) // '"'
412             CALL message( 'check_parameters', 'PA0049', 1, 2, 0, 6, 0 )
413          ENDIF
414          IF ( bc_ns /= 'cyclic'  .AND.  bc_ns /= 'dirichlet/radiation'  .AND. &
415               bc_ns /= 'radiation/dirichlet'  .AND.  bc_ns /= 'nested' )  THEN
416             message_string = 'unknown boundary condition: bc_ns = "' // &
417                              TRIM( bc_ns ) // '"'
418             CALL message( 'check_parameters', 'PA0050', 1, 2, 0, 6, 0 )
419          ENDIF
420
421!
422!--       Set internal variables used for speed optimization in if clauses
423          IF ( bc_lr /= 'cyclic' )               bc_lr_cyc    = .FALSE.
424          IF ( bc_lr == 'dirichlet/radiation' )  bc_lr_dirrad = .TRUE.
425          IF ( bc_lr == 'radiation/dirichlet' )  bc_lr_raddir = .TRUE.
426          IF ( bc_ns /= 'cyclic' )               bc_ns_cyc    = .FALSE.
427          IF ( bc_ns == 'dirichlet/radiation' )  bc_ns_dirrad = .TRUE.
428          IF ( bc_ns == 'radiation/dirichlet' )  bc_ns_raddir = .TRUE.
429
430!
431!--       Definition of names of areas used for computing statistics. They must
432!--       be defined at this place, because they are allowed to be redefined by
433!--       the user in user_parin.
434          region = 'total domain'
435
436!
437!--       Read runtime parameters given by the user for this run (namelist
438!--       "d3par"). The namelist "d3par" can be omitted. In that case, default
439!--       values are used for the parameters.
440          READ ( 11, d3par, END=20 )
441
442          IF ( nested_run )  THEN
443!
444!--          In nested domains, npex or npey can not be given in the d3par-
445!--          NAMELIST because here the PE-grids are always defined in the
446!--          nestpar-NAMELIST. Settings will be ignored.
447             IF ( ( npex /= -1 ) .OR. ( npey /= -1 ) )  THEN
448                message_string = 'npex or npey can not be given in \$d3par ' // &
449                                 'for nested runs & they will be ignored'
450                CALL message( 'parin', 'PA0352', 0, 1, 0, 6, 0 )
451             ENDIF
452          ENDIF
453
454!
455!--       Read control parameters for optionally used model software packages
456 20       CALL package_parin
457
458!
459!--       Read user-defined variables
460          CALL user_parin
461
462!
463!--       Check in case of initial run, if the grid point numbers are well
464!--       defined and allocate some arrays which are already needed in
465!--       init_pegrid or check_parameters. During restart jobs, these arrays
466!--       will be allocated in read_var_list. All other arrays are allocated
467!--       in init_3d_model.
468          IF ( TRIM( initializing_actions ) /= 'read_restart_data' )  THEN
469
470             IF ( nx <= 0 )  THEN
471                WRITE( message_string, * ) 'no value or wrong value given',    &
472                                           ' for nx: nx=', nx
473                CALL message( 'parin', 'PA0273', 1, 2, 0, 6, 0 )
474             ENDIF
475             IF ( ny <= 0 )  THEN
476                WRITE( message_string, * ) 'no value or wrong value given',    &
477                                           ' for ny: ny=', ny
478                CALL message( 'parin', 'PA0274', 1, 2, 0, 6, 0 )
479             ENDIF
480             IF ( nz <= 0 )  THEN
481                WRITE( message_string, * ) 'no value or wrong value given',    &
482                                           ' for nz: nz=', nz
483                CALL message( 'parin', 'PA0275', 1, 2, 0, 6, 0 )
484             ENDIF
485!
486!--          ATTENTION: in case of changes to the following statement please
487!--                  also check the allocate statement in routine read_var_list
488             ALLOCATE( pt_init(0:nz+1), q_init(0:nz+1),                       &
489                       ref_state(0:nz+1), sa_init(0:nz+1), ug(0:nz+1),         &
490                       u_init(0:nz+1), v_init(0:nz+1), vg(0:nz+1),             &
491                       hom(0:nz+1,2,pr_palm+max_pr_user,0:statistic_regions),  &
492                       hom_sum(0:nz+1,pr_palm+max_pr_user,0:statistic_regions) )
493
494             hom = 0.0_wp
495
496          ENDIF
497
498!
499!--       NAMELIST-file is not needed anymore
500          CALL close_file( 11 )
501
502       ENDIF
503#if defined( __parallel ) && ! ( __check )
504       CALL MPI_BARRIER( MPI_COMM_WORLD, ierr )
505#endif
506    ENDDO
507
508    CALL location_message( 'finished', .TRUE. )
509
510    RETURN
511
512 30 message_string = 'local file ENVPAR not found' //                          &
513                     '&some variables for steering may not be properly set'
514    CALL message( 'parin', 'PA0276', 0, 1, 0, 6, 0 )
515    RETURN
516
517 31 message_string = 'errors in local file ENVPAR' //                          &
518                     '&some variables for steering may not be properly set'
519    CALL message( 'parin', 'PA0277', 0, 1, 0, 6, 0 )
520    RETURN
521
522 32 message_string = 'no envpar-NAMELIST found in local file ENVPAR'  //       &
523                     '&some variables for steering may not be properly set'
524    CALL message( 'parin', 'PA0278', 0, 1, 0, 6, 0 )
525
526 END SUBROUTINE parin
Note: See TracBrowser for help on using the repository browser.