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

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

ONLY-attribute added to USE-statements,
kind-parameters added to all INTEGER and REAL declaration statements,
kinds are defined in new module kinds,
old module precision_kind is removed,
revision history before 2012 removed,
comment fields (!:) to be used for variable explanations added to all variable declaration statements

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