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

Last change on this file since 1353 was 1353, checked in by heinze, 7 years ago

REAL constants provided with KIND-attribute

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