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

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

last commit documented

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