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

Last change on this file since 1354 was 1354, checked in by heinze, 9 years ago

last commit documented

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