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

Last change on this file since 1804 was 1804, checked in by maronga, 5 years ago

removed parameter file check. update of mrungui for compilation with qt5

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