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

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

output of location messages to stdout

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