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

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

last commit documented

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